Difference between revisions of "ScummVM Tools"

Jump to navigation Jump to search
3,084 bytes added ,  10:19, 3 August 2019
m (→‎Vorbis mode params: Update quality range following modification in the code)
(23 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 150: 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 225: 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>


Default outpufile is the name of the input file with modified extension (depends on compression method).
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.
 
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 288: 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 316: 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 324: 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 355: 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 ==
Line 430: Line 464:


== Other Tools ==
== Other Tools ==
=== 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.
Syntax:
  ./scummvm-tools-cli --tool pack_bladerunner <inputdir>/CDFRAMES1.DAT
The <inputdir> is the path to the folder that 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; 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 ===
Line 435: Line 477:
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)
  Syntax:
  Syntax:
   create_sjisfnt [compatible font] [output file]
   create_sjisfnt [compatible font] SJIS.FNT
Currently only in use with the Kyra engine.
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}}
1,310

edits

Navigation menu