Sovereignty/jecs
1
0
Fork 0
mirror of https://github.com/Ukendio/jecs.git synced 2026-02-04 15:15:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A fast, portable Entity Component System for Luau. https://ukendio.github.io/jecs/
810 commits 8 branches 56 tags 13 MiB
Luau 92.4%
Python 7.6%
Find a file
Magic e494c35b78
Automatically build a rbxm of documentation for Studio users (#287) 
* Add types for (Cached)Query.has (#286)

* ts type update

* changed to hard tabs

* reverted back to old formatting for some

* more fixes

* only keep query has

* Build studio docs

* Fix the nightly.link

* Make the nightly.link work for the main Jecs repo, rename the workflow

* Add alias resolution

* Artifacts expire, run the action every month

* Add deleted flag to removed handler typings (#288)

* update types

* change "StatefulHook" to "HookWithData" and "StatelessHook" to "HookWithDeleted"

* Update deleted flag type

---------

Co-authored-by: maeriil <104389763+maeriil@users.noreply.github.com>
Co-authored-by: m10 <165406716+mrkboy10@users.noreply.github.com>
Co-authored-by: Marcus <ukendio@gmail.com>
2026-01-02 06:41:05 +01:00
.github Automatically build a rbxm of documentation for Studio users (#287) 2026-01-02 06:41:05 +01:00
examples Correct Cleanup example: Change OnSet to OnAdd (#289) 2025-12-16 22:33:48 +01:00
how_to Document delete flag in OnRemove hooks 2025-12-28 12:35:08 +01:00
modules Automatically build a rbxm of documentation for Studio users (#287) 2026-01-02 06:41:05 +01:00
scripts Automatically build a rbxm of documentation for Studio users (#287) 2026-01-02 06:41:05 +01:00
src Add missing delete parameter in types for OnRemove 2026-01-02 06:38:16 +01:00
test Fix desired id being overriden 2026-01-02 06:32:59 +01:00
.gitignore Automatically build a rbxm of documentation for Studio users (#287) 2026-01-02 06:41:05 +01:00
.luaurc Fix alias paths 2025-11-30 08:19:28 +01:00
CHANGELOG.md Improve relationship performance 2025-08-07 18:53:50 +02:00
default.project.json Cleanup repository 2025-11-30 08:13:31 +01:00
LICENSE Optimize column access 2025-06-25 17:16:04 +02:00
package.json Cleanup repository 2025-11-30 08:13:31 +01:00
README.md Automatically build a rbxm of documentation for Studio users (#287) 2026-01-02 06:41:05 +01:00
rokit.toml Automatically build a rbxm of documentation for Studio users (#287) 2026-01-02 06:41:05 +01:00
studio_docs.project.json Automatically build a rbxm of documentation for Studio users (#287) 2026-01-02 06:41:05 +01:00
test.rbxl Fix desired id being overriden 2026-01-02 06:32:59 +01:00
tsconfig.json Optimize column access 2025-06-25 17:16:04 +02:00
wally.toml Cleanup repository 2025-11-30 08:13:31 +01:00

README.md

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

Get Started

It is recommended that you clone the repository and navigate the documentation in your favourite editor.

This repository includes a few subfolders that can help you get started with jecs:

  • how_to: This is a step-by-step introduction to how this ECS works and the reasoning behind its design.

  • modules: These are regularly used modules and should be mostly working, but some might not be. You can look in this folder to see some code that you might use to help you hit the ground running quickly.

  • examples: These are larger programs that showcase real use cases and can help you understand how everything fits together.

If you wish to view the documentation inside Roblox Studio, you can find an importable model file here.

Benchmarks

21,000 entities 125 archetypes 4 random components queried. Queries Can be found under /test/benches/visual/query.luau

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