Excalibur is a simple, free game engine written in TypeScript for making 2D games in HTML5 canvas. Our goal with Excalibur is to make it incredibly simple to create and write 2D HTML/JS games aimed at folks new to game development all the way up to more experienced game developers. We take care of all the boilerplate engine code, cross-platform targeting, and more so you don't have to. 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 Excalbur, please let us know so we can feature you in our online gallery.
Our user documentation is at http://docs.excaliburjs.com.
- Follow our Installation guide to learn how to install Excalibur
- Follow our Getting Started guide if you're looking to get started.
- Learn what Features are available for you to leverage in your games
- View the Release roadmap to see what's coming next
Please note while we try to minimize API changes, we are still in 0.x which means breaking changes will occur in new released versions.
Visit the API Documentation section for full annotated API documentation.
The master branch documentation is always available and up-to-date on our Edge documentation site.
Ask us anything in the Excalibur.js forum. If you find a bug, report it on the GitHub issues page (please review our guidelines for reporting bugs). You can also follow us on Twitter @excaliburjs for updates or read the blog.
Compiled examples can be found in the Excalibur Samples.
Please view the Contributing guidelines. Whether you've spotted a bug, have a question, or think of a good feature, we thank you for your help!
The Excalibur.js team primarily uses Visual Studio Code as a platform agnostic editor to allow the widest contributions possible. You can always use your own preferred editor of choice.
After cloning the repository, install the dependencies:
npm install grunt-cli -g
npm installYou can then run the grunt tasks for various purposes:
# Run compilation, linting, and all unit & visual tests
# Recommend to do this before finalizing pull requests
grunt
# Run engine core compilation only
grunt compile
# Run engine compilation & tests only
grunt tests
# Run sandbox compilation only
grunt sample
# Run visual tests compilation only
grunt visualExcalibur is open source and operates under the 2-clause BSD license:
Copyright (c) 2014, Erik Onarheim
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.