@ignifx/ui 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1 -0
- package/dist/index.js +0 -0
- package/package.json +62 -0
- package/skills/ui/SKILL.md +51 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {}
|
package/dist/index.js
ADDED
|
File without changes
|
package/package.json
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ignifx/ui",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "ignifx UI: DOM overlay host, focus routing, world and HUD text.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"ignifx",
|
|
7
|
+
"ignifx-extension"
|
|
8
|
+
],
|
|
9
|
+
"homepage": "https://ignifx.com",
|
|
10
|
+
"license": "Apache-2.0",
|
|
11
|
+
"author": "Astrum Forge Studios",
|
|
12
|
+
"files": [
|
|
13
|
+
"dist",
|
|
14
|
+
"skills"
|
|
15
|
+
],
|
|
16
|
+
"type": "module",
|
|
17
|
+
"sideEffects": false,
|
|
18
|
+
"exports": {
|
|
19
|
+
".": {
|
|
20
|
+
"types": "./dist/index.d.ts",
|
|
21
|
+
"import": "./dist/index.js"
|
|
22
|
+
},
|
|
23
|
+
"./package.json": "./package.json"
|
|
24
|
+
},
|
|
25
|
+
"publishConfig": {
|
|
26
|
+
"access": "public",
|
|
27
|
+
"provenance": true
|
|
28
|
+
},
|
|
29
|
+
"scripts": {
|
|
30
|
+
"build": "tsdown",
|
|
31
|
+
"typecheck": "tsc --build tsconfig.json tsconfig.test.json",
|
|
32
|
+
"test": "vitest run --project node --root ../.. packages/ui",
|
|
33
|
+
"api-report": "api-extractor run --verbose",
|
|
34
|
+
"docs:api": "typedoc",
|
|
35
|
+
"api-report:update": "api-extractor run --local --verbose",
|
|
36
|
+
"pack-check": "publint && attw --pack . --profile esm-only"
|
|
37
|
+
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"@arethetypeswrong/cli": "catalog:",
|
|
40
|
+
"@ignifx/core": "workspace:*",
|
|
41
|
+
"@microsoft/api-extractor": "catalog:",
|
|
42
|
+
"@types/webxr": "catalog:",
|
|
43
|
+
"@webgpu/types": "catalog:",
|
|
44
|
+
"publint": "catalog:",
|
|
45
|
+
"tsdown": "catalog:",
|
|
46
|
+
"typedoc": "catalog:",
|
|
47
|
+
"typedoc-plugin-markdown": "catalog:",
|
|
48
|
+
"typescript-native": "catalog:",
|
|
49
|
+
"vitest": "catalog:"
|
|
50
|
+
},
|
|
51
|
+
"peerDependencies": {
|
|
52
|
+
"@ignifx/core": "workspace:*"
|
|
53
|
+
},
|
|
54
|
+
"ignifx": {
|
|
55
|
+
"extension": true,
|
|
56
|
+
"engine": ">=0.0.0 <1.0.0",
|
|
57
|
+
"requires": [],
|
|
58
|
+
"optional": [],
|
|
59
|
+
"capabilities": [],
|
|
60
|
+
"skill": "./skills/ui/SKILL.md"
|
|
61
|
+
}
|
|
62
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ui
|
|
3
|
+
description: Builds game UI in ignifx with @ignifx/ui: the DOM overlay host and layers, scaling modes, input focus routing, world-space anchors, world and HUD text, virtual joysticks and buttons for touch, dialogs, toasts, loading screens, and localization. Use when adding or editing menus, HUDs, on-screen text, touch controls, or overlay UI in an ignifx project, or when the user mentions @ignifx/ui, HudText, WorldAnchor, or VirtualJoystick.
|
|
4
|
+
license: Apache-2.0
|
|
5
|
+
metadata:
|
|
6
|
+
ignifx-version: "0.0.0-unreleased"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# @ignifx/ui
|
|
10
|
+
|
|
11
|
+
> **Scaffold notice.** ignifx is in the planning phase and `@ignifx/ui` is an empty package. Every section below is filled by Phase 8 of `docs/plan/engineering-plan.md`; until then this file makes no API claims (`CONSTITUTION.md` Article V).
|
|
12
|
+
|
|
13
|
+
## What this is / when to use
|
|
14
|
+
|
|
15
|
+
`@ignifx/ui` is the ignifx extension that provides the DOM overlay UI host, input focus routing, and world and HUD text components _(populated in Phase 8)_.
|
|
16
|
+
|
|
17
|
+
## Environment
|
|
18
|
+
|
|
19
|
+
Engine version, the pinned Babylon Lite version, and the registration snippet for this extension _(populated in Phase 8)_.
|
|
20
|
+
|
|
21
|
+
## Mental model
|
|
22
|
+
|
|
23
|
+
How this subsystem's components, services, and phases fit into the App → World → Entity model _(populated in Phase 8)_.
|
|
24
|
+
|
|
25
|
+
## First app
|
|
26
|
+
|
|
27
|
+
A complete, compiling example that registers the extension and uses it once _(populated in Phase 8)_.
|
|
28
|
+
|
|
29
|
+
## Core APIs
|
|
30
|
+
|
|
31
|
+
Component and service tables generated from `skills/ignifx/references/api/ui.md` _(populated in Phase 8)_.
|
|
32
|
+
|
|
33
|
+
## Recipes
|
|
34
|
+
|
|
35
|
+
Task-oriented examples extracted from `examples/recipes/` _(populated in Phase 8)_.
|
|
36
|
+
|
|
37
|
+
## File formats
|
|
38
|
+
|
|
39
|
+
The file formats this subsystem reads and writes, with links to `skills/ignifx/references/formats/` _(populated in Phase 8)_.
|
|
40
|
+
|
|
41
|
+
## Gotchas
|
|
42
|
+
|
|
43
|
+
The traps this subsystem has, each with the replacement to use instead _(populated in Phase 8)_.
|
|
44
|
+
|
|
45
|
+
## Deprecated (current window)
|
|
46
|
+
|
|
47
|
+
None (pre-1.0: no deprecation window; breaking changes are listed in the changelog).
|
|
48
|
+
|
|
49
|
+
## Where to look next
|
|
50
|
+
|
|
51
|
+
`skills/ignifx/SKILL.md` for the engine entry skill · `docs/architecture/` for design rationale.
|