JSPM – @rbxts/jecs@0.8.0

Package Exports

@rbxts/jecs
@rbxts/jecs/jecs.luau

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rbxts/jecs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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 API
Zero-dependency package
Optimized for column-major operations
Cache friendly archetype/SoA storage
Rigorously unit tested for stability

Installation

With Wally:

jecs = "ukendio/jecs@0.6.0" # Inside wally.toml

With pesde:

pesde add wally#ukendio/jecs@0.6.0

With npm (roblox-ts):

npm i @rbxts/jecs

Example

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. Queries 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