Skip to content

Add ToneForge game-dev workflow guide for tableau card game SFX#245

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/write-toneforge-workflow-guide
Draft

Add ToneForge game-dev workflow guide for tableau card game SFX#245
Copilot wants to merge 2 commits intomainfrom
copilot/write-toneforge-workflow-guide

Conversation

Copy link
Contributor

Copilot AI commented Mar 12, 2026

New users lacked a concrete, copy-pasteable CLI guide covering the full discovery → authoring → iteration → export loop for a real game scenario. This adds that guide using a high-street economy tableau card game as the running example.

New files

  • docs/guides/gamedev-workflow-example.md — 10-step guide covering:

    • Discovery: list recipes --category card-game, --search, --tags, --json

    • Preview & inspect: generate, show, sequence inspect/simulate, stack inspect

    • Iteration: explore sweep + explore mutate for seed selection

    • Full worked export for each of the five required events, mapping to existing presets:

      Event Preset used Command
      tableau_play_card sequences/tableau_play_card.json sequence generate
      coin_collect sequences/economy_income.json sequence generate
      market_upgrade stacks/market_buy_event.json stack render
      rent_collect sequences/economy_income.json (seed 77) sequence generate
      turn_end sequences/round_end_cleanup.json sequence generate
    • Verification: ls -lR, file-existence loop, sha256sum --check against scripts/tableau-checksums.sha256

    • Naming convention table and full command recap

  • scripts/generate-tableau-example.sh — headless script rendering all five events, verifying outputs, and writing checksums to scripts/tableau-checksums.sha256 (tracked; CI-safe)

Modified files

  • .gitignore — adds assets/sfx/ so generated WAVs are never accidentally committed
Original prompt

This section details on the original issue you should resolve

<issue_title>Write ToneForge game-dev workflow guide for tableau card game</issue_title>
<issue_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

  • node and npm installed (Node 16+ recommended) and the repo checked out locally.
  • ToneForge CLI installed and on PATH (e.g., npm install then npm run build or use npm link if applicable). See Install the CLI (TF-0MLW2K2V51AY2N9T) for details.

Success criteria

  • Guide is published at docs/guides/gamedev-workflow-example.md and 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, and turn_end, producing WAV files at assets/sfx/tableau/<event>/<name>.wav.
  • Includes simple verification commands (e.g., ls, checksum or sha256sum) 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 under assets/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.md and 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 --category and --search usage.
  • 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 experimental in the guide and add a short note explaining alternate approaches (e.g., stack render vs generate).
  • 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...

📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Co-authored-by: SorraTheOrc <250240+SorraTheOrc@users.noreply.github.com>
Copilot AI changed the title [WIP] Create ToneForge game-dev workflow guide for tableau card game Add ToneForge game-dev workflow guide for tableau card game SFX Mar 12, 2026
Copilot AI requested a review from SorraTheOrc March 12, 2026 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write ToneForge game-dev workflow guide for tableau card game

2 participants