Difference between revisions of "ScummVM Tools"

Jump to navigation Jump to search

ScummVM Tools (view source)

Revision as of 10:25, 5 April 2010

7,739 bytes added ,  10:25, 5 April 2010
Quick and dirty merge with the GUI version of the doc (from User Manual/Appendix: Tools/new)
m (→‎extract_loom_tg16: - Added another windows dumping option)
(Quick and dirty merge with the GUI version of the doc (from User Manual/Appendix: Tools/new))
Line 6: Line 6:


This is a collection of various tools that may be useful to use in conjunction with ScummVM. Please note that although a tool may support a feature, certain ScummVM versions may not. ScummVM 0.6.x does not support FLAC audio, for example.
This is a collection of various tools that may be useful to use in conjunction with ScummVM. Please note that although a tool may support a feature, certain ScummVM versions may not. ScummVM 0.6.x does not support FLAC audio, for example.
== Using the GUI ==
The recommended way to use the tools are using the tool GUI, run the program tool program.
Most common usage is to compress files, to do that, simply click Next as compression is the default activity. If you are compressing Touche data files, you need to select advanced mode and then compress_touche, as the tools do not support selecting the touche directory automatically.
[[Image:Toolguide1.png]]
Next select the input file, depending on the tool you are using, this file to be selected differs greatly. You can look in the list below for the expected extension or filename, if you don't know it already. For some games this is obvious as there only is a single data file. For games that ship on multiple disks, select the first disk on this page, you will be asked for the second disk on the next page.
In most cases, the tool to be used will be automatically detected, if there are multiple options, you must manually select the correct tool to be used, this is usually obvious from the name of the tool, if you are unsure, check the list of tools below.
[[Image:Toolguide2.png]]
In this case, the correct tool (compress_queen) was automatically detected. Now select the output directory, note that the directory '''must exist'''. Extraction tools usually generate a large amount of output files, while compression tools generate a single archive. Since ScummVM usually expects a specific filename for compressed archives, you should not change the default after extraction completes.
[[Image:Toolguide3.png]]
Next, you will be asked for target platform. This is the platform that you are running ScummVM on, '''not''' the platform you are running the tools on. Note that this does not make the output files incompatible with other platforms. Instead it affects the default audio settings to be optimized for the platform selected, as support for some are very poor on certain platform (and will make ScummVM run very slow).
[[Image:Toolguide4.png]]
Next page asks audio for audio format to use, in most cases you can leave this at the default setting. If you want to configure bitrate and quality settings manually, check the advanced options checkbox, and you can change this at the next page.
[[Image:Toolguide5.png]]
After this, the tool will run. This can take a while and if all went well, you can continue on to the next page. If an error occured, you can go back to adjust settings. Take
special care to note that some input files can cause the entire application to crash as many tools don't check too well for mal-formatted input files.
[[Image:Toolguide6.png]]
If all is well, advance to the next page to finish the guide! Enjoy your newly compressed/extracted data files!
[[Image:Toolguide7.png]]
== Using the CLI ==
You can access all tools through the command line interface using the following syntax:
./scummvm-tools-cli [audio mode params] [params] [-o output] [extract|compress] <inputfile N ...>
Normally, all arguments except the input file(s) can be skipped. You can specify extract or compress before the filename to hint the tool what activity you want to perform. In many cases, the tools will output to the directory "out/" relative to the input file, if no directory is specified.
Some tools take additional parameters, use --help <tool name> to display extra arguments for that tool.
Use --list to display a list of all supported tools.
Use the -o or --output flag to specify the output file, if it's a directory, it's strongly recommended to append / to the filename for clarity. Normally the tools will output to the directory "out/" relative to the input file, if no directory is specified, some tools output to a file instead of a directory.
You can also specify the tool explicitly to ignore automatic detection:
./scummvm-tools-cli --tool <tool name> [audio mode params] [params] [-o output] <inputfile N ...>
=== Audio mode params ===
You can specify what compression method to use. Use '''--mp3''', '''--flac''' or '''--vorbis''' first to select a special format, default is MP3.
==== MP3 mode params ====
*'''-b ''rate''''' &mdash; ''rate'' is the target bitrate(ABR)/minimal bitrate(VBR).
*'''-B ''rate''''' &mdash; ''rate'' is the maximum VBR/ABR bitrate.
*'''--vbr''' &mdash; LAME Uses the VBR mode (default).
*'''--abr''' &mdash; LAME Uses the ABR mode.
*'''-V ''value''''' &mdash; Specifies the value (0 - 9) of VBR quality (0 being the best quality).
*'''-q ''value''''' &mdash; Specifies the MPEG algorithm quality (0 - 9) (0 being the best quality).
*'''--silent''' &mdash; The output of LAME is hidden.
==== Vorbis mode params ====
*'''-b ''rate''''' &mdash; ''rate'' is the nominal bitrate.
*'''-m ''rate''''' &mdash; ''rate'' is the minimum bitrate.
*'''-M ''rate''''' &mdash; ''rate'' is the maximum bitrate.
*'''-q ''value''''' &mdash; Specifies the value (0 - 10) of VBR quality 10 is best quality.
*'''--silent''' &mdash; The output of oggenc is hidden.
==== Flac mode params ====
*'''--fast''' &mdash; FLAC uses compression level 0.
*'''--best''' &mdash; FLAC uses compression level 8.
*'''-''value''''' &mdash; Specifies the ''value'' (0 - 8) of compression, with 8 being the best quality.
*'''-b ''value''''' &mdash; Specifies a blocksize of ''value'' samples, must be a multiple of 8 between 8 and 160.
*'''--verify'''' &mdash; Files are encoded and then decoded to check accuracy.
*'''--silent''' &mdash; The output of FLAC is hidden.


