Giter Club home page Giter Club logo

ecs's Introduction

Warning: This package is currently not being maintained. Use ECSY instead.

BrowserByte/ECS

Simple Entity Component System written in TypeScript.

Features

  • Fully written in TypeScript
  • Fully tested
  • Large focus on performance, handles thousands of entities without a problem.
  • Simple API
  • Component serialization and deserialization (for networking or storage purposes).
  • Used in multiple real-world applications.

Installation

Using npm:

$ npm install @browserbyte/ecs

Using yarn:

$ yarn add @browserbyte/ecs

Example usage

Below is a small example on how you could use this package, there are multiple ways to accomplish certain things.

// Create a component class
class TestComponent extends Component
{
    public testValue: number;

    constructor(testValue: number) {
        super();

        this.testValue = testValue;
    }

    allowMultiple = true;
}

// Create a system
class TestSystem extends System
{
    private _testFamily!: Family;

    onAttach(engine: Engine): void {
        this._testFamily = engine.createFamily([], [ TestComponent ], []);
    }

    update(delta: number): void {
        this._testFamily.entities.forEach(entity => {
            const testComponent = testTwoEntity.getComponent(TestComponent);
            testComponent.testValue += 1;
        });
    }
}

// Create the ECS and attach a system
const ECS = new Engine(TestSystem);

// Create an entity with a component
const testEntity = ECS.createEntity(new TestComponent(2));

// Start the update loop
setInterval(() => ECS.update(deltaTime), 1000);

See the /examples folder for more example usages.

Resources / Inspirations

ecs's People

Contributors

ansien avatar

Stargazers

 avatar

Watchers

 avatar

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.