TrustedUser
2,147
edits
m (more rename of tools_cli into scummvm-tools-cli) |
(→compress_sword1: write doc for compress_sword1) |
||
Line 176: | Line 176: | ||
=== compress_sword1 === | === compress_sword1 === | ||
Used to compress Broken Sword 1's music and speech files to | Used to compress Broken Sword 1's music and speech files to MP3 or Vorbis or FLAC. | ||
MP3 or Vorbis or FLAC. | Only the PC and the Mac version are currently supported. The PSX version is not supported by this tool. | ||
Example of usage: | |||
./scummvm-tools-cli --tool compress_sword1 --vorbis -q 7 BS1/swordres.rif | |||
The input file (in that case BS1/swordres.rif) can be any file at the root of the directory that contains the Broken Sword data files. When the tool is auto-detected (i.e. when not using the --tool flag), the input file should be either the swordres.rif file or one of the cluster file (*.clu for the PC version or *.clm for the mac version). | |||
The tool will look for the speech and the music files in the SPEECH/ and MUSIC/ sub-directories respectively (e.g. BS1/SPEECH/speech1.clu). If they are not found there, it then looks for them directly at the root of the input directory (e.g. BS1/speech1.clu). The compressed files will also be created in the MUSIC/ and SPEECH/ sub-directories of the output directory if these sub-directories exist. Otherwise the compressed files will be created at the root of the output directory. | |||
It is possible to compress only the speech files or the music files using the '''--speech-only''' or '''--music-only''' flags: | |||
./scummvm-tools-cli --tool compress_sword1 --vorbis --speech-only BS1/swordres.rif | |||
=== compress_sword2 === | === compress_sword2 === |