diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..fab2a6a --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,47 @@ +# Checks the site on every pull request and after every docs-sync push to main (the synced folders arrive without a PR). +name: Tests + +on: + pull_request: + branches: + - main + push: + branches: + - main + workflow_dispatch: + +permissions: + contents: read + +jobs: + tests: + name: Validate the site + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v6 + with: + persist-credentials: false + + - name: Set up Node + uses: actions/setup-node@v6 + with: + node-version-file: .nvmrc + + - name: Install dependencies + run: | + npm install -g "$(node -p 'require("./package.json").packageManager')" + pnpm install --frozen-lockfile + + - name: Lint + run: pnpm run lint + + # docs.json $refs, missing pages, invalid MDX and imports + - name: Validate the build + run: pnpm run validate + + - name: Check the links + run: pnpm run broken-links + + - name: Check accessibility + run: pnpm run a11y diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..40606b6 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,7 @@ +# Owned by the source repositories, written by the docs-sync action at their releases. +docs/ +guides/ +references/ +pnpm-lock.yaml +# Written by pnpm. +pnpm-workspace.yaml diff --git a/README.md b/README.md index eb0d970..d4b2078 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,33 @@ -Build status +Tests status # NanoForge Documentation -Welcome to the official documentation for NanoForge, your go-to tool for building and managing ECS-based applications with ease. This documentation provides comprehensive guides, tutorials, and reference materials to help you get started and make the most out of NanoForge. +The NanoForge documentation site, built with [Mintlify](https://mintlify.com): https://docs.nanoforge.eu -https://docs.nanoforge.eu +## How the site is made +Each product's pages live in its own repository and reach this one through the `docs-sync` action of [NanoForge-dev/actions](https://github.com/NanoForge-dev/actions), at each release of that repository: + +| Folder | Written by | Source | +| ---------------------------------- | --------------- | ----------------------------------------------------- | +| `docs/engine`, `references/engine` | engine releases | `docs/docs`, the TypeDoc references (`pnpm run docs`) | +| `docs/cli`, `guides/cli` | cli releases | `docs/docs`, `docs/guides` | +| `docs/loader` | loader releases | `docs/docs` | +| `docs/editor` | editor releases | `docs/docs` | + +- **Don't edit those folders here:** the next sync deletes and rewrites them. Change the pages in their repository. +- Each synced folder holds a `navigation.json`, written from the source repository's own one. It sets the order and the groups of its pages. +- `references//navigation.json` lists the reference versions: the latest release of each major. +- This repository owns `docs.json` (theme, tabs, dropdowns, redirects), `index.mdx` and `custom.css`. `docs.json` includes each `navigation.json` with a `$ref`, so a new product is one entry there. + +## Commands + +Mintlify needs Node 24 (`.nvmrc`); it refuses Node 25+. + +```sh +pnpm dev # preview on port 3001 +pnpm validate # docs.json, $refs, missing pages, MDX +pnpm broken-links +pnpm a11y +pnpm lint +``` diff --git a/docs.json b/docs.json index 90b89d8..020f4da 100644 --- a/docs.json +++ b/docs.json @@ -3,9 +3,7 @@ "theme": "almond", "name": "NanoForge", "custom": { - "css": [ - "custom.css" - ] + "css": ["custom.css"] }, "colors": { "primary": "#4923b6", @@ -13,2690 +11,265 @@ "dark": "#7c3aed" }, "navigation": { - "languages": [ + "tabs": [ { - "language": "en", - "tabs": [ + "tab": "Documentation", + "dropdowns": [ { - "tab": "Documentation", - "dropdowns": [ - { - "dropdown": "Engine", - "groups": [ - { - "group": "Getting-Started", - "pages": [ - "docs/engine/getting-started/1-index", - "docs/engine/getting-started/documentation", - "docs/engine/getting-started/how_to_use" - ] - }, - { - "group": "Network", - "pages": [ - "docs/engine/network/index", - "docs/engine/network/network-client-api", - "docs/engine/network/network-client", - "docs/engine/network/network-server-api", - "docs/engine/network/network-server", - "docs/engine/network/packet-framing" - ] - }, - { - "group": "Registry", - "pages": [ - "docs/engine/registry/index", - "docs/engine/registry/writing_web_assembly" - ] - } - ] - }, - { - "dropdown": "CLI", - "groups": [ - { - "group": "Commands", - "pages": [ - "docs/cli/commands/1-overview", - { - "group": "Commands", - "pages": [ - "docs/cli/commands/2-commands/1-new", - "docs/cli/commands/2-commands/2-dev", - "docs/cli/commands/2-commands/3-build", - "docs/cli/commands/2-commands/4-start", - "docs/cli/commands/2-commands/5-create", - "docs/cli/commands/2-commands/6-install", - "docs/cli/commands/2-commands/7-install", - "docs/cli/commands/2-commands/7-editor", - "docs/cli/commands/2-commands/8-editor", - "docs/cli/commands/2-commands/8-registry", - "docs/cli/commands/2-commands/9-registry" - ] - } - ] - }, - { - "group": "Configuration", - "pages": [ - "docs/cli/configuration/1-configuration-file", - "docs/cli/configuration/2-environment-variables" - ] - }, - { - "group": "Getting-Started", - "pages": [ - "docs/cli/getting-started/1-introduction", - "docs/cli/getting-started/2-installation", - "docs/cli/getting-started/3-quickstart", - "docs/cli/getting-started/index", - "docs/cli/getting-started/usage" - ] - }, - { - "group": "Loader", - "pages": [ - "docs/cli/loader/1-overview", - "docs/cli/loader/2-client", - "docs/cli/loader/3-website", - "docs/cli/loader/4-server" - ] - }, - { - "group": "Schematics", - "pages": [ - "docs/cli/schematics/1-overview", - { - "group": "Schematics", - "pages": [ - "docs/cli/schematics/2-schematics/1-application", - "docs/cli/schematics/2-schematics/1-workspace", - "docs/cli/schematics/2-schematics/2-configuration", - "docs/cli/schematics/2-schematics/2-project", - "docs/cli/schematics/2-schematics/3-component", - "docs/cli/schematics/2-schematics/3-part-base", - "docs/cli/schematics/2-schematics/4-system", - "docs/cli/schematics/2-schematics/4-part-main", - "docs/cli/schematics/2-schematics/5-docker", - "docs/cli/schematics/2-schematics/6-component", - "docs/cli/schematics/2-schematics/7-system" - ] - } - ] - } - ] - } - ] + "dropdown": "Overview", + "icon": "house", + "pages": ["index"] }, { - "tab": "Guides", - "dropdowns": [ - { - "dropdown": "CLI", - "groups": [ - { - "group": "CLI", - "pages": [ - "guides/cli/cli/1-overview", - "guides/cli/cli/2-create-a-project", - "guides/cli/cli/3-develop-locally", - "guides/cli/cli/4-build-and-deploy", - "guides/cli/cli/5-components-and-systems", - "guides/cli/cli/6-publish-a-package" - ] - } - ] - } - ] + "dropdown": "Engine", + "icon": "gears", + "pages": { + "$ref": "./docs/engine/navigation.json" + } }, { - "tab": "References", - "versions": [ - { - "version": "1.4.0", - "dropdowns": [ - { - "dropdown": "Asset-Manager", - "pages": [ - "references/1.4.0/asset-manager/0-index", - { - "group": "AssetManagerLibrary", - "pages": [ - "references/1.4.0/asset-manager/AssetManagerLibrary/getAsset_1", - "references/1.4.0/asset-manager/AssetManagerLibrary/getAsset" - ], - "root": "references/1.4.0/asset-manager/AssetManagerLibrary" - } - ] - }, - { - "dropdown": "Common", - "pages": [ - "references/1.4.0/common/0-index", - { - "group": "ApplicationContext", - "pages": [ - "references/1.4.0/common/ApplicationContext/delta", - "references/1.4.0/common/ApplicationContext/isRunning" - ], - "root": "references/1.4.0/common/ApplicationContext" - }, - "references/1.4.0/common/ASSET_MANAGER_LIBRARY", - { - "group": "BaseAssetManagerLibrary", - "pages": [ - "references/1.4.0/common/BaseAssetManagerLibrary/getAsset_1", - "references/1.4.0/common/BaseAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.0/common/BaseAssetManagerLibrary" - }, - "references/1.4.0/common/BaseComponentSystemLibrary", - "references/1.4.0/common/BaseGraphicsLibrary", - "references/1.4.0/common/BaseInputLibrary", - { - "group": "BaseMusicLibrary", - "pages": [ - "references/1.4.0/common/BaseMusicLibrary/mute", - "references/1.4.0/common/BaseMusicLibrary/play" - ], - "root": "references/1.4.0/common/BaseMusicLibrary" - }, - "references/1.4.0/common/BaseNetworkLibrary", - { - "group": "BaseSoundLibrary", - "pages": [ - "references/1.4.0/common/BaseSoundLibrary/mute", - "references/1.4.0/common/BaseSoundLibrary/play" - ], - "root": "references/1.4.0/common/BaseSoundLibrary" - }, - "references/1.4.0/common/ClearContext", - { - "group": "ClientLibraryManager", - "pages": [ - "references/1.4.0/common/ClientLibraryManager/constructor", - "references/1.4.0/common/ClientLibraryManager/get", - "references/1.4.0/common/ClientLibraryManager/getAssetManager", - "references/1.4.0/common/ClientLibraryManager/getComponentSystem", - "references/1.4.0/common/ClientLibraryManager/getGraphics", - "references/1.4.0/common/ClientLibraryManager/getInput", - "references/1.4.0/common/ClientLibraryManager/getMusic", - "references/1.4.0/common/ClientLibraryManager/getNetwork", - "references/1.4.0/common/ClientLibraryManager/getSound" - ], - "root": "references/1.4.0/common/ClientLibraryManager" - }, - "references/1.4.0/common/COMPONENT_SYSTEM_LIBRARY", - { - "group": "Context", - "pages": [ - "references/1.4.0/common/Context/app", - "references/1.4.0/common/Context/constructor", - "references/1.4.0/common/Context/libs" - ], - "root": "references/1.4.0/common/Context" - }, - "references/1.4.0/common/DefaultLibrariesEnum", - "references/1.4.0/common/ExecutionContext", - "references/1.4.0/common/GRAPHICS_LIBRARY", - { - "group": "IAssetManagerLibrary", - "pages": [ - "references/1.4.0/common/IAssetManagerLibrary/getAsset_1", - "references/1.4.0/common/IAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.0/common/IAssetManagerLibrary" - }, - "references/1.4.0/common/IComponentSystemLibrary", - { - "group": "IConfigRegistry", - "pages": [ - "references/1.4.0/common/IConfigRegistry/registerConfig" - ], - "root": "references/1.4.0/common/IConfigRegistry" - }, - "references/1.4.0/common/IExposedLibrary", - "references/1.4.0/common/IGraphicsLibrary", - "references/1.4.0/common/IInputLibrary", - "references/1.4.0/common/ILibrary", - "references/1.4.0/common/IMusicLibrary", - { - "group": "IMutableLibrary", - "pages": [ - "references/1.4.0/common/IMutableLibrary/mute" - ], - "root": "references/1.4.0/common/IMutableLibrary" - }, - "references/1.4.0/common/INetworkLibrary", - { - "group": "InitContext", - "pages": [ - "references/1.4.0/common/InitContext/config", - "references/1.4.0/common/InitContext/constructor", - "references/1.4.0/common/InitContext/container", - "references/1.4.0/common/InitContext/env", - "references/1.4.0/common/InitContext/files" - ], - "root": "references/1.4.0/common/InitContext" - }, - "references/1.4.0/common/INPUT_LIBRARY", - { - "group": "IRunClientOptions", - "pages": [ - "references/1.4.0/common/IRunClientOptions/container", - "references/1.4.0/common/IRunClientOptions/env", - "references/1.4.0/common/IRunClientOptions/files" - ], - "root": "references/1.4.0/common/IRunClientOptions" - }, - "references/1.4.0/common/IRunnerLibrary", - "references/1.4.0/common/IRunOptions", - { - "group": "IRunServerOptions", - "pages": [ - "references/1.4.0/common/IRunServerOptions/env", - "references/1.4.0/common/IRunServerOptions/files" - ], - "root": "references/1.4.0/common/IRunServerOptions" - }, - "references/1.4.0/common/ISoundLibrary", - { - "group": "Library", - "pages": [ - "references/1.4.0/common/Library/_relationship", - "references/1.4.0/common/Library/constructor" - ], - "root": "references/1.4.0/common/Library" - }, - { - "group": "LibraryContext", - "pages": [ - "references/1.4.0/common/LibraryContext/status" - ], - "root": "references/1.4.0/common/LibraryContext" - }, - { - "group": "LibraryHandle", - "pages": [ - "references/1.4.0/common/LibraryHandle/constructor", - "references/1.4.0/common/LibraryHandle/context", - "references/1.4.0/common/LibraryHandle/library", - "references/1.4.0/common/LibraryHandle/symbol" - ], - "root": "references/1.4.0/common/LibraryHandle" - }, - { - "group": "LibraryManager", - "pages": [ - "references/1.4.0/common/LibraryManager/constructor", - "references/1.4.0/common/LibraryManager/getAssetManager", - "references/1.4.0/common/LibraryManager/getComponentSystem", - "references/1.4.0/common/LibraryManager/getGraphics", - "references/1.4.0/common/LibraryManager/getInput", - "references/1.4.0/common/LibraryManager/getMusic", - "references/1.4.0/common/LibraryManager/getNetwork", - "references/1.4.0/common/LibraryManager/getSound" - ], - "root": "references/1.4.0/common/LibraryManager" - }, - "references/1.4.0/common/LibraryStatusEnum", - "references/1.4.0/common/MUSIC_LIBRARY", - "references/1.4.0/common/NETWORK_LIBRARY", - { - "group": "NfConfigException", - "pages": [ - "references/1.4.0/common/NfConfigException/code", - "references/1.4.0/common/NfConfigException/constructor" - ], - "root": "references/1.4.0/common/NfConfigException" - }, - { - "group": "NfFetchException", - "pages": [ - "references/1.4.0/common/NfFetchException/code", - "references/1.4.0/common/NfFetchException/constructor" - ], - "root": "references/1.4.0/common/NfFetchException" - }, - { - "group": "NfFile", - "pages": [ - "references/1.4.0/common/NfFile/arrayBuffer", - "references/1.4.0/common/NfFile/blob", - "references/1.4.0/common/NfFile/bytes", - "references/1.4.0/common/NfFile/constructor", - "references/1.4.0/common/NfFile/formData", - "references/1.4.0/common/NfFile/json", - "references/1.4.0/common/NfFile/path", - "references/1.4.0/common/NfFile/text" - ], - "root": "references/1.4.0/common/NfFile" - }, - { - "group": "NfNotFound", - "pages": [ - "references/1.4.0/common/NfNotFound/code", - "references/1.4.0/common/NfNotFound/constructor" - ], - "root": "references/1.4.0/common/NfNotFound" - }, - { - "group": "NfNotInitializedException", - "pages": [ - "references/1.4.0/common/NfNotInitializedException/code", - "references/1.4.0/common/NfNotInitializedException/constructor" - ], - "root": "references/1.4.0/common/NfNotInitializedException" - }, - "references/1.4.0/common/SOUND_LIBRARY" - ] - }, - { - "dropdown": "Config", - "pages": [ - "references/1.4.0/config/0-index", - "references/1.4.0/config/Default", - "references/1.4.0/config/IsIpOrFQDN", - "references/1.4.0/config/TransformToBoolean" - ] - }, - { - "dropdown": "Core", - "pages": [ - "references/1.4.0/core/0-index", - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.0/core/NanoforgeClient/useGraphics", - "references/1.4.0/core/NanoforgeClient/useInput", - "references/1.4.0/core/NanoforgeClient/useSound" - ], - "root": "references/1.4.0/core/NanoforgeClient" - }, - "references/1.4.0/core/NanoforgeFactory", - "references/1.4.0/core/NanoforgeServer" - ] - }, - { - "dropdown": "Core-Editor", - "pages": [ - "references/1.4.0/core-editor/0-index", - "references/1.4.0/core-editor/CoreEvents", - "references/1.4.0/core-editor/EditorEvents", - { - "group": "EventEmitter", - "pages": [ - "references/1.4.0/core-editor/EventEmitter/constructor", - "references/1.4.0/core-editor/EventEmitter/emit", - "references/1.4.0/core-editor/EventEmitter/on", - "references/1.4.0/core-editor/EventEmitter/runEvents" - ], - "root": "references/1.4.0/core-editor/EventEmitter" - }, - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.0/core-editor/NanoforgeClient/useGraphics", - "references/1.4.0/core-editor/NanoforgeClient/useInput", - "references/1.4.0/core-editor/NanoforgeClient/useSound" - ], - "root": "references/1.4.0/core-editor/NanoforgeClient" - }, - "references/1.4.0/core-editor/NanoforgeFactory", - "references/1.4.0/core-editor/NanoforgeServer" - ] - }, - { - "dropdown": "ECS-Client", - "pages": [ - "references/1.4.0/ecs-client/0-index", - { - "group": "ECSClientLibrary", - "pages": [ - "references/1.4.0/ecs-client/ECSClientLibrary/constructor" - ], - "root": "references/1.4.0/ecs-client/ECSClientLibrary" - } - ] - }, - { - "dropdown": "ECS-Lib", - "pages": [ - "references/1.4.0/ecs-lib/0-index", - { - "group": "AbstractECSLibrary", - "pages": [ - "references/1.4.0/ecs-lib/AbstractECSLibrary/_registry", - "references/1.4.0/ecs-lib/AbstractECSLibrary/constructor", - "references/1.4.0/ecs-lib/AbstractECSLibrary/module", - "references/1.4.0/ecs-lib/AbstractECSLibrary/path", - "references/1.4.0/ecs-lib/AbstractECSLibrary/registry" - ], - "root": "references/1.4.0/ecs-lib/AbstractECSLibrary" - }, - "references/1.4.0/ecs-lib/Component", - "references/1.4.0/ecs-lib/EditorComponentManifest", - "references/1.4.0/ecs-lib/EditorSystemManifest", - { - "group": "Entity", - "pages": [ - "references/1.4.0/ecs-lib/Entity/getId" - ], - "root": "references/1.4.0/ecs-lib/Entity" - }, - { - "group": "Registry", - "pages": [ - "references/1.4.0/ecs-lib/Registry/addComponent", - "references/1.4.0/ecs-lib/Registry/addSystem", - "references/1.4.0/ecs-lib/Registry/clearEntities", - "references/1.4.0/ecs-lib/Registry/clearSystems", - "references/1.4.0/ecs-lib/Registry/entityFromIndex", - "references/1.4.0/ecs-lib/Registry/getComponents", - "references/1.4.0/ecs-lib/Registry/getComponentsConst", - "references/1.4.0/ecs-lib/Registry/getEntityComponent", - "references/1.4.0/ecs-lib/Registry/getEntityComponentConst", - "references/1.4.0/ecs-lib/Registry/getIndexedZipper", - "references/1.4.0/ecs-lib/Registry/getZipper", - "references/1.4.0/ecs-lib/Registry/killEntity", - "references/1.4.0/ecs-lib/Registry/maxEntities", - "references/1.4.0/ecs-lib/Registry/registerComponent", - "references/1.4.0/ecs-lib/Registry/removeComponent", - "references/1.4.0/ecs-lib/Registry/removeSystem", - "references/1.4.0/ecs-lib/Registry/runSystems", - "references/1.4.0/ecs-lib/Registry/spawnEntity" - ], - "root": "references/1.4.0/ecs-lib/Registry" - }, - { - "group": "SparseArray", - "pages": [ - "references/1.4.0/ecs-lib/SparseArray/clear", - "references/1.4.0/ecs-lib/SparseArray/empty", - "references/1.4.0/ecs-lib/SparseArray/erase", - "references/1.4.0/ecs-lib/SparseArray/get", - "references/1.4.0/ecs-lib/SparseArray/getConst", - "references/1.4.0/ecs-lib/SparseArray/getIndex", - "references/1.4.0/ecs-lib/SparseArray/insertAt_1", - "references/1.4.0/ecs-lib/SparseArray/insertAt", - "references/1.4.0/ecs-lib/SparseArray/resize", - "references/1.4.0/ecs-lib/SparseArray/set", - "references/1.4.0/ecs-lib/SparseArray/setByCopy", - "references/1.4.0/ecs-lib/SparseArray/setByMove", - "references/1.4.0/ecs-lib/SparseArray/size" - ], - "root": "references/1.4.0/ecs-lib/SparseArray" - }, - "references/1.4.0/ecs-lib/System" - ] - }, - { - "dropdown": "ECS-Server", - "pages": [ - "references/1.4.0/ecs-server/0-index", - { - "group": "ECSServerLibrary", - "pages": [ - "references/1.4.0/ecs-server/ECSServerLibrary/constructor" - ], - "root": "references/1.4.0/ecs-server/ECSServerLibrary" - }, - "references/1.4.0/ecs-server/Module" - ] - }, - { - "dropdown": "Graphics-2d", - "pages": [ - "references/1.4.0/graphics-2d/0-index", - "references/1.4.0/graphics-2d/Animation_2", - "references/1.4.0/graphics-2d/Arc", - "references/1.4.0/graphics-2d/ArcConfig", - "references/1.4.0/graphics-2d/Arrow", - "references/1.4.0/graphics-2d/ArrowConfig", - "references/1.4.0/graphics-2d/Canvas", - "references/1.4.0/graphics-2d/Circle", - "references/1.4.0/graphics-2d/CircleConfig", - "references/1.4.0/graphics-2d/Container", - "references/1.4.0/graphics-2d/ContainerConfig", - "references/1.4.0/graphics-2d/Context", - "references/1.4.0/graphics-2d/DD", - "references/1.4.0/graphics-2d/Easings", - "references/1.4.0/graphics-2d/Ellipse", - "references/1.4.0/graphics-2d/EllipseConfig", - "references/1.4.0/graphics-2d/FastLayer", - "references/1.4.0/graphics-2d/Filters", - { - "group": "Graphics2DLibrary", - "pages": [ - "references/1.4.0/graphics-2d/Graphics2DLibrary/baseLayer", - "references/1.4.0/graphics-2d/Graphics2DLibrary/stage" - ], - "root": "references/1.4.0/graphics-2d/Graphics2DLibrary" - }, - "references/1.4.0/graphics-2d/Group", - "references/1.4.0/graphics-2d/GroupConfig", - "references/1.4.0/graphics-2d/Image_2", - "references/1.4.0/graphics-2d/ImageConfig", - "references/1.4.0/graphics-2d/KonvaEventListener", - "references/1.4.0/graphics-2d/KonvaEventObject", - "references/1.4.0/graphics-2d/KonvaPointerEvent", - "references/1.4.0/graphics-2d/Label", - "references/1.4.0/graphics-2d/LabelConfig", - "references/1.4.0/graphics-2d/Layer", - "references/1.4.0/graphics-2d/LayerConfig", - "references/1.4.0/graphics-2d/Line", - "references/1.4.0/graphics-2d/LineConfig", - "references/1.4.0/graphics-2d/Node_2", - "references/1.4.0/graphics-2d/NodeConfig", - "references/1.4.0/graphics-2d/Path", - "references/1.4.0/graphics-2d/PathConfig", - "references/1.4.0/graphics-2d/Rect", - "references/1.4.0/graphics-2d/RectConfig", - "references/1.4.0/graphics-2d/RegularPolygon", - "references/1.4.0/graphics-2d/RegularPolygonConfig", - "references/1.4.0/graphics-2d/Ring", - "references/1.4.0/graphics-2d/RingConfig", - "references/1.4.0/graphics-2d/Shape", - "references/1.4.0/graphics-2d/ShapeConfig", - "references/1.4.0/graphics-2d/Sprite", - "references/1.4.0/graphics-2d/SpriteConfig", - "references/1.4.0/graphics-2d/Stage", - "references/1.4.0/graphics-2d/StageConfig", - "references/1.4.0/graphics-2d/Star", - "references/1.4.0/graphics-2d/StarConfig", - "references/1.4.0/graphics-2d/Tag", - "references/1.4.0/graphics-2d/TagConfig", - "references/1.4.0/graphics-2d/Text_2", - "references/1.4.0/graphics-2d/TextConfig", - "references/1.4.0/graphics-2d/TextPath", - "references/1.4.0/graphics-2d/TextPathConfig", - "references/1.4.0/graphics-2d/Transform", - "references/1.4.0/graphics-2d/Transformer_2", - "references/1.4.0/graphics-2d/TransformerConfig", - "references/1.4.0/graphics-2d/Tween", - "references/1.4.0/graphics-2d/TweenConfig", - "references/1.4.0/graphics-2d/Util", - "references/1.4.0/graphics-2d/Vector2d", - "references/1.4.0/graphics-2d/Wedge", - "references/1.4.0/graphics-2d/WedgeConfig" - ] - }, - { - "dropdown": "Input", - "pages": [ - "references/1.4.0/input/0-index", - "references/1.4.0/input/InputEnum", - { - "group": "InputLibrary", - "pages": [ - "references/1.4.0/input/InputLibrary/constructor", - "references/1.4.0/input/InputLibrary/getDragState", - "references/1.4.0/input/InputLibrary/getMousePosition", - "references/1.4.0/input/InputLibrary/getMouseState", - "references/1.4.0/input/InputLibrary/getPressedKeys", - "references/1.4.0/input/InputLibrary/getWheelState", - "references/1.4.0/input/InputLibrary/isDragging", - "references/1.4.0/input/InputLibrary/isKeyPressed" - ], - "root": "references/1.4.0/input/InputLibrary" - } - ] - }, - { - "dropdown": "Music", - "pages": [ - "references/1.4.0/music/0-index", - { - "group": "MusicLibrary", - "pages": [ - "references/1.4.0/music/MusicLibrary/load", - "references/1.4.0/music/MusicLibrary/mute", - "references/1.4.0/music/MusicLibrary/play" - ], - "root": "references/1.4.0/music/MusicLibrary" - } - ] - }, - { - "dropdown": "Network-Client", - "pages": [ - "references/1.4.0/network-client/0-index", - { - "group": "NetworkClientLibrary", - "pages": [ - "references/1.4.0/network-client/NetworkClientLibrary/tcp", - "references/1.4.0/network-client/NetworkClientLibrary/udp" - ], - "root": "references/1.4.0/network-client/NetworkClientLibrary" - }, - { - "group": "TCPClient", - "pages": [ - "references/1.4.0/network-client/TCPClient/connect", - "references/1.4.0/network-client/TCPClient/constructor", - "references/1.4.0/network-client/TCPClient/getReceivedPackets", - "references/1.4.0/network-client/TCPClient/isConnected", - "references/1.4.0/network-client/TCPClient/sendData" - ], - "root": "references/1.4.0/network-client/TCPClient" - }, - { - "group": "UDPClient", - "pages": [ - "references/1.4.0/network-client/UDPClient/connect", - "references/1.4.0/network-client/UDPClient/constructor", - "references/1.4.0/network-client/UDPClient/getReceivedPackets", - "references/1.4.0/network-client/UDPClient/isConnected", - "references/1.4.0/network-client/UDPClient/sendData" - ], - "root": "references/1.4.0/network-client/UDPClient" - } - ] - }, - { - "dropdown": "Network-Server", - "pages": [ - "references/1.4.0/network-server/0-index", - { - "group": "NetworkServerLibrary", - "pages": [ - "references/1.4.0/network-server/NetworkServerLibrary/tcp", - "references/1.4.0/network-server/NetworkServerLibrary/udp" - ], - "root": "references/1.4.0/network-server/NetworkServerLibrary" - }, - { - "group": "TCPServer", - "pages": [ - "references/1.4.0/network-server/TCPServer/constructor", - "references/1.4.0/network-server/TCPServer/getConnectedClients", - "references/1.4.0/network-server/TCPServer/getReceivedPackets", - "references/1.4.0/network-server/TCPServer/listen", - "references/1.4.0/network-server/TCPServer/sendToClient", - "references/1.4.0/network-server/TCPServer/sendToEverybody" - ], - "root": "references/1.4.0/network-server/TCPServer" - }, - { - "group": "UDPServer", - "pages": [ - "references/1.4.0/network-server/UDPServer/constructor", - "references/1.4.0/network-server/UDPServer/getConnectedClients", - "references/1.4.0/network-server/UDPServer/getReceivedPackets", - "references/1.4.0/network-server/UDPServer/listen", - "references/1.4.0/network-server/UDPServer/sendToClient", - "references/1.4.0/network-server/UDPServer/sendToEverybody" - ], - "root": "references/1.4.0/network-server/UDPServer" - } - ] - }, - { - "dropdown": "Sound", - "pages": [ - "references/1.4.0/sound/0-index", - { - "group": "SoundLibrary", - "pages": [ - "references/1.4.0/sound/SoundLibrary/load", - "references/1.4.0/sound/SoundLibrary/mute", - "references/1.4.0/sound/SoundLibrary/play" - ], - "root": "references/1.4.0/sound/SoundLibrary" - } - ] - } - ] - }, + "dropdown": "CLI", + "icon": "terminal", + "groups": [ { - "version": "1.4.2", - "dropdowns": [ - { - "dropdown": "Asset-Manager", - "pages": [ - "references/1.4.2/asset-manager/0-index", - { - "group": "AssetManagerLibrary", - "pages": [ - "references/1.4.2/asset-manager/AssetManagerLibrary/getAsset_1", - "references/1.4.2/asset-manager/AssetManagerLibrary/getAsset" - ], - "root": "references/1.4.2/asset-manager/AssetManagerLibrary" - } - ] - }, - { - "dropdown": "Common", - "pages": [ - "references/1.4.2/common/0-index", - { - "group": "ApplicationContext", - "pages": [ - "references/1.4.2/common/ApplicationContext/delta", - "references/1.4.2/common/ApplicationContext/isRunning" - ], - "root": "references/1.4.2/common/ApplicationContext" - }, - "references/1.4.2/common/ASSET_MANAGER_LIBRARY", - { - "group": "BaseAssetManagerLibrary", - "pages": [ - "references/1.4.2/common/BaseAssetManagerLibrary/getAsset_1", - "references/1.4.2/common/BaseAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.2/common/BaseAssetManagerLibrary" - }, - "references/1.4.2/common/BaseComponentSystemLibrary", - "references/1.4.2/common/BaseGraphicsLibrary", - "references/1.4.2/common/BaseInputLibrary", - { - "group": "BaseMusicLibrary", - "pages": [ - "references/1.4.2/common/BaseMusicLibrary/mute", - "references/1.4.2/common/BaseMusicLibrary/play" - ], - "root": "references/1.4.2/common/BaseMusicLibrary" - }, - "references/1.4.2/common/BaseNetworkLibrary", - { - "group": "BaseSoundLibrary", - "pages": [ - "references/1.4.2/common/BaseSoundLibrary/mute", - "references/1.4.2/common/BaseSoundLibrary/play" - ], - "root": "references/1.4.2/common/BaseSoundLibrary" - }, - "references/1.4.2/common/ClearContext", - { - "group": "ClientLibraryManager", - "pages": [ - "references/1.4.2/common/ClientLibraryManager/constructor", - "references/1.4.2/common/ClientLibraryManager/get", - "references/1.4.2/common/ClientLibraryManager/getAssetManager", - "references/1.4.2/common/ClientLibraryManager/getComponentSystem", - "references/1.4.2/common/ClientLibraryManager/getGraphics", - "references/1.4.2/common/ClientLibraryManager/getInput", - "references/1.4.2/common/ClientLibraryManager/getMusic", - "references/1.4.2/common/ClientLibraryManager/getNetwork", - "references/1.4.2/common/ClientLibraryManager/getSound" - ], - "root": "references/1.4.2/common/ClientLibraryManager" - }, - "references/1.4.2/common/COMPONENT_SYSTEM_LIBRARY", - { - "group": "Context", - "pages": [ - "references/1.4.2/common/Context/app", - "references/1.4.2/common/Context/constructor", - "references/1.4.2/common/Context/libs" - ], - "root": "references/1.4.2/common/Context" - }, - "references/1.4.2/common/DefaultLibrariesEnum", - "references/1.4.2/common/ExecutionContext", - "references/1.4.2/common/GRAPHICS_LIBRARY", - { - "group": "IAssetManagerLibrary", - "pages": [ - "references/1.4.2/common/IAssetManagerLibrary/getAsset_1", - "references/1.4.2/common/IAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.2/common/IAssetManagerLibrary" - }, - "references/1.4.2/common/IComponentSystemLibrary", - { - "group": "IConfigRegistry", - "pages": [ - "references/1.4.2/common/IConfigRegistry/registerConfig" - ], - "root": "references/1.4.2/common/IConfigRegistry" - }, - "references/1.4.2/common/IExposedLibrary", - "references/1.4.2/common/IGraphicsLibrary", - "references/1.4.2/common/IInputLibrary", - "references/1.4.2/common/ILibrary", - "references/1.4.2/common/IMusicLibrary", - { - "group": "IMutableLibrary", - "pages": [ - "references/1.4.2/common/IMutableLibrary/mute" - ], - "root": "references/1.4.2/common/IMutableLibrary" - }, - "references/1.4.2/common/INetworkLibrary", - { - "group": "InitContext", - "pages": [ - "references/1.4.2/common/InitContext/config", - "references/1.4.2/common/InitContext/constructor", - "references/1.4.2/common/InitContext/container", - "references/1.4.2/common/InitContext/env", - "references/1.4.2/common/InitContext/files" - ], - "root": "references/1.4.2/common/InitContext" - }, - "references/1.4.2/common/INPUT_LIBRARY", - { - "group": "IRunClientOptions", - "pages": [ - "references/1.4.2/common/IRunClientOptions/container", - "references/1.4.2/common/IRunClientOptions/env", - "references/1.4.2/common/IRunClientOptions/files" - ], - "root": "references/1.4.2/common/IRunClientOptions" - }, - "references/1.4.2/common/IRunnerLibrary", - "references/1.4.2/common/IRunOptions", - { - "group": "IRunServerOptions", - "pages": [ - "references/1.4.2/common/IRunServerOptions/env", - "references/1.4.2/common/IRunServerOptions/files" - ], - "root": "references/1.4.2/common/IRunServerOptions" - }, - "references/1.4.2/common/ISoundLibrary", - { - "group": "Library", - "pages": [ - "references/1.4.2/common/Library/_relationship", - "references/1.4.2/common/Library/constructor" - ], - "root": "references/1.4.2/common/Library" - }, - { - "group": "LibraryContext", - "pages": [ - "references/1.4.2/common/LibraryContext/status" - ], - "root": "references/1.4.2/common/LibraryContext" - }, - { - "group": "LibraryHandle", - "pages": [ - "references/1.4.2/common/LibraryHandle/constructor", - "references/1.4.2/common/LibraryHandle/context", - "references/1.4.2/common/LibraryHandle/library", - "references/1.4.2/common/LibraryHandle/symbol" - ], - "root": "references/1.4.2/common/LibraryHandle" - }, - { - "group": "LibraryManager", - "pages": [ - "references/1.4.2/common/LibraryManager/constructor", - "references/1.4.2/common/LibraryManager/getAssetManager", - "references/1.4.2/common/LibraryManager/getComponentSystem", - "references/1.4.2/common/LibraryManager/getGraphics", - "references/1.4.2/common/LibraryManager/getInput", - "references/1.4.2/common/LibraryManager/getMusic", - "references/1.4.2/common/LibraryManager/getNetwork", - "references/1.4.2/common/LibraryManager/getSound" - ], - "root": "references/1.4.2/common/LibraryManager" - }, - "references/1.4.2/common/LibraryStatusEnum", - "references/1.4.2/common/MUSIC_LIBRARY", - "references/1.4.2/common/NETWORK_LIBRARY", - { - "group": "NfConfigException", - "pages": [ - "references/1.4.2/common/NfConfigException/code", - "references/1.4.2/common/NfConfigException/constructor" - ], - "root": "references/1.4.2/common/NfConfigException" - }, - { - "group": "NfFetchException", - "pages": [ - "references/1.4.2/common/NfFetchException/code", - "references/1.4.2/common/NfFetchException/constructor" - ], - "root": "references/1.4.2/common/NfFetchException" - }, - { - "group": "NfFile", - "pages": [ - "references/1.4.2/common/NfFile/arrayBuffer", - "references/1.4.2/common/NfFile/blob", - "references/1.4.2/common/NfFile/bytes", - "references/1.4.2/common/NfFile/constructor", - "references/1.4.2/common/NfFile/formData", - "references/1.4.2/common/NfFile/json", - "references/1.4.2/common/NfFile/path", - "references/1.4.2/common/NfFile/text" - ], - "root": "references/1.4.2/common/NfFile" - }, - { - "group": "NfNotFound", - "pages": [ - "references/1.4.2/common/NfNotFound/code", - "references/1.4.2/common/NfNotFound/constructor" - ], - "root": "references/1.4.2/common/NfNotFound" - }, - { - "group": "NfNotInitializedException", - "pages": [ - "references/1.4.2/common/NfNotInitializedException/code", - "references/1.4.2/common/NfNotInitializedException/constructor" - ], - "root": "references/1.4.2/common/NfNotInitializedException" - }, - "references/1.4.2/common/SOUND_LIBRARY" - ] - }, - { - "dropdown": "Config", - "pages": [ - "references/1.4.2/config/0-index", - "references/1.4.2/config/Default", - "references/1.4.2/config/IsIpOrURL", - "references/1.4.2/config/TransformToBoolean" - ] - }, - { - "dropdown": "Core", - "pages": [ - "references/1.4.2/core/0-index", - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.2/core/NanoforgeClient/useGraphics", - "references/1.4.2/core/NanoforgeClient/useInput", - "references/1.4.2/core/NanoforgeClient/useSound" - ], - "root": "references/1.4.2/core/NanoforgeClient" - }, - "references/1.4.2/core/NanoforgeFactory", - "references/1.4.2/core/NanoforgeServer" - ] - }, - { - "dropdown": "Core-Editor", - "pages": [ - "references/1.4.2/core-editor/0-index", - "references/1.4.2/core-editor/CoreEvents", - "references/1.4.2/core-editor/EditorEvents", - { - "group": "EventEmitter", - "pages": [ - "references/1.4.2/core-editor/EventEmitter/constructor", - "references/1.4.2/core-editor/EventEmitter/emit", - "references/1.4.2/core-editor/EventEmitter/on", - "references/1.4.2/core-editor/EventEmitter/runEvents" - ], - "root": "references/1.4.2/core-editor/EventEmitter" - }, - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.2/core-editor/NanoforgeClient/useGraphics", - "references/1.4.2/core-editor/NanoforgeClient/useInput", - "references/1.4.2/core-editor/NanoforgeClient/useSound" - ], - "root": "references/1.4.2/core-editor/NanoforgeClient" - }, - "references/1.4.2/core-editor/NanoforgeFactory", - "references/1.4.2/core-editor/NanoforgeServer" - ] - }, - { - "dropdown": "ECS-Client", - "pages": [ - "references/1.4.2/ecs-client/0-index", - { - "group": "ECSClientLibrary", - "pages": [ - "references/1.4.2/ecs-client/ECSClientLibrary/constructor" - ], - "root": "references/1.4.2/ecs-client/ECSClientLibrary" - } - ] - }, - { - "dropdown": "ECS-Lib", - "pages": [ - "references/1.4.2/ecs-lib/0-index", - { - "group": "AbstractECSLibrary", - "pages": [ - "references/1.4.2/ecs-lib/AbstractECSLibrary/_registry", - "references/1.4.2/ecs-lib/AbstractECSLibrary/constructor", - "references/1.4.2/ecs-lib/AbstractECSLibrary/module", - "references/1.4.2/ecs-lib/AbstractECSLibrary/path", - "references/1.4.2/ecs-lib/AbstractECSLibrary/registry" - ], - "root": "references/1.4.2/ecs-lib/AbstractECSLibrary" - }, - "references/1.4.2/ecs-lib/Component", - "references/1.4.2/ecs-lib/EditorComponentManifest", - "references/1.4.2/ecs-lib/EditorSystemManifest", - { - "group": "Entity", - "pages": [ - "references/1.4.2/ecs-lib/Entity/getId" - ], - "root": "references/1.4.2/ecs-lib/Entity" - }, - { - "group": "Registry", - "pages": [ - "references/1.4.2/ecs-lib/Registry/addComponent", - "references/1.4.2/ecs-lib/Registry/addSystem", - "references/1.4.2/ecs-lib/Registry/clearEntities", - "references/1.4.2/ecs-lib/Registry/clearSystems", - "references/1.4.2/ecs-lib/Registry/entityFromIndex", - "references/1.4.2/ecs-lib/Registry/getComponents", - "references/1.4.2/ecs-lib/Registry/getComponentsConst", - "references/1.4.2/ecs-lib/Registry/getEntityComponent", - "references/1.4.2/ecs-lib/Registry/getEntityComponentConst", - "references/1.4.2/ecs-lib/Registry/getIndexedZipper", - "references/1.4.2/ecs-lib/Registry/getZipper", - "references/1.4.2/ecs-lib/Registry/killEntity", - "references/1.4.2/ecs-lib/Registry/maxEntities", - "references/1.4.2/ecs-lib/Registry/registerComponent", - "references/1.4.2/ecs-lib/Registry/removeComponent", - "references/1.4.2/ecs-lib/Registry/removeSystem", - "references/1.4.2/ecs-lib/Registry/runSystems", - "references/1.4.2/ecs-lib/Registry/spawnEntity" - ], - "root": "references/1.4.2/ecs-lib/Registry" - }, - { - "group": "SparseArray", - "pages": [ - "references/1.4.2/ecs-lib/SparseArray/clear", - "references/1.4.2/ecs-lib/SparseArray/empty", - "references/1.4.2/ecs-lib/SparseArray/erase", - "references/1.4.2/ecs-lib/SparseArray/get", - "references/1.4.2/ecs-lib/SparseArray/getConst", - "references/1.4.2/ecs-lib/SparseArray/getIndex", - "references/1.4.2/ecs-lib/SparseArray/insertAt_1", - "references/1.4.2/ecs-lib/SparseArray/insertAt", - "references/1.4.2/ecs-lib/SparseArray/resize", - "references/1.4.2/ecs-lib/SparseArray/set", - "references/1.4.2/ecs-lib/SparseArray/setByCopy", - "references/1.4.2/ecs-lib/SparseArray/setByMove", - "references/1.4.2/ecs-lib/SparseArray/size" - ], - "root": "references/1.4.2/ecs-lib/SparseArray" - }, - "references/1.4.2/ecs-lib/System" - ] - }, - { - "dropdown": "ECS-Server", - "pages": [ - "references/1.4.2/ecs-server/0-index", - { - "group": "ECSServerLibrary", - "pages": [ - "references/1.4.2/ecs-server/ECSServerLibrary/constructor" - ], - "root": "references/1.4.2/ecs-server/ECSServerLibrary" - }, - "references/1.4.2/ecs-server/Module" - ] - }, - { - "dropdown": "Graphics-2d", - "pages": [ - "references/1.4.2/graphics-2d/0-index", - "references/1.4.2/graphics-2d/Animation_2", - "references/1.4.2/graphics-2d/Arc", - "references/1.4.2/graphics-2d/ArcConfig", - "references/1.4.2/graphics-2d/Arrow", - "references/1.4.2/graphics-2d/ArrowConfig", - "references/1.4.2/graphics-2d/Canvas", - "references/1.4.2/graphics-2d/Circle", - "references/1.4.2/graphics-2d/CircleConfig", - "references/1.4.2/graphics-2d/Container", - "references/1.4.2/graphics-2d/ContainerConfig", - "references/1.4.2/graphics-2d/Context", - "references/1.4.2/graphics-2d/DD", - "references/1.4.2/graphics-2d/Easings", - "references/1.4.2/graphics-2d/Ellipse", - "references/1.4.2/graphics-2d/EllipseConfig", - "references/1.4.2/graphics-2d/FastLayer", - "references/1.4.2/graphics-2d/Filters", - { - "group": "Graphics2DLibrary", - "pages": [ - "references/1.4.2/graphics-2d/Graphics2DLibrary/baseLayer", - "references/1.4.2/graphics-2d/Graphics2DLibrary/stage" - ], - "root": "references/1.4.2/graphics-2d/Graphics2DLibrary" - }, - "references/1.4.2/graphics-2d/Group", - "references/1.4.2/graphics-2d/GroupConfig", - "references/1.4.2/graphics-2d/Image_2", - "references/1.4.2/graphics-2d/ImageConfig", - "references/1.4.2/graphics-2d/KonvaEventListener", - "references/1.4.2/graphics-2d/KonvaEventObject", - "references/1.4.2/graphics-2d/KonvaPointerEvent", - "references/1.4.2/graphics-2d/Label", - "references/1.4.2/graphics-2d/LabelConfig", - "references/1.4.2/graphics-2d/Layer", - "references/1.4.2/graphics-2d/LayerConfig", - "references/1.4.2/graphics-2d/Line", - "references/1.4.2/graphics-2d/LineConfig", - "references/1.4.2/graphics-2d/Node_2", - "references/1.4.2/graphics-2d/NodeConfig", - "references/1.4.2/graphics-2d/Path", - "references/1.4.2/graphics-2d/PathConfig", - "references/1.4.2/graphics-2d/Rect", - "references/1.4.2/graphics-2d/RectConfig", - "references/1.4.2/graphics-2d/RegularPolygon", - "references/1.4.2/graphics-2d/RegularPolygonConfig", - "references/1.4.2/graphics-2d/Ring", - "references/1.4.2/graphics-2d/RingConfig", - "references/1.4.2/graphics-2d/Shape", - "references/1.4.2/graphics-2d/ShapeConfig", - "references/1.4.2/graphics-2d/Sprite", - "references/1.4.2/graphics-2d/SpriteConfig", - "references/1.4.2/graphics-2d/Stage", - "references/1.4.2/graphics-2d/StageConfig", - "references/1.4.2/graphics-2d/Star", - "references/1.4.2/graphics-2d/StarConfig", - "references/1.4.2/graphics-2d/Tag", - "references/1.4.2/graphics-2d/TagConfig", - "references/1.4.2/graphics-2d/Text_2", - "references/1.4.2/graphics-2d/TextConfig", - "references/1.4.2/graphics-2d/TextPath", - "references/1.4.2/graphics-2d/TextPathConfig", - "references/1.4.2/graphics-2d/Transform", - "references/1.4.2/graphics-2d/Transformer_2", - "references/1.4.2/graphics-2d/TransformerConfig", - "references/1.4.2/graphics-2d/Tween", - "references/1.4.2/graphics-2d/TweenConfig", - "references/1.4.2/graphics-2d/Util", - "references/1.4.2/graphics-2d/Vector2d", - "references/1.4.2/graphics-2d/Wedge", - "references/1.4.2/graphics-2d/WedgeConfig" - ] - }, - { - "dropdown": "Input", - "pages": [ - "references/1.4.2/input/0-index", - "references/1.4.2/input/InputEnum", - { - "group": "InputLibrary", - "pages": [ - "references/1.4.2/input/InputLibrary/constructor", - "references/1.4.2/input/InputLibrary/getDragState", - "references/1.4.2/input/InputLibrary/getMousePosition", - "references/1.4.2/input/InputLibrary/getMouseState", - "references/1.4.2/input/InputLibrary/getPressedKeys", - "references/1.4.2/input/InputLibrary/getWheelState", - "references/1.4.2/input/InputLibrary/isDragging", - "references/1.4.2/input/InputLibrary/isKeyPressed" - ], - "root": "references/1.4.2/input/InputLibrary" - } - ] - }, - { - "dropdown": "Music", - "pages": [ - "references/1.4.2/music/0-index", - { - "group": "MusicLibrary", - "pages": [ - "references/1.4.2/music/MusicLibrary/load", - "references/1.4.2/music/MusicLibrary/mute", - "references/1.4.2/music/MusicLibrary/play" - ], - "root": "references/1.4.2/music/MusicLibrary" - } - ] - }, - { - "dropdown": "Network-Client", - "pages": [ - "references/1.4.2/network-client/0-index", - { - "group": "NetworkClientLibrary", - "pages": [ - "references/1.4.2/network-client/NetworkClientLibrary/tcp", - "references/1.4.2/network-client/NetworkClientLibrary/udp" - ], - "root": "references/1.4.2/network-client/NetworkClientLibrary" - }, - { - "group": "TCPClient", - "pages": [ - "references/1.4.2/network-client/TCPClient/connect", - "references/1.4.2/network-client/TCPClient/constructor", - "references/1.4.2/network-client/TCPClient/getReceivedPackets", - "references/1.4.2/network-client/TCPClient/isConnected", - "references/1.4.2/network-client/TCPClient/sendData" - ], - "root": "references/1.4.2/network-client/TCPClient" - }, - { - "group": "UDPClient", - "pages": [ - "references/1.4.2/network-client/UDPClient/connect", - "references/1.4.2/network-client/UDPClient/constructor", - "references/1.4.2/network-client/UDPClient/getReceivedPackets", - "references/1.4.2/network-client/UDPClient/isConnected", - "references/1.4.2/network-client/UDPClient/sendData" - ], - "root": "references/1.4.2/network-client/UDPClient" - } - ] - }, - { - "dropdown": "Network-Server", - "pages": [ - "references/1.4.2/network-server/0-index", - { - "group": "NetworkServerLibrary", - "pages": [ - "references/1.4.2/network-server/NetworkServerLibrary/tcp", - "references/1.4.2/network-server/NetworkServerLibrary/udp" - ], - "root": "references/1.4.2/network-server/NetworkServerLibrary" - }, - { - "group": "TCPServer", - "pages": [ - "references/1.4.2/network-server/TCPServer/constructor", - "references/1.4.2/network-server/TCPServer/getConnectedClients", - "references/1.4.2/network-server/TCPServer/getReceivedPackets", - "references/1.4.2/network-server/TCPServer/listen", - "references/1.4.2/network-server/TCPServer/sendToClient", - "references/1.4.2/network-server/TCPServer/sendToEverybody" - ], - "root": "references/1.4.2/network-server/TCPServer" - }, - { - "group": "UDPServer", - "pages": [ - "references/1.4.2/network-server/UDPServer/constructor", - "references/1.4.2/network-server/UDPServer/getConnectedClients", - "references/1.4.2/network-server/UDPServer/getReceivedPackets", - "references/1.4.2/network-server/UDPServer/listen", - "references/1.4.2/network-server/UDPServer/sendToClient", - "references/1.4.2/network-server/UDPServer/sendToEverybody" - ], - "root": "references/1.4.2/network-server/UDPServer" - } - ] - }, - { - "dropdown": "Sound", - "pages": [ - "references/1.4.2/sound/0-index", - { - "group": "SoundLibrary", - "pages": [ - "references/1.4.2/sound/SoundLibrary/load", - "references/1.4.2/sound/SoundLibrary/mute", - "references/1.4.2/sound/SoundLibrary/play" - ], - "root": "references/1.4.2/sound/SoundLibrary" - } - ] - } - ] + "group": "CLI", + "pages": { + "$ref": "./docs/cli/navigation.json" + } }, { - "version": "1.4.1", - "dropdowns": [ - { - "dropdown": "Asset-Manager", - "pages": [ - "references/1.4.1/asset-manager/0-index", - { - "group": "AssetManagerLibrary", - "pages": [ - "references/1.4.1/asset-manager/AssetManagerLibrary/getAsset_1", - "references/1.4.1/asset-manager/AssetManagerLibrary/getAsset" - ], - "root": "references/1.4.1/asset-manager/AssetManagerLibrary" - } - ] - }, - { - "dropdown": "Common", - "pages": [ - "references/1.4.1/common/0-index", - { - "group": "ApplicationContext", - "pages": [ - "references/1.4.1/common/ApplicationContext/delta", - "references/1.4.1/common/ApplicationContext/isRunning" - ], - "root": "references/1.4.1/common/ApplicationContext" - }, - "references/1.4.1/common/ASSET_MANAGER_LIBRARY", - { - "group": "BaseAssetManagerLibrary", - "pages": [ - "references/1.4.1/common/BaseAssetManagerLibrary/getAsset_1", - "references/1.4.1/common/BaseAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.1/common/BaseAssetManagerLibrary" - }, - "references/1.4.1/common/BaseComponentSystemLibrary", - "references/1.4.1/common/BaseGraphicsLibrary", - "references/1.4.1/common/BaseInputLibrary", - { - "group": "BaseMusicLibrary", - "pages": [ - "references/1.4.1/common/BaseMusicLibrary/mute", - "references/1.4.1/common/BaseMusicLibrary/play" - ], - "root": "references/1.4.1/common/BaseMusicLibrary" - }, - "references/1.4.1/common/BaseNetworkLibrary", - { - "group": "BaseSoundLibrary", - "pages": [ - "references/1.4.1/common/BaseSoundLibrary/mute", - "references/1.4.1/common/BaseSoundLibrary/play" - ], - "root": "references/1.4.1/common/BaseSoundLibrary" - }, - "references/1.4.1/common/ClearContext", - { - "group": "ClientLibraryManager", - "pages": [ - "references/1.4.1/common/ClientLibraryManager/constructor", - "references/1.4.1/common/ClientLibraryManager/get", - "references/1.4.1/common/ClientLibraryManager/getAssetManager", - "references/1.4.1/common/ClientLibraryManager/getComponentSystem", - "references/1.4.1/common/ClientLibraryManager/getGraphics", - "references/1.4.1/common/ClientLibraryManager/getInput", - "references/1.4.1/common/ClientLibraryManager/getMusic", - "references/1.4.1/common/ClientLibraryManager/getNetwork", - "references/1.4.1/common/ClientLibraryManager/getSound" - ], - "root": "references/1.4.1/common/ClientLibraryManager" - }, - "references/1.4.1/common/COMPONENT_SYSTEM_LIBRARY", - { - "group": "Context", - "pages": [ - "references/1.4.1/common/Context/app", - "references/1.4.1/common/Context/constructor", - "references/1.4.1/common/Context/libs" - ], - "root": "references/1.4.1/common/Context" - }, - "references/1.4.1/common/DefaultLibrariesEnum", - "references/1.4.1/common/ExecutionContext", - "references/1.4.1/common/GRAPHICS_LIBRARY", - { - "group": "IAssetManagerLibrary", - "pages": [ - "references/1.4.1/common/IAssetManagerLibrary/getAsset_1", - "references/1.4.1/common/IAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.1/common/IAssetManagerLibrary" - }, - "references/1.4.1/common/IComponentSystemLibrary", - { - "group": "IConfigRegistry", - "pages": [ - "references/1.4.1/common/IConfigRegistry/registerConfig" - ], - "root": "references/1.4.1/common/IConfigRegistry" - }, - "references/1.4.1/common/IExposedLibrary", - "references/1.4.1/common/IGraphicsLibrary", - "references/1.4.1/common/IInputLibrary", - "references/1.4.1/common/ILibrary", - "references/1.4.1/common/IMusicLibrary", - { - "group": "IMutableLibrary", - "pages": [ - "references/1.4.1/common/IMutableLibrary/mute" - ], - "root": "references/1.4.1/common/IMutableLibrary" - }, - "references/1.4.1/common/INetworkLibrary", - { - "group": "InitContext", - "pages": [ - "references/1.4.1/common/InitContext/config", - "references/1.4.1/common/InitContext/constructor", - "references/1.4.1/common/InitContext/container", - "references/1.4.1/common/InitContext/env", - "references/1.4.1/common/InitContext/files" - ], - "root": "references/1.4.1/common/InitContext" - }, - "references/1.4.1/common/INPUT_LIBRARY", - { - "group": "IRunClientOptions", - "pages": [ - "references/1.4.1/common/IRunClientOptions/container", - "references/1.4.1/common/IRunClientOptions/env", - "references/1.4.1/common/IRunClientOptions/files" - ], - "root": "references/1.4.1/common/IRunClientOptions" - }, - "references/1.4.1/common/IRunnerLibrary", - "references/1.4.1/common/IRunOptions", - { - "group": "IRunServerOptions", - "pages": [ - "references/1.4.1/common/IRunServerOptions/env", - "references/1.4.1/common/IRunServerOptions/files" - ], - "root": "references/1.4.1/common/IRunServerOptions" - }, - "references/1.4.1/common/ISoundLibrary", - { - "group": "Library", - "pages": [ - "references/1.4.1/common/Library/_relationship", - "references/1.4.1/common/Library/constructor" - ], - "root": "references/1.4.1/common/Library" - }, - { - "group": "LibraryContext", - "pages": [ - "references/1.4.1/common/LibraryContext/status" - ], - "root": "references/1.4.1/common/LibraryContext" - }, - { - "group": "LibraryHandle", - "pages": [ - "references/1.4.1/common/LibraryHandle/constructor", - "references/1.4.1/common/LibraryHandle/context", - "references/1.4.1/common/LibraryHandle/library", - "references/1.4.1/common/LibraryHandle/symbol" - ], - "root": "references/1.4.1/common/LibraryHandle" - }, - { - "group": "LibraryManager", - "pages": [ - "references/1.4.1/common/LibraryManager/constructor", - "references/1.4.1/common/LibraryManager/getAssetManager", - "references/1.4.1/common/LibraryManager/getComponentSystem", - "references/1.4.1/common/LibraryManager/getGraphics", - "references/1.4.1/common/LibraryManager/getInput", - "references/1.4.1/common/LibraryManager/getMusic", - "references/1.4.1/common/LibraryManager/getNetwork", - "references/1.4.1/common/LibraryManager/getSound" - ], - "root": "references/1.4.1/common/LibraryManager" - }, - "references/1.4.1/common/LibraryStatusEnum", - "references/1.4.1/common/MUSIC_LIBRARY", - "references/1.4.1/common/NETWORK_LIBRARY", - { - "group": "NfConfigException", - "pages": [ - "references/1.4.1/common/NfConfigException/code", - "references/1.4.1/common/NfConfigException/constructor" - ], - "root": "references/1.4.1/common/NfConfigException" - }, - { - "group": "NfFetchException", - "pages": [ - "references/1.4.1/common/NfFetchException/code", - "references/1.4.1/common/NfFetchException/constructor" - ], - "root": "references/1.4.1/common/NfFetchException" - }, - { - "group": "NfFile", - "pages": [ - "references/1.4.1/common/NfFile/arrayBuffer", - "references/1.4.1/common/NfFile/blob", - "references/1.4.1/common/NfFile/bytes", - "references/1.4.1/common/NfFile/constructor", - "references/1.4.1/common/NfFile/formData", - "references/1.4.1/common/NfFile/json", - "references/1.4.1/common/NfFile/path", - "references/1.4.1/common/NfFile/text" - ], - "root": "references/1.4.1/common/NfFile" - }, - { - "group": "NfNotFound", - "pages": [ - "references/1.4.1/common/NfNotFound/code", - "references/1.4.1/common/NfNotFound/constructor" - ], - "root": "references/1.4.1/common/NfNotFound" - }, - { - "group": "NfNotInitializedException", - "pages": [ - "references/1.4.1/common/NfNotInitializedException/code", - "references/1.4.1/common/NfNotInitializedException/constructor" - ], - "root": "references/1.4.1/common/NfNotInitializedException" - }, - "references/1.4.1/common/SOUND_LIBRARY" - ] - }, - { - "dropdown": "Config", - "pages": [ - "references/1.4.1/config/0-index", - "references/1.4.1/config/Default", - "references/1.4.1/config/IsIpOrURL", - "references/1.4.1/config/TransformToBoolean" - ] - }, - { - "dropdown": "Core", - "pages": [ - "references/1.4.1/core/0-index", - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.1/core/NanoforgeClient/useGraphics", - "references/1.4.1/core/NanoforgeClient/useInput", - "references/1.4.1/core/NanoforgeClient/useSound" - ], - "root": "references/1.4.1/core/NanoforgeClient" - }, - "references/1.4.1/core/NanoforgeFactory", - "references/1.4.1/core/NanoforgeServer" - ] - }, - { - "dropdown": "Core-Editor", - "pages": [ - "references/1.4.1/core-editor/0-index", - "references/1.4.1/core-editor/CoreEvents", - "references/1.4.1/core-editor/EditorEvents", - { - "group": "EventEmitter", - "pages": [ - "references/1.4.1/core-editor/EventEmitter/constructor", - "references/1.4.1/core-editor/EventEmitter/emit", - "references/1.4.1/core-editor/EventEmitter/on", - "references/1.4.1/core-editor/EventEmitter/runEvents" - ], - "root": "references/1.4.1/core-editor/EventEmitter" - }, - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.1/core-editor/NanoforgeClient/useGraphics", - "references/1.4.1/core-editor/NanoforgeClient/useInput", - "references/1.4.1/core-editor/NanoforgeClient/useSound" - ], - "root": "references/1.4.1/core-editor/NanoforgeClient" - }, - "references/1.4.1/core-editor/NanoforgeFactory", - "references/1.4.1/core-editor/NanoforgeServer" - ] - }, - { - "dropdown": "ECS-Client", - "pages": [ - "references/1.4.1/ecs-client/0-index", - { - "group": "ECSClientLibrary", - "pages": [ - "references/1.4.1/ecs-client/ECSClientLibrary/constructor" - ], - "root": "references/1.4.1/ecs-client/ECSClientLibrary" - } - ] - }, - { - "dropdown": "ECS-Lib", - "pages": [ - "references/1.4.1/ecs-lib/0-index", - { - "group": "AbstractECSLibrary", - "pages": [ - "references/1.4.1/ecs-lib/AbstractECSLibrary/_registry", - "references/1.4.1/ecs-lib/AbstractECSLibrary/constructor", - "references/1.4.1/ecs-lib/AbstractECSLibrary/module", - "references/1.4.1/ecs-lib/AbstractECSLibrary/path", - "references/1.4.1/ecs-lib/AbstractECSLibrary/registry" - ], - "root": "references/1.4.1/ecs-lib/AbstractECSLibrary" - }, - "references/1.4.1/ecs-lib/Component", - "references/1.4.1/ecs-lib/EditorComponentManifest", - "references/1.4.1/ecs-lib/EditorSystemManifest", - { - "group": "Entity", - "pages": [ - "references/1.4.1/ecs-lib/Entity/getId" - ], - "root": "references/1.4.1/ecs-lib/Entity" - }, - { - "group": "Registry", - "pages": [ - "references/1.4.1/ecs-lib/Registry/addComponent", - "references/1.4.1/ecs-lib/Registry/addSystem", - "references/1.4.1/ecs-lib/Registry/clearEntities", - "references/1.4.1/ecs-lib/Registry/clearSystems", - "references/1.4.1/ecs-lib/Registry/entityFromIndex", - "references/1.4.1/ecs-lib/Registry/getComponents", - "references/1.4.1/ecs-lib/Registry/getComponentsConst", - "references/1.4.1/ecs-lib/Registry/getEntityComponent", - "references/1.4.1/ecs-lib/Registry/getEntityComponentConst", - "references/1.4.1/ecs-lib/Registry/getIndexedZipper", - "references/1.4.1/ecs-lib/Registry/getZipper", - "references/1.4.1/ecs-lib/Registry/killEntity", - "references/1.4.1/ecs-lib/Registry/maxEntities", - "references/1.4.1/ecs-lib/Registry/registerComponent", - "references/1.4.1/ecs-lib/Registry/removeComponent", - "references/1.4.1/ecs-lib/Registry/removeSystem", - "references/1.4.1/ecs-lib/Registry/runSystems", - "references/1.4.1/ecs-lib/Registry/spawnEntity" - ], - "root": "references/1.4.1/ecs-lib/Registry" - }, - { - "group": "SparseArray", - "pages": [ - "references/1.4.1/ecs-lib/SparseArray/clear", - "references/1.4.1/ecs-lib/SparseArray/empty", - "references/1.4.1/ecs-lib/SparseArray/erase", - "references/1.4.1/ecs-lib/SparseArray/get", - "references/1.4.1/ecs-lib/SparseArray/getConst", - "references/1.4.1/ecs-lib/SparseArray/getIndex", - "references/1.4.1/ecs-lib/SparseArray/insertAt_1", - "references/1.4.1/ecs-lib/SparseArray/insertAt", - "references/1.4.1/ecs-lib/SparseArray/resize", - "references/1.4.1/ecs-lib/SparseArray/set", - "references/1.4.1/ecs-lib/SparseArray/setByCopy", - "references/1.4.1/ecs-lib/SparseArray/setByMove", - "references/1.4.1/ecs-lib/SparseArray/size" - ], - "root": "references/1.4.1/ecs-lib/SparseArray" - }, - "references/1.4.1/ecs-lib/System" - ] - }, - { - "dropdown": "ECS-Server", - "pages": [ - "references/1.4.1/ecs-server/0-index", - { - "group": "ECSServerLibrary", - "pages": [ - "references/1.4.1/ecs-server/ECSServerLibrary/constructor" - ], - "root": "references/1.4.1/ecs-server/ECSServerLibrary" - }, - "references/1.4.1/ecs-server/Module" - ] - }, - { - "dropdown": "Graphics-2d", - "pages": [ - "references/1.4.1/graphics-2d/0-index", - "references/1.4.1/graphics-2d/Animation_2", - "references/1.4.1/graphics-2d/Arc", - "references/1.4.1/graphics-2d/ArcConfig", - "references/1.4.1/graphics-2d/Arrow", - "references/1.4.1/graphics-2d/ArrowConfig", - "references/1.4.1/graphics-2d/Canvas", - "references/1.4.1/graphics-2d/Circle", - "references/1.4.1/graphics-2d/CircleConfig", - "references/1.4.1/graphics-2d/Container", - "references/1.4.1/graphics-2d/ContainerConfig", - "references/1.4.1/graphics-2d/Context", - "references/1.4.1/graphics-2d/DD", - "references/1.4.1/graphics-2d/Easings", - "references/1.4.1/graphics-2d/Ellipse", - "references/1.4.1/graphics-2d/EllipseConfig", - "references/1.4.1/graphics-2d/FastLayer", - "references/1.4.1/graphics-2d/Filters", - { - "group": "Graphics2DLibrary", - "pages": [ - "references/1.4.1/graphics-2d/Graphics2DLibrary/baseLayer", - "references/1.4.1/graphics-2d/Graphics2DLibrary/stage" - ], - "root": "references/1.4.1/graphics-2d/Graphics2DLibrary" - }, - "references/1.4.1/graphics-2d/Group", - "references/1.4.1/graphics-2d/GroupConfig", - "references/1.4.1/graphics-2d/Image_2", - "references/1.4.1/graphics-2d/ImageConfig", - "references/1.4.1/graphics-2d/KonvaEventListener", - "references/1.4.1/graphics-2d/KonvaEventObject", - "references/1.4.1/graphics-2d/KonvaPointerEvent", - "references/1.4.1/graphics-2d/Label", - "references/1.4.1/graphics-2d/LabelConfig", - "references/1.4.1/graphics-2d/Layer", - "references/1.4.1/graphics-2d/LayerConfig", - "references/1.4.1/graphics-2d/Line", - "references/1.4.1/graphics-2d/LineConfig", - "references/1.4.1/graphics-2d/Node_2", - "references/1.4.1/graphics-2d/NodeConfig", - "references/1.4.1/graphics-2d/Path", - "references/1.4.1/graphics-2d/PathConfig", - "references/1.4.1/graphics-2d/Rect", - "references/1.4.1/graphics-2d/RectConfig", - "references/1.4.1/graphics-2d/RegularPolygon", - "references/1.4.1/graphics-2d/RegularPolygonConfig", - "references/1.4.1/graphics-2d/Ring", - "references/1.4.1/graphics-2d/RingConfig", - "references/1.4.1/graphics-2d/Shape", - "references/1.4.1/graphics-2d/ShapeConfig", - "references/1.4.1/graphics-2d/Sprite", - "references/1.4.1/graphics-2d/SpriteConfig", - "references/1.4.1/graphics-2d/Stage", - "references/1.4.1/graphics-2d/StageConfig", - "references/1.4.1/graphics-2d/Star", - "references/1.4.1/graphics-2d/StarConfig", - "references/1.4.1/graphics-2d/Tag", - "references/1.4.1/graphics-2d/TagConfig", - "references/1.4.1/graphics-2d/Text_2", - "references/1.4.1/graphics-2d/TextConfig", - "references/1.4.1/graphics-2d/TextPath", - "references/1.4.1/graphics-2d/TextPathConfig", - "references/1.4.1/graphics-2d/Transform", - "references/1.4.1/graphics-2d/Transformer_2", - "references/1.4.1/graphics-2d/TransformerConfig", - "references/1.4.1/graphics-2d/Tween", - "references/1.4.1/graphics-2d/TweenConfig", - "references/1.4.1/graphics-2d/Util", - "references/1.4.1/graphics-2d/Vector2d", - "references/1.4.1/graphics-2d/Wedge", - "references/1.4.1/graphics-2d/WedgeConfig" - ] - }, - { - "dropdown": "Input", - "pages": [ - "references/1.4.1/input/0-index", - "references/1.4.1/input/InputEnum", - { - "group": "InputLibrary", - "pages": [ - "references/1.4.1/input/InputLibrary/constructor", - "references/1.4.1/input/InputLibrary/getDragState", - "references/1.4.1/input/InputLibrary/getMousePosition", - "references/1.4.1/input/InputLibrary/getMouseState", - "references/1.4.1/input/InputLibrary/getPressedKeys", - "references/1.4.1/input/InputLibrary/getWheelState", - "references/1.4.1/input/InputLibrary/isDragging", - "references/1.4.1/input/InputLibrary/isKeyPressed" - ], - "root": "references/1.4.1/input/InputLibrary" - } - ] - }, - { - "dropdown": "Music", - "pages": [ - "references/1.4.1/music/0-index", - { - "group": "MusicLibrary", - "pages": [ - "references/1.4.1/music/MusicLibrary/load", - "references/1.4.1/music/MusicLibrary/mute", - "references/1.4.1/music/MusicLibrary/play" - ], - "root": "references/1.4.1/music/MusicLibrary" - } - ] - }, - { - "dropdown": "Network-Client", - "pages": [ - "references/1.4.1/network-client/0-index", - { - "group": "NetworkClientLibrary", - "pages": [ - "references/1.4.1/network-client/NetworkClientLibrary/tcp", - "references/1.4.1/network-client/NetworkClientLibrary/udp" - ], - "root": "references/1.4.1/network-client/NetworkClientLibrary" - }, - { - "group": "TCPClient", - "pages": [ - "references/1.4.1/network-client/TCPClient/connect", - "references/1.4.1/network-client/TCPClient/constructor", - "references/1.4.1/network-client/TCPClient/getReceivedPackets", - "references/1.4.1/network-client/TCPClient/isConnected", - "references/1.4.1/network-client/TCPClient/sendData" - ], - "root": "references/1.4.1/network-client/TCPClient" - }, - { - "group": "UDPClient", - "pages": [ - "references/1.4.1/network-client/UDPClient/connect", - "references/1.4.1/network-client/UDPClient/constructor", - "references/1.4.1/network-client/UDPClient/getReceivedPackets", - "references/1.4.1/network-client/UDPClient/isConnected", - "references/1.4.1/network-client/UDPClient/sendData" - ], - "root": "references/1.4.1/network-client/UDPClient" - } - ] - }, - { - "dropdown": "Network-Server", - "pages": [ - "references/1.4.1/network-server/0-index", - { - "group": "NetworkServerLibrary", - "pages": [ - "references/1.4.1/network-server/NetworkServerLibrary/tcp", - "references/1.4.1/network-server/NetworkServerLibrary/udp" - ], - "root": "references/1.4.1/network-server/NetworkServerLibrary" - }, - { - "group": "TCPServer", - "pages": [ - "references/1.4.1/network-server/TCPServer/constructor", - "references/1.4.1/network-server/TCPServer/getConnectedClients", - "references/1.4.1/network-server/TCPServer/getReceivedPackets", - "references/1.4.1/network-server/TCPServer/listen", - "references/1.4.1/network-server/TCPServer/sendToClient", - "references/1.4.1/network-server/TCPServer/sendToEverybody" - ], - "root": "references/1.4.1/network-server/TCPServer" - }, - { - "group": "UDPServer", - "pages": [ - "references/1.4.1/network-server/UDPServer/constructor", - "references/1.4.1/network-server/UDPServer/getConnectedClients", - "references/1.4.1/network-server/UDPServer/getReceivedPackets", - "references/1.4.1/network-server/UDPServer/listen", - "references/1.4.1/network-server/UDPServer/sendToClient", - "references/1.4.1/network-server/UDPServer/sendToEverybody" - ], - "root": "references/1.4.1/network-server/UDPServer" - } - ] - }, - { - "dropdown": "Sound", - "pages": [ - "references/1.4.1/sound/0-index", - { - "group": "SoundLibrary", - "pages": [ - "references/1.4.1/sound/SoundLibrary/load", - "references/1.4.1/sound/SoundLibrary/mute", - "references/1.4.1/sound/SoundLibrary/play" - ], - "root": "references/1.4.1/sound/SoundLibrary" - } - ] - } - ] - }, - { - "version": "1.3.0", - "dropdowns": [ - { - "dropdown": "Asset-Manager", - "pages": [ - "references/1.3.0/asset-manager/index", - { - "group": "Asset-Manager", - "pages": [ - { - "group": "AssetManagerLibrary", - "pages": [ - "references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__init", - "references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__name", - "references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/getAsset" - ], - "root": "references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary" - } - ], - "root": "references/1.3.0/asset-manager/asset-manager" - } - ] - }, - { - "dropdown": "Common", - "pages": [ - "references/1.3.0/common/index", - { - "group": "Common", - "pages": [ - { - "group": "ApplicationContext", - "pages": [ - "references/1.3.0/common/common/ApplicationContext/_delta", - "references/1.3.0/common/common/ApplicationContext/delta", - "references/1.3.0/common/common/ApplicationContext/isRunning", - "references/1.3.0/common/common/ApplicationContext/muteSoundLibraries", - "references/1.3.0/common/common/ApplicationContext/setIsRunning" - ], - "root": "references/1.3.0/common/common/ApplicationContext" - }, - "references/1.3.0/common/common/ASSET_MANAGER_LIBRARY", - { - "group": "BaseAssetManagerLibrary", - "pages": [ - "references/1.3.0/common/common/BaseAssetManagerLibrary/__init", - "references/1.3.0/common/common/BaseAssetManagerLibrary/getAsset" - ], - "root": "references/1.3.0/common/common/BaseAssetManagerLibrary" - }, - { - "group": "BaseComponentSystemLibrary", - "pages": [ - "references/1.3.0/common/common/BaseComponentSystemLibrary/__run" - ], - "root": "references/1.3.0/common/common/BaseComponentSystemLibrary" - }, - { - "group": "BaseGraphicsLibrary", - "pages": [ - "references/1.3.0/common/common/BaseGraphicsLibrary/__run" - ], - "root": "references/1.3.0/common/common/BaseGraphicsLibrary" - }, - { - "group": "BaseInputLibrary", - "pages": [ - "references/1.3.0/common/common/BaseInputLibrary/__run" - ], - "root": "references/1.3.0/common/common/BaseInputLibrary" - }, - { - "group": "BaseMusicLibrary", - "pages": [ - "references/1.3.0/common/common/BaseMusicLibrary/__init", - "references/1.3.0/common/common/BaseMusicLibrary/mute", - "references/1.3.0/common/common/BaseMusicLibrary/play" - ], - "root": "references/1.3.0/common/common/BaseMusicLibrary" - }, - "references/1.3.0/common/common/BaseNetworkLibrary", - { - "group": "BaseSoundLibrary", - "pages": [ - "references/1.3.0/common/common/BaseSoundLibrary/__init", - "references/1.3.0/common/common/BaseSoundLibrary/mute", - "references/1.3.0/common/common/BaseSoundLibrary/play" - ], - "root": "references/1.3.0/common/common/BaseSoundLibrary" - }, - "references/1.3.0/common/common/ClearContext", - { - "group": "ClientLibraryManager", - "pages": [ - "references/1.3.0/common/common/ClientLibraryManager/constructor", - "references/1.3.0/common/common/ClientLibraryManager/get", - "references/1.3.0/common/common/ClientLibraryManager/getAssetManager", - "references/1.3.0/common/common/ClientLibraryManager/getComponentSystem", - "references/1.3.0/common/common/ClientLibraryManager/getGraphics", - "references/1.3.0/common/common/ClientLibraryManager/getInput", - "references/1.3.0/common/common/ClientLibraryManager/getMusic", - "references/1.3.0/common/common/ClientLibraryManager/getNetwork", - "references/1.3.0/common/common/ClientLibraryManager/getSound" - ], - "root": "references/1.3.0/common/common/ClientLibraryManager" - }, - "references/1.3.0/common/common/COMPONENT_SYSTEM_LIBRARY", - { - "group": "Context", - "pages": [ - "references/1.3.0/common/common/Context/app", - "references/1.3.0/common/common/Context/constructor", - "references/1.3.0/common/common/Context/libs" - ], - "root": "references/1.3.0/common/common/Context" - }, - "references/1.3.0/common/common/DefaultLibrariesEnum", - "references/1.3.0/common/common/ExecutionContext", - "references/1.3.0/common/common/GRAPHICS_LIBRARY", - { - "group": "IAssetManagerLibrary", - "pages": [ - "references/1.3.0/common/common/IAssetManagerLibrary/getAsset" - ], - "root": "references/1.3.0/common/common/IAssetManagerLibrary" - }, - "references/1.3.0/common/common/IComponentSystemLibrary", - { - "group": "IConfigRegistry", - "pages": [ - "references/1.3.0/common/common/IConfigRegistry/registerConfig" - ], - "root": "references/1.3.0/common/common/IConfigRegistry" - }, - "references/1.3.0/common/common/IExposedLibrary", - "references/1.3.0/common/common/IGraphicsLibrary", - "references/1.3.0/common/common/IInputLibrary", - { - "group": "ILibrary", - "pages": [ - "references/1.3.0/common/common/ILibrary/__clear", - "references/1.3.0/common/common/ILibrary/__init", - "references/1.3.0/common/common/ILibrary/__name", - "references/1.3.0/common/common/ILibrary/__relationship" - ], - "root": "references/1.3.0/common/common/ILibrary" - }, - "references/1.3.0/common/common/IMusicLibrary", - { - "group": "IMutableLibrary", - "pages": [ - "references/1.3.0/common/common/IMutableLibrary/mute" - ], - "root": "references/1.3.0/common/common/IMutableLibrary" - }, - "references/1.3.0/common/common/INetworkLibrary", - { - "group": "InitContext", - "pages": [ - "references/1.3.0/common/common/InitContext/config", - "references/1.3.0/common/common/InitContext/constructor", - "references/1.3.0/common/common/InitContext/container", - "references/1.3.0/common/common/InitContext/env", - "references/1.3.0/common/common/InitContext/files" - ], - "root": "references/1.3.0/common/common/InitContext" - }, - "references/1.3.0/common/common/INPUT_LIBRARY", - { - "group": "IRunClientOptions", - "pages": [ - "references/1.3.0/common/common/IRunClientOptions/container", - "references/1.3.0/common/common/IRunClientOptions/env", - "references/1.3.0/common/common/IRunClientOptions/files" - ], - "root": "references/1.3.0/common/common/IRunClientOptions" - }, - { - "group": "IRunnerLibrary", - "pages": [ - "references/1.3.0/common/common/IRunnerLibrary/__run" - ], - "root": "references/1.3.0/common/common/IRunnerLibrary" - }, - "references/1.3.0/common/common/IRunOptions", - { - "group": "IRunServerOptions", - "pages": [ - "references/1.3.0/common/common/IRunServerOptions/env", - "references/1.3.0/common/common/IRunServerOptions/files" - ], - "root": "references/1.3.0/common/common/IRunServerOptions" - }, - "references/1.3.0/common/common/ISoundLibrary", - { - "group": "LibraryContext", - "pages": [ - "references/1.3.0/common/common/LibraryContext/_status", - "references/1.3.0/common/common/LibraryContext/status" - ], - "root": "references/1.3.0/common/common/LibraryContext" - }, - { - "group": "LibraryHandle", - "pages": [ - "references/1.3.0/common/common/LibraryHandle/constructor", - "references/1.3.0/common/common/LibraryHandle/context", - "references/1.3.0/common/common/LibraryHandle/library", - "references/1.3.0/common/common/LibraryHandle/symbol" - ], - "root": "references/1.3.0/common/common/LibraryHandle" - }, - { - "group": "LibraryManager", - "pages": [ - "references/1.3.0/common/common/LibraryManager/constructor", - "references/1.3.0/common/common/LibraryManager/getAssetManager", - "references/1.3.0/common/common/LibraryManager/getComponentSystem", - "references/1.3.0/common/common/LibraryManager/getGraphics", - "references/1.3.0/common/common/LibraryManager/getInput", - "references/1.3.0/common/common/LibraryManager/getMusic", - "references/1.3.0/common/common/LibraryManager/getNetwork", - "references/1.3.0/common/common/LibraryManager/getSound" - ], - "root": "references/1.3.0/common/common/LibraryManager" - }, - "references/1.3.0/common/common/LibraryStatusEnum", - "references/1.3.0/common/common/MUSIC_LIBRARY", - "references/1.3.0/common/common/NETWORK_LIBRARY", - { - "group": "NfConfigException", - "pages": [ - "references/1.3.0/common/common/NfConfigException/code", - "references/1.3.0/common/common/NfConfigException/constructor" - ], - "root": "references/1.3.0/common/common/NfConfigException" - }, - { - "group": "NfFetchException", - "pages": [ - "references/1.3.0/common/common/NfFetchException/code", - "references/1.3.0/common/common/NfFetchException/constructor" - ], - "root": "references/1.3.0/common/common/NfFetchException" - }, - { - "group": "NfFile", - "pages": [ - "references/1.3.0/common/common/NfFile/arrayBuffer", - "references/1.3.0/common/common/NfFile/blob", - "references/1.3.0/common/common/NfFile/bytes", - "references/1.3.0/common/common/NfFile/constructor", - "references/1.3.0/common/common/NfFile/formData", - "references/1.3.0/common/common/NfFile/json", - "references/1.3.0/common/common/NfFile/path", - "references/1.3.0/common/common/NfFile/text" - ], - "root": "references/1.3.0/common/common/NfFile" - }, - { - "group": "NfNotFound", - "pages": [ - "references/1.3.0/common/common/NfNotFound/code", - "references/1.3.0/common/common/NfNotFound/constructor" - ], - "root": "references/1.3.0/common/common/NfNotFound" - }, - { - "group": "NfNotInitializedException", - "pages": [ - "references/1.3.0/common/common/NfNotInitializedException/code", - "references/1.3.0/common/common/NfNotInitializedException/constructor" - ], - "root": "references/1.3.0/common/common/NfNotInitializedException" - }, - "references/1.3.0/common/common/SOUND_LIBRARY" - ], - "root": "references/1.3.0/common/common" - } - ] - }, - { - "dropdown": "Config", - "pages": [ - "references/1.3.0/config/index", - { - "group": "Config", - "pages": [ - "references/1.3.0/config/config/Default", - "references/1.3.0/config/config/IsIpOrFQDN", - "references/1.3.0/config/config/TransformToBoolean" - ], - "root": "references/1.3.0/config/config" - } - ] - }, - { - "dropdown": "Core", - "pages": [ - "references/1.3.0/core/index", - { - "group": "Core", - "pages": [ - { - "group": "NanoforgeClient", - "pages": [ - "references/1.3.0/core/core/NanoforgeClient/useGraphics", - "references/1.3.0/core/core/NanoforgeClient/useInput", - "references/1.3.0/core/core/NanoforgeClient/useSound" - ], - "root": "references/1.3.0/core/core/NanoforgeClient" - }, - "references/1.3.0/core/core/NanoforgeFactory", - "references/1.3.0/core/core/NanoforgeServer" - ], - "root": "references/1.3.0/core/core" - } - ] - }, - { - "dropdown": "Core-Editor", - "pages": [ - "references/1.3.0/core-editor/index", - { - "group": "Core-Editor", - "pages": [ - { - "group": "NanoforgeClient", - "pages": [ - "references/1.3.0/core-editor/core-editor/NanoforgeClient/useGraphics", - "references/1.3.0/core-editor/core-editor/NanoforgeClient/useInput", - "references/1.3.0/core-editor/core-editor/NanoforgeClient/useSound" - ], - "root": "references/1.3.0/core-editor/core-editor/NanoforgeClient" - }, - "references/1.3.0/core-editor/core-editor/NanoforgeFactory", - "references/1.3.0/core-editor/core-editor/NanoforgeServer" - ], - "root": "references/1.3.0/core-editor/core-editor" - } - ] - }, - { - "dropdown": "ECS-Client", - "pages": [ - "references/1.3.0/ecs-client/index", - { - "group": "ECS-Client", - "pages": [ - { - "group": "ECSClientLibrary", - "pages": [ - "references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__init", - "references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__name", - "references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/constructor" - ], - "root": "references/1.3.0/ecs-client/ecs-client/ECSClientLibrary" - } - ], - "root": "references/1.3.0/ecs-client/ecs-client" - } - ] - }, - { - "dropdown": "ECS-Lib", - "pages": [ - "references/1.3.0/ecs-lib/index", - { - "group": "ECS-Lib", - "pages": [ - { - "group": "AbstractECSLibrary", - "pages": [ - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__name", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__run", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/_registry", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/constructor", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/module", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/path", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/registry" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary" - }, - "references/1.3.0/ecs-lib/ecs-lib/Component", - "references/1.3.0/ecs-lib/ecs-lib/EditorComponentManifest", - "references/1.3.0/ecs-lib/ecs-lib/EditorSystemManifest", - { - "group": "Entity", - "pages": [ - "references/1.3.0/ecs-lib/ecs-lib/Entity/getId" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib/Entity" - }, - { - "group": "Registry", - "pages": [ - "references/1.3.0/ecs-lib/ecs-lib/Registry/addComponent", - "references/1.3.0/ecs-lib/ecs-lib/Registry/addSystem", - "references/1.3.0/ecs-lib/ecs-lib/Registry/clearEntities", - "references/1.3.0/ecs-lib/ecs-lib/Registry/clearSystems", - "references/1.3.0/ecs-lib/ecs-lib/Registry/entityFromIndex", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getComponents", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getComponentsConst", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponent", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponentConst", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getZipper", - "references/1.3.0/ecs-lib/ecs-lib/Registry/killEntity", - "references/1.3.0/ecs-lib/ecs-lib/Registry/maxEntities", - "references/1.3.0/ecs-lib/ecs-lib/Registry/registerComponent", - "references/1.3.0/ecs-lib/ecs-lib/Registry/removeComponent", - "references/1.3.0/ecs-lib/ecs-lib/Registry/removeSystem", - "references/1.3.0/ecs-lib/ecs-lib/Registry/runSystems", - "references/1.3.0/ecs-lib/ecs-lib/Registry/spawnEntity" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib/Registry" - }, - { - "group": "SparseArray", - "pages": [ - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/clear", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/empty", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/erase", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/get", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/getConst", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/getIndex", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt_1", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/resize", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/set", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByCopy", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByMove", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/size" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib/SparseArray" - }, - "references/1.3.0/ecs-lib/ecs-lib/System" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib" - } - ] - }, - { - "dropdown": "ECS-Server", - "pages": [ - "references/1.3.0/ecs-server/index", - { - "group": "ECS-Server", - "pages": [ - { - "group": "ECSServerLibrary", - "pages": [ - "references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__init", - "references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__name", - "references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/constructor" - ], - "root": "references/1.3.0/ecs-server/ecs-server/ECSServerLibrary" - }, - "references/1.3.0/ecs-server/ecs-server/Module" - ], - "root": "references/1.3.0/ecs-server/ecs-server" - } - ] - }, - { - "dropdown": "Graphics-2d", - "pages": [ - "references/1.3.0/graphics-2d/index", - { - "group": "Graphics-2d", - "pages": [ - "references/1.3.0/graphics-2d/graphics-2d/_global", - "references/1.3.0/graphics-2d/graphics-2d/_injectGlobal", - "references/1.3.0/graphics-2d/graphics-2d/_mouseDblClickPointerId", - "references/1.3.0/graphics-2d/graphics-2d/_mouseInDblClickWindow", - "references/1.3.0/graphics-2d/graphics-2d/_mouseListenClick", - "references/1.3.0/graphics-2d/graphics-2d/_pointerDblClickPointerId", - "references/1.3.0/graphics-2d/graphics-2d/_pointerInDblClickWindow", - "references/1.3.0/graphics-2d/graphics-2d/_pointerListenClick", - "references/1.3.0/graphics-2d/graphics-2d/_renderBackend", - "references/1.3.0/graphics-2d/graphics-2d/_touchDblClickPointerId", - "references/1.3.0/graphics-2d/graphics-2d/_touchInDblClickWindow", - "references/1.3.0/graphics-2d/graphics-2d/_touchListenClick", - "references/1.3.0/graphics-2d/graphics-2d/angleDeg", - "references/1.3.0/graphics-2d/graphics-2d/Animation_2", - "references/1.3.0/graphics-2d/graphics-2d/Arc", - "references/1.3.0/graphics-2d/graphics-2d/ArcConfig", - "references/1.3.0/graphics-2d/graphics-2d/Arrow", - "references/1.3.0/graphics-2d/graphics-2d/ArrowConfig", - "references/1.3.0/graphics-2d/graphics-2d/autoDrawEnabled", - "references/1.3.0/graphics-2d/graphics-2d/Canvas", - "references/1.3.0/graphics-2d/graphics-2d/capturePointerEventsEnabled", - "references/1.3.0/graphics-2d/graphics-2d/Circle", - "references/1.3.0/graphics-2d/graphics-2d/CircleConfig", - "references/1.3.0/graphics-2d/graphics-2d/Container", - "references/1.3.0/graphics-2d/graphics-2d/ContainerConfig", - "references/1.3.0/graphics-2d/graphics-2d/Context", - "references/1.3.0/graphics-2d/graphics-2d/dblClickWindow", - "references/1.3.0/graphics-2d/graphics-2d/DD", - "references/1.3.0/graphics-2d/graphics-2d/document_2", - "references/1.3.0/graphics-2d/graphics-2d/dragButtons", - "references/1.3.0/graphics-2d/graphics-2d/dragDistance", - "references/1.3.0/graphics-2d/graphics-2d/Easings", - "references/1.3.0/graphics-2d/graphics-2d/Ellipse", - "references/1.3.0/graphics-2d/graphics-2d/EllipseConfig", - "references/1.3.0/graphics-2d/graphics-2d/enableTrace", - "references/1.3.0/graphics-2d/graphics-2d/FastLayer", - "references/1.3.0/graphics-2d/graphics-2d/Filters", - "references/1.3.0/graphics-2d/graphics-2d/getAngle", - { - "group": "Graphics2DLibrary", - "pages": [ - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__init", - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__name", - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__run", - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/baseLayer", - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/stage" - ], - "root": "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary" - }, - "references/1.3.0/graphics-2d/graphics-2d/Group", - "references/1.3.0/graphics-2d/graphics-2d/GroupConfig", - "references/1.3.0/graphics-2d/graphics-2d/hitOnDragEnabled", - "references/1.3.0/graphics-2d/graphics-2d/Image_2", - "references/1.3.0/graphics-2d/graphics-2d/ImageConfig", - "references/1.3.0/graphics-2d/graphics-2d/isBrowser", - "references/1.3.0/graphics-2d/graphics-2d/isDragging", - "references/1.3.0/graphics-2d/graphics-2d/isDragReady", - "references/1.3.0/graphics-2d/graphics-2d/isTransforming", - "references/1.3.0/graphics-2d/graphics-2d/isUnminified", - "references/1.3.0/graphics-2d/graphics-2d/KonvaEventListener", - "references/1.3.0/graphics-2d/graphics-2d/KonvaEventObject", - "references/1.3.0/graphics-2d/graphics-2d/KonvaPointerEvent", - "references/1.3.0/graphics-2d/graphics-2d/Label", - "references/1.3.0/graphics-2d/graphics-2d/LabelConfig", - "references/1.3.0/graphics-2d/graphics-2d/Layer", - "references/1.3.0/graphics-2d/graphics-2d/LayerConfig", - "references/1.3.0/graphics-2d/graphics-2d/legacyTextRendering", - "references/1.3.0/graphics-2d/graphics-2d/Line", - "references/1.3.0/graphics-2d/graphics-2d/LineConfig", - "references/1.3.0/graphics-2d/graphics-2d/Node_2", - "references/1.3.0/graphics-2d/graphics-2d/NodeConfig", - "references/1.3.0/graphics-2d/graphics-2d/Path", - "references/1.3.0/graphics-2d/graphics-2d/PathConfig", - "references/1.3.0/graphics-2d/graphics-2d/pixelRatio", - "references/1.3.0/graphics-2d/graphics-2d/pointerEventsEnabled", - "references/1.3.0/graphics-2d/graphics-2d/Rect", - "references/1.3.0/graphics-2d/graphics-2d/RectConfig", - "references/1.3.0/graphics-2d/graphics-2d/RegularPolygon", - "references/1.3.0/graphics-2d/graphics-2d/RegularPolygonConfig", - "references/1.3.0/graphics-2d/graphics-2d/releaseCanvasOnDestroy", - "references/1.3.0/graphics-2d/graphics-2d/Ring", - "references/1.3.0/graphics-2d/graphics-2d/RingConfig", - "references/1.3.0/graphics-2d/graphics-2d/Shape", - "references/1.3.0/graphics-2d/graphics-2d/ShapeConfig", - "references/1.3.0/graphics-2d/graphics-2d/shapes", - "references/1.3.0/graphics-2d/graphics-2d/showWarnings", - "references/1.3.0/graphics-2d/graphics-2d/Sprite", - "references/1.3.0/graphics-2d/graphics-2d/SpriteConfig", - "references/1.3.0/graphics-2d/graphics-2d/Stage", - "references/1.3.0/graphics-2d/graphics-2d/StageConfig", - "references/1.3.0/graphics-2d/graphics-2d/stages", - "references/1.3.0/graphics-2d/graphics-2d/Star", - "references/1.3.0/graphics-2d/graphics-2d/StarConfig", - "references/1.3.0/graphics-2d/graphics-2d/Tag", - "references/1.3.0/graphics-2d/graphics-2d/TagConfig", - "references/1.3.0/graphics-2d/graphics-2d/Text_2", - "references/1.3.0/graphics-2d/graphics-2d/TextConfig", - "references/1.3.0/graphics-2d/graphics-2d/TextPath", - "references/1.3.0/graphics-2d/graphics-2d/TextPathConfig", - "references/1.3.0/graphics-2d/graphics-2d/Transform", - "references/1.3.0/graphics-2d/graphics-2d/Transformer_2", - "references/1.3.0/graphics-2d/graphics-2d/TransformerConfig", - "references/1.3.0/graphics-2d/graphics-2d/Tween", - "references/1.3.0/graphics-2d/graphics-2d/TweenConfig", - "references/1.3.0/graphics-2d/graphics-2d/Util", - "references/1.3.0/graphics-2d/graphics-2d/Vector2d", - "references/1.3.0/graphics-2d/graphics-2d/version", - "references/1.3.0/graphics-2d/graphics-2d/Wedge", - "references/1.3.0/graphics-2d/graphics-2d/WedgeConfig" - ], - "root": "references/1.3.0/graphics-2d/graphics-2d" - } - ] - }, - { - "dropdown": "Input", - "pages": [ - "references/1.3.0/input/index", - { - "group": "Input", - "pages": [ - "references/1.3.0/input/input/InputEnum", - { - "group": "InputLibrary", - "pages": [ - "references/1.3.0/input/input/InputLibrary/__init", - "references/1.3.0/input/input/InputLibrary/__name", - "references/1.3.0/input/input/InputLibrary/__run", - "references/1.3.0/input/input/InputLibrary/constructor", - "references/1.3.0/input/input/InputLibrary/getDragState", - "references/1.3.0/input/input/InputLibrary/getMousePosition", - "references/1.3.0/input/input/InputLibrary/getMouseState", - "references/1.3.0/input/input/InputLibrary/getPressedKeys", - "references/1.3.0/input/input/InputLibrary/getWheelState", - "references/1.3.0/input/input/InputLibrary/isDragging", - "references/1.3.0/input/input/InputLibrary/isKeyPressed" - ], - "root": "references/1.3.0/input/input/InputLibrary" - } - ], - "root": "references/1.3.0/input/input" - } - ] - }, - { - "dropdown": "Music", - "pages": [ - "references/1.3.0/music/index", - { - "group": "Music", - "pages": [ - { - "group": "MusicLibrary", - "pages": [ - "references/1.3.0/music/music/MusicLibrary/__init", - "references/1.3.0/music/music/MusicLibrary/__name", - "references/1.3.0/music/music/MusicLibrary/load", - "references/1.3.0/music/music/MusicLibrary/mute", - "references/1.3.0/music/music/MusicLibrary/play" - ], - "root": "references/1.3.0/music/music/MusicLibrary" - } - ], - "root": "references/1.3.0/music/music" - } - ] - }, - { - "dropdown": "Network-Client", - "pages": [ - "references/1.3.0/network-client/index", - { - "group": "Network-Client", - "pages": [ - { - "group": "NetworkClientLibrary", - "pages": [ - "references/1.3.0/network-client/network-client/NetworkClientLibrary/__init", - "references/1.3.0/network-client/network-client/NetworkClientLibrary/__name", - "references/1.3.0/network-client/network-client/NetworkClientLibrary/tcp", - "references/1.3.0/network-client/network-client/NetworkClientLibrary/udp" - ], - "root": "references/1.3.0/network-client/network-client/NetworkClientLibrary" - }, - { - "group": "TCPClient", - "pages": [ - "references/1.3.0/network-client/network-client/TCPClient/connect", - "references/1.3.0/network-client/network-client/TCPClient/constructor", - "references/1.3.0/network-client/network-client/TCPClient/getReceivedPackets", - "references/1.3.0/network-client/network-client/TCPClient/isConnected", - "references/1.3.0/network-client/network-client/TCPClient/sendData" - ], - "root": "references/1.3.0/network-client/network-client/TCPClient" - }, - { - "group": "UDPClient", - "pages": [ - "references/1.3.0/network-client/network-client/UDPClient/connect", - "references/1.3.0/network-client/network-client/UDPClient/constructor", - "references/1.3.0/network-client/network-client/UDPClient/getReceivedPackets", - "references/1.3.0/network-client/network-client/UDPClient/isConnected", - "references/1.3.0/network-client/network-client/UDPClient/sendData" - ], - "root": "references/1.3.0/network-client/network-client/UDPClient" - } - ], - "root": "references/1.3.0/network-client/network-client" - } - ] - }, - { - "dropdown": "Network-Server", - "pages": [ - "references/1.3.0/network-server/index", - { - "group": "Network-Server", - "pages": [ - { - "group": "NetworkServerLibrary", - "pages": [ - "references/1.3.0/network-server/network-server/NetworkServerLibrary/__init", - "references/1.3.0/network-server/network-server/NetworkServerLibrary/__name", - "references/1.3.0/network-server/network-server/NetworkServerLibrary/tcp", - "references/1.3.0/network-server/network-server/NetworkServerLibrary/udp" - ], - "root": "references/1.3.0/network-server/network-server/NetworkServerLibrary" - }, - { - "group": "TCPServer", - "pages": [ - "references/1.3.0/network-server/network-server/TCPServer/constructor", - "references/1.3.0/network-server/network-server/TCPServer/getConnectedClients", - "references/1.3.0/network-server/network-server/TCPServer/getReceivedPackets", - "references/1.3.0/network-server/network-server/TCPServer/listen", - "references/1.3.0/network-server/network-server/TCPServer/sendToClient", - "references/1.3.0/network-server/network-server/TCPServer/sendToEverybody" - ], - "root": "references/1.3.0/network-server/network-server/TCPServer" - }, - { - "group": "UDPServer", - "pages": [ - "references/1.3.0/network-server/network-server/UDPServer/constructor", - "references/1.3.0/network-server/network-server/UDPServer/getConnectedClients", - "references/1.3.0/network-server/network-server/UDPServer/getReceivedPackets", - "references/1.3.0/network-server/network-server/UDPServer/listen", - "references/1.3.0/network-server/network-server/UDPServer/sendToClient", - "references/1.3.0/network-server/network-server/UDPServer/sendToEverybody" - ], - "root": "references/1.3.0/network-server/network-server/UDPServer" - } - ], - "root": "references/1.3.0/network-server/network-server" - } - ] - }, - { - "dropdown": "Sound", - "pages": [ - "references/1.3.0/sound/index", - { - "group": "Sound", - "pages": [ - { - "group": "SoundLibrary", - "pages": [ - "references/1.3.0/sound/sound/SoundLibrary/__init", - "references/1.3.0/sound/sound/SoundLibrary/__name", - "references/1.3.0/sound/sound/SoundLibrary/load", - "references/1.3.0/sound/sound/SoundLibrary/mute", - "references/1.3.0/sound/sound/SoundLibrary/play" - ], - "root": "references/1.3.0/sound/sound/SoundLibrary" - } - ], - "root": "references/1.3.0/sound/sound" - } - ] - } - ] + "group": "Loader", + "pages": { + "$ref": "./docs/loader/navigation.json" + } } ] + }, + { + "dropdown": "Editor", + "icon": "pen-ruler", + "pages": { + "$ref": "./docs/editor/navigation.json" + } + } + ] + }, + { + "tab": "Guides", + "dropdowns": [ + { + "dropdown": "CLI", + "icon": "terminal", + "pages": { + "$ref": "./guides/cli/navigation.json" + } } ] + }, + { + "tab": "API reference", + "versions": { + "$ref": "./references/engine/navigation.json" + } } ] - } -} \ No newline at end of file + }, + "redirects": [ + { + "source": "/docs/cli/getting-started/1-introduction", + "destination": "/docs/cli/getting-started/introduction" + }, + { + "source": "/docs/cli/getting-started/2-installation", + "destination": "/docs/cli/getting-started/installation" + }, + { + "source": "/docs/cli/getting-started/3-quickstart", + "destination": "/docs/cli/getting-started/quickstart" + }, + { + "source": "/docs/cli/getting-started/index", + "destination": "/docs/cli/getting-started/introduction" + }, + { + "source": "/docs/cli/getting-started/usage", + "destination": "/docs/cli/getting-started/introduction" + }, + { + "source": "/docs/cli/commands/1-overview", + "destination": "/docs/cli/commands/overview" + }, + { + "source": "/docs/cli/configuration/1-configuration-file", + "destination": "/docs/cli/configuration/configuration-file" + }, + { + "source": "/docs/cli/configuration/2-environment-variables", + "destination": "/docs/cli/configuration/environment-variables" + }, + { + "source": "/docs/cli/schematics/1-overview", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/commands/2-commands/1-new", + "destination": "/docs/cli/commands/new" + }, + { + "source": "/docs/cli/commands/2-commands/2-dev", + "destination": "/docs/cli/commands/dev" + }, + { + "source": "/docs/cli/commands/2-commands/3-build", + "destination": "/docs/cli/commands/build" + }, + { + "source": "/docs/cli/commands/2-commands/4-start", + "destination": "/docs/cli/commands/start" + }, + { + "source": "/docs/cli/commands/2-commands/5-create", + "destination": "/docs/cli/commands/create" + }, + { + "source": "/docs/cli/commands/2-commands/6-install", + "destination": "/docs/cli/commands/install" + }, + { + "source": "/docs/cli/commands/2-commands/7-install", + "destination": "/docs/cli/commands/install" + }, + { + "source": "/docs/cli/commands/2-commands/7-editor", + "destination": "/docs/cli/commands/editor" + }, + { + "source": "/docs/cli/commands/2-commands/8-editor", + "destination": "/docs/cli/commands/editor" + }, + { + "source": "/docs/cli/commands/2-commands/8-registry", + "destination": "/docs/cli/commands/registry" + }, + { + "source": "/docs/cli/commands/2-commands/9-registry", + "destination": "/docs/cli/commands/registry" + }, + { + "source": "/docs/cli/schematics/2-schematics/1-workspace", + "destination": "/docs/cli/schematics/workspace" + }, + { + "source": "/docs/cli/schematics/2-schematics/2-project", + "destination": "/docs/cli/schematics/project" + }, + { + "source": "/docs/cli/schematics/2-schematics/3-component", + "destination": "/docs/cli/schematics/component" + }, + { + "source": "/docs/cli/schematics/2-schematics/4-system", + "destination": "/docs/cli/schematics/system" + }, + { + "source": "/docs/cli/schematics/2-schematics/1-application", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/2-configuration", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/3-part-base", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/4-part-main", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/5-docker", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/6-component", + "destination": "/docs/cli/schematics/component" + }, + { + "source": "/docs/cli/schematics/2-schematics/7-system", + "destination": "/docs/cli/schematics/system" + }, + { + "source": "/docs/cli/loader/1-overview", + "destination": "/docs/loader/overview" + }, + { + "source": "/docs/cli/loader/2-client", + "destination": "/docs/loader/client" + }, + { + "source": "/docs/cli/loader/3-website", + "destination": "/docs/loader/website" + }, + { + "source": "/docs/cli/loader/4-server", + "destination": "/docs/loader/server" + }, + { + "source": "/guides/cli/cli/1-overview", + "destination": "/guides/cli/overview" + }, + { + "source": "/guides/cli/cli/2-create-a-project", + "destination": "/guides/cli/create-a-project" + }, + { + "source": "/guides/cli/cli/3-develop-locally", + "destination": "/guides/cli/develop-locally" + }, + { + "source": "/guides/cli/cli/4-build-and-deploy", + "destination": "/guides/cli/build-and-deploy" + }, + { + "source": "/guides/cli/cli/5-components-and-systems", + "destination": "/guides/cli/components-and-systems" + }, + { + "source": "/guides/cli/cli/6-publish-a-package", + "destination": "/guides/cli/publish-a-package" + }, + { + "source": "/references/1.3.0/:slug*", + "destination": "/" + }, + { + "source": "/references/1.4.0/:slug*", + "destination": "/" + }, + { + "source": "/references/1.4.1/:slug*", + "destination": "/" + }, + { + "source": "/references/1.4.2/:slug*", + "destination": "/" + }, + { + "source": "/docs/engine/getting-started/1-index", + "destination": "/docs/engine/getting-started/index" + }, + { + "source": "/docs/engine/getting-started/how_to_use", + "destination": "/docs/engine/getting-started/how-to-use" + }, + { + "source": "/docs/engine/registry/writing_web_assembly", + "destination": "/docs/engine/registry/writing-web-assembly" + }, + { + "source": "/docs/cli/getting-started", + "destination": "/docs/cli/getting-started/introduction" + } + ] +} diff --git a/docs/cli/commands/2-commands/7-install.mdx b/docs/cli/commands/2-commands/7-install.mdx deleted file mode 100644 index f08fccc..0000000 --- a/docs/cli/commands/2-commands/7-install.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: install / add -description: Add components, systems, or libraries to your project ---- - -import { Note } from "mintlify/components"; - -## Overview - -`nf install` (aliased as `nf add`) pulls components, systems, or libraries from the NanoForge -registry into your project. By default it installs components and systems for the client; use -`--lib` for libraries and `--server` to target the server. - -## Usage - -```bash -nf install [names...] -``` - -## Options - -| Option | Description | -| ----------------------------- | ------------------------------------------------------------------ | -| `[names...]` | Names of the components/systems/libraries to install. | -| `-d, --directory ` | Working directory of the command. | -| `-l, --lib` | Install a library instead of a component/system. Default: `false`. | -| `-s, --server` | Install on the server instead of the client. Default: `false`. | - -## Examples - -**Install a component for the client:** - -```bash -nf install my-org/health-bar -``` - -**Install a library on the server:** - -```bash -nf add my-org/physics --lib --server -``` - - - Installing from a private scope may require authentication. See the [registry - commands](./9-registry) to log in first. - diff --git a/docs/cli/commands/2-commands/8-editor.mdx b/docs/cli/commands/2-commands/8-editor.mdx deleted file mode 100644 index 4e752f4..0000000 --- a/docs/cli/commands/2-commands/8-editor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: editor -description: Launch the NanoForge visual editor ---- - -## Overview - -`nf editor` starts the NanoForge editor - a visual environment for inspecting and authoring your -game. When a project `path` is given, the editor opens that project; by default it then opens in -your browser. - -## Usage - -```bash -nf editor [path] -``` - -## Options - -| Option | Description | -| ----------------------------- | --------------------------------------------------------------------------------------------- | -| `[path]` | Path to the project to open in the editor. | -| `-d, --directory ` | Working directory of the command. | -| `--open` | Open the editor in the default web browser. Default: `true` when `path` is set, else `false`. | -| `--no-open` | Do not open the editor in the browser. | - -## Examples - -**Open the editor for the current project:** - -```bash -nf editor . -``` - -**Start the editor without opening a browser tab:** - -```bash -nf editor --no-open -``` diff --git a/docs/cli/commands/2-commands/9-registry.mdx b/docs/cli/commands/2-commands/9-registry.mdx deleted file mode 100644 index bba7010..0000000 --- a/docs/cli/commands/2-commands/9-registry.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: registry -description: Authenticate with and publish to the NanoForge registry ---- - -## Overview - -These commands manage your relationship with the NanoForge registry: authenticating, then publishing -or removing packages. Authentication can be **global** (default, stored for your user) or **local** -(scoped to the current project) with `-l, --local`. - -## login - -Log in to the NanoForge registry. - -```bash -nf login -``` - -| Option | Description | -| ----------------------------- | ------------------------------------------------------ | -| `-d, --directory ` | Working directory of the command. | -| `-l, --local` | Log in only for the current project. Default: `false`. | -| `-k, --api-key ` | API key for the NanoForge registry. | - -```bash -nf login --api-key -``` - -## logout - -Log out from the NanoForge registry. - -```bash -nf logout -``` - -| Option | Description | -| ----------------------------- | ------------------------------------- | -| `-d, --directory ` | Working directory of the command. | -| `-l, --local` | Log out only for the current project. | - -## publish - -Publish a package to the NanoForge registry. - -```bash -nf publish -``` - -| Option | Description | -| ----------------------------- | --------------------------------- | -| `-d, --directory ` | Working directory of the command. | - -## unpublish - -Unpublish a package from the NanoForge registry. - -```bash -nf unpublish -``` - -| Option | Description | -| ----------------------------- | --------------------------------- | -| `-d, --directory ` | Working directory of the command. | diff --git a/docs/cli/commands/2-commands/3-build.mdx b/docs/cli/commands/build.mdx similarity index 84% rename from docs/cli/commands/2-commands/3-build.mdx rename to docs/cli/commands/build.mdx index 930f210..7af6ac5 100644 --- a/docs/cli/commands/2-commands/3-build.mdx +++ b/docs/cli/commands/build.mdx @@ -7,7 +7,10 @@ description: Build your NanoForge project for production `nf build` compiles your NanoForge project. The client and server entry points, static directories, and output directories all default to the values in your -[configuration file](../../configuration/1-configuration-file) and can be overridden per run. +[configuration file](/docs/cli/configuration/configuration-file) and can be overridden per run. + +When the workspace sets `network: "p2p"`, each server app is also built for the browser, into the +client's output directory under `server/`, so the host player's tab can run it. ## Usage diff --git a/docs/cli/commands/2-commands/5-create.mdx b/docs/cli/commands/create.mdx similarity index 51% rename from docs/cli/commands/2-commands/5-create.mdx rename to docs/cli/commands/create.mdx index e63ebcf..0f8751b 100644 --- a/docs/cli/commands/2-commands/5-create.mdx +++ b/docs/cli/commands/create.mdx @@ -1,6 +1,6 @@ --- title: create -description: Create a NanoForge component or system +description: Create a NanoForge component, system or editor plugin --- ## Overview @@ -14,18 +14,19 @@ creates files for the client; pass `--server` to target the server instead. nf create ``` -`` is either `component` or `system`. +`` is `component`, `system`, or `plugin` (an editor plugin, a project of its own). ## Options -| Option | Description | -| ----------------------------- | ------------------------------------------------------------- | -| `` | The type to create: `component` or `system`. | -| `-d, --directory ` | Working directory of the command. | -| `-c, --config ` | Path to the configuration file. | -| `-n, --name ` | Name of the component or system. | -| `-s, --server` | Create on the server instead of the client. Default: `false`. | -| `-p, --path ` | Path to the component/system folder. | +| Option | Description | +| ----------------------------- | --------------------------------------------------------------- | +| `` | The type to create: `component`, `system` or `plugin`. | +| `-d, --directory ` | Working directory of the command. | +| `-c, --config ` | Path to the configuration file. | +| `-n, --name ` | Name of the component or system. | +| `-s, --server` | Create on the server instead of the client. Default: `false`. | +| `-p, --path ` | Path to the component/system folder, or the plugin's folder. | +| `-t, --template