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 (https://github.com/vgmstream/vgmstream-releases/releases/tag/nightly)

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:

• 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.

If you want to convert game audio to .wav, try getting vgmstream-cli (see below) then drag-and-drop one or more files to the executable (support may vary per O.S. or distro). This should create (file.extension).wav, if the format is supported. More user-friendly would be installing a player like foobar2000 (for Windows) or Audacious (for Linux) and the vgmstream plugin. Then you can directly listen your files and set options like infinite looping, or convert to .wav with the player's options (also easier if your file has multiple "subsongs").

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

Note that vgmstream cannot encode (convert from .wav to a video game format), it only decodes (plays game audio).

Windows

Get the latest prebuilt binaries (CLI/plugins/etc) on our website:

• https://vgmstream.org

Or the less frequent "official" releases on GitHub:

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

The foobar2000 component is also available on https://www.foobar2000.org based on current release.

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

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

You may compile from source as well, see the build guide.

Linux

A prebuilt CLI binary is available. It's statically linked and should work on systems running Linux kernel v3.2 and above:

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

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

When building, many extra components have to be installed or compiled separately, which the build guide describes in detail. For a quick build on Debian and Ubuntu-style distributions run ./make-build-cmake.sh. The script will need to install various dependencies, so you may prefer to copy commands and run them manually.

macOS

A prebuilt CLI binary is available as well:

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

Otherwise follow the build guide.

More info

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

Enjoy! hcs