Skip to content

Commit 426e953

Browse files
author
DavidQ
committed
Update all How to Use pages
1 parent 0ec3e36 commit 426e953

18 files changed

Lines changed: 102 additions & 162 deletions

File tree

tools/3D Asset Viewer/how_to_use.html

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,22 @@ <h2>Tool vs Workspace Saves</h2>
3030
<p><strong>Workspace save</strong><br />Action: Use Workspace Manager save controls to persist cross-tool session state.<br />Why this step matters: Restores coordinated context (selected tool state, shared refs) but does not replace explicit artifact exports.</p>
3131
</div>
3232
</section>
33-
3433
<section class="section">
3534
<h2>Workflow</h2>
3635
<div class="tools-howto-workflow-compare">
3736
<article class="card tools-howto-workflow-column">
3837
<h3>Tool Mode</h3>
39-
<p><strong>1. Open the tool directly</strong><br />Action: Launch this tool from <code>tools/&lt;tool&gt;/index.html</code> (not through Workspace Manager).<br />Why this step matters: Keeps the session focused on one tool and its local outputs.</p>
40-
<p><strong>2. Build/edit in the tool</strong><br />Action: Perform core edits using the tool controls and validate output in-place.<br />Why this step matters: Produces the working data and preview state for this specific tool.</p>
41-
<p><strong>3. Save/export deliverables</strong><br />Action: Use tool save/export controls (JSON/PNG/sheets/runtime payloads as applicable).<br />Why this step matters: Creates the real files consumed by games, samples, and pipeline steps.</p>
42-
<p><strong>4. Continue or close</strong><br />Action: Open another tool directly as needed.
43-
<br />Why this step matters: Tool mode is best for isolated tasks and fast single-tool iteration.</p>
38+
<p><strong>1. Inspect 3D asset metadata</strong><br />Action: Launch this tool from <code>tools/&lt;tool&gt;/index.html</code> (not through Workspace Manager).<br />Why this step matters: Uses this tool as a focused single-tool surface.</p>
39+
<p><strong>2. Inspect and validate</strong><br />Action: Load or paste asset payloads, then inspect vertices, bounds, and normalized payload output.<br />Why this step matters: 3D Asset Viewer is read-only, so its value is validation and visibility, not editing.</p>
40+
<p><strong>3. Save/export deliverables</strong><br />Action: Copy or export inspection payloads/reports when needed for handoff.<br />Why this step matters: Preserves analysis outputs without changing source assets.</p>
41+
<p><strong>4. Continue or close</strong><br />Action: Open another tool directly as needed.<br />Why this step matters: Tool mode is best for isolated tasks and rapid single-tool iteration.</p>
4442
</article>
4543

4644
<article class="card tools-howto-workflow-column">
4745
<h3>Workspace Mode</h3>
4846
<p><strong>1. Create a named workspace</strong><br />Action: Click <code>New Workspace</code> and enter a meaningful name (example: <code>UAT 001 Workspace</code>).<br />Why this step matters: Starts from a clear baseline and makes saved snapshots easy to identify.</p>
49-
<p><strong>2. Open tools from Workspace Manager tiles</strong><br />Action: Select needed tool tiles and make edits across tools.<br />Why this step matters: Keeps multi-tool work coordinated under one shared context.</p>
50-
<p><strong>3. Save both levels intentionally</strong><br />Action: Use tool-level save/export for artifacts, then click <code>Save Workspace</code> for session state.
51-
<br />Why this step matters: Preserves both deliverable files and cross-tool orchestration state.</p>
47+
<p><strong>2. Open tools from Workspace Manager tiles</strong><br />Action: Select needed tool tiles and perform each tool's primary task.<br />Why this step matters: Keeps multi-tool work coordinated under one shared context.</p>
48+
<p><strong>3. Save both levels intentionally</strong><br />Action: Use tool-level save/export for artifacts, then click <code>Save Workspace</code> for session state.<br />Why this step matters: Preserves both deliverable files and cross-tool orchestration state.</p>
5249
<p><strong>4. Checkpoint and resume</strong><br />Action: Use <code>Save Workspace As</code> for milestones and <code>Open Workspace</code> to resume later.<br />Why this step matters: Supports versioned progress and reliable continuation.</p>
5350
</article>
5451
</div>

