diff --git a/docs/coverage/ansi.luau.html b/coverage/ansi.luau.html similarity index 100% rename from docs/coverage/ansi.luau.html rename to coverage/ansi.luau.html diff --git a/docs/coverage/entity_visualiser.luau.html b/coverage/entity_visualiser.luau.html similarity index 100% rename from docs/coverage/entity_visualiser.luau.html rename to coverage/entity_visualiser.luau.html diff --git a/docs/coverage/index.html b/coverage/index.html similarity index 100% rename from docs/coverage/index.html rename to coverage/index.html diff --git a/docs/coverage/jecs.luau.html b/coverage/jecs.luau.html similarity index 100% rename from docs/coverage/jecs.luau.html rename to coverage/jecs.luau.html diff --git a/docs/coverage/lifetime_tracker.luau.html b/coverage/lifetime_tracker.luau.html similarity index 100% rename from docs/coverage/lifetime_tracker.luau.html rename to coverage/lifetime_tracker.luau.html diff --git a/docs/coverage/testkit.luau.html b/coverage/testkit.luau.html similarity index 100% rename from docs/coverage/testkit.luau.html rename to coverage/testkit.luau.html diff --git a/docs/coverage/tests.luau.html b/coverage/tests.luau.html similarity index 100% rename from docs/coverage/tests.luau.html rename to coverage/tests.luau.html diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index acd17a4..537cf76 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -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: { diff --git a/docs/learn/concepts/addons.md b/docs/learn/concepts/addons.md index 4a667fc..8a7ba01 100644 --- a/docs/learn/concepts/addons.md +++ b/docs/learn/concepts/addons.md @@ -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) @@ -25,4 +39,6 @@ Provides hooks and a scheduler that implements jabby and a topographical runtime ## [planck](https://github.com/YetAnotherClown/planck) 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. \ No newline at end of file +Planck also provides plugins for Jabby, Matter Hooks, and more. + +# Observers diff --git a/test/tests.luau b/test/tests.luau index ce0f9fd..2b3ada8 100644 --- a/test/tests.luau +++ b/test/tests.luau @@ -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 diff --git a/test/addons/entity_visualiser.luau b/test/tools/entity_visualiser.luau similarity index 90% rename from test/addons/entity_visualiser.luau rename to test/tools/entity_visualiser.luau index e011041..9698939 100644 --- a/test/addons/entity_visualiser.luau +++ b/test/tools/entity_visualiser.luau @@ -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() diff --git a/addons/entity_visualiser.luau b/tools/entity_visualiser.luau similarity index 100% rename from addons/entity_visualiser.luau rename to tools/entity_visualiser.luau diff --git a/addons/lifetime_tracker.luau b/tools/lifetime_tracker.luau similarity index 98% rename from addons/lifetime_tracker.luau rename to tools/lifetime_tracker.luau index 54d9ee9..b5e74fe 100644 --- a/addons/lifetime_tracker.luau +++ b/tools/lifetime_tracker.luau @@ -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