Compare commits

..

1 commit

Author SHA1 Message Date
Ajay
be50638832
Merge 918231a1ad into bb03e88d3d 2025-05-22 08:18:17 -05:00
3 changed files with 1 additions and 33 deletions

View file

@ -14,21 +14,6 @@ Just a stupidly fast Entity Component System
- Cache friendly [archetype/SoA](https://ajmmertens.medium.com/building-an-ecs-2-archetypes-and-vectorization-fe21690805f9) storage - Cache friendly [archetype/SoA](https://ajmmertens.medium.com/building-an-ecs-2-archetypes-and-vectorization-fe21690805f9) storage
- Rigorously [unit tested](https://github.com/Ukendio/jecs/actions/workflows/ci.yaml) for stability - Rigorously [unit tested](https://github.com/Ukendio/jecs/actions/workflows/ci.yaml) for stability
### Installation
With [Wally](https://wally.run/):
```bash
jecs = "ukendio/jecs@0.6.0" # Inside wally.toml
```
With [pesde](https://pesde.dev/):
```bash
pesde add wally#ukendio/jecs@0.6.0
```
With [npm](https://www.npmjs.com/package/@rbxts/jecs) ([roblox-ts](https://roblox-ts.com/)):
```bash
npm i @rbxts/jecs
```
### Example ### Example
```lua ```lua

View file

@ -7,7 +7,7 @@ type Observer = {
type Monitor = { type Monitor = {
callback: (jecs.Entity, jecs.Entity) -> (), callback: (jecs.Entity, jecs.Entity) -> (),
query: jecs.Query<any> queyr: jecs.Query<any>
} }
export type PatchedWorld = jecs.World & { export type PatchedWorld = jecs.World & {

View file

@ -2,23 +2,6 @@
Jecs is a standalone entity-component-system module written in Luau. Jecs is a standalone entity-component-system module written in Luau.
ECS ("entity-component-system") describes one way to write games in a more data oriented design. ECS ("entity-component-system") describes one way to write games in a more data oriented design.
## Installation
Jecs supports the following installation methods using package managers:
:::code-group
```bash [wally]
jecs = "ukendio/jecs@0.6.0" # Inside wally.toml
```
```bash [pesde]
pesde add wally#ukendio/jecs@0.6.0
```
```bash [npm]
npm i @rbxts/jecs
```
:::
Additionally an `rbxm` is published with [each release under the assets submenu](https://github.com/Ukendio/jecs/releases/latest).
## Hello World, Entity and Component ## Hello World, Entity and Component
It all has to start somewhere. A world stores entities and their components, and manages them. This tour will reference it for every operation. It all has to start somewhere. A world stores entities and their components, and manages them. This tour will reference it for every operation.
:::code-group :::code-group