excalibur
Advanced tools
Changelog
[v0.29.2]
ex.ImageSource with the new ex.ImageWrapping.Clamp (default), ex.ImageWrapping.Repeat, and ex.ImageWrapping.Mirror.
const image = new ex.ImageSource('path/to/image.png', {
filtering: ex.ImageFiltering.Pixel,
wrapping: {
x: ex.ImageWrapping.Repeat,
y: ex.ImageWrapping.Repeat,
}
});
ex.TileMap's and individual ex.Tile'sex.IsometricMap's and individual ex.IsometricTile'suseAnchor parameter to ex.GraphicsGroup to allow users to opt out of anchor based positioning, if set to false all graphics members
will be positioned with the top left of the graphic at the actor's position.
const graphicGroup = new ex.GraphicsGroup({
useAnchor: false,
members: [
{
graphic: heartImage.toSprite(),
offset: ex.vec(0, 0),
},
{
graphic: heartImage.toSprite(),
offset: ex.vec(0, 16),
},
{
graphic: heartImage.toSprite(),
offset: ex.vec(16, 16),
},
{
graphic: heartImage.toSprite(),
offset: ex.vec(16, 0),
},
],
});
ex.coroutine overloads, you need not pass engine as long as you are in an Excalibur lifecycle
const result = ex.coroutine(function* () {...});
ex.coroutine overloads, you need not pass engine as long as you are in an Excalibur lifecycle
const result = ex.coroutine({myThis: 'cool'}, function* () {...});
ex.coroutine timing parameter to schedule when they are updated
const result = ex.coroutine(engine, function * () {...}, { timing: 'postupdate' })
GraphicsComponent.bounds which will report the world bounds of the graphic if applicable!ex.Vector.EQUALS_EPSILON to configure the ex.Vector.equals(v) thresholdconst game = new ex.Engine({
handleContextLost: (e) => {...},
handleContextRestored: (e) => {...}
})
ex.TileMap culling did not work properly when using fixed updates lower than refresh rateex.FontSource().toFont(options)ex.Loader start button position when using CSS transformsex.LoaderDisplayMode.FillContainerDisplayMode.FitContainerDisplayMode.FitContainerAndFillDisplayMode.FitContainerAndZoomex.ParticleEmitter z-index did not propagate to particlestransform.scale = v and transform.scale.setTo(x, y)ex.coroutine TypeScript type to include yielding undefinedColor.toHex() produced invalid strings if the channel values are negative or fractional, or if the alpha channel was different than 1ex.Loader viewport/resolution internal configurationReadme
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!
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!
Visit the API Reference section for fully-annotated documentation of the API.
Compiled examples can be found in the Excalibur Samples collection.
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!
Prerequisites
docker-compose build (setup build environment and installs dependencies, only needed once)docker-compose run --rm dev npm run test:watchdocker-compose run --rm dev npm run allWe love when people help improve our documentation. You can contribute to the docs in this repo under /site
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.
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.
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
# Build a nuget package and specify a version
npm run nuget -- 1.1.1
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.
FAQs
Excalibur.js is a simple JavaScript game engine with TypeScript bindings for making 2D games in HTML5 Canvas. Our mission is to make web game development as simple as possible.
The npm package excalibur receives a total of 2,518 weekly downloads. As such, excalibur popularity was classified as popular.
We found that excalibur demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.