Excalibur.js

_images/logo.png

https://travis-ci.org/excaliburjs/Excalibur.png?branch=master https://badge.fury.io/bo/excalibur.png https://badge.fury.io/nu/Excalibur.png

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.

Installation

Follow our Installing Excalibur.js guide.

Getting Started

Follow our Getting Started guide.

API Documentation

The master branch API documentation is always available and up-to-date on our Edge documentation site.

Otherwise, see the TOC on the left to find the stable API documentation.

Support

Ask us anything in the Excalibur.js mailing list. If you find a bug, report it on the GitHub issues page.

Samples

Compiled examples can be found in the Excalibur Samples.

Contributing

Please view the Contributing guidelines. If you spot a bug, have a question, or want to contribute, please open a GitHub issue!

License

Excalibur 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.

Indices and tables