ukendio / jecs Goto Github PK

https://roblox-ts.com/docs/guides/using-existing-luau

We need to add comprehensive documentation to our GitHub repository to help new contributors understand the project, its structure, and how to contribute. Proper documentation will also assist users in understanding how to use the project effectively.

Documentation should include:

1. Overview

   • Brief description of the project.
   • Key features and functionalities.

2. Installation

   • Prerequisites.
   • Step-by-step installation guide.
   • Configuration instructions.

3. Usage

   • How to run the project.
   • Basic usage examples.
   • Explanation of main components.

4. Contributing

   • Contribution guidelines.
   • How to report issues.
   • How to submit pull requests.
   • Code of conduct.

5. FAQs

   • Common issues and troubleshooting.
   • Frequently asked questions.

6. License

   • Licensing information.

Additional Notes:

• Use Markdown for documentation.
• Include images/screenshots where applicable.
• Ensure the documentation is easy to navigate and well-organized.

Tasks:

• Create an overview section.
• Write installation instructions.
• Provide usage examples.
• Draft contributing guidelines.
• Compile FAQs.
• Add license information.

The coverage over the codebase is pretty poor and a lot of potential edge cases have not been found yet. This is something we can add incrementally!

Queries should be able to have wildcard terms that can match multiple instances of a relationship

A lot of the computations in the queries are very expensive, e.g. populating the compatible archetypes in the world, caching indices to the the columns and unpacking the entity ID's for flags + low and high IDs for indexing and relations.

All of this overhead can be paid once up front for each system. This similar to how Matter's runtime queries work right now.

When an entity is deleted, World.__iter tries getting the archetype of a non-existent sparse array record.

local world = jecs.World.new()

local entity = world:entity()

world:delete(entity)

for e in world do -- jecs:839: attempt to index nil with 'archetype' 
	
end

Non-movable components, that when inserted goes into the sparse set storage. The sparse component itself does not need to be moved to the destination archetype during insertion.

Benefits

• Doesn't need to move the sparse component itself so slightly faster removals and insertions
• Fast iteration of single sparse components since it should just iterate over the densely packed pool/column

Drawbacks

• Explicit storage specification
• Queries of sparse components are always slower than archetype queries except for two scenarios:

1. if the query is just interested in a single sparse component (just iterate the dense array of the sparse set)
2. if fragmentation is very high (like 1-2 entities per archetype, and lots of archetypes)