Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Ukendio/jecs/llms.txt

Use this file to discover all available pages before exploring further.

​
Introduction to jecs

jecs is a high-performance Entity Component System (ECS) for Luau that prioritizes speed, type safety, and developer experience. Built with cache-friendly archetype/SoA storage, jecs can iterate through 800,000 entities at 60 frames per second.

​
Key Features

Blazing Fast Performance

Iterate 800,000 entities at 60 FPS with optimized column-major operations and cache-friendly archetype storage

Entity Relationships

Build complex game logic with entity relationships as first-class citizens

Type-Safe API

Full Luau type safety ensures compile-time type checking for components and queries

Zero Dependencies

Lightweight package with no external dependencies - just pure performance

Battle Tested

Rigorously unit tested for stability and reliability in production environments

Cache Optimized

Archetype/SoA storage pattern maximizes CPU cache efficiency for maximum throughput

​
Performance Benchmarks

jecs delivers exceptional performance across common ECS operations:
  • Query Performance: 21,000 entities across 125 archetypes with 4 random components queried efficiently
  • Insertion Performance: Insert 8 components to an entity and update them over 50 times with minimal overhead

​
What is an ECS?

An Entity Component System is a software architectural pattern used primarily in game development that separates data from behavior:
  • Entities represent things in your game (characters, buildings, projectiles, etc.)
  • Components are data attached to entities (Position, Health, Velocity, etc.)
  • Systems contain the logic that operates on entities with specific components
This pattern enables high performance through cache-friendly data layouts and promotes code reusability through composition over inheritance.

​
Get Started

Quickstart

Jump right in with a quick tutorial showing world creation, entities, and queries

Installation

Install jecs using npm, yarn, pnpm, or Wally for Roblox projects

​
Community & Support

jecs is open source and actively maintained on GitHub. The repository includes:
  • how_to: Step-by-step introduction to ECS concepts and design patterns
  • modules: Ready-to-use modules to help you hit the ground running
  • examples: Real-world programs showcasing how everything fits together
For Roblox Studio users, you can download an importable model file from the GitHub Actions artifacts.

Build docs developers (and LLMs) love

Get started for freeTalk to us