docs: consolidate music routing tables into music.md; DMWeb no-music corrections #61
No reviewers
Labels
No labels
area/ci-release
area/cli
area/docs
area/dungeon
area/ftl
area/graphics
area/gui
area/music
area/saves
area/tooling
port/amiga
port/dos
port/fm-towns
port/mac
port/pc98
port/sega-cd
priority/high
priority/low
priority/medium
type/bug
type/chore
type/docs
type/feature
type/research
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
jqueuniet/dm2-tools!61
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "refs/pull/61/head"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Three-part editorial pass on the music documentation:
Part A — Merge
docs/formats/md-dat.mdintodocs/formats/music.mdmd-dat.mdwas named after Mac US's filename (md.dat), but the doc covered all three structural variants of the on-disc music routing table (Format 1 / 2 / 3) including the Format-1CD.DAT(Sega CD / Mac JP / FM-Towns / PC-9821), Format-2md.dat(Mac US) andCD.DAT(Amiga), and Format-3songlist.dat(DOS). The Mac-specific filename in the doc title and path was misleading.## Music routing tablessection inmusic.mdwith three Format subsections.iMapNumberpositional-indexing finding, theskcore.cpp:7611defensive-fallback citation, the'ckid'MPW Projector resource decode with all field values (Skull_Keep.rcs / MacDMFiles / Kirk Baker / "Music fixes"), the cross-port'ckid'sweep table, the 10-record Sega CD CD.DAT fully-decoded table, the Amiga music-ID distribution table, and the "Why this rules out the SoundMusicSys-companion theory" subsection.docs/formats/md-dat.md.docs/sources/*.md,docs/external-references.md,ROADMAP.md, andcrates/dm2-music/src/{md_dat,songlist,lib}.rsdoc comments to point atmusic.md.Out of scope: Rust filename / module / type renames (
crates/dm2-music/src/md_dat.rs,dm2_music::md_dat,MdDat,MdRecord,formats/dm2_md_dat.ksy). Rename is invasive (public API change, kaitai spec rename, ~30 files) and deserves its own focused PR.Part B — Deduplicate music.md ↔ overview.md
Selective dedup of port-enumeration prose in music.md against the canonical port-to-format mapping in
docs/sources/overview.md § "Cross-port audio routing". Each per-format section's "ports that use this format" enumeration collapsed to a one-line pointer where the port list was pure restatement; port mentions carrying real information (track counts, byte-identity between regions, CDDA-vs-resource-fork distinctions, Mac-US-is-data-only-no-Red-Book-session) preserved.Part C — Factual corrections per DMWeb
Per DMWeb research, three ports were previously documented with hedge language ("no audio fixtures shipped" — sounds like we don't have a fixture) but are actually confirmed to have no music at all:
none (per [DMWEB]; sound playback broken on contemporary hardware)— DMWeb notes the game produces "strange noises with the DOSBox emulator", consistent with the absence of music data.none (port has no music per [DMWEB])— port confirmed silent.none (port has no music per [DMWEB])— port confirmed silent.none (port has no music per [DMWEB])— port confirmed silent.Applied to:
docs/sources/overview.md— both the attribute matrix (L34-51) and the cross-port audio routing table (L92-104) updated for all four ports with matching language.docs/sources/dos-en-beta.md,docs/sources/ibm-psv-jp.md,docs/sources/pc9801-jp.md,docs/sources/pc9801-jp-demo.md— DMWeb citation added per port.Net delta
docs/formats/music.mddocs/formats/md-dat.mddocs/sources/overview.mddocs/sources/amiga-eu.mdNotescolumn)Commit footprint: 18 files changed, 433 insertions, 408 deletions.
Test plan
cargo test --workspace— 339 tests pass (unchanged; pure docs).cargo clippy --workspace --all-targets— clean.cargo doc --workspace --no-deps --locked— clean (Rust doc-comment cross-refs inmd_dat.rs,songlist.rs,lib.rsupdated).prettier --check docs/formats/music.md docs/sources/*.md ROADMAP.md docs/external-references.md—All matched files use Prettier code style!md-dat.mdare preserved in the newmusic.md § "Music routing tables"section, Part B deduplication was appropriate (no over-stripping), Part C DMWeb corrections applied consistently across all four target ports and both overview.md tables, all cross-references resolve, and the high-churn diffs onamiga-eu.mdandoverview.mdare explained by prettier widening table column widths after the longer corrected DMWeb strings were inserted.grep -rn 'md-dat\|md_dat\.md' docs/ ROADMAP.md crates/— only the intentional historical note inROADMAP.md:180remains; Rust filename / module references are out of scope for this PR.Out of scope
md_dat.rs/dm2_music::md_dat/MdDat/MdRecord/dm2_md_dat.ksy— separate PR to bikeshed the name (format2_routingvsmusic_routingvs other).