Xedge>> Excalibur>> 返回
项目作者： excaliburjs

项目描述 ：
🎮 An easy to use 2D HTML5 game engine written in TypeScript
高级语言： TypeScript
项目地址: git://github.com/excaliburjs/Excalibur.git
创建时间： 2013-01-05T17:05:56Z
项目社区：https://github.com/excaliburjs/Excalibur
开源协议：BSD 2-Clause "Simplified" License
下载


Logo

CI
Coverage Status
npm version
npm downloads
NuGet version
Discord

Sweep Stacks

Excalibur is a free game engine written in TypeScript for making 2D games in HTML5 canvas. Our goal is to make it easier for you to create 2D HTML/JS games, whether you’re new to game development or you’re an experienced game developer. We take care of all of the boilerplate engine code, cross-platform targeting (using browserstack 😎), and more! Use as much or as little as you need!

Excalibur is an open source project licensed under the 2-clause BSD license (this means you can use it in commercial projects!). It’s free and always will be. We welcome any feedback or contributions! If you make something with Excalibur, please let us know!

Get Started

Our user documentation is at https://excaliburjs.com/docs (and you can contribute to the docs at https://github.com/excaliburjs/Excalibur/tree/main/site)

:exclamation: Note: Excalibur is still in version 0.x, which means this project and its associated plugins may be a little rough around the edges. We try to minimize API changes, but breaking changes will occur in new released versions. Excalibur is a labor of love and the product of many hours of spare time. Thanks for checking it out!

API Reference

Visit the API Reference section for fully-annotated documentation of the API.

Questions

Samples

Compiled examples can be found in the Excalibur Samples collection.

Contributing

Please read our Contributing Guidelines and our Code of Conduct. Whether you’ve spotted a bug, have a question, or think of a new feature, we thank you for your help!

Mac/Linux

Prerequisites

  • Docker for Mac https://docs.docker.com/desktop/mac/install/
  • In the root, run docker compose build (setup build environment and installs dependencies, only needed once)
  • To run tests in watch mode docker compose run --rm dev npm run test:watch
  • To run a build docker compose run --rm dev npm run all

Writing Documentation

We love when people help improve our documentation. You can contribute to the docs in this repo under /site

Environment Setup

The Excalibur.js team primarily uses Visual Studio Code as a platform agnostic editor to
allow the widest contributions possible. However, you can always use your own preferred editor.

Testing

Browserstack

Excalibur is committed to supporting the latest 2 versions of popular desktop and mobile browsers. We leverage browserstack automated testing to ensure that Excalibur is automatically tested as thoroughly as possible on all our supported platforms.

Prerequisites

After cloning the repository, run:

  1. npm install

You can then run the npm tasks for various purposes:

  1. # Run compilation, linting, and all unit & visual tests
  2. # Recommend to do this before finalizing pull requests
  3. npm run all
  5. # Run engine core compilation only
  6. # Useful for quick checks to ensure everything compiles
  7. npm run build
  9. # Run engine tests only (does not run compile task)
  10. # Useful to run tests ad-hoc
  11. npm test
  12. npm run test
  14. # Start Storybook-based sandbox
  15. # Used for creating interactive visual tests and examples for docs
  16. npm run sandbox
  18. # Build a nuget package and specify a version
  19. npm run nuget -- 1.1.1

License

Excalibur is open source and operates under the 2-clause BSD license:

  1. BSD 2-Clause License
  3. Copyright (c) 2014, Erik Onarheim
  4. All rights reserved.
  6. Redistribution and use in source and binary forms, with or without
  7. modification, are permitted provided that the following conditions are met:
  9. * Redistributions of source code must retain the above copyright notice, this
  10.   list of conditions and the following disclaimer.
  12. * Redistributions in binary form must reproduce the above copyright notice,
  13.   this list of conditions and the following disclaimer in the documentation
  14.   and/or other materials provided with the distribution.
  16. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  20. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  22. SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  23. CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  24. OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.