Cool_Tools/vgmstream
1
0
Fork 0
mirror of https://github.com/vgmstream/vgmstream.git synced 2024-11-24 06:50:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
bnnm 2021-12-31 17:45:00 +01:00
parent adc7fe23a2
commit b9516ff509
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -38,10 +38,20 @@ There are multiple end-user components:
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](doc/USAGE.md#components) in the *usage guide* for install instructions and
If you just want to convert game audio to `.wav`, easiest would be getting *test.exe/vgmstream-cli* (see
below) then drag-and-drop one or more files to the executable. This should create `(file.extension).wav`,
if the format is supported. More usable would be installing a music player like *foobar2000* (for
Windows) or *Audacious* (for Linux) then the appropriate component, so you can listen to VGM without
converting and set options like infinite looping.
See [components](doc/USAGE.md#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 implementation on vgmstream's side or lack of support in target player or API.
Note vgmstream cannot *encode* (convert from `.wav` to some video game format), it only *decodes*
(plays game audio).
### 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