Update docs

This commit is contained in:
Ukendio 2025-03-30 22:29:43 +02:00
parent 2b90fabec5
commit 7bcd6bd220
13 changed files with 24 additions and 9 deletions

View file

@ -11,7 +11,6 @@ export default defineConfig({
{ text: "Learn", link: "/" },
{ text: "API", link: "/api/jecs.md" },
{ text: "Examples", link: "https://github.com/Ukendio/jecs/tree/main/examples" },
{ text: "Coverage", link: "/coverage/index.html" },
],
sidebar: {

View file

@ -2,12 +2,26 @@
A collection of third-party jecs addons made by the community. If you would like to share what you're working on, [submit a pull request](https://github.com/Ukendio/jecs)!
# Debuggers
# Development tools
## [jabby](https://github.com/alicesaidhi/jabby)
A jecs debugger with a string-based query language and entity editing capabilities.
## [jecs_entity_visualiser](https://github.com/Ukendio/jecs/tree/main/addons/entity_visualiser)
A simple entity and component visualiser in the output
## [jecs_lifetime_tracker](https://github.com/Ukendio/jecs/tree/main/addons/lifetime_tracker)
A tool for inspecting entity lifetimes
# Helpers
## [jecs_observers](https://github.com/Ukendio/jecs/tree/main/addons/observers)
Observers for queries and signals for components
# Schedulers
## [lockstep scheduler](https://gist.github.com/1Axen/6d4f78b3454cf455e93794505588354b)
@ -26,3 +40,5 @@ Provides hooks and a scheduler that implements jabby and a topographical runtime
An agnostic scheduler inspired by Bevy and Flecs, with core features including phases, pipelines, run conditions, and startup systems.
Planck also provides plugins for Jabby, Matter Hooks, and more.
# Observers

View file

@ -133,7 +133,7 @@ TEST("#adding a recycled target", function()
end)
local entity_visualizer = require("@addons/entity_visualiser")
local entity_visualizer = require("@tools/entity_visualiser")
TEST("#repro2", function()
local world = world_new()
@ -170,7 +170,7 @@ TEST("#repro2", function()
CHECK(world:get(entity, pair(Lifetime, Beam)) == 1)
end)
local lifetime_tracker_add = require("@addons/lifetime_tracker")
local lifetime_tracker_add = require("@tools/lifetime_tracker")
TEST("another", function()
local world = world_new()
@ -307,8 +307,8 @@ TEST("world:cleanup()", function()
CHECK(#archetype_index["1_2_3"].entities == 1)
end)
local pe = require("@addons/entity_visualiser").prettify
local lifetime_tracker_add = require("@addons/lifetime_tracker")
local pe = require("@tools/entity_visualiser").prettify
local lifetime_tracker_add = require("@tools/lifetime_tracker")
TEST("world:entity()", function()
do

View file

@ -1,7 +1,7 @@
local jecs = require("@jecs")
local pair = jecs.pair
local ChildOf = jecs.ChildOf
local lifetime_tracker_add = require("@addons/lifetime_tracker")
local lifetime_tracker_add = require("@tools/lifetime_tracker")
local world = lifetime_tracker_add(jecs.world(), {padding_enabled=false})
local FriendsWith = world:component()
world:print_snapshot()

View file

@ -4,7 +4,7 @@ local ECS_ID = jecs.ECS_ID
local __ = jecs.Wildcard
local pair = jecs.pair
local prettify = require("@addons/entity_visualiser").prettify
local prettify = require("@tools/entity_visualiser").prettify
local pe = prettify