TrustedUser, Bureaucrats, Administrators
442
edits
Difference between revisions of "ScummVM Tools"
Adds link to tools package download on website
m (Cadi moved page User Manual/Appendix: Tools to ScummVM Tools: Remove page from the user manual appendix to standalone page) |
(Adds link to tools package download on website) |
||
| Line 1: | Line 1: | ||
{| border="0" cellpadding="2" cellspacing="1" style="margin:1em; background:#FF0000;" | {| border="0" cellpadding="2" cellspacing="1" style="margin:1em; background:#FF0000;" | ||
|- style="background:#ffffff" | |- style="background:#ffffff" | ||
| Line 5: | Line 4: | ||
|} | |} | ||
This is a collection of various tools that may be useful to use in conjunction with ScummVM. | This is a collection of various tools that may be useful to use in conjunction with ScummVM. To download the Tools package, go to the ScummVM [https://www.scummvm.org/downloads/#tools Downloads page] | ||
== Using the GUI == | ==Using the GUI== | ||
The recommended way to use the tools are using the tool GUI, run the program tool program. | The recommended way to use the tools are using the tool GUI, run the program tool program. | ||
| Line 43: | Line 42: | ||
[[Image:Toolguide7.png]] | [[Image:Toolguide7.png]] | ||
== Using the CLI == | ==Using the CLI== | ||
You can access all tools through the command line interface using the following syntax: | You can access all tools through the command line interface using the following syntax: | ||
| Line 60: | Line 59: | ||
./scummvm-tools-cli --tool <tool name> [audio mode params] [params] [-o output] <inputfile N ...> | ./scummvm-tools-cli --tool <tool name> [audio mode params] [params] [-o output] <inputfile N ...> | ||
=== Audio mode params === | ===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. | 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 (version 1.1.1) ==== | ====MP3 mode params (version 1.1.1)==== | ||
*'''-b ''rate''''' — ''rate'' is the target bitrate(ABR)/minimal bitrate(VBR). | *'''-b ''rate''''' — ''rate'' is the target bitrate(ABR)/minimal bitrate(VBR). | ||
*'''-B ''rate''''' — ''rate'' is the maximum ABR/VBR bitrate. | *'''-B ''rate''''' — ''rate'' is the maximum ABR/VBR bitrate. | ||
| Line 73: | Line 72: | ||
*'''--lame-path''' — Specifies the path to lame (default: lame). | *'''--lame-path''' — Specifies the path to lame (default: lame). | ||
==== MP3 mode params (version 1.2.0svn) ==== | ====MP3 mode params (version 1.2.0svn)==== | ||
*'''--vbr''' — LAME Uses the VBR mode (default). | *'''--vbr''' — LAME Uses the VBR mode (default). | ||
*'''--abr ''rate''''' — LAME Uses the ABR mode with the given target bit rate. | *'''--abr ''rate''''' — LAME Uses the ABR mode with the given target bit rate. | ||
| Line 84: | Line 83: | ||
*'''--lame-path''' — Specifies the path to lame (default: lame). | *'''--lame-path''' — Specifies the path to lame (default: lame). | ||
==== Vorbis mode params ==== | ====Vorbis mode params==== | ||
*'''-b ''rate''''' — ''rate'' is the nominal bitrate. | *'''-b ''rate''''' — ''rate'' is the nominal bitrate. | ||
*'''-m ''rate''''' — ''rate'' is the minimum bitrate. | *'''-m ''rate''''' — ''rate'' is the minimum bitrate. | ||
| Line 91: | Line 90: | ||
*'''--silent''' — The output of oggenc is hidden. | *'''--silent''' — The output of oggenc is hidden. | ||
==== Flac mode params ==== | ====Flac mode params==== | ||
*'''--fast''' — FLAC uses compression level 0. | *'''--fast''' — FLAC uses compression level 0. | ||
*'''--best''' — FLAC uses compression level 8. | *'''--best''' — FLAC uses compression level 8. | ||
| Line 99: | Line 98: | ||
*'''--silent''' — The output of FLAC is hidden. | *'''--silent''' — The output of FLAC is hidden. | ||
== Compression Tools == | ==Compression Tools== | ||
=== 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. | ||
| Line 108: | Line 107: | ||
./scummvm-tools-cli --tool compress_agos --vorbis -q 7 SIMON2.WAV | ./scummvm-tools-cli --tool compress_agos --vorbis -q 7 SIMON2.WAV | ||
=== compress_gob === | ===compress_gob=== | ||
Compresses Gobliiins! data files. | Compresses Gobliiins! data files. | ||
=== compress_kyra === | ===compress_kyra=== | ||
Used to compress The Legend of Kyrandia's speech files with | Used to compress The Legend of Kyrandia's speech files with | ||
MP3, Vorbis or FLAC. | MP3, Vorbis or FLAC. | ||
| Line 133: | Line 132: | ||
The default output file is "queen.1c" | The default output file is "queen.1c" | ||
=== compress_saga === | === compress_saga=== | ||
Used to compress SAGA engine digital sound files to MP3, Vorbis | Used to compress SAGA engine digital sound files to MP3, Vorbis | ||
or FLAC. | or FLAC. | ||
| Line 152: | Line 151: | ||
There is no compression support yet for the following versions: | There is no compression support yet for the following versions: | ||
* The Mac CD Guild version of Inherit the Earth (uses MacBinary *.bin files) | *The Mac CD Guild version of Inherit the Earth (uses MacBinary *.bin files) | ||
* The unsupported early DOS demo of Inherit the Earth | *The unsupported early DOS demo of Inherit the Earth | ||
=== compress_sci === | ===compress_sci === | ||
Used to compress Sierra resource.aud/.sfx and AUDIO001.002 files. This tool is not compatible with SCI32 games! | Used to compress Sierra resource.aud/.sfx and AUDIO001.002 files. This tool is not compatible with SCI32 games! | ||
| Line 161: | Line 160: | ||
./scummvm-tools-cli --tool compress_sci --vorbis [-o output] resource.aud | ./scummvm-tools-cli --tool compress_sci --vorbis [-o output] resource.aud | ||
=== compress_scumm_bun === | ===compress_scumm_bun=== | ||
Used to the compress '.bun' music/voice files with MP3, Vorbis | Used to the compress '.bun' music/voice files with MP3, Vorbis | ||
or FLAC. | or FLAC. | ||
| Line 171: | Line 170: | ||
than the original, for The Curse of Monkey Island! | than the original, for The Curse of Monkey Island! | ||
=== compress_scumm_san === | ===compress_scumm_san === | ||
Compresses '.san' smush animation files. It uses lossless | Compresses '.san' smush animation files. It uses lossless | ||
zlib for compressing FOBJ gfx chunks inside a san file. | zlib for compressing FOBJ gfx chunks inside a san file. | ||
| Line 193: | Line 192: | ||
move the '.flu' files, too! | move the '.flu' files, too! | ||
=== compress_scumm_sou === | ===compress_scumm_sou=== | ||
Used to compress .sou files to .so3 (MP3), .sog (Vorbis), | Used to compress .sou files to .so3 (MP3), .sog (Vorbis), | ||
or .sof (FLAC). | or .sof (FLAC). | ||
| Line 202: | Line 201: | ||
./scummvm-tools-cli --mp3 MONSTER.SOU | ./scummvm-tools-cli --mp3 MONSTER.SOU | ||
=== compress_sword1 === | ===compress_sword1 === | ||
Used to compress Broken Sword 1's music and speech files to MP3 or Vorbis or FLAC. | 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. | Only the PC and the Mac version are currently supported. The PSX version is not supported by this tool. | ||
| Line 216: | Line 215: | ||
./scummvm-tools-cli --tool compress_sword1 --vorbis --speech-only BS1/swordres.rif | ./scummvm-tools-cli --tool compress_sword1 --vorbis --speech-only BS1/swordres.rif | ||
=== compress_sword2 === | ===compress_sword2=== | ||
Used to compress Broken Sword 2's music and speech .clu | Used to compress Broken Sword 2's music and speech .clu | ||
files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC). | files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC). | ||
| Line 224: | Line 223: | ||
use lossy compression. | use lossy compression. | ||
=== compress_tinsel === | ===compress_tinsel=== | ||
Used to compress tinsel .smp files. | Used to compress tinsel .smp files. | ||
=== compress_touche === | ===compress_touche=== | ||
Used to compress and pack Touche speech files ('Vxxx' and | Used to compress and pack Touche speech files ('Vxxx' and | ||
'OBJ') to MP3, Vorbis or FLAC to a single file named | 'OBJ') to MP3, Vorbis or FLAC to a single file named | ||
| Line 241: | Line 240: | ||
The ''inputdir'' should be the directory that contains all the touche data files (''TOUCHE.DAT'', ''OBJ'' and the ''Vxxx'' files). | The ''inputdir'' should be the directory that contains all the touche data files (''TOUCHE.DAT'', ''OBJ'' and the ''Vxxx'' files). | ||
=== compress_tucker === | ===compress_tucker=== | ||
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. | 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. | ||
== Encoder Tools == | ==Encoder Tools== | ||
=== encode_dxa <filename> === | ===encode_dxa <filename>=== | ||
Creates DXA file out of extracted Smacker video. | Creates DXA file out of extracted Smacker video. | ||
| Line 274: | Line 273: | ||
and conversion options work the same. | and conversion options work the same. | ||
=== convert_dxa.bat, convert_dxa_one.bat === | === convert_dxa.bat, convert_dxa_one.bat=== | ||
To ease your life we also provide batch files to autoconvert | To ease your life we also provide batch files to autoconvert | ||
all files. It should work with any game version. | all files. It should work with any game version. | ||
| Line 287: | Line 286: | ||
press OK | press OK | ||
=== convert_dxa.sh === | ===convert_dxa.sh=== | ||
Same as above convert_dxa.bat, just for *nix-based systems. | Same as above convert_dxa.bat, just for *nix-based systems. | ||
It uses Wine to run RAD Game Tools. | It uses Wine to run RAD Game Tools. | ||
== Extraction Tools == | ==Extraction Tools== | ||
Many games package together all their game data in a few big archive files. The following tools can be used to extract these archives, and in some cases are needed to make certain game versions usable with ScummVM. In general, though, they are mostly intended for ScummVM developers and not useful to end users. | Many games package together all their game data in a few big archive files. The following tools can be used to extract these archives, and in some cases are needed to make certain game versions usable with ScummVM. In general, though, they are mostly intended for ScummVM developers and not useful to end users. | ||
=== extract_agos === | ===extract_agos === | ||
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. | ||
| Line 301: | Line 300: | ||
./scummvm-tools-cli --tool extract_agos <infile 1> ... <infile n> | ./scummvm-tools-cli --tool extract_agos <infile 1> ... <infile n> | ||
=== extract_cge === | ===extract_cge=== | ||
Unpack Soltys and Sfinx game data files. | Unpack Soltys and Sfinx game data files. | ||
| Line 310: | Line 309: | ||
See also the [[#pack_cge|re-packaging tool]] for the Soltys game files. | See also the [[#pack_cge|re-packaging tool]] for the Soltys game files. | ||
=== extract_cine === | === extract_cine=== | ||
Unpacks Delphine's Cinematique engine's archive files. Should work at least with Future Wars and Operation Stealth. It seems to also work with Cruise for a Corpse. | Unpacks Delphine's Cinematique engine's archive files. Should work at least with Future Wars and Operation Stealth. It seems to also work with Cruise for a Corpse. | ||
It accepts only one input file. This may be either one of the archive file, in which case only this file is unpacked, or the 'vol.cnf' file, in which case all archive files listed in the 'vol.cnf' file are unpacked. | It accepts only one input file. This may be either one of the archive file, in which case only this file is unpacked, or the 'vol.cnf' file, in which case all archive files listed in the 'vol.cnf' file are unpacked. | ||
| Line 317: | Line 316: | ||
./scummvm-tools-cli --tool extract_cine [-o outputdir] <infile> | ./scummvm-tools-cli --tool extract_cine [-o outputdir] <infile> | ||
=== extract_cruise_pc === | ===extract_cruise_pc=== | ||
Unpack the E1, E4 and E5 files found in some versions of Cruise for a Corpse. To extract the D1 to D5 files, use the extract_cine tool instead. | Unpack the E1, E4 and E5 files found in some versions of Cruise for a Corpse. To extract the D1 to D5 files, use the extract_cine tool instead. | ||
| Line 323: | Line 322: | ||
./scummvm-tools-cli --tool extract_cruise_pc [-o outputdir] <infile> | ./scummvm-tools-cli --tool extract_cruise_pc [-o outputdir] <infile> | ||
=== extract_fascination_cd === | ===extract_fascination_cd=== | ||
Extract the hidden STK from Fascination CD. It's designed to work on ISO files of the first data track only i.e. ~11M, not 652M. If your CD reading tool does not support single track ISO creation, this can be created using a tool such as "dd" to truncate the ISO dump. | Extract the hidden STK from Fascination CD. It's designed to work on ISO files of the first data track only i.e. ~11M, not 652M. If your CD reading tool does not support single track ISO creation, this can be created using a tool such as "dd" to truncate the ISO dump. | ||
=== extract_gob_stk === | === extract_gob_stk=== | ||
Extract the files from a Stick file used by 'gob' engine (.STK/.ITK/.LTK). | Extract the files from a Stick file used by 'gob' engine (.STK/.ITK/.LTK). | ||
=== extract_kyra === | === extract_kyra=== | ||
Unpacks .PAK files from Kyrandia games. | Unpacks .PAK files from Kyrandia games. | ||
| Line 339: | Line 338: | ||
./scummvm-tools-cli --tool extract_kyra -x [-o outputdir] <infile> | ./scummvm-tools-cli --tool extract_kyra -x [-o outputdir] <infile> | ||
=== extract_loom_tg16 === | ===extract_loom_tg16=== | ||
Extracts data files from the PC-Engine version of Loom. | Extracts data files from the PC-Engine version of Loom. | ||
| Line 358: | Line 357: | ||
You may compile dumpcd using the source code available [[https://adrianastley.com/files/scummvm/dumpcd-0.1.zip here]]. | You may compile dumpcd using the source code available [[https://adrianastley.com/files/scummvm/dumpcd-0.1.zip here]]. | ||
=== extract_mm_apple === | ===extract_mm_apple=== | ||
Extracts data files from the Apple II version of Maniac | Extracts data files from the Apple II version of Maniac | ||
Mansion. | Mansion. | ||
=== extract_mm_c64 === | ===extract_mm_c64 === | ||
Extracts data files from the Commodore 64 version of Maniac | Extracts data files from the Commodore 64 version of Maniac | ||
Mansion. | Mansion. | ||
=== extract_mm_nes === | ===extract_mm_nes === | ||
Extracts data files from the NES version of Maniac Mansion. | Extracts data files from the NES version of Maniac Mansion. | ||
=== 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 === | ===extract_scumm_mac === | ||
Extracts Macintosh "single file" SCUMM games into their | Extracts Macintosh "single file" SCUMM games into their | ||
component parts, for use with ScummVM. | component parts, for use with ScummVM. | ||
| Line 382: | Line 381: | ||
Extract data files from the The 7th Guest Macintosh data file. | Extract data files from the The 7th Guest Macintosh data file. | ||
=== extract_zak_c64 === | ===extract_zak_c64=== | ||
Extracts data files from the Commodore 64 version of Zak | Extracts data files from the Commodore 64 version of Zak | ||
McKracken. | McKracken. | ||
=== pack_cge === | ===pack_cge=== | ||
Pack Soltys and Sfinx game data files (as such this is not really an extraction tool, see [[#extract_cge|extract_cge]] for the extraction tool). | Pack Soltys and Sfinx game data files (as such this is not really an extraction tool, see [[#extract_cge|extract_cge]] for the extraction tool). | ||
| Line 395: | Line 394: | ||
The following tools can be used to analyze the game scripts (controlling the behavior of certain scenes and actors in a game). They are intended for use by developers, and as such in general not helpful to normal users. | The following tools can be used to analyze the game scripts (controlling the behavior of certain scenes and actors in a game). They are intended for use by developers, and as such in general not helpful to normal users. | ||
=== decine === | ===decine=== | ||
Decompiles Delphine's Cinematique engine's scripts. | Decompiles Delphine's Cinematique engine's scripts. | ||
Should work at least with Future Wars and Operation Stealth. | Should work at least with Future Wars and Operation Stealth. | ||
| Line 406: | Line 405: | ||
filename: The name of the script file to decode | filename: The name of the script file to decode | ||
=== degob === | === degob=== | ||
Decompiles TOT scripts used in Coktel Vision games | Decompiles TOT scripts used in Coktel Vision games | ||
| Line 416: | Line 415: | ||
If the script file calls loadMult(), the script file's EXT file must be supplied on the command line as well; some script files also require a commun.ext. degob throws an error to let you know if any of the two should be the case. | If the script file calls loadMult(), the script file's EXT file must be supplied on the command line as well; some script files also require a commun.ext. degob throws an error to let you know if any of the two should be the case. | ||
=== dekyra === | ===dekyra=== | ||
Basic script disassembler for Legend of Kyrandia games | Basic script disassembler for Legend of Kyrandia games | ||
=== descumm === | ===descumm=== | ||
Decompiles SCUMM scripts. | Decompiles SCUMM scripts. | ||
| Line 462: | Line 461: | ||
If the script has been "unblocked", it is missing the header information as described in [[SCUMM/Technical_Reference/Script_resources]]. This information is not necessary to interperet the code, but you must tell descumm if is not present via the "-u" option. | If the script has been "unblocked", it is missing the header information as described in [[SCUMM/Technical_Reference/Script_resources]]. This information is not necessary to interperet the code, but you must tell descumm if is not present via the "-u" option. | ||
=== desword2 === | ===desword2=== | ||
Disassembles Broken Sword II scripts | Disassembles Broken Sword II scripts | ||
== Other Tools == | ==Other Tools== | ||
=== pack_bladerunner === | ===pack_bladerunner=== | ||
Can be used to pack the four "CDFRAMES.DAT" files from the four Blade Runner CDs into a single "HDFRAMES.DAT" file (this is the file that the original game installer creates) which should be copied into the game's directory. | Can be used to pack the four "CDFRAMES.DAT" files from the four Blade Runner CDs into a single "HDFRAMES.DAT" file (this is the file that the original game installer creates) which should be copied into the game's directory. | ||
Syntax: | Syntax: | ||
| Line 475: | Line 474: | ||
Note that '''an alternative method''', also supported by ScummVM, is to simply copy the "CDFRAMES.DAT" files from each CD directly into the game directory; the "CDFRAMES.DAT" files would still have to be renamed as ''"CDFRAMES1.DAT", "CDFRAMES2.DAT", "CDFRAMES3.DAT", "CDFRAMES4.DAT"'' as above, so that they are properly detected by ScummVM. | Note that '''an alternative method''', also supported by ScummVM, is to simply copy the "CDFRAMES.DAT" files from each CD directly into the game directory; the "CDFRAMES.DAT" files would still have to be renamed as ''"CDFRAMES1.DAT", "CDFRAMES2.DAT", "CDFRAMES3.DAT", "CDFRAMES4.DAT"'' as above, so that they are properly detected by ScummVM. | ||
=== create_sjisfnt === | === create_sjisfnt=== | ||
Allows the creation of a Shift JIS Japanese font from a compatible truetype font (sazanami-mincho.ttf / kochi-mincho.ttf) | Allows the creation of a Shift JIS Japanese font from a compatible truetype font (sazanami-mincho.ttf / kochi-mincho.ttf) | ||