@vib3code/sdk 2.0.3-canary.3b3ca18 → 2.0.3-canary.4e0dace
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/DOCS/AGENT_HARNESS_ARCHITECTURE.md +2 -0
- package/DOCS/ANDROID_DEPLOYMENT.md +59 -0
- package/DOCS/ARCHITECTURE.md +1 -0
- package/DOCS/CI_TESTING.md +2 -0
- package/DOCS/CLI_ONBOARDING.md +2 -0
- package/DOCS/CONTROL_REFERENCE.md +2 -0
- package/DOCS/CROSS_SITE_DESIGN_PATTERNS.md +2 -0
- package/DOCS/ENV_SETUP.md +2 -0
- package/DOCS/EPIC_SCROLL_EVENTS.md +2 -0
- package/DOCS/EXPANSION_DESIGN.md +2 -0
- package/DOCS/EXPANSION_DESIGN_ULTRA.md +2 -0
- package/DOCS/EXPORT_FORMATS.md +2 -0
- package/DOCS/GPU_DISPOSAL_GUIDE.md +2 -0
- package/DOCS/HANDOFF_LANDING_PAGE.md +2 -0
- package/DOCS/HANDOFF_SDK_DEVELOPMENT.md +2 -0
- package/DOCS/LICENSING_TIERS.md +2 -0
- package/DOCS/MASTER_PLAN_2026-01-31.md +2 -0
- package/DOCS/MULTIVIZ_CHOREOGRAPHY_PATTERNS.md +3 -1
- package/DOCS/OBS_SETUP_GUIDE.md +2 -0
- package/DOCS/OPTIMIZATION_PLAN_MATH.md +1 -0
- package/DOCS/PRODUCT_STRATEGY.md +2 -0
- package/DOCS/PROJECT_SETUP.md +2 -0
- package/DOCS/README.md +5 -3
- package/DOCS/REFERENCE_SCROLL_ANALYSIS.md +2 -0
- package/DOCS/RENDERER_LIFECYCLE.md +2 -0
- package/DOCS/REPO_MANIFEST.md +2 -0
- package/DOCS/ROADMAP.md +2 -0
- package/DOCS/SCROLL_TIMELINE_v3.md +2 -0
- package/DOCS/SITE_REFACTOR_PLAN.md +2 -0
- package/DOCS/STATUS.md +2 -0
- package/DOCS/SYSTEM_INVENTORY.md +2 -0
- package/DOCS/TELEMETRY_EXPORTS.md +2 -0
- package/DOCS/VISUAL_ANALYSIS_CLICKERSS.md +2 -0
- package/DOCS/VISUAL_ANALYSIS_FACETAD.md +2 -0
- package/DOCS/VISUAL_ANALYSIS_SIMONE.md +2 -0
- package/DOCS/VISUAL_ANALYSIS_TABLESIDE.md +2 -0
- package/DOCS/WEBGPU_STATUS.md +2 -0
- package/DOCS/XR_BENCHMARKS.md +2 -0
- package/DOCS/archive/BLUEPRINT_EXECUTION_PLAN_2026-01-07.md +1 -34
- package/DOCS/archive/DEV_TRACK_ANALYSIS.md +1 -80
- package/DOCS/archive/DEV_TRACK_PLAN_2026-01-07.md +1 -42
- package/DOCS/archive/SESSION_014_PLAN.md +1 -195
- package/DOCS/archive/SESSION_LOG_2026-01-07.md +1 -56
- package/DOCS/archive/STRATEGIC_BLUEPRINT_2026-01-07.md +1 -72
- package/DOCS/archive/SYSTEM_AUDIT_2026-01-30.md +1 -741
- package/DOCS/archive/WEBGPU_STATUS_2026-02-15_STALE.md +1 -38
- package/DOCS/dev-tracks/DEV_TRACK_SESSION_2026-01-31.md +2 -0
- package/DOCS/dev-tracks/DEV_TRACK_SESSION_2026-02-06.md +2 -0
- package/DOCS/dev-tracks/DEV_TRACK_SESSION_2026-02-13.md +2 -0
- package/DOCS/dev-tracks/DEV_TRACK_SESSION_2026-02-15.md +2 -0
- package/DOCS/dev-tracks/DEV_TRACK_SESSION_2026-02-16.md +2 -0
- package/DOCS/dev-tracks/PERF_UPGRADE_2026-02-16.md +2 -0
- package/DOCS/dev-tracks/README.md +2 -0
- package/package.json +2 -4
- package/src/cli/index.js +59 -5
- package/src/geometry/warp/HypersphereCore.js +53 -24
- package/src/math/Mat4x4.js +86 -72
- package/src/math/Projection.js +39 -4
- package/src/math/Rotor4D.js +31 -1
- package/src/scene/Node4D.js +74 -24
- package/src/testing/ProjectionClass.test.js +38 -0
- package/tools/update_projection.py +109 -0
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
Last reviewed: 2026-02-17
|
|
2
|
+
|
|
3
|
+
# Building VIB3+ Ultra for Android
|
|
4
|
+
|
|
5
|
+
This guide explains how to build the "Crystal Labyrinth" demo as an Android APK using the existing Flutter integration.
|
|
6
|
+
|
|
7
|
+
## Prerequisites
|
|
8
|
+
|
|
9
|
+
- Flutter SDK installed
|
|
10
|
+
- Android Studio / Android SDK installed
|
|
11
|
+
- Connected Android device or emulator
|
|
12
|
+
|
|
13
|
+
## Quick Build (GitHub Actions)
|
|
14
|
+
|
|
15
|
+
The repository includes a workflow `.github/workflows/flutter-apk.yml` that automatically builds an APK on push to `examples/flutter_demo/`.
|
|
16
|
+
|
|
17
|
+
To trigger a build for the Crystal Labyrinth demo:
|
|
18
|
+
1. Copy the built web assets to the Flutter assets directory (see Local Build below).
|
|
19
|
+
2. Push changes.
|
|
20
|
+
3. Download the artifact from the Actions tab.
|
|
21
|
+
|
|
22
|
+
## Local Build Instructions
|
|
23
|
+
|
|
24
|
+
1. **Build the Web Demo**
|
|
25
|
+
Run the Vite build to bundle the Crystal Labyrinth demo:
|
|
26
|
+
```bash
|
|
27
|
+
npm install
|
|
28
|
+
npm run build:web
|
|
29
|
+
```
|
|
30
|
+
This will output optimized files to `dist/`.
|
|
31
|
+
|
|
32
|
+
2. **Prepare Flutter Assets**
|
|
33
|
+
Copy the build output to the Flutter project's asset folder:
|
|
34
|
+
```bash
|
|
35
|
+
mkdir -p examples/flutter_demo/assets/vib3/
|
|
36
|
+
cp -r dist/* examples/flutter_demo/assets/vib3/
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
3. **Configure Entry Point**
|
|
40
|
+
Open `examples/flutter_demo/lib/vib3_controller.dart` and ensure the WebView points to the local index file or the deployed GitHub Pages URL:
|
|
41
|
+
`https://<your-username>.github.io/vib3codeSDK/examples/dogfood/crystal_labyrinth.html`
|
|
42
|
+
|
|
43
|
+
4. **Build APK**
|
|
44
|
+
Navigate to the Flutter directory and build:
|
|
45
|
+
```bash
|
|
46
|
+
cd examples/flutter_demo
|
|
47
|
+
flutter build apk --release
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
5. **Install**
|
|
51
|
+
```bash
|
|
52
|
+
flutter install
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## VIB3Link Networking on Android
|
|
56
|
+
|
|
57
|
+
For multi-user features (`VIB3Link`) to work on Android:
|
|
58
|
+
- Ensure the device has internet access.
|
|
59
|
+
- If using local dev server, use `adb reverse tcp:5173 tcp:5173` to forward ports.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Last reviewed: 2026-02-17
|
package/DOCS/CI_TESTING.md
CHANGED
package/DOCS/CLI_ONBOARDING.md
CHANGED
package/DOCS/ENV_SETUP.md
CHANGED
package/DOCS/EXPANSION_DESIGN.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
Last reviewed: 2026-02-17
|
|
2
|
+
|
|
1
3
|
# VIB3+ Premium Tier — Expansion Design Document
|
|
2
4
|
|
|
3
5
|
**Purpose**: Technical specification for `@vib3code/premium`, a separate npm package that extends the free `@vib3code/sdk` with fine-grained shader control, axis locking, per-layer geometry, event-triggered state changes, and live CSS/framework integration.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
Last reviewed: 2026-02-17
|
|
2
|
+
|
|
1
3
|
# VIB3+ Ultra — The Emergent Media Engine
|
|
2
4
|
|
|
3
5
|
**Purpose**: This document defines the **Ultra Tier** expansion for VIB3+. While the Premium Tier (`EXPANSION_DESIGN.md`) focuses on professional visualization tools, the Ultra Tier transforms the SDK into a **full-stack emergent media engine** capable of powering 4D video games, generative cartoons, and multi-user hallucinations.
|
package/DOCS/EXPORT_FORMATS.md
CHANGED
package/DOCS/LICENSING_TIERS.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
Last reviewed: 2026-02-17
|
|
2
|
+
|
|
1
3
|
# VIB3+ Multi-Visualizer Choreography Patterns
|
|
2
4
|
|
|
3
5
|
**Generated: 2026-02-09**
|
|
@@ -11,7 +13,7 @@
|
|
|
11
13
|
1. [Depth Illusion Engine](#1-depth-illusion-engine)
|
|
12
14
|
2. [Multi-Visualizer Coordination Modes](#2-multi-visualizer-coordination-modes)
|
|
13
15
|
3. [Section-by-Section Choreography Upgrades](#3-section-by-section-choreography-upgrades)
|
|
14
|
-
4. [Accent & Texture Effects Library](#4-accent
|
|
16
|
+
4. [Accent & Texture Effects Library](#4-accent-texture-effects-library)
|
|
15
17
|
5. [Mathematical Intertwining Functions](#5-mathematical-intertwining-functions)
|
|
16
18
|
6. [Implementation Priority Map](#6-implementation-priority-map)
|
|
17
19
|
|
package/DOCS/OBS_SETUP_GUIDE.md
CHANGED
package/DOCS/PRODUCT_STRATEGY.md
CHANGED
package/DOCS/PROJECT_SETUP.md
CHANGED
package/DOCS/README.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
Last reviewed: 2026-02-17
|
|
2
|
+
|
|
1
3
|
# Documentation Index
|
|
2
4
|
|
|
3
5
|
## Strategy & Planning
|
|
@@ -54,7 +56,7 @@ Use these canonical documents first:
|
|
|
54
56
|
| Architecture | [`DOCS/SYSTEM_INVENTORY.md`](./SYSTEM_INVENTORY.md) | ✅ System boundaries, modules, and capabilities | SDK Architecture | 2026-02-12 |
|
|
55
57
|
| Product Strategy | [`DOCS/LICENSING_TIERS.md`](./LICENSING_TIERS.md) | ✅ Packaging, positioning, and commercial model | Product | 2026-02-12 |
|
|
56
58
|
| Master Plan | [`DOCS/MASTER_PLAN_2026-01-31.md`](./MASTER_PLAN_2026-01-31.md) | ✅ Program-level priorities and sequencing | Program Management | 2026-02-12 |
|
|
57
|
-
| Dev Track | [`DOCS/DEV_TRACK_SESSION_2026-02-06.md`](./DEV_TRACK_SESSION_2026-02-06.md) | ✅ Current implementation log and execution status | Engineering | 2026-02-12 |
|
|
59
|
+
| Dev Track | [`DOCS/DEV_TRACK_SESSION_2026-02-06.md`](./dev-tracks/DEV_TRACK_SESSION_2026-02-06.md) | ✅ Current implementation log and execution status | Engineering | 2026-02-12 |
|
|
58
60
|
|
|
59
61
|
## Reading Paths by Persona
|
|
60
62
|
|
|
@@ -70,7 +72,7 @@ Use these canonical documents first:
|
|
|
70
72
|
2. [`DOCS/REPO_MANIFEST.md`](./REPO_MANIFEST.md)
|
|
71
73
|
3. [`DOCS/SYSTEM_INVENTORY.md`](./SYSTEM_INVENTORY.md)
|
|
72
74
|
4. [`DOCS/MASTER_PLAN_2026-01-31.md`](./MASTER_PLAN_2026-01-31.md)
|
|
73
|
-
5. Latest dev track session (currently [`DOCS/DEV_TRACK_SESSION_2026-02-06.md`](./DEV_TRACK_SESSION_2026-02-06.md))
|
|
75
|
+
5. Latest dev track session (currently [`DOCS/DEV_TRACK_SESSION_2026-02-06.md`](./dev-tracks/DEV_TRACK_SESSION_2026-02-06.md))
|
|
74
76
|
|
|
75
77
|
### Product lead
|
|
76
78
|
1. [`DOCS/LICENSING_TIERS.md`](./LICENSING_TIERS.md)
|
|
@@ -91,7 +93,7 @@ Use these canonical documents first:
|
|
|
91
93
|
| Category | Scope | Primary files |
|
|
92
94
|
|---|---|---|
|
|
93
95
|
| Architecture | Runtime model, systems, lifecycles, controls | [`SYSTEM_INVENTORY.md`](./SYSTEM_INVENTORY.md) **(SOT)**, [`RENDERER_LIFECYCLE.md`](./RENDERER_LIFECYCLE.md), [`CONTROL_REFERENCE.md`](./CONTROL_REFERENCE.md), [`GPU_DISPOSAL_GUIDE.md`](./GPU_DISPOSAL_GUIDE.md) |
|
|
94
|
-
| Planning | Strategy, roadmap, execution direction | [`MASTER_PLAN_2026-01-31.md`](./MASTER_PLAN_2026-01-31.md) **(SOT)**, [`DEV_TRACK_SESSION_2026-02-06.md`](./DEV_TRACK_SESSION_2026-02-06.md) **(SOT for active sprint log)**, [`DEV_TRACK_SESSION_2026-01-31.md`](./DEV_TRACK_SESSION_2026-01-31.md), [`LICENSING_TIERS.md`](./LICENSING_TIERS.md) **(SOT for product packaging)** |
|
|
96
|
+
| Planning | Strategy, roadmap, execution direction | [`MASTER_PLAN_2026-01-31.md`](./MASTER_PLAN_2026-01-31.md) **(SOT)**, [`DEV_TRACK_SESSION_2026-02-06.md`](./dev-tracks/DEV_TRACK_SESSION_2026-02-06.md) **(SOT for active sprint log)**, [`DEV_TRACK_SESSION_2026-01-31.md`](./dev-tracks/DEV_TRACK_SESSION_2026-01-31.md), [`LICENSING_TIERS.md`](./LICENSING_TIERS.md) **(SOT for product packaging)** |
|
|
95
97
|
| Operations | Setup, CI, runbooks, observability | [`PROJECT_SETUP.md`](./PROJECT_SETUP.md) **(SOT for project bootstrap)**, [`ENV_SETUP.md`](./ENV_SETUP.md), [`CI_TESTING.md`](./CI_TESTING.md), [`OBS_SETUP_GUIDE.md`](./OBS_SETUP_GUIDE.md), [`TELEMETRY_EXPORTS.md`](./TELEMETRY_EXPORTS.md) |
|
|
96
98
|
| Analysis | Benchmarks, visual analysis, design studies | [`WEBGPU_STATUS.md`](./WEBGPU_STATUS.md), [`XR_BENCHMARKS.md`](./XR_BENCHMARKS.md), [`CROSS_SITE_DESIGN_PATTERNS.md`](./CROSS_SITE_DESIGN_PATTERNS.md), `VISUAL_ANALYSIS_*.md`, [`REFERENCE_SCROLL_ANALYSIS.md`](./REFERENCE_SCROLL_ANALYSIS.md) |
|
|
97
99
|
| Archive | Historical plans and audits retained for traceability | [`archive/`](./archive/) including [`archive/SYSTEM_AUDIT_2026-01-30.md`](./archive/SYSTEM_AUDIT_2026-01-30.md), [`archive/STRATEGIC_BLUEPRINT_2026-01-07.md`](./archive/STRATEGIC_BLUEPRINT_2026-01-07.md), [`archive/SESSION_LOG_2026-01-07.md`](./archive/SESSION_LOG_2026-01-07.md) |
|
package/DOCS/REPO_MANIFEST.md
CHANGED
package/DOCS/ROADMAP.md
CHANGED
package/DOCS/STATUS.md
CHANGED
package/DOCS/SYSTEM_INVENTORY.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
Last reviewed: 2026-02-17
|
|
2
|
+
|
|
1
3
|
# Telemetry export manifests
|
|
2
4
|
|
|
3
5
|
The telemetry export pipeline standardizes manifest payloads for downstream automation, QA, and observability. Each manifest is designed to be cache-friendly with deterministic hashes so CI can diff outputs without ambiguity.
|
package/DOCS/WEBGPU_STATUS.md
CHANGED
package/DOCS/XR_BENCHMARKS.md
CHANGED
|
@@ -1,34 +1 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
This execution plan operationalizes the strategic blueprint and defines what each session should deliver. Each session should update `DOCS/archive/SESSION_LOG_2026-01-07.md` with timestamped progress and keep the checklist current.
|
|
4
|
-
|
|
5
|
-
## Session cadence
|
|
6
|
-
- **Start of session**: review this plan and the strategic blueprint.
|
|
7
|
-
- **During session**: implement the next unchecked items, keep scope tight.
|
|
8
|
-
- **End of session**: update the session log with timestamped outcomes and any blockers.
|
|
9
|
-
|
|
10
|
-
## Execution checklist
|
|
11
|
-
### Phase 1 — Mathematical foundation
|
|
12
|
-
- [x] Add rotor/matrix utilities for the six rotation planes.
|
|
13
|
-
- [x] Implement stereographic + perspective projection helpers.
|
|
14
|
-
- [x] Add rotation drift/stability tests.
|
|
15
|
-
|
|
16
|
-
### Phase 2 — Rendering core consolidation
|
|
17
|
-
- [x] Define renderer contracts and resource manager interfaces.
|
|
18
|
-
- [ ] Unify visualization systems behind a shared scene graph.
|
|
19
|
-
- [x] Document GPU disposal patterns and lifecycle hooks.
|
|
20
|
-
|
|
21
|
-
### Phase 3 — Agentic integration
|
|
22
|
-
- [x] Define MCP tools for create/apply/render workflows.
|
|
23
|
-
- [x] Emit structured telemetry spans and error schemas.
|
|
24
|
-
- [x] Implement CLI JSON output and non-interactive modes.
|
|
25
|
-
|
|
26
|
-
### Phase 4 — Cross-platform execution
|
|
27
|
-
- [x] Define WASM build target and shared math core strategy.
|
|
28
|
-
- [x] Add Flutter bindings with a batched render command buffer.
|
|
29
|
-
- [x] Prototype WebGPU backend behind feature flags.
|
|
30
|
-
|
|
31
|
-
### Phase 5 — Production hardening
|
|
32
|
-
- [x] Draft licensing tiers and activation workflow.
|
|
33
|
-
- [x] Add export formats with golden snapshot tests.
|
|
34
|
-
- [x] Document XR integration benchmarks and performance targets.
|
|
1
|
+
Last reviewed: 2026-02-17
|
|
@@ -1,80 +1 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
> **Archived document:** This file is retained for historical reference in `DOCS/archive/` and is not part of the active docs set.
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
This document summarizes the current development track status, highlights gaps, and proposes the
|
|
7
|
-
next execution steps. It should be updated after each multi-system delivery.
|
|
8
|
-
|
|
9
|
-
**Last Updated:** 2026-01-30 (v2.0.0)
|
|
10
|
-
|
|
11
|
-
## Current status snapshot
|
|
12
|
-
- **Math foundation:** rotation utilities, projection clamping, and stability tests are in place.
|
|
13
|
-
- **Renderer lifecycle:** unified contract and lifecycle manager are defined with adapters for the
|
|
14
|
-
core systems; resource tracking is centralized in the WebGL backend.
|
|
15
|
-
- **Agentic tooling:** MCP/CLI response envelopes are standardized with schema validation.
|
|
16
|
-
- **Docs/ops:** environment setup, CI testing, repo manifest, and project provisioning guides are
|
|
17
|
-
documented.
|
|
18
|
-
- **WebGPU scaffold:** experimental backend initializes device/context and supports clear-pass render frames.
|
|
19
|
-
- **WebGPU status/testing:** documented current WebGPU state and validation requirements.
|
|
20
|
-
- **v2.0.0 Core Fixes (Phase A):** Quantum color restored, Faceted saturation + audio wired, clickIntensity bug fixed, shader sync tool added.
|
|
21
|
-
- **v2.0.0 SpatialInputSystem:** Universal spatial input with 8 source types, 6 profiles, integrated into VIB3Engine. Decouples "card tilting" from device orientation.
|
|
22
|
-
- **v2.0.0 Creative Tooling (Phase B):** Color presets (22), transitions (14 easings), post-processing (14 effects), parameter timeline (BPM sync).
|
|
23
|
-
- **v2.0.0 Platform Integrations (Phase C):** React, Vue, Svelte component wrappers; Figma plugin; Three.js ShaderMaterial; TouchDesigner GLSL export; OBS mode.
|
|
24
|
-
- **v2.0.0 Advanced Features (Phase D):** WebXR renderer, WebGPU compute shaders, MIDI controller, AI preset generator, OffscreenCanvas worker.
|
|
25
|
-
|
|
26
|
-
## Completed phases
|
|
27
|
-
| Phase | Status | Deliverables |
|
|
28
|
-
|-------|--------|-------------|
|
|
29
|
-
| Phase 1: Foundation | ✅ Complete | Math, geometry, parameters |
|
|
30
|
-
| Phase 2: Rendering | ✅ Mostly Complete | Contracts, adapters, backends |
|
|
31
|
-
| Phase 3: Agentic | ✅ Complete | MCP, CLI, Telemetry |
|
|
32
|
-
| Phase 4: WebGPU | 🔄 In Progress | Scaffold exists |
|
|
33
|
-
| Phase 5: Hardening | ✅ Complete | 694 tests, XSS prevention |
|
|
34
|
-
| Phase A: Parity & Polish | ✅ Complete | Color/audio/saturation fixes |
|
|
35
|
-
| Phase B: Creative Tooling | ✅ Complete | 4 modules, 3,837 lines |
|
|
36
|
-
| Phase C: Platform Integrations | ✅ Complete | 7 modules, 4,693 lines |
|
|
37
|
-
| Phase D: Advanced | ✅ Complete | 5 modules, 4,262 lines |
|
|
38
|
-
| SpatialInputSystem | ✅ Complete | 1,783 lines, 8 sources, 6 profiles |
|
|
39
|
-
|
|
40
|
-
## Key gaps to close
|
|
41
|
-
1. **v2.0.0 module test coverage:**
|
|
42
|
-
- Creative, integrations, and advanced modules need unit/integration tests.
|
|
43
|
-
- SpatialInputSystem profiles need validation tests.
|
|
44
|
-
2. **WebGPU prototype (Phase 4):**
|
|
45
|
-
- Confirm feature-flag gating and parity with WebGL backend entry points.
|
|
46
|
-
- Establish a minimal shader/material pipeline that mirrors the WebGL contract.
|
|
47
|
-
3. **Platform integration validation:**
|
|
48
|
-
- Test React/Vue/Svelte components with actual framework projects.
|
|
49
|
-
- Validate Figma plugin with Figma Developer Console.
|
|
50
|
-
- Test TouchDesigner GLSL export in actual TD environment.
|
|
51
|
-
4. **Cross-platform command buffers:**
|
|
52
|
-
- Document and validate the render command buffer format for Flutter/WASM integration.
|
|
53
|
-
- Ensure command buffer batching and lifecycle hooks align with `RendererContract`.
|
|
54
|
-
5. **Telemetry export hardening:**
|
|
55
|
-
- Add validation for telemetry manifests and scene packs in CI.
|
|
56
|
-
- Produce golden snapshot tests for core geometries.
|
|
57
|
-
|
|
58
|
-
## Recommended next steps
|
|
59
|
-
1. **Test coverage for v2.0.0 modules:**
|
|
60
|
-
- Write Vitest unit tests for SpatialInputSystem (profile loading, input feeding, sensitivity).
|
|
61
|
-
- Write tests for creative tooling (preset application, transition interpolation, timeline playback).
|
|
62
|
-
- Add E2E tests for OBS mode and framework components.
|
|
63
|
-
2. **NPM publish preparation:**
|
|
64
|
-
- Verify all package.json exports resolve correctly.
|
|
65
|
-
- Test tree-shaking with the creative/integrations/advanced imports.
|
|
66
|
-
- Run `npm pack --dry-run` to verify published file list.
|
|
67
|
-
3. **WebGPU spike (Phase 4):**
|
|
68
|
-
- Build a feature-flagged WebGPU backend scaffold in `src/render/backends/`.
|
|
69
|
-
- Add a minimal triangle pipeline with uniform updates and buffer management.
|
|
70
|
-
4. **Renderer diagnostics:**
|
|
71
|
-
- Expand `RenderResourceRegistry` stats to include peak usage and per-frame deltas.
|
|
72
|
-
5. **Project automation:**
|
|
73
|
-
- Provide a scripted `make setup` (or `pnpm setup`) that runs env + project setup steps.
|
|
74
|
-
|
|
75
|
-
## Risks and mitigation
|
|
76
|
-
- **GPU resource churn:** ensure registry-based disposal is called during renderer swaps.
|
|
77
|
-
- **Numerical drift:** keep normalization utilities and baseline tests running in CI.
|
|
78
|
-
- **Cross-platform divergence:** ensure WebGL and WebGPU share material definitions.
|
|
79
|
-
- **v2.0.0 module breadth:** 18 new files need test coverage before production use.
|
|
80
|
-
- **Framework integration drift:** framework APIs evolve; pin versions in test fixtures.
|
|
1
|
+
Last reviewed: 2026-02-17
|
|
@@ -1,42 +1 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
This plan captures the staged work needed to deliver a production-ready agentic telemetry pipeline and export workflow. It is written as a living track plan so future sessions can append progress and maintain consistent architecture decisions.
|
|
4
|
-
|
|
5
|
-
## North-star goals
|
|
6
|
-
1. Agent-friendly CLI onboarding and help output.
|
|
7
|
-
2. Deterministic telemetry manifest exports with previews and asset hashing.
|
|
8
|
-
3. Clear documentation for automation, QA, and CI workflows.
|
|
9
|
-
|
|
10
|
-
## Architecture anchors
|
|
11
|
-
- **Telemetry pipeline**: `tools/telemetry/manifestPipeline.js` is the single source of truth for manifest normalization and hashing.
|
|
12
|
-
- **Preview generation**: `js/core/telemetry-director.js` generates previews (renderer-backed or placeholders) and passes them into manifests.
|
|
13
|
-
- **Docs hub**: `DOCS/` is the canonical location for workflow documentation (onboarding, telemetry, control references).
|
|
14
|
-
|
|
15
|
-
## Planned track (phased)
|
|
16
|
-
### Phase 1 — Onboarding + documentation hardening
|
|
17
|
-
- Publish an agentic CLI onboarding guide with tool requirements, commands, and telemetry workflow steps.
|
|
18
|
-
- Update README references so new onboarding docs are discoverable.
|
|
19
|
-
- Extend telemetry docs with explicit CLI integration guidance and export flow notes.
|
|
20
|
-
- Add a lightweight knowledge-check template that validates geometry/control comprehension without blocking execution.
|
|
21
|
-
|
|
22
|
-
### Phase 2 — Agentic workflow hooks
|
|
23
|
-
- Add CLI wrappers for telemetry export flows (pack selection, preview generation, manifest hashing).
|
|
24
|
-
- Emit summaries designed for CI cache validation and diffing.
|
|
25
|
-
- Provide optional validation hooks for manifest/preview consistency.
|
|
26
|
-
|
|
27
|
-
### Phase 3 — Quality and verification
|
|
28
|
-
- Add lint/test targets for telemetry outputs if applicable.
|
|
29
|
-
- Document CI steps for telemetry export validation.
|
|
30
|
-
- Add golden snapshot routines for preview images when the pipeline stabilizes.
|
|
31
|
-
|
|
32
|
-
## Risks and mitigations
|
|
33
|
-
- **Risk**: Hash drift due to unstable object serialization.
|
|
34
|
-
**Mitigation**: Keep stable hashing in `manifestPipeline.js` and avoid non-deterministic fields.
|
|
35
|
-
- **Risk**: Preview generation inconsistency across runtimes.
|
|
36
|
-
**Mitigation**: Maintain browser-safe fallback encoding and ensure renderer contracts are documented.
|
|
37
|
-
|
|
38
|
-
## Deliverables checklist
|
|
39
|
-
- [ ] CLI onboarding doc is complete and linked in README.
|
|
40
|
-
- [ ] Telemetry docs include export integration steps.
|
|
41
|
-
- [ ] Agentic CLI support documented or implemented.
|
|
42
|
-
- [ ] CI guidance includes telemetry hashes and preview artifacts.
|
|
1
|
+
Last reviewed: 2026-02-17
|