mirror of
https://github.com/Ukendio/jecs.git
synced 2025-04-24 17:10:03 +00:00
A fast, portable Entity Component System for Luau.
https://ukendio.github.io/jecs/
data-orienteddata-oriented-designecsentity-component-systemgame-developmentgamedevjecslualuauno-dependencies
* Add package.json, tsconfig.json, and change gitignore * Typescript Types * Make World a single class, refactor of all query types * Fix InferComponents types due to typo / misunderstanding * Bump dependencies * Fix get type to include undefined and add documentation * Remove non-user facing types * Rename PossiblyUndefinedPack -> Nullable * Some changes to how EntityIndex is handled * Consistent formatting * Remove EntityIndex related type definitions * Match API * Doc comments |
||
---|---|---|
.github/workflows | ||
benches | ||
docs | ||
lib | ||
mirror | ||
tests | ||
thesis | ||
.gitignore | ||
aftman.toml | ||
bench.project.json | ||
default.project.json | ||
image-1.png | ||
image-2.png | ||
image-3.png | ||
image-4.png | ||
image.png | ||
jecs_darkmode.svg | ||
jecs_lightmode.svg | ||
LICENSE | ||
logo_old.png | ||
mkdocs.yml | ||
package-lock.json | ||
package.json | ||
README.md | ||
rgb.lua | ||
selene.toml | ||
stylua.toml | ||
test.project.json | ||
testez-companion.toml | ||
testez.d.lua | ||
testkit.lua | ||
tsconfig.json | ||
wally.toml |
Just an ECS
jecs is a stupidly fast Entity Component System (ECS).
- Entity Relationships as first class citizens
- Iterate 350,000 entities at 60 frames per second
- Type-safe Luau API
- Zero-dependency package
- Optimized for column-major operations
- Cache friendly archetype/SoA storage
- Unit tested for stability
Example
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
125 archetypes, 4 random components queried.
Can be found under /benches/query.lua
Inserting 8 components to an entity and updating them over 50 times.
Can be found under /benches/insertions.lua