tools/3D Camera Path Editor/how_to_use.html

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,22 @@ <h2>Tool vs Workspace Saves</h2>
3030
<p><strong>Workspace save</strong><br />Action: Use Workspace Manager save controls to persist cross-tool session state.<br />Why this step matters: Restores coordinated context (selected tool state, shared refs) but does not replace explicit artifact exports.</p>
3131
</div>
3232
</section>
33-
3433
<section class="section">
3534
<h2>Workflow</h2>
3635
<div class="tools-howto-workflow-compare">
3736
<article class="card tools-howto-workflow-column">
3837
<h3>Tool Mode</h3>
39-
<p><strong>1. Open the tool directly</strong><br />Action: Launch this tool from <code>tools/&lt;tool&gt;/index.html</code> (not through Workspace Manager).<br />Why this step matters: Keeps the session focused on one tool and its local outputs.</p>
40-
<p><strong>2. Build/edit in the tool</strong><br />Action: Perform core edits using the tool controls and validate output in-place.<br />Why this step matters: Produces the working data and preview state for this specific tool.</p>
41-
<p><strong>3. Save/export deliverables</strong><br />Action: Use tool save/export controls (JSON/PNG/sheets/runtime payloads as applicable).<br />Why this step matters: Creates the real files consumed by games, samples, and pipeline steps.</p>
42-
<p><strong>4. Continue or close</strong><br />Action: Open another tool directly as needed.
43-
<br />Why this step matters: Tool mode is best for isolated tasks and fast single-tool iteration.</p>
38+
<p><strong>1. Author camera waypoint paths</strong><br />Action: Launch this tool from <code>tools/&lt;tool&gt;/index.html</code> (not through Workspace Manager).<br />Why this step matters: Uses this tool as a focused single-tool surface.</p>
39+
<p><strong>2. Build/edit in the tool</strong><br />Action: Add/adjust camera waypoints and normalize the path timeline.<br />Why this step matters: Produces deterministic camera motion definitions.</p>
40+
<p><strong>3. Save/export deliverables</strong><br />Action: Save path state and export normalized camera-path JSON.<br />Why this step matters: Preserves cinematic path behavior for reuse.</p>
41+
<p><strong>4. Continue or close</strong><br />Action: Open another tool directly as needed.<br />Why this step matters: Tool mode is best for isolated tasks and rapid single-tool iteration.</p>
4442
</article>
4543

4644
<article class="card tools-howto-workflow-column">
4745
<h3>Workspace Mode</h3>
4846
<p><strong>1. Create a named workspace</strong><br />Action: Click <code>New Workspace</code> and enter a meaningful name (example: <code>UAT 001 Workspace</code>).<br />Why this step matters: Starts from a clear baseline and makes saved snapshots easy to identify.</p>
49-
<p><strong>2. Open tools from Workspace Manager tiles</strong><br />Action: Select needed tool tiles and make edits across tools.<br />Why this step matters: Keeps multi-tool work coordinated under one shared context.</p>
50-
<p><strong>3. Save both levels intentionally</strong><br />Action: Use tool-level save/export for artifacts, then click <code>Save Workspace</code> for session state.
51-
<br />Why this step matters: Preserves both deliverable files and cross-tool orchestration state.</p>
47+
<p><strong>2. Open tools from Workspace Manager tiles</strong><br />Action: Select needed tool tiles and perform each tool's primary task.<br />Why this step matters: Keeps multi-tool work coordinated under one shared context.</p>
48+
<p><strong>3. Save both levels intentionally</strong><br />Action: Use tool-level save/export for artifacts, then click <code>Save Workspace</code> for session state.<br />Why this step matters: Preserves both deliverable files and cross-tool orchestration state.</p>
5249
<p><strong>4. Checkpoint and resume</strong><br />Action: Use <code>Save Workspace As</code> for milestones and <code>Open Workspace</code> to resume later.<br />Why this step matters: Supports versioned progress and reliable continuation.</p>
5350
</article>
5451
</div>

