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
jecs/README.md
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

1.8 KiB
Executable file
Raw Blame History

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