Negligent Parachute Maintainers

    excalibur
    TypeScript icon, indicating that this package has built-in type declarations

    0.26.0 • Public • Published

    Logo

    Appveyor status Coverage Status npm version npm downloads NuGet version

    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/excaliburjs.github.io)

    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!

    Writing Documentation

    We love when people help improve our documentation. You can contribute to the docs in this repository.

    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:

    npm install

    You can then run the npm tasks for various purposes:

    # Run compilation, linting, and all unit & visual tests
    # Recommend to do this before finalizing pull requests
    npm run all
    
    # Run engine core compilation only
    # Useful for quick checks to ensure everything compiles
    npm run build
    
    # Run engine tests only (does not run compile task)
    # Useful to run tests ad-hoc
    npm test
    npm run test
    
    # Start Storybook-based sandbox
    # Used for creating interactive visual tests and examples for docs
    npm run sandbox
    
    # Compile API docs
    npm run apidocs
    
    # Build a nuget package and specify a version
    npm run nuget -- 1.1.1

    License

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

    BSD 2-Clause 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:
    
    * Redistributions of source code must retain the above copyright notice, this
      list of conditions and the following disclaimer.
    
    * 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 HOLDER 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.
    

    Install

    npm i excalibur

    DownloadsWeekly Downloads

    3,264

    Version

    0.26.0

    License

    BSD-2-Clause

    Unpacked Size

    14 MB

    Total Files

    542

    Last publish

    Collaborators

    • jedeen
    • eonarheim
    • kamranayub
    • alanag13