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

orion-ecs

v0.1.1

Published

A lightweight and flexible Entity Component System (ECS) framework for JavaScript

Downloads

11

Readme

Orion ECS

Orion ECS is a lightweight and flexible Entity Component System (ECS) framework written in JavaScript. It provides a solid foundation for building games and other applications that can benefit from a component-based architecture.

Features

  • Simple and intuitive API
  • Efficient entity and component management
  • Flexible system creation and execution
  • Easy to integrate with existing projects

Installation

You can install Orion ECS using npm:

npm install orion-ecs

Usage

Here's a basic example of how to use Orion ECS:

import { Engine } from 'orion-ecs';

// Create a new engine
const game = new Engine();

// Define components
class Position {
  constructor(x = 0, y = 0) {
    this.x = x;
    this.y = y;
  }
}

class Velocity {
  constructor(x = 0, y = 0) {
    this.x = x;
    this.y = y;
  }
}

// Create a system
game.createSystem([Position, Velocity], {
  act: function(entity, [position, velocity]) {
    position.x += velocity.x;
    position.y += velocity.y;
  }
});

// Create an entity and add components
const entity = game.createEntity();
entity.addComponent(new Position(0, 0));
entity.addComponent(new Velocity(1, 1));

// Run the engine
game.run(16, 0); // Run every 16ms, indefinitely

API Reference

Engine

  • createEntity(): Creates and returns a new entity
  • createSystem(components, options): Creates a new system
  • run(interval, maxSteps): Runs the engine
  • perform(): Performs a single step of the engine

Entity

  • addComponent(component): Adds a component to the entity
  • removeComponent(componentName): Removes a component from the entity
  • hasComponent(componentName): Checks if the entity has a specific component

System

Systems are created using the createSystem method of the engine. The options object can include:

  • before(): Function called before processing entities
  • act(entity, ...components): Function called for each matching entity
  • after(): Function called after processing entities

Testing

To run the tests:

npm test

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.