Merge pull request 'Sync to upstream Jecs 0.4.0-rc.0' (#1) from auto/update-jecs into main
Reviewed-on: #1
This commit is contained in:
commit
20467b301b
4 changed files with 453 additions and 451 deletions
4
.luaurc
4
.luaurc
|
|
@ -2,7 +2,7 @@
|
|||
"aliases": {
|
||||
"jecs": "src",
|
||||
"testkit": "testkit",
|
||||
"mirror": "mirror",
|
||||
"mirror": "mirror"
|
||||
},
|
||||
"languageMode": "strict"
|
||||
}
|
||||
}
|
||||
132
README.md
132
README.md
|
|
@ -1,68 +1,68 @@
|
|||
An unofficial pesde package for [jecs](https://github.com/ukendio/jecs).
|
||||
An automatically synced minimal copy of the [jecs](https://github.com/Ukendio/jecs) repo published to pesde.
|
||||
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img src="jecs_darkmode.svg#gh-dark-mode-only" width=50%/>
|
||||
<img src="jecs_lightmode.svg#gh-light-mode-only" width=50%/>
|
||||
</p>
|
||||
|
||||
[](LICENSE-APACHE)
|
||||
[](https://wally.run/package/ukendio/jecs)
|
||||
|
||||
jecs is Just a stupidly fast Entity Component System
|
||||
|
||||
- Entity Relationships 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 storage
|
||||
- Unit tested for stability
|
||||
|
||||
### Example
|
||||
|
||||
```lua
|
||||
local world = jecs.World.new()
|
||||
local pair = jecs.pair
|
||||
|
||||
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 in world:query(pair(ChildOf, alice)) do
|
||||
print(getName(e), "is the child of alice")
|
||||
end
|
||||
|
||||
-- Output
|
||||
-- "alice"
|
||||
-- bob is the child of alice
|
||||
-- sara is the child of alice
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
<p align="center">
|
||||
<img src="image-5.png" width=35%/>
|
||||
</p>
|
||||
|
||||
[](LICENSE) [](https://wally.run/package/ukendio/jecs)
|
||||
|
||||
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/ci.yaml) for stability
|
||||
|
||||
### 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 in world:query(pair(ChildOf, alice)) do
|
||||
print(getName(e), "is the child of alice")
|
||||
end
|
||||
|
||||
-- Output
|
||||
-- "alice"
|
||||
-- bob is the child of alice
|
||||
-- sara is the child of alice
|
||||
```
|
||||
|
||||
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
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ includes = [
|
|||
license = "MIT"
|
||||
name = "mark_marks/jecs_pesde"
|
||||
repository = "https://git.devmarked.win/marked/jecs-pesde"
|
||||
version = "0.3.2"
|
||||
version = "0.4.0-rc.0"
|
||||
|
||||
[indices]
|
||||
default = "https://github.com/daimond113/pesde-index"
|
||||
|
|
|
|||
Loading…
Reference in a new issue