Difference between revisions of "ScummVM Tools"

Jump to navigation Jump to search

ScummVM Tools (view source)

Revision as of 21:40, 28 May 2019

5,188 bytes added ,  21:40, 28 May 2019
Add compress_sci tool
m (→‎compress_saga: formatting)
(Add compress_sci tool)
(28 intermediate revisions by 8 users not shown)
Line 15: Line 15:


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.
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.
Sometime a tool is applied on a single file, but the game may contain many such file. By selecting ''Run on all files with the same extension'' you can automatically run the tool on all the files with the same extension and present in the same directory as the selected input file. For example you can run [[User_Manual/Appendix:_Tools#compress_scumm_san|compress_scumm_san]] on all the SAN file of a game.


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.
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.
Line 61: Line 63:
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 ====
==== 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 VBR/ABR bitrate.
*'''-B ''rate''''' — ''rate'' is the maximum ABR/VBR bitrate.
*'''--vbr''' — LAME Uses the VBR mode (default).
*'''--vbr''' — LAME Uses the VBR mode (default).
*'''--abr''' — LAME Uses the ABR mode.
*'''--abr''' — LAME Uses the ABR mode.
Line 69: Line 71:
*'''-q ''value''''' — Specifies the MPEG algorithm quality (0 - 9) (0 being the best quality).
*'''-q ''value''''' — Specifies the MPEG algorithm quality (0 - 9) (0 being the best quality).
*'''--silent''' — The output of LAME is hidden.
*'''--silent''' — The output of LAME is hidden.
*'''--lame-path''' — Specifies the path to lame (default: lame).
==== MP3 mode params (version 1.2.0svn) ====
*'''--vbr''' — LAME Uses the VBR mode (default).
*'''--abr ''rate''''' — LAME Uses the ABR mode with the given target bit rate.
*'''--cbr ''rate''''' — LAME Uses the CBR mode with the given bit rate.
*'''-b ''rate''''' — ''rate'' is the minimum ABR/VBR bitrate (undefined by default).
*'''-B ''rate''''' — ''rate'' is the maximum ABR/VBR bitrate (undefined by default).
*'''-V ''value''''' — Specifies the value (0 - 9) of VBR quality (0 being the best quality).
*'''-q ''value''''' — Specifies the MPEG algorithm quality (0 - 9) (0 being the best quality).
*'''--silent''' — The output of LAME is hidden.
*'''--lame-path''' — Specifies the path to lame (default: lame).


==== Vorbis mode params ====
==== Vorbis mode params ====
Line 74: Line 88:
*'''-m ''rate''''' — ''rate'' is the minimum bitrate.
*'''-m ''rate''''' — ''rate'' is the minimum bitrate.
*'''-M ''rate''''' — ''rate'' is the maximum bitrate.
*'''-M ''rate''''' — ''rate'' is the maximum bitrate.
*'''-q ''value''''' — Specifies the value (0 - 10) of VBR quality 10 is best quality.
*'''-q ''value''''' — Specifies the value (-1 - 10) of VBR quality 10 is best quality.
*'''--silent''' — The output of oggenc is hidden.
*'''--silent''' — The output of oggenc is hidden.


Line 138: Line 152:
* 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 ===
Used to compress Sierra resource.aud/.sfx and AUDIO001.002 files. This tool is not compatible with SCI32 games!
Example of usage:
  ./scummvm-tools-cli --tool compress_sci --vorbis [-o output] resource.aud


=== compress_scumm_bun ===
=== compress_scumm_bun ===
Line 203: Line 223:


=== compress_tinsel ===
=== compress_tinsel ===
Pending content...
Used to compress tinsel .smp files.


=== compress_touche ===
=== compress_touche ===
Line 213: Line 233:


Example of usage:
Example of usage:
   ./scummvm-tools-cli --tool compress_touche <flags here> [-o outputfile] <file>
   ./scummvm-tools-cli --tool compress_touche <flags here> [-o outputfile] <inputdir>
 
If no ''outputfile'' is provided, or if it is a directory, the file will be named ''TOUCHE.XXX'', where XXX depends on the compression method, and will be created in the output directory if one is given, or the current directory otherwise.


Default outpufile is the name of the input file with modified extension (depends on compression method).
The ''inputdir'' should be the directory that contains all the touche data files (''TOUCHE.DAT'', ''OBJ'' and the ''Vxxx'' files).


=== compress_tucker ===
=== compress_tucker ===
Line 276: Line 298:
Example of usage:
Example of usage:
  ./scummvm-tools-cli --tool extract_agos <infile 1> ... <infile n>
  ./scummvm-tools-cli --tool extract_agos <infile 1> ... <infile n>
=== extract_cge ===
Unpack Soltys and Sfinx game data files.
Example of usage:
./scummvm-tools-cli --tool extract_cge [-o outputdir] <inputfile>
The <inputfile> has to be either the vol.cat or the vol.dat file.
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.
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.
Supports using Operation Stealth's 'vol.cnf' file as input in which case it will try to unpack all the archive files listed in 'vol.cnf'. Accepts only one input file.
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.
 
Example of usage:
./scummvm-tools-cli --tool extract_cine [-o outputdir] <infile>
 
=== 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.


Example of usage:
Example of usage:
  ./scummvm-tools-cli --tool extract_cine <infile>
  ./scummvm-tools-cli --tool extract_cruise_pc [-o outputdir] <infile>
 
=== 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_gob_stk ===
=== extract_gob_stk ===
Line 304: Line 344:
'''Windows'''
'''Windows'''


Use dumpcd [[http://www.zeograd.com/misc_download.php dumpcd]]/[[http://gracesdisposal.bpweb.net/LOOM/ISO%20TOOLS/DUMPCD%20WIN/ GUI]]
Use dumpcd [[http://www.zeograd.com/misc_download.php dumpcd Link]]/[[https://adrianastley.com/files/scummvm/dumpcd.exe.gz Alternative Link]]
 
Alternatively use TurboRip from [[http://pcedev.net/utils/ here]].
There is also a version with a GUI available [[https://adrianastley.com/files/scummvm/windumpcd.rar here.]]
 
Alternatively use TurboRip from [[https://adrianastley.com/files/scummvm/TurboRipV100.rar here]].


Another alternative is to use the PC-Engine emulator [http://www.ouma.jp/ootake/ Ootake] (You will need to own an original console because Ootake requires that you dump the system card)   
Another alternative is to use the PC-Engine emulator [http://www.ouma.jp/ootake/ Ootake] (You will need to own an original console because Ootake requires that you dump the system card)   
Line 312: Line 354:
'''Linux'''
'''Linux'''


Use dumpcd [[http://gracesdisposal.bpweb.net/LOOM/ISO%20TOOLS/DUMPCD%20LINUX/dumpcd-bin-0.1.tar.bz2 dumpcd]]
You may compile dumpcd using the source code available [[https://adrianastley.com/files/scummvm/dumpcd-0.1.zip here]].
 
Alternatively you may compile dumpcd using the source code available [[http://gracesdisposal.bpweb.net/LOOM/ISO%20TOOLS/DUMPCD%20SOURCE%20LINUX/ here]].


=== extract_mm_apple ===
=== extract_mm_apple ===
Line 343: Line 383:
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 Soltys and Sfinx game data files (as such this is not really an extraction tool, see [[#extract_cge|extract_cge]] for the extraction tool).
Example of usage:
./scummvm-tools-cli --tool pack_cge [-o outputdir] <inputdir>


== Script Tools ==
== Script Tools ==
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 ===
Decompiles Delphine's Cinematique engine's scripts.
Should work at least with Future Wars and Operation Stealth.
Example of usage:
decine [type] [version] [filename]
type: -prc or -rel (Use -prc for *.prc-files, -rel for *.rel-files)<br>
version: -v1 or -v2 (Use -v1 for Future Wars, -v2 for Operation Stealth)<br>
filename: The name of the script file to decode
=== degob ===
Decompiles TOT scripts used in Coktel Vision games
Example of usage:
  degob <version> <file.tot> [<file.ext>] [<commun.ext>]
<version> describes from which game the script file was taken and is one of "Gob1", "Gob2", "Gob3", "Ween", "Bargon", "Fascination, "Lost", "Woodruff", "Dynasty" and "Urban".
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 ===
Basic script disassembler for Legend of Kyrandia games


=== descumm ===
=== descumm ===
Line 393: Line 463:
Disassembles Broken Sword II scripts
Disassembles Broken Sword II scripts


=== dekyra ===
== Other Tools ==
Basic script disassembler for Legend of Kyrandia games
 
=== pack_bladerunner ===
Can be used to pack the four "CDFRAMES.DAT" files from the four Blade Runner CDs into a single "HDFRAMES.DAT" file (same file as created by the original game installer) that should be copied into the game's directory.
Syntax:
  ./scummvm-tools-cli --tool pack_bladerunner [-o outputfile] <inputdir>/CDFRAMES1.DAT
The <inputdir> should contain the "CDFRAMES.DAT" files from the game CDs, renamed as ''"CDFRAMES1.DAT", "CDFRAMES2.DAT", "CDFRAMES3.DAT", "CDFRAMES4.DAT"'' copied from the first, second, third and fourth CD respectively.
 
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; following this approach, the files from the first, second, third and fourth CDs should also be renamed as ''"CDFRAMES1.DAT", "CDFRAMES2.DAT", "CDFRAMES3.DAT", "CDFRAMES4.DAT"'' respectively, in order to be properly detected by ScummVM.
 
=== create_sjisfnt ===
 
Allows the creation of a Shift JIS Japanese font from a compatible truetype font (sazanami-mincho.ttf / kochi-mincho.ttf)
Syntax:
  create_sjisfnt [compatible font] SJIS.FNT
Can be used for all FM-Towns/PC-98/PC-Engine games which require the original font ROMs.
 


{{ManualFooterLinksNoNext|prev=Appendix: Config file description}}
{{ManualFooterLinksNoNext|prev=Appendix: Config file description}}
Criezy
TrustedUser
2,147

edits

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

Navigation menu