tools/3D Map Editor/how_to_use.html

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,22 @@ <h2>Tool vs Workspace Saves</h2>
3030
<p><strong>Workspace save</strong><br />Action: Use Workspace Manager save controls to persist cross-tool session state.<br />Why this step matters: Restores coordinated context (selected tool state, shared refs) but does not replace explicit artifact exports.</p>
3131
</div>
3232
</section>
33-
3433
<section class="section">
3534
<h2>Workflow</h2>
3635
<div class="tools-howto-workflow-compare">
3736
<article class="card tools-howto-workflow-column">
3837
<h3>Tool Mode</h3>
39-
<p><strong>1. Open the tool directly</strong><br />Action: Launch this tool from <code>tools/&lt;tool&gt;/index.html</code> (not through Workspace Manager).<br />Why this step matters: Keeps the session focused on one tool and its local outputs.</p>
40-
<p><strong>2. Build/edit in the tool</strong><br />Action: Perform core edits using the tool controls and validate output in-place.<br />Why this step matters: Produces the working data and preview state for this specific tool.</p>
41-
<p><strong>3. Save/export deliverables</strong><br />Action: Use tool save/export controls (JSON/PNG/sheets/runtime payloads as applicable).<br />Why this step matters: Creates the real files consumed by games, samples, and pipeline steps.</p>
42-
<p><strong>4. Continue or close</strong><br />Action: Open another tool directly as needed.
43-
<br />Why this step matters: Tool mode is best for isolated tasks and fast single-tool iteration.</p>
38+
<p><strong>1. Author 3D map layout</strong><br />Action: Launch this tool from <code>tools/&lt;tool&gt;/index.html</code> (not through Workspace Manager).<br />Why this step matters: Uses this tool as a focused single-tool surface.</p>
39+
<p><strong>2. Build/edit in the tool</strong><br />Action: Create/edit 3D points and segments, then inspect normalized map output.<br />Why this step matters: Builds 3D map documents suitable for deterministic runtime consumption.</p>
40+
<p><strong>3. Save/export deliverables</strong><br />Action: Save map state and export normalized 3D map payloads.<br />Why this step matters: Keeps authored layout and runtime data synchronized.</p>
41+
<p><strong>4. Continue or close</strong><br />Action: Open another tool directly as needed.<br />Why this step matters: Tool mode is best for isolated tasks and rapid single-tool iteration.</p>
4442
</article>
4543

4644
<article class="card tools-howto-workflow-column">
4745
<h3>Workspace Mode</h3>
4846
<p><strong>1. Create a named workspace</strong><br />Action: Click <code>New Workspace</code> and enter a meaningful name (example: <code>UAT 001 Workspace</code>).<br />Why this step matters: Starts from a clear baseline and makes saved snapshots easy to identify.</p>
49-
<p><strong>2. Open tools from Workspace Manager tiles</strong><br />Action: Select needed tool tiles and make edits across tools.<br />Why this step matters: Keeps multi-tool work coordinated under one shared context.</p>
50-
<p><strong>3. Save both levels intentionally</strong><br />Action: Use tool-level save/export for artifacts, then click <code>Save Workspace</code> for session state.
51-
<br />Why this step matters: Preserves both deliverable files and cross-tool orchestration state.</p>
47+
<p><strong>2. Open tools from Workspace Manager tiles</strong><br />Action: Select needed tool tiles and perform each tool's primary task.<br />Why this step matters: Keeps multi-tool work coordinated under one shared context.</p>
48+
<p><strong>3. Save both levels intentionally</strong><br />Action: Use tool-level save/export for artifacts, then click <code>Save Workspace</code> for session state.<br />Why this step matters: Preserves both deliverable files and cross-tool orchestration state.</p>
5249
<p><strong>4. Checkpoint and resume</strong><br />Action: Use <code>Save Workspace As</code> for milestones and <code>Open Workspace</code> to resume later.<br />Why this step matters: Supports versioned progress and reliable continuation.</p>
5350
</article>
5451
</div>

