JavaScript HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
examples
src
.gitignore
.jshintrc
CHANGELOG.md
Gruntfile.js
README.md
config.json
package.json
style-guide.md

README.md

Psykick2D


Psykick2D is an HTML5 game engine built with performance and usability in mind. Rendering is lightning fast with Pixi.js. Psykick2D aims to help your code be easy to work with, highly performant, and easily modified for special needs.


Features

  • Clean separation of concerns with an Entity-Component architecture
  • Easily modified camera system
  • Built in collision detection systems
  • Pre-built platformer physics (more coming soon)
  • Audio, images, and sprite sheets management
  • Keyboard, mouse, and gamepad support
  • Built in animation
  • Can be used as a Node.js module or loaded directly into the browser
  • Don't need everything? Use the custom build system to keep what you need

Requirements

Psykick2D requires a modern browser. I develop it in Chrome but have also tested in Firefox without any issues. Attempt in IE at your own risk.

Examples

All of the code and resources for the examples are in the examples folder.

Getting Started

Node.js

Just install it like you would any other module:

npm install psykick2d

Browser

If you just want to drop it in your browser and go, use the pre-built version:

build/psykick2d.js

Guides

For more information, check out the Getting Started guides or any one of the included examples.

How to Build

Building is just a simple grunt command: grunt build

Bugs

If you find any bugs, please submit them to the issue tracker.

Contributing

If you like Psykick2D and would like to help I'd love to have you! Feel free to tackle any bugs in the issue tracker or jump on the mailing list and talk about what you want out of the engine, stuff that needs to be fixed, anything. My vision is to make this a game engine by developers, for developers.

License

Psykick2D is licensed under the MIT License.