A fast, portable Entity Component System for Luau. https://ukendio.github.io/jecs/
Find a file
2024-05-12 05:26:37 +02:00
benches Relationships (#31) 2024-05-10 17:59:57 +02:00
lib add name field to record 2024-05-12 05:25:26 +02:00
mirror Update mirror 2024-05-05 15:06:57 +02:00
tests Remove print 2024-05-12 05:26:37 +02:00
thesis Publish paper 2024-04-23 17:20:33 +02:00
.gitignore Add case for when component is not found in archetype (#25) 2024-05-08 00:57:22 +02:00
aftman.toml Fix style and add some micro optimizations (#27) 2024-05-05 01:52:01 +02:00
default.project.json Rebase 2024-04-23 17:10:49 +02:00
image-1.png More benchmarks 2024-04-25 05:48:22 +02:00
image-2.png Update benchmark 2024-04-25 05:55:11 +02:00
image-3.png Include ECR in benchmark 2024-04-25 16:41:41 +02:00
image-4.png Move assertion up (#9) 2024-04-30 17:52:44 +02:00
image.png Add image 2024-04-24 02:24:34 +02:00
jecs_darkmode.svg Add svg images (#18) 2024-05-07 18:37:14 +02:00
jecs_lightmode.svg Add svg images (#18) 2024-05-07 18:37:14 +02:00
logo_old.png Add svg images (#18) 2024-05-07 18:37:14 +02:00
README.md Update readme 2024-05-11 02:12:47 +02:00
rgb.lua Rebase 2024-04-23 17:10:49 +02:00
selene.toml Fix style and add some micro optimizations (#27) 2024-05-05 01:52:01 +02:00
stylua.toml Fix style and add some micro optimizations (#27) 2024-05-05 01:52:01 +02:00
test.project.json Add without (#4) 2024-04-29 15:21:05 +02:00
testez-companion.toml Fix style and add some micro optimizations (#27) 2024-05-05 01:52:01 +02:00
testez.d.lua Rebase 2024-04-23 17:10:49 +02:00
testkit.lua Add testkit 2024-05-01 14:41:51 +02:00
tests.server.lua Rebase 2024-04-23 17:10:49 +02:00
wally.toml Bump version 2024-05-10 20:36:01 +02:00

License: Apache 2.0 Wally

Just an ECS

jecs is a stupidly fast Entity Component System (ECS).

  • Entity Relationships as first class citizens
  • Process tens of thousands of entities with ease every frame
  • Type-safe Luau API
  • Zero-dependency package
  • Optimized for column-major operations
  • Cache friendly archetype/SoA storage
  • Unit tested for stability

Example

local world = World.new()

local player = world:entity()
local opponent = world:entity()

local Health = world:component()
local Position = world:component()
-- Notice how components can just be entities as well?
-- It allows you to model relationships easily!
local Damage = world:entity()
local DamagedBy = world:entity()

world:set(player, Health, 100)
world:set(player, Damage, 8)
world:set(player, Position, Vector3.new(0, 5, 0))

world:set(opponent, Health, 100)
world:set(opponent, Damage, 21)
world:set(opponent, Position, Vector3.new(0, 5, 3))

for playerId, playerPosition, health in world:query(Position, Health) do
    local totalDamage = 0
    for opponentId, opponentPosition, damage in world:query(Position, Damage) do
        if playerId == opponentId then 
            continue
        end
        if (playerPosition - opponentPosition).Magnitude < 5 then
            totalDamage += damage
        end
        -- We create a pair between the relation component `DamagedBy` and the entity id of the opponent. 
        -- This will allow us to specifically query for damage exerted by a specific opponent.
        world:set(playerId, ECS_PAIR(DamagedBy, opponentId), totalDamage)
    end
end

-- Gets the damage inflicted by our specific opponent!
for playerId, health, inflicted in world:query(Health, ECS_PAIR(DamagedBy, opponent)) do 
    world:set(playerId, health - inflicted)
end

assert(world:get(player, Health) == 79)

125 archetypes, 4 random components queried. Queries Can be found under /benches/query.lua

Inserting 8 components to an entity and updating them over 50 times. Insertions Can be found under /benches/insertions.lua