TypeScript library starter

Gux-FSM - gux-fsm

A simple implementation of a Finite State Machine to use with Phaser 3.

Getting Started

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.

Versiones de Node.JS soportadas

Tests with NodeJS 6 failed, though it might work.

• 11
• 10
• 8

Prerequisites

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.

Running the tests

I use jest to run the tests. To run them just do:

npm run test

Built With

• typescript-library-starter - Typescript library starter kit.

Contributing

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.

Versioning

~~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.

Authors

• Guzmán Monné - Initial work - guzmonne

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details

Acknowledgments

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.