== Compression Tools ==
== Compression Tools ==
=== compress_scumm_sou ===
Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
or .sof (FLAC).


=== compress_agos ===
=== compress_agos ===
Used to compress the Feeble Files or Simon 1/2 voc/wav files
Used to compress the Feeble Files or Simon 1/2 voc/wav files
to MP3, Vorbis or FLAC.
to MP3, Vorbis or FLAC.
Example of usage:
  ./scummvm-tools-cli --tool compress_agos --vorbis -q 7 SIMON2.WAV
=== compress_gob ===
Pending content...
=== compress_kyra ===
Used to compress The Legend of Kyrandia's speech files with
MP3, Vorbis or FLAC.
Example of usage:
  ./scummvm-tools-cli --tool compress_kyra <flags here> input/GEMCUT.VRM output/GEMCUT.VRM
Note: You have to keep the VRM extension, else it will NOT work.
Use it like shown above, copy all *.VRM files to a directory
and let the tool put the output file in another directory.


=== compress_queen ===
=== compress_queen ===
Used to rebuild the datafile of Flight of the Amazon Queen,
Used to rebuild the datafile of Flight of the Amazon Queen,
and allow optional MP3, Vorbis or FLAC compression.
and allow optional MP3, Vorbis or FLAC compression.
Example of usage:
  ./scummvm-tools-cli --tool compress_queen <flags here> [-o outputfile] queen.1
The default output file is "queen.1c"


=== compress_saga ===
=== compress_saga ===
Line 25: Line 122:


Example of usage:
Example of usage:
   compress_saga <flags here> <file>
   ./scummvm-tools-cli --tool compress_saga <flags here> <file>


Where <file> is the sound file you with to compress, without the
Where <file> is the sound file you with to compress, without the
Line 42: Line 139:
- The unsupported early DOS demo of Inherit the Earth
- The unsupported early DOS demo of Inherit the Earth


=== compress_sword1 ===
=== compress_scumm_bun ===
Used to compress Broken Sword 1's music and speech files to
Used to the compress '.bun' music/voice files with MP3, Vorbis
MP3 or Vorbis or FLAC.
or FLAC.


=== compress_sword2 ===
Example of usage:
Used to compress Broken Sword 2's music and speech .clu
  ./scummvm-tools-cli --tool compress_scumm_bun --flac digmusic.bun uncomp comp
files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).


Please note that FLAC compression will produce a larger file
Please note that FLAC compression will produce larger files
than the original! This is because the original files already
than the original, for The Curse of Monkey Island!
use lossy compression.
 
