mirror of
https://github.com/Ukendio/jecs.git
synced 2025-11-04 02:49:18 +00:00
81 lines
2.6 KiB
Markdown
Executable file
81 lines
2.6 KiB
Markdown
Executable file
<p align="center">
|
|
<img src="assets/image-5.png" width=35%/>
|
|
</p>
|
|
|
|
[](LICENSE) [](https://wally.run/package/ukendio/jecs) [](https://github.com/Ukendio/jecs/actions/workflows/unit-testing.yaml)
|
|
|
|
Just a stupidly fast Entity Component System
|
|
|
|
- [Entity Relationships](https://ajmmertens.medium.com/building-games-in-ecs-with-entity-relationships-657275ba2c6c) as first class citizens
|
|
- Iterate 800,000 entities at 60 frames per second
|
|
- Type-safe [Luau](https://luau-lang.org/) API
|
|
- Zero-dependency package
|
|
- Optimized for column-major operations
|
|
- 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/unit-testing.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
|
|
|
|
```lua
|
|
local world = jecs.World.new()
|
|
local pair = jecs.pair
|
|
|
|
-- These components and functions are actually already builtin
|
|
-- but have been illustrated for demonstration purposes
|
|
local ChildOf = world:component()
|
|
local Name = world:component()
|
|
|
|
local function parent(entity)
|
|
return world:target(entity, ChildOf)
|
|
end
|
|
local function getName(entity)
|
|
return world:get(entity, Name)
|
|
end
|
|
|
|
local alice = world:entity()
|
|
world:set(alice, Name, "alice")
|
|
|
|
local bob = world:entity()
|
|
world:add(bob, pair(ChildOf, alice))
|
|
world:set(bob, Name, "bob")
|
|
|
|
local sara = world:entity()
|
|
world:add(sara, pair(ChildOf, alice))
|
|
world:set(sara, Name, "sara")
|
|
|
|
print(getName(parent(sara)))
|
|
|
|
for e, name in world:query(Name, pair(ChildOf, alice)) do
|
|
print(name, "is the child of alice")
|
|
end
|
|
|
|
-- Output
|
|
-- "alice"
|
|
-- bob is the child of alice
|
|
-- sara is the child of alice
|
|
```
|
|
|
|
### Benchmarks
|
|
|
|
21,000 entities 125 archetypes 4 random components queried.
|
|
|
|
Can be found under /benches/visual/query.luau
|
|
|
|
Inserting 8 components to an entity and updating them over 50 times.
|
|
|
|
Can be found under /benches/visual/insertions.luau
|