Document console sound formats (SPC, VGM, VGZ, GYM) in the Jukebox page - #165
Merged
Merged
Conversation
List SPC, VGM, VGZ and GYM as soundtrack formats, note that they play through game-music-emu, and cover their current limits (no tags or catalog duration, no media keys). Adds an .spc line to the example tree. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RYuuiD5sUCyKqJ5AP1jZcU
Contributor
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
Although #5079 is now merged, a maintainer must confirm its release has shipped before merging these versioned docs.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Updates the Jukebox guide for console soundtrack support introduced by rommapp/romm#5079.
Changes:
- Documents SPC, VGM, VGZ and GYM playback and archive extraction.
- Explains metadata, radio and media-control limitations.
- Adds an SPC track to the folder example.
| File | Description |
|---|---|
docs/using/jukebox.md |
Adds console format guidance, limitations and a mixed-format example. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
gantoine
approved these changes
Oct 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the four single-song console sound formats from rommapp/romm#5079 to
docs/using/jukebox.md.Don't merge until a romm release that includes rommapp/romm#5079 ships. The docs are versioned with
mike. #5079 merged tomasterbut hasn't been released yet..spc,.vgm,.vgzand.gymafter the existing formats. Notes that they play in the browser through game-music-emu, that multi-song formats (.nsf,.gbs) aren't supported, and that.rsnSPC sets need extracting first.03 - Wind Scene.spcto the example tree, so readers see the formats can share a folder.folder-structure.md,glossary.mdanduploads.mdmentionsoundtrack/only generically, so they're unchanged. The "complete rescan for files already on disk" caveat belongs in the romm release notes, not here.Checks
uv run mkdocs build --strictpasses.trunk checkcouldn't download its plugins in the authoring environment (HTTP 403). The same linters ran directly instead: prettier 3.5.2 and markdownlint-cli 0.45.0 with the repo's.trunk/configs, plusgit diff --check. All clean.🤖 Generated with Claude Code
https://claude.ai/code/session_01RYuuiD5sUCyKqJ5AP1jZcU