tools/Asset Browser/how_to_use.html

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,22 @@ <h2>Tool vs Workspace Saves</h2>
3030
<p><strong>Workspace save</strong><br />Action: Use Workspace Manager save controls to persist cross-tool session state.<br />Why this step matters: Restores coordinated context (selected tool state, shared refs) but does not replace explicit artifact exports.</p>
3131
</div>
3232
</section>
33-
3433
<section class="section">
3534
<h2>Workflow</h2>
3635
<div class="tools-howto-workflow-compare">
3736
<article class="card tools-howto-workflow-column">
3837
<h3>Tool Mode</h3>
39-
<p><strong>1. Open the tool directly</strong><br />Action: Launch this tool from <code>tools/&lt;tool&gt;/index.html</code> (not through Workspace Manager).<br />Why this step matters: Keeps the session focused on one tool and its local outputs.</p>
40-
<p><strong>2. Build/edit in the tool</strong><br />Action: Perform core edits using the tool controls and validate output in-place.<br />Why this step matters: Produces the working data and preview state for this specific tool.</p>
41-
<p><strong>3. Save/export deliverables</strong><br />Action: Use tool save/export controls (JSON/PNG/sheets/runtime payloads as applicable).<br />Why this step matters: Creates the real files consumed by games, samples, and pipeline steps.</p>
42-
<p><strong>4. Continue or close</strong><br />Action: Open another tool directly as needed.
43-
<br />Why this step matters: Tool mode is best for isolated tasks and fast single-tool iteration.</p>
38+
<p><strong>1. Browse approved assets and plan imports</strong><br />Action: Launch this tool from <code>tools/&lt;tool&gt;/index.html</code> (not through Workspace Manager).<br />Why this step matters: Uses this tool as a focused single-tool surface.</p>
39+
<p><strong>2. Build/edit in the tool</strong><br />Action: Filter categories, inspect asset payloads, and choose candidate imports.<br />Why this step matters: Keeps asset selection deterministic and aligned to shared contracts.</p>
40+
<p><strong>3. Save/export deliverables</strong><br />Action: Commit selected asset references/exports used by downstream tools.<br />Why this step matters: Carries approved asset decisions into production flow.</p>
41+
<p><strong>4. Continue or close</strong><br />Action: Open another tool directly as needed.<br />Why this step matters: Tool mode is best for isolated tasks and rapid single-tool iteration.</p>
4442
</article>
4543

4644
<article class="card tools-howto-workflow-column">
4745
<h3>Workspace Mode</h3>
4846
<p><strong>1. Create a named workspace</strong><br />Action: Click <code>New Workspace</code> and enter a meaningful name (example: <code>UAT 001 Workspace</code>).<br />Why this step matters: Starts from a clear baseline and makes saved snapshots easy to identify.</p>
49-
<p><strong>2. Open tools from Workspace Manager tiles</strong><br />Action: Select needed tool tiles and make edits across tools.<br />Why this step matters: Keeps multi-tool work coordinated under one shared context.</p>
50-
<p><strong>3. Save both levels intentionally</strong><br />Action: Use tool-level save/export for artifacts, then click <code>Save Workspace</code> for session state.
51-
<br />Why this step matters: Preserves both deliverable files and cross-tool orchestration state.</p>
47+
<p><strong>2. Open tools from Workspace Manager tiles</strong><br />Action: Select needed tool tiles and perform each tool's primary task.<br />Why this step matters: Keeps multi-tool work coordinated under one shared context.</p>
48+
<p><strong>3. Save both levels intentionally</strong><br />Action: Use tool-level save/export for artifacts, then click <code>Save Workspace</code> for session state.<br />Why this step matters: Preserves both deliverable files and cross-tool orchestration state.</p>
5249
<p><strong>4. Checkpoint and resume</strong><br />Action: Use <code>Save Workspace As</code> for milestones and <code>Open Workspace</code> to resume later.<br />Why this step matters: Supports versioned progress and reliable continuation.</p>
5350
</article>
5451
</div>

0 commit comments

Comments
 (0)