A fast, portable Entity Component System for Luau. https://ukendio.github.io/jecs/
Find a file
2025-02-21 00:11:38 +01:00
.github Bump analysis.yaml 2025-02-02 19:06:11 -05:00
assets Cleanup repository 2024-11-23 04:42:54 +01:00
benches Improve cached queries 2025-01-14 11:09:18 +01:00
demo Modify example 2025-02-05 22:26:12 +01:00
docs Updated with changes as per PR #194 2025-02-20 00:16:57 +05:30
examples Modify example 2025-02-05 22:26:12 +01:00
test Add stress test 2025-02-15 21:57:30 +01:00
thesis Add tests for scheduler example 2024-08-21 01:59:25 +02:00
tools Cleanup codebase 2025-01-29 08:28:08 +01:00
.gitignore Cleanup codebase 2025-01-29 08:28:08 +01:00
.luaurc Cleanup repository 2024-11-23 04:42:54 +01:00
.prettierrc Update ts type definitions (#142) 2024-10-12 03:45:37 +02:00
bench.project.json Update changelog 2024-11-23 20:52:01 +01:00
CHANGELOG.md Fix types (#190) 2025-02-14 10:51:30 +01:00
default.project.json Cleanup repository 2024-11-23 04:42:54 +01:00
demo.rbxl decouple start 2024-09-08 19:45:49 +02:00
jecs.d.ts Typescript Types for Archetypes 2025-01-31 15:29:32 +01:00
jecs.luau Fix critical issue with deleted entity being swapped with the last 2025-02-20 22:55:07 +01:00
LICENSE Create LICENSE 2024-06-11 21:06:27 +02:00
mirror.luau Cleanup repository 2024-11-23 04:42:54 +01:00
mkdocs.yml Fix docs 2024-05-27 03:50:46 +02:00
package-lock.json 0.4.0-rc.0 2024-11-14 21:11:23 +01:00
package.json Bump 2025-01-17 10:42:24 +01:00
README.md Updated with changes as per PR #194 2025-02-20 00:16:57 +05:30
rokit.toml fix(ci): stylua ci failing (#158) 2024-11-22 22:14:10 +01:00
selene.toml Fix style and add some micro optimizations (#27) 2024-05-05 01:52:01 +02:00
stress.project.json Add stress test 2025-02-15 21:57:30 +01:00
stylua.toml fix(ci): stylua ci failing (#158) 2024-11-22 22:14:10 +01:00
testez.d.luau Rename files to luau (#54) 2024-06-24 03:20:43 +02:00
tsconfig.json Update roblox-ts 2024-10-21 19:31:51 +02:00
wally.toml Bump 2025-01-17 10:42:24 +01:00

Jecs Logo

Jecs

Just a Stupidly Fast Entity Component System

License: MIT Wally

Features

  • 🚀 Blazing Fast: Iterate over 800,000 entities at 60 FPS
  • 🔗 Entity Relationships: First-class support for entity relationships
  • 📝 Type Safety: Fully typed Luau API
  • 🎯 Zero Dependencies: Simple integration with no external dependencies
  • Optimized Storage: Cache-friendly archetype/SoA storage
  • Battle-tested: Rigorously tested for stability

🚀 Example Usage

local world = jecs.World.new()
local pair = jecs.pair
local Position = world:component() :: jecs.Id<Vector3>
local Velocity = world:component() :: jecs.Id<Vector3>

-- These components and functions are actually already builtin
-- but have been illustrated for demonstration purposes
local ChildOf = world:component()
local Name = world:component()
local entity = world:entity()
world:set(entity, Position, Vector3.new(0, 0, 0))
world:set(entity, Velocity, Vector3.new(1, 0, 0))

local function parent(entity)
    return world:target(entity, ChildOf)
-- Update system (example)
for id, position, velocity in world:query(Position, Velocity) do
    world:set(id, Position, position + velocity)
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

Performance

Query Performance

21,000 entities, 125 archetypes, 4 random components queried: Queries Benchmark source: /benches/visual/query.luau

Insertion Performance

Inserting 8 components to an entity and updating them over 50 times: Insertions Benchmark source: /benches/visual/insertions.luau

📖 Documentation

🤝 Contributing

Please read our Contributing Guidelines before submitting pull requests.

💬 Community

📄 License

Jecs is licensed under the MIT License - see the LICENSE file for details.