A simple implementation of a Finite State Machine to use with Phaser 3.
Add to your project through npm
.
npm install --save gux-fsm
Then import into your project either through a script
tag:
<script src="//node_modules/gux-fsm/dist/gux-fsm.umd.js"></script>
Or as a commonjs
, es6
, or typescript
module:
// CommonJS
const {State, StateMachine} = require('gux-fsm');
// ES6 and Typescript
import {State, StateMachine} from 'gux-fsm';
You can find the Typescript types
at ./dist/types/gux-fsm.d.ts
.
Tests with NodeJS 6 failed, though it might work.
- 11
- 10
- 8
This library was meant to be used with Phaser, though it isn't a requirement. For now part of the API might look weird if taken outside a Phaser app, but there is nothing special unwarranting its use for a diferent project.
I use jest
to run the tests. To run them just do:
npm run test
- typescript-library-starter - Typescript library starter kit.
Do what you want and create a PR. If it's cool, it will get merged. If it isn't we'll work it untili it is, and then it'll get merged.
I use I would like to use, or at least, I am trying to use, SemVer for versioning. For the versions available, see the tags on this repository.
- Guzmán Monné - Initial work - guzmonne
This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details
Heavily inspired by the State
chapter of the book "Game Programming Patterns", by Robert Nystrom. You should read this book if you want to delve into game programming.