Skip to content

Installation

Forge on itch.io

Forge is the desktop app that edits, previews, bakes, and shares .soundef files.

  • Download the latest build for Windows, macOS, or Linux on itch.io.
  • Open Forge, then File → Open Project… and pick your project folder (any name) that holds sounds/ and soundefs/ side by side. See Getting Started for the full edit → preview → bake loop.

Forge never copies or owns your audio. It reads sounds/* in place and writes only to soundefs/* (on Save) and baked/* (on Bake).

The format: no install needed

A .soundef file is plain YAML 1.2. JSON is valid too, validated against the canonical schema. There is no library to install.

  • Schema (canonical): served directly by this site at /schemas/soundef.v0.json. Use it to validate in any language.

  • Two paths for your game:

    1. No runtime: bake to wav. In Forge, Bake renders a .soundef plus seed to baked/<name>_baked_<seed>.wav. Ship the wav. No code needed. See Getting Started: Bake + Download + Share.

    2. Live variation: implement the spec. Parse the YAML/JSON, validate it against the schema, then resolve a PlaybackPlan per Spec and Integration. Any engine (Godot, Unity, Unreal, Bevy, web) can do this. Or pre-resolve at build time: in Forge check includes json plan and Bake to write baked/<name>_<seed>.plan.json (validated at /schemas/playback-plan.v0.json) and ship that JSON.

See also

  • Getting Started - open a project and run the loop.
  • Spec - the file reference for every key, unit, and value form.
  • Integration - map a PlaybackPlan to audio and match Forge's determinism.
  • Examples - runnable project skeleton (examples/demo-project/ with sounds/ + soundefs/ + baked/) that covers every feature.

Soundef — declarative SFX behavior