vgmstream

This is vgmstream, a library for playing streamed (prerecorded) video game audio.

Some of vgmstream's features:

• Hundreds of video game music formats and codecs, from typical game engine files to obscure single-game codecs, aiming for high accuracy and compatibility.
• Support for looped BGM, using file's internal metadata for smooth transitions, with accurate sample counts.
• Subsongs, playing a format's multiple internal songs separately.
• Many types of companion files (data split into multiple files) and custom containers.
• Encryption keys, internal stream names, and many other unusual cases found in game audio.
• TXTH function, to add external support for extra formats, including raw audio in many forms.
• TXTP function, for real-time and per-file config, like forced looping, removing channels, playing certain subsong, or fusing multiple files into a single one.
• Simple external tagging via .m3u files.
• Plugins are available for various media player software and operating systems.

The main development repository: https://github.com/vgmstream/vgmstream/

Automated builds with the latest changes: https://vgmstream.org/downloads

Common releases: https://github.com/vgmstream/vgmstream/releases

Help can be found here: https://www.hcs64.com/

More documentation: https://github.com/vgmstream/vgmstream/tree/master/doc

Getting vgmstream

There are multiple end-user components:

• test.exe/vgmstream-cli: A command-line decoder.
• in_vgmstream: A Winamp plugin.
• foo_input_vgmstream: A foobar2000 component.
• xmp-vgmstream: An XMPlay plugin.
• vgmstream.so: An Audacious plugin.
• vgmstream123: A command-line player.

The main library (plain vgmstream) is the code that handles the internal conversion, while the above components are what you use to get sound.

See components in the usage guide for install instructions and explanations. The aim is feature parity, but there are a few differences between them due to missing implementation on vgmstream's side or lack of support in target player or API.

Windows

You should get vgmstream-win.zip, which also bundles various components, or foo_input_vgmstream.fb2k-component for the installable foobar2000 plugin from the latest prebuilt binaries on our website:

• https://vgmstream.org/downloads

You can also get them from the less frequently updated releases on GitHub:

• https://github.com/vgmstream/vgmstream/releases

If the above links fail, you may also try the alternative, somewhat recent versions built by bnnm:

• https://github.com/bnnm/vgmstream-builds/raw/master/bin/vgmstream-latest-test-u.zip

If you prefer, you may compile the components from source as well, see the build guide for more information.

Linux

For convenience, releases distribute a command-line decoder in vgmstream-cli.zip. It is statically linked and should work on all systems running Linux kernel v3.2 and above.

• https://vgmstream.org/downloads
• https://github.com/vgmstream/vgmstream/releases

Building from source will also give you vgmstream.so, an Audacious plugin, and vgmstream123, a command-line player.

When building from source code, many components have to be installed or compiled separately. The build guide describes this process in more detail. For a quick build on Debian and Ubuntu-style distributions, run ./make-build-cmake.sh. The script will be installing various dependencies, so you may prefer to copy the commands from the file and run them one by one.

macOS

Please follow the build guide.

More info

• Usage guide
• List of supported audio formats
• Build guide
• TXTH file format
• TXTP file format

Enjoy! hcs