=== compress_touche ===
Used to compress and pack Touche speech files ('Vxxx' and
'OBJ') to MP3, Vorbis or FLAC to a single file named
TOUCHE.SO3/.SOG/.SOF depending on the sound compression. Once
compressed, only TOUCHE.DAT and TOUCHE.SOx files are required
to play the game under ScummVM.


=== compress_scumm_san ===
=== compress_scumm_san ===
Line 67: Line 155:


Example of usage:
Example of usage:
   compress_scumm_san opening.san uncomp comp
   ./scummvm-tools-cli --tool compress_scumm_san opening.san uncomp/ comp/


In order to use such compressed files, your ScummVM binary
In order to use such compressed files, your ScummVM binary
Line 83: Line 171:
move the '.flu' files, too!
move the '.flu' files, too!


=== compress_scumm_bun ===
=== compress_scumm_sou ===
Used to the compress '.bun' music/voice files with MP3, Vorbis
Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
or FLAC.
or .sof (FLAC).
 
Example of usage:
  ./scummvm-tools-cli --tool compress_scumm_sou --mp3 MONSTER.SOU
or simply:
  ./scummvm-tools-cli --mp3 MONSTER.SOU
 
=== compress_sword1 ===
Used to compress Broken Sword 1's music and speech files to 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:
Example of usage:
   compress_scumm.bun digmusic.bun uncomp comp --flac
./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


Please note that FLAC compression will produce larger files
=== compress_sword2 ===
than the original, for The Curse of Monkey Island!
Used to compress Broken Sword 2's music and speech .clu
files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
 
Please note that FLAC compression will produce a larger file
than the original! This is because the original files already
use lossy compression.
 
=== compress_tinsel ===
Pending content...


=== compress_kyra ===
=== compress_touche ===
Used to compress The Legend of Kyrandia's speech files with
Used to compress and pack Touche speech files ('Vxxx' and
MP3, Vorbis or FLAC.
'OBJ') to MP3, Vorbis or FLAC to a single file named
TOUCHE.SO3/.SOG/.SOF depending on the sound compression. Once
compressed, only TOUCHE.DAT and TOUCHE.SOx files are required
to play the game under ScummVM.


Example of usage:
Example of usage:
   compress_kyra <flags here> input/GEMCUT.VRM output/GEMCUT.VRM
   ./scummvm-tools-cli --tool compress_touche <flags here> [-o outputfile] <file>
 
Default outpufile is the name of the input file with modified extension (depends on compression method).


Note: You have to keep the VRM extension, else it will NOT work.
=== compress_tucker ===
Use it like shown above, copy all *.VRM files to a directory
Used to compress .wav files from FX/MUSIC/SPEECH directories to a single file named TUCKER.SOx Once compressed, the 3 directories aren't required to play the game under ScummVM.
and let the tool put the output file in another directory.


== Encoder Tools ==
== Encoder Tools ==
Line 157: Line 273:
Extracts the packed files used in the Amiga and AtariST
Extracts the packed files used in the Amiga and AtariST
versions of Elvira 1/2, Waxworks and Simon the Sorcerer 1.
versions of Elvira 1/2, Waxworks and Simon the Sorcerer 1.
=== extract_cine ===
...
=== extract_gob_stk ===
...


=== extract_kyra ===
=== extract_kyra ===
Unpacks .PAK files from Kyrandia games.
Unpacks .PAK files from Kyrandia games.
=== extract_scumm_mac ===
Extracts Macintosh "single file" SCUMM games into their
component parts, for use with ScummVM.
This is required for ScummVM up to version 0.6.x; all
later versions directly support reading this file
format.


=== extract_loom_tg16 ===
=== extract_loom_tg16 ===
Line 200: Line 315:
=== extract_parallaction ===
=== extract_parallaction ===
Extracts the contents of archives used by Nippon Safes
Extracts the contents of archives used by Nippon Safes
=== extract_scumm_mac ===
Extracts Macintosh "single file" SCUMM games into their
component parts, for use with ScummVM.
This is required for ScummVM up to version 0.6.x; all
later versions directly support reading this file
format.
=== extract_t7g_mac ===
...


=== extract_zak_c64 ===
=== extract_zak_c64 ===
Criezy
TrustedUser
2,147

edits

Retrieved from "https://wiki.scummvm.org/index.php?title=Special:MobileDiff/13373"

Navigation menu