Sovereignty/jecs
1
0
Fork 0
mirror of https://github.com/Ukendio/jecs.git synced 2025-04-25 01:20:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Raghav Arora 2025-02-19 23:56:50 +05:30
parent 6c47df37a4
commit 04546a8665
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -11,19 +11,19 @@ A high-performance Entity Component System (ECS) for Roblox games, supporting bo
## Features ## Features
* **Blazing Fast:** Iterate over hundreds of thousands of entities at 60 frames per second. Benchmark results are available in the documentation. * **Blazing Fast:** Iterate over hundreds of thousands of entities at 60 frames per second. Benchmark results are available in the documentation.
* **Entity Relationships:** First-class support for defining and querying relationships between entities. * **Entity Relationships:** First-class support for defining and querying relationships between entities.
* **Type Safety:** Fully typed API for both Luau and TypeScript, enhancing code maintainability and reducing errors. * **Type Safety:** Fully typed API for both Luau and TypeScript, enhancing code maintainability and reducing errors.
* **Zero Dependencies:** No external dependencies required, simplifying integration into your project. * **Zero Dependencies:** No external dependencies required, simplifying integration into your project.
* **Optimized Storage:** Cache-friendly archetype/SoA (Structure of Arrays) storage for optimal performance. * **Optimized Storage:** Cache-friendly archetype/SoA (Structure of Arrays) storage for optimal performance.
* **Battle-tested:** Rigorously unit tested for stability and reliability. * **Battle-tested:** Rigorously unit tested for stability and reliability.
* **Comprehensive Documentation:** Detailed documentation guides you through installation, usage, and advanced concepts. * **Comprehensive Documentation:** Detailed documentation guides you through installation, usage, and advanced concepts.
## Documentation ## Documentation
* [Getting Started](docs/learn/overview/get-started.md) * [Getting Started](docs/learn/overview/get-started.md)
* [API Reference](docs/api/jecs.md) (Note: This link may need updating to reflect the actual location of the API docs if they are generated separately) * [API Reference](docs/api/jecs.md) (Note: This link may need updating to reflect the actual location of the API docs if they are generated separately)
* [Concepts](docs/learn/concepts/) * [Concepts](docs/learn/concepts/)
* Entities and Components * Entities and Components
* Queries * Queries
@ -73,7 +73,7 @@ for (const [id, position, velocity] of world.query(Position, Velocity)) {
## Performance ## Performance
Benchmark results demonstrating Jecs' performance are available in the documentation. These include query and insertion performance tests. Benchmark results demonstrating Jecs' performance are available in the documentation. These include query and insertion performance tests.
## Installation ## Installation
@ -118,3 +118,5 @@ We welcome contributions! Please see our [contribution guidelines](docs/contribu
Jecs is [MIT licensed](LICENSE). Jecs is [MIT licensed](LICENSE).
```