JavaScript Game Engine

TempoJS is a JavaScript Game Engine for turn-based games on both Client or Server side.

Getting Started

First, install the package on your project via NPM.

npm i @katreque/tempojs --save

Here's a quick example of what to use in order to develop your game. Further documentation will added soon. :)

const { Action, GameLoop, Player, eventListener, GLOBAL_EVENTS } = require('tempojs');

class MyPlayer extends Player {
    constructor(id, Actions, name) {
        super(id, Actions);
        this.name = name;
    }
}

class MyAction extends Action {
    constructor(id, priority, subPriority) {
        super(id, priority, subPriority);
    }

    //The logic behind this Action.
    run() {
        console.log(`ID: ${this.id}, Priority: ${this.priority}, SubPriority: ${this.subPriority}`);
    }
}

const MA1 = new MyAction('Action 1', 1, 1);
const MA2 = new MyAction('Action 2', 1, 2);

const Player1 = new MyPlayer(1, [MA1], 'Pog Player');
const Player2 = new MyPlayer(2, [MA2], 'Noob Player');

//New Game Instance
const Game = new GameLoop([Player1, Player2], []);

//Global Events Listeners
eventListener(GLOBAL_EVENTS.turnEnded, () => {
    console.log('End of turn.');
});

//Run one turn of the game
await Game.runGameIteration();

/*
Output:

Name: Action 1, Priority: 1, SubPriority: 1
Name: Action 2, Priority: 1, SubPriority: 2
End of turn.
*/

Documentation

In The Future. :)

Contributing

Code of Conduct

Our Code of Conduct is adapted from the Contributor Covenant with some aditions. Make sure to read it in order to be part of our Community.

Contributing Guide

We appreciate any kind of contribution! :3 Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to TempoJS.

About

TempoJS was created by Renan "Katreque" Verissimo as a project with Terê AWS User Group. If you have any interest in learning about the ideia, share thoughts or want to join the team, feel free to join our Discord.

License

TempoJS is BSD 3-Clause Licensed.