npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@krol22/ecs

v0.2.3

Published

Javascript entity component system

Downloads

7

Readme

ECS

ECS is a Entity Component System written in TypeScript for developing small JS games.

Installation

Use the npm repository to install ecs.

npm install @krol22/ecs

Basic usage

First create component class that will extend EcsComponent with some data that you would like to use in your systems.

I will create DrawComponent that will be responsible for keeping necessary data for rendering object on canvas.

import { EcsComponent } from '@krol22/ecs';

export default class DrawComponent extends EcsComponent {
  constructor(x, y, imageUrl) {
    super('DRAW'); // You need to set component type in order to find it in your entities.
    
    this.x = x;
    this.y = y;
    this.image = imageUrl;
  }
}

Next you need to implement system that will be responsible for rendering our object based on DrawComponent data.

import { EcsSystem } from '@krol22/ecs';

export default class DrawSystem extends EcsSystem {
  constructor(graphicsManager) {
    super(['DRAW']) // Only entities with component 'DRAW' will be in systemEntities property. This is auto populated when entity is added to ECS,
    
    this.graphicsManager = graphicsManager;
  }
  
  tick(delta) {
    this.systemEntities.forEach(entity => {
      const drawComponent = entity.getComponent('DRAW');
      const { x, y, imageUrl } = drawComponent;
      
      this.graphicsManager.draw(x, y, imageUrl);
    });
  }
}

Then you need to create actuall ECS instance and add your entities.

import { ECS, EcsEntity } from '@krol22/ecs';

import DrawSystem from './draw.system';
import DrawComponent from './draw.component';

const graphicsManager = {
  draw: () => { /* TODO implement me */ }
};

const ecs = new ECS;

const initialize = () => {
  const drawSystem = new DrawSystem(graphicsManager);
 	
  // IMPORTANT - you need to add all systems to ecs before entites, if you change order `systemEntities` property will not be correctly populated
  ecs.addSystem(drawSystem);
  
  const player = new EcsEntity([
    new DrawComponent(0, 0, './assets/player.png'),
  ]);
  
  ecs.addEntity(player);
}

const loop = () => {
  ecs.update();
  window.requestAnimationFrame(loop);
};

initialize();
loop();

Done!