Atrinik sound assets

This repository owns the background music and sound effects distributed with Atrinik clients. The maintained consumer is atrinik/classic/client; the fresh atrinik/client will consume a released archive when replacement integration lands. Consumers use immutable checksum-pinned releases instead of Git submodules.

Licensing and attribution

These assets do not have one blanket repository license. The LICENSE and README.md files under background/ and effects/ identify the terms and attribution for their respective assets. Preserve those files and update the nearest applicable attribution when adding or replacing media.

Releases

Every squash merge uses its Conventional Commits pull-request title to create at least a patch release. Each release continues to publish the preserved-source atrinik-sound-VERSION.tar.gz archive and SHA256SUMS.

The checked source manifest inventories all 339 current audio inputs and maps each legacy logical path to a collision-free Opus path. For example, background/fireside.mid maps to audio/background/fireside.mid.opus; consumers resolve the mapping instead of renaming authored content.

Every release also publishes atrinik-sound-classic-runtime-VERSION.tar.gz, the compatibility product used to restore the maintained Classic client. Beneath one archive prefix it exposes all 339 unchanged legacy logical paths: 189 current Vorbis payloads copied byte-for-byte and 150 deterministic Opus renderings of the 122 MIDI and 28 FLAC sources. SDL3_mixer identifies those payloads by content when a legacy filename extension names the authored format. The archive carries a publishable manifest, its schema and pinned toolchain, internal checksums, notices, attribution, license texts, and the complete modernization inventory. The same inventory is a release-level atrinik-sound-classic-runtime-VERSION-REMEDIATION.json asset.

The restoration decision permits republication of Atrinik's already-published corpus; it does not clear, erase, or hide the 248 license/provenance and 217 formal quality-review findings. Those 465 findings remain modernization work. Missing or colliding paths, changed inputs, unsafe files, hash or toolchain drift, nondeterministic conversion, or decoder failure still blocks the Classic runtime completely.

The separately normalized atrinik-sound-runtime-VERSION.tar.gz remains gated until every source has exact conversion and redistribution permission and every second-generation conversion has source-hash-bound quality approval. Until then, releases continue to publish its explicit atrinik-sound-runtime-VERSION-BLOCKED.json report and no partial normalized runtime.

Approvals are immutable-input contracts: license reviews bind source, notice, and SPDX hashes, while required quality reviews additionally bind the exact toolchain, evidence artifact, and generated output. Versioned JSON Schemas in schemas/ define the checked and packaged manifest interfaces.

Consumers pin source and runtime products independently by all four immutable coordinates:

1. release tag, such as v1.2.0;
2. the tag's source commit;
3. the exact GitHub release asset URL;
4. the asset's entry in SHA256SUMS.

See the runtime release contract for build, determinism, quality, validation, and consumer details.

Local Classic playtest tree

Source-building Classic playtesters can opt into a complete, local-only tree without weakening the released-runtime gates:

python3 tools/sound_release.py build-playtest-tree build/classic-playtest
python3 tools/sound_release.py verify-playtest-tree build/classic-playtest

The command requires a clean Git checkout and the separate pinned playtest audio toolchain; released-runtime inputs remain unchanged. It copies all 189 Vorbis inputs byte-for-byte, deterministically renders the 150 FLAC/MIDI inputs to Opus, and stages every payload at its existing legacy logical path. The canonical manifest records the source and actual payload codecs, so content-based SDL3_mixer decoding is required where a legacy extension names the authored format.

The resulting directory remains below ignored build/ state. Its marker and manifest declare playtest_only: true and publishable: false; it is not an archive, release input, cache, package, container layer, or provenance or listening approval. An existing verified tree is reused, while an invalid, stale, dirty, or concurrently changing input fails without replacing it. Fresh builds validate exact closure, hashes, metadata, control files, source stability, and mutation safety without repeating conversion or whole-tree decode work. CI passes two such builds to verify-paired-playtest-trees, which holds both mutation-safe snapshots, validates and compares their complete canonical manifests, then fully decodes all 339 byte-identical payloads exactly once without rerendering. The one-tree verify-playtest-tree command and reuse of a pre-existing local tree retain conversion reproduction and full decode because they have no paired-build evidence.

tools/audio/playtest.Dockerfile builds the required local environment without changing the released-runtime tools/audio/Dockerfile contract.