[Scummvm-cvs-logs] SF.net SVN: scummvm: [29669] tools/trunk/README
fingolfin at users.sourceforge.net
fingolfin at users.sourceforge.net
Fri Nov 30 15:30:35 CET 2007
Revision: 29669
http://scummvm.svn.sourceforge.net/scummvm/?rev=29669&view=rev
Author: fingolfin
Date: 2007-11-30 06:30:34 -0800 (Fri, 30 Nov 2007)
Log Message:
-----------
Merged some README changes from the gsoc2007-decompiler branch
Modified Paths:
--------------
tools/trunk/README
Modified: tools/trunk/README
===================================================================
--- tools/trunk/README 2007-11-30 14:29:51 UTC (rev 29668)
+++ tools/trunk/README 2007-11-30 14:30:34 UTC (rev 29669)
@@ -11,52 +11,92 @@
Extracts the packed files used in the Amiga and AtariST
versions of Elvira 1/2, Waxworks and Simon the Sorcerer 1.
+ Example of usage:
+ extract_agos <file 1> ... <file n>
+
extract_kyra
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.
-
+
+ Example of usage:
+ extract_kyra [params] <file>
+
extract_loom_tg16
Extracts data files from the PC-Engine version of Loom.
Use the dumpcd utility at http://www.zeograd.com/misc_download.php
to dump the code tracks on the CD.
+
+ Example of usage:
+ extract_loom_tg16 <code_##.ISO>
extract_mm_apple
Extracts data files from the Apple II version of Maniac
Mansion.
+
+ Example of usage:
+ extract_mm_apple <disk1.dsk> <disk2.dsk>
extract_mm_c64
Extracts data files from the Commodore 64 version of Maniac
Mansion.
+ Example of usage:
+ extract_mm_apple <disk1.d64> <disk2.d64>
+
extract_mm_nes
Extracts data files from the NES version of Maniac Mansion.
+ Example of usage:
+ extract_mm_nes <file.PRG>
+
extract_parallaction
Extracts the contents of archives used by Nippon Safes
+ Example of usage:
+ extract_parallaction [--small] <file> <outputdir>
+
+ 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.
+
+ Example of usage:
+ extract_scumm_mac <file>
+
extract_zak_c64
Extracts data files from the Commodore 64 version of Zak
McKracken.
+ Example of usage:
+ extract_zak_c64 <disk1.d64> <disk2.d64>
+
Compression Tools:
- compress_scumm_sou
- Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
- or .sof (FLAC).
-
compress_agos
Used to compress the Feeble Files or Simon 1/2 voc/wav files
to MP3, Vorbis or FLAC.
+ Example of usage:
+ compress_agos [params] <file | mac>
+
+ compress_kyra
+ Used to compress The Legend of Kyrandia's speech files with
+ MP3, Vorbis or FLAC.
+
+ Example of usage:
+ 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
Used to rebuild the datafile of Flight of the Amazon Queen,
and allow optional MP3, Vorbis or FLAC compression.
+ Example of usage:
+ compress_queen [params] queen.1
+
compress_saga
Used to compress SAGA engine digital sound files to MP3, Vorbis
or FLAC.
@@ -80,25 +120,16 @@
*.bin files)
- The unsupported early DOS demo of Inherit the Earth
- compress_sword1
- Used to compress Broken Sword 1's music and speech files to
- MP3 or Vorbis or FLAC.
+ compress_scumm_bun <inputfile> <inputdir> <outputdir> [params]
+ Used to the compress '.bun' music/voice files with MP3, Vorbis
+ or FLAC.
- compress_sword2
- Used to compress Broken Sword 2's music and speech .clu
- files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
+ Example of usage:
+ compress_scumm.bun digmusic.bun uncomp comp --flac
- Please note that FLAC compression will produce a larger file
- than the original! This is because the original files already
- use lossy compression.
+ Please note that FLAC compression will produce larger files
+ than the original, for The Curse of Monkey Island!
- 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 <inputfile> <inputdir> <outputdir> [--ogg]
Compresses '.san' smush animation files. It uses lossless
zlib for compressing FOBJ gfx chunks inside a san file.
@@ -121,27 +152,42 @@
move the '.san' files before compressing them, make sure to
move the '.flu' files, too!
- compress_scumm_bun <inputfile> <inputdir> <outputdir> [params]
- Used to the compress '.bun' music/voice files with MP3, Vorbis
- or FLAC.
+ compress_scumm_sou
+ Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
+ or .sof (FLAC).
Example of usage:
- compress_scumm.bun digmusic.bun uncomp comp --flac
+ compress_scumm_sou [params] monster.sou
- Please note that FLAC compression will produce larger files
- than the original, for The Curse of Monkey Island!
+ compress_sword1
+ Used to compress Broken Sword 1's music and speech .clu
+ files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
- compress_kyra
- Used to compress The Legend of Kyrandia's speech files with
- MP3, Vorbis or FLAC.
+ Example of usage:
+ compress_sword1 [params] <inputdir>
+ compress_sword2
+ 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.
+
Example of usage:
- compress_kyra <flags here> input/GEMCUT.VRM output/GEMCUT.VRM
+ compress_sword2 [params] <file>
- 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_touche
+ Used to compress and pack Touche speech files ('Vxxx' and
+ 'OBJ') to MP3, Vorbis or FLAC to a single file named
+ TOUCHE.SO3 (MP3), TOUCHE.SOG (Vorbis), or TOUCHE.SOF (FLAC).
+ Once compressed, only TOUCHE.DAT and TOUCHE.SOx files are
+ required to play the game under ScummVM.
+
+ Example of usage:
+ compress_touche [params] <inputdir> <outputdir>
+
Script Tools:
descumm
Decompiles SCUMM scripts
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Scummvm-git-logs
mailing list