AthenaJS
© 2017, Nicolas Ramz (@warpdesign). MIT licence.
A simple framework for building 2D games in HTML5 and JavaScript.
- Read the tutorials to get started with AthenaJS
- Visit the API documentation for a list of classes and methods available
- Clone samples repository to get started with AthenaJS
- For an example of a complete game written using AthenaJS check the athenajs-tetris repository
Features
Here is a non-exhaustive list of features of AthenaJS:
- Unlimited number of scenes with an unlimited number of sprites
- Image-based Sprites with any number of animations
- Tiles-based Maps with horizontal & vertical scrolling
- Special scene transition effects like Fades, Mosaic can be added easily
- Map VS Sprite and Sprite vs Sprite collision detection
- Map Triggers support
- Sound support with volume and horizontal panning
- Keyboard & Joytisck input event supported (touch support is planned)
Install
npm install athenajs --save
Quick Start
ES2015
; // create a new gameconst myGame = name: 'first-game' width: 320 height: 200// create a new empty scenemyScene = MyScene extends Scene { const myText = 'my text' text: 'This is a test' color: 'black' ; // add the object onto the scene this; }; // play this scenemyGame;
ES5
in your html file:
Apps written using AthenaJS
Contributing
If you are interested in contributing to the AthenaJS code base, simply fork the repository and make a pull-request.
Once you have cloned the repository, simply type:
npm install && npm link && npm start
This will install the prerequisites, add a link to athenajs into your global npm modules directory and build & start watching for changes.
Now to start using athenaJS for testing, simply type the following in the directory of your project using AthenaJS:
npm link athenajs
This will add a link from your project to the global athenajs link that was just created.
License
Copyright (c) Nicolas Ramz.
Licensed under the MIT License.