Code Monkey home page Code Monkey logo

tempojs's Introduction

drawing

JavaScript Game Engine

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

Downloads NPM Coverage Status Discord code style: prettier License

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.

tempojs's People

Contributors

katreque avatar marcelaomp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

tempojs's Issues

Fix core tests on GameLoop

The core tests from GameLoop are not working properly. The Sinon Spies calledOnce are returning false, even though the spied functions are called.

test('runGameIteration should work.', async (t) => {

test('runGameIteration should stop once stopGameIteration is called.', (t) => {

Maybe the spies are not being used properly or the runGameIteration function is not well structured.
Help is wanted since these tests assure the functioning of the engine.

Fix the CD for NPM Publish

The CD for the automatic publish to NPM and GitHub Packages are not working properly. The auto increment of the package version is probably failing in some point.

Add number of turns on GameLoop class

Changes should be done on GameLoop class. (src/classes/GameLoop.js)

  • Add property for number of turns.
  • The prop should be incremented on turnEnded event.

Add and Remove actions on Player class

Changes should be done on Player class. (src/classes/Player.js)

  • Add method to add Action(s) to the Actions array.
  • Add method to remove Action by id from the Actions array.
  • Add method to remove all Actions from the Actions array.

This issue should be done after #5 be closed.

Let EventEmitter send info

Currently the EventEmitter function do not allow send data to the EventListener, it does only calls.

function eventEmitter(id: string): any {

The events API already allows it, so it should add to our event system.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.