Skip to content

Document console sound formats (SPC, VGM, VGZ, GYM) in the Jukebox page #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gantoine merged 1 commit into from
Oct 4, 2026
Merged

Document console sound formats (SPC, VGM, VGZ, GYM) in the Jukebox page #165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/using/jukebox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,20 @@ roms/snes/chrono trigger/
鈹溾攢 chrono trigger.sfc
鈹斺攢 soundtrack/
鈹溾攢 01 - Chrono Trigger.flac
鈹斺攢 02 - Memories of Green.flac
鈹溾攢 02 - Memories of Green.flac
鈹斺攢 03 - Wind Scene.spc
```

Supported formats are `.mp3`, `.ogg`, `.oga`, `.opus`, `.m4a`, `.aac`, `.wav` and `.flac`.

Console sound files also work, and play in the browser through [game-music-emu](https://github.com/libgme/game-music-emu): `.spc` for the SNES, and `.vgm`, `.vgz` and `.gym` for the Sega Genesis/Mega Drive and other systems VGM covers. They're much smaller than rips (a whole SNES soundtrack as SPC is about 1 MB). Each file holds one song, so multi-song formats such as `.nsf` and `.gbs` aren't supported. SPC sets often ship as `.rsn` files, which are RAR archives, so extract the `.spc` files into the `soundtrack/` folder first.
Comment thread
sdornan marked this conversation as resolved.

Scanning reads each file's tags (title, artist, album, genre, year, track number, duration) and grabs the embedded cover if there is one. Drop in a properly tagged rip and it'll display correctly, while untagged files just show their filename.

Console sound files aren't read for tags yet. They show their filename and have no duration in the library, which also leaves them out of Free Radio and Decade Mix. Their length appears once they start playing.

Media keys and lock-screen controls don't work while a console sound file plays.

## Browsing

Tracks can be browsed several ways:
Expand Down
Loading