[Scummvm-cvs-logs] SF.net SVN: scummvm: [28086] tools/branches/gsoc2007-toolsgui/README

Sun Jul 15 05:31:29 CEST 2007

Revision: 28086
          http://scummvm.svn.sourceforge.net/scummvm/?rev=28086&view=rev
Author:   lightcast
Date:     2007-07-14 20:31:29 -0700 (Sat, 14 Jul 2007)

Log Message:
-----------
Update README to reflect changes to the tools.
Added examples of usage to all compression and extraction tools.

Modified Paths:
--------------
    tools/branches/gsoc2007-toolsgui/README

Modified: tools/branches/gsoc2007-toolsgui/README
===================================================================

--- tools/branches/gsoc2007-toolsgui/README	2007-07-15 03:29:33 UTC (rev 28085)
+++ tools/branches/gsoc2007-toolsgui/README	2007-07-15 03:31:29 UTC (rev 28086)
@@ -11,54 +11,81 @@
 		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 <file> [params]
+		
 	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.
 
-Compression Tools:
-	compress_scumm_sou
-		Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
-		or .sof (FLAC).
-
 		Example of usage:
-		compress_scumm_sou [params] monster.sou
+		extract_zak_c64 <disk1.d64> <disk2.d64>
 
+Compression Tools:
 	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_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 [params] <file> <inputdir> <outputdir>
+
 	compress_queen
 		Used to rebuild the datafile of Flight of the Amazon Queen,
 		and allow optional MP3, Vorbis or FLAC compression.
@@ -70,12 +97,6 @@
 		Used to compress SAGA engine digital sound files to MP3, Vorbis
 		or FLAC. 
 
-		Example of usage:
-		compress_saga [params] <file>
-
-		Where <file> is the sound file you with to compress, without the
-		extension.
-
 		For Inherit the Earth, the digital music (music.rsc), speech 
 		(voices.rsc or "inherit the earth voices") and sound effects
 		(sounds.rsc) files can be compressed. For I have no mouth, the 
@@ -92,34 +113,18 @@
 		the Earth are not currently supported. Finally, there is no support 
 		for compressed sounds in I have no mouth yet.
 
-	compress_sword1
-		Used to compress Broken Sword 1's music and speech .clu
-		files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
-
 		Example of usage:
-		compress_sword1 [params]
+		compress_saga [params] <file>
 
-       compress_sword2
-		Used to compress Broken Sword 2's music and speech .clu
-		files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
+		Where <file> is the sound file you with to compress, without the
+		extension.
 
-		Please note that FLAC compression will produce a larger file
-		than the original! This is because the original files already
-		use lossy compression.
+	compress_scumm_bun
+		Compresses '.bun' music/voice files.
 
 		Example of usage:
-		compress_sword2 [params] <file>
+		compress_scumm_bun [--vorbis] [params] <file> <inputdir> <outputdir>
 
-	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
-
-		Example of usage:
-		comrpess_touche [params] <inputdir>
-
 	compress_scumm_san
 		Compresses '.san' smush animation files. It uses lossless
 		zlib for compressing FOBJ gfx chunks inside a san file.
@@ -140,24 +145,43 @@
 		move the '.flu' files, too!
 
 		Example of usage:
-		compress_scumm_bun [--vorbis] [params] <inputfile> <inputdir> <outputdir>
+		compress_scumm_bun [--vorbis] [params] <file> <inputdir> <outputdir>
 
-	compress_scumm_bun
-		Compresses '.bun' music/voice files.
+	compress_scumm_sou
+		Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
+		or .sof (FLAC).
 
-		For the Ogg or MP3 compression feature, your ScummVM binary
-		naturally must have been built with Ogg or MP3 support enabled.
+		Example of usage:
+		compress_scumm_sou [params] monster.sou
 
+	compress_sword1
+		Used to compress Broken Sword 1's music and speech .clu
+		files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
+
 		Example of usage:
-		compress_scumm_bun [--vorbis] [params] <inputfile> <inputdir> <outputdir>
+		compress_sword1 [params] <inputdir>
 
-	compress_kyra
-		Used to compress The Legend of Kyrandia's speech 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).
 
+		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 [params] <inputfile> <inputdir> <outputdir>
+		compress_sword2 [params] <file>
 
+	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
+
+		Example of usage:
+		comrpess_touche [params] <inputdir> <outputdir>
+
 Script Tools:
 	descumm
 		Decompiles SCUMM scripts
@@ -169,7 +193,7 @@
 		Basic script disassembler for Legend of Kyrandia games
 
 Encoder Tools:
-	encode_dxa <filename>
+	encode_dxa [params] <file>
 
 		Creates DXA file out of extracted Smacker video.
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


