-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Problem statement
Create a short, command-driven ToneForge workflow guide that teaches a new user how to discover, author, iterate, and export game-ready sound assets for a tableau-style card game (high-street economy example). The guide must be runnable from the CLI and produce verified output files in a predictable assets path.
Users
- Primary audience: New ToneForge users (game audio implementers and general game developers) who need exact commands and reproducible steps.
- Example user stories:
- As a new audio implementer, I want to find relevant card-game recipes so I can preview candidate sounds before authoring.
- As a game developer, I want a worked example showing how to create a new recipe/preset and export a final WAV into my repo so I can include it in the build.
- As a tech artist, I want verification commands to confirm generated assets landed in the correct path so CI or a reviewer can validate outputs.
Prerequisites
nodeandnpminstalled (Node 16+ recommended) and the repo checked out locally.- ToneForge CLI installed and on PATH (e.g.,
npm installthennpm run buildor usenpm linkif applicable). SeeInstall the CLI (TF-0MLW2K2V51AY2N9T)for details.
Success criteria
- Guide is published at
docs/guides/gamedev-workflow-example.mdand easy to find from the docs index. - Contains step-by-step CLI commands for: discovery (
list/search), creation/editing (recipe/preset commands), iteration (render/parameter tweaks), and export (render/export to files). - Includes at least one full worked flow for each event:
tableau_play_card,coin_collect,market_upgrade,rent_collect, andturn_end, producing WAV files atassets/sfx/tableau/<event>/<name>.wav. - Includes simple verification commands (e.g.,
ls, checksum orsha256sum) that a user or CI can run to confirm files exist and match expected names. - Steps are verbatim and reproducible by a new user given ToneForge installed and the repo checked out.
Constraints
- Keep the guide CLI-first (no built audio assets committed to repo); do not add large binary assets to the repo.
- Assume readers have a working ToneForge install and Node toolchain; list prerequisites explicitly near the top.
- Keep scope limited to one doc (docs/guides/gamedev-workflow-example.md) and placeholder scripts where runnable examples are needed (do not commit generated audio).
Existing state
- The repo already contains card-game focused documentation and demos that this guide should reference or reuse:
demos/card-game-sounds.md— shows available card-game recipes and discovery examples; good reference for discovery and preview steps.demos/recipe-filtering.md— explains filtering & category normalization; useful for search and filter examples.presets/sequences/tableau_play_card.json— an existing sequence preset for the tableau play event; useful as an example preset to render.presets/stacks/card_play_landing.json— stack preset relevant to card-place landing; can be referenced for naming conventions.
Desired change
- Produce
docs/guides/gamedev-workflow-example.md: a concise, ordered guide that uses the tableau card game high-street economy as the running example and demonstrates the full flow from discovery to exported WAVs underassets/sfx/tableau/<event>/. - Provide copy-paste CLI commands, example naming conventions, and simple verification commands.
- Add links from the new guide to
demos/card-game-sounds.mdand other related docs; add a short section listing assumptions/prereqs.
Related work
- docs/demos/card-game-sounds.md — existing card-game demo with discovery and export snippets; should be referenced for discovery/context.
- docs/demos/recipe-filtering.md — filtering and category normalization guide; use examples for
--categoryand--searchusage. - presets/sequences/tableau_play_card.json — concrete preset that can be used as a worked example for
tableau_play_card. - presets/stacks/card_play_landing.json — stack preset useful for landing-impact example.
- Worklog: Card Game Sequence/Stack Presets (TF-0MM79GCTT1CPF9F3) — completed preset pack; useful historical reference.
- Worklog: Card Game Sound Effects Recipe Library (TF-0MM65RIDV0EJH50O) — related epic collecting card-game recipes.
Risks & mitigations
- CLI stability: if some commands are experimental or change during implementation, label them
experimentalin the guide and add a short note explaining alternate approaches (e.g.,stack rendervsgenerate). - Scope creep: additional engine integration, CI hardening, or committed audio increases scope. Mitigation: record these as separate, linked work items and keep this guide focused on the CLI workflow.
- CI / reproducibility risks: differences in platform audio backends may cause differing render outputs. Mitigation: include checksums and name-based verification rather than bitwise content guarantees; recommend running the same Node/ToneForge versions.
Assumptions
- ToneForge CLI commands used in the guide are stable and available to the target users; any commands that are experimental must be flagged.
- No pre-rendered audio will be committed; the guide shows how to generate assets locally.
Open questions for the author
- Do you want brief Unity/Unreal import examples included, or keep strictly CLI-only? (Current selection: CLI-only)
- Should we add a small
scripts/generate-tableau-example.shhelper script in the repo to run the worked flows (script only, no committed audio)? - Any preferred naming convention beyond
assets/sfx/tableau/<event>/<name>.wav(e.g., include version or repository slug)?
File location
- Draft saved to:
.opencode/tmp/intake-draft-write-toneforge-gamedev-workflow-tableau-TF-0MMNC7ECO1Y2Z47I.md
Draft headline (1–2 sentence)
Create a concise, copy-pasteable CLI guide that walks a new ToneForge user through discovery, authoring, iteration, and export of game-ready sounds for a tableau card game, producing verified WAVs at assets/sfx/tableau/<event>/.
Reactions are currently unavailable