This is a collection of various tools that may be useful to use in conjunction
with ScummVM. Please note that this module is not always in-sync with the latest
STABLE version of ScummVM.

This means that although a tool may support a feature, certain
ScummVM versions may not. ScummVM 0.6.x does not support FLAC audio, for
example.

Extraction Tools:
        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.

        extract_loom_tg16
                Extracts data files from TG16 version of Loom.
                Use the dumpcd utility at
http://www.zeograd.com/misc_download.php
                to dump the code tracks on the CD.
                There is currently no support for this game in ScummVM!

        extract_mm_c64
                Extracts data files from Commodore 64 version of Maniac
Mansion.

        extract_mm_nes
                Extracts data files from NES version of Maniac Mansion.

        extract_simon1_amiga
                Extracts the graphics or music files in AGA/ECS
                versions of Simon the Sorcerer 1 for Amiga

        extract_zak_c64
                Extracts data files from Commodore 64 version of Zak McKracken

Compression Tools:
        compress_scumm_sou 
                Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
                or .sof (FLAC).

        compress_queen
                Used to rebuild the datafile of Flight of the Amazon Queen,
                to allow optional MP3/Ogg/FLAC compression.

        compress_saga
                Compress SAGA engine digital sound files into MP3 and Ogg
                Vorbis format.

        compress_simon
                Compresses Simon voc/wav files to MP3/Ogg/FLAC.

        compress_sword1
                Used to compress Broken Sword 1's music and speech files
                using mp3 or vorbis.

        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.

        compress_san <inputfile> <inputdir> <outputdir> [--ogg]
                Compresses '.san' smush animation files. It uses lossless
                zlib for compressing FOBJ gfx chunks inside a san file.
                It also can create a separate Ogg file with the audio track.

                Example of usage:
                compress_san opening.san uncomp comp

                In order to use such compressed files, your ScummVM binary 
                must have been built with zlib support enabled (you can find
                out whether that's the case by looking at the About dialog).
                For the Ogg or Mad compression feature, your ScummVM binary
                naturally must have been built with Ogg or Mad support enabled.

        compress_scumm_bun <inputfile> <inputdir> <outputdir> [--ogg]

                Compresses '.bun' music/voice files.

                Example of usage:
                compress_scumm.bun digmusic.bun uncomp comp

                For the Ogg or Mad compression feature, your ScummVM binary
                naturally must have been built with Ogg or Mad support enabled.

Script Tools:
        descumm
                Decompiles SCUMM scripts

        desword2
                Disassembles Broken Sword II scripts

        dekyra
                Basic script disassembler for Legend of Kyrandia games

 PERMSSN    UID  GID    PACKED    SIZE  RATIO METHOD CRC     STAMP          NAME
---------- ----------- ------- ------- ------ ---------- ------------ -------------
[generic]                49011  121163  40.5% -lh5- de72 Jan 16 00:38 compress_agos
[generic]               162856  394022  41.3% -lh5- 3c7a Jan 16 00:38 compress_kyra
[generic]                39919   97867  40.8% -lh5- 12e3 Jan 16 00:38 compress_queen
[generic]               218124  556520  39.2% -lh5- 5908 Jan 16 00:38 compress_saga
[generic]               168132  402284  41.8% -lh5- 5db4 Jan 16 00:38 compress_scumm_bun
[generic]                93500  196154  47.7% -lh5- e8f2 Jan 16 00:38 compress_scumm_san
[generic]                47637  117867  40.4% -lh5- 0053 Jan 16 00:38 compress_scumm_sou
[generic]                52349  128324  40.8% -lh5- dbe2 Jan 16 00:38 compress_sword1
[generic]                47626  117220  40.6% -lh5- 3494 Jan 16 00:38 compress_sword2
[generic]                47596  116687  40.8% -lh5- 7555 Jan 16 00:38 compress_touche
[generic]                  402     685  58.7% -lh5- 38e3 Jan 16 00:38 convert_dxa.bat
[generic]                  452     767  58.9% -lh5- fd39 Jan 16 00:38 convert_dxa.sh
[generic]                  441     792  55.7% -lh5- 10a1 Jan 16 00:38 convert_dxa_one.bat
[generic]                 7022   18013  39.0% -lh5- 8eea Jan 16 00:38 copying
[generic]               166564  404297  41.2% -lh5- 774d Jan 16 00:38 dekyra
[generic]               257116  643300  40.0% -lh5- db50 Jan 16 00:38 descumm
[generic]                47509  112720  42.1% -lh5- 2219 Jan 16 00:38 desword2
[generic]               259269  639300  40.6% -lh5- 849d Jan 16 00:38 encode_dxa
[generic]                32107   78825  40.7% -lh5- abb0 Jan 16 00:38 extract_agos
[generic]               151847  368241  41.2% -lh5- 7234 Jan 16 00:38 extract_kyra
[generic]                50180  124512  40.3% -lh5- 7c92 Jan 16 00:38 extract_loom_tg16
[generic]                35500   88173  40.3% -lh5- 3cb1 Jan 16 00:38 extract_mm_apple
[generic]                35449   88103  40.2% -lh5- 9355 Jan 16 00:38 extract_mm_c64
[generic]                57189  149907  38.1% -lh5- af24 Jan 16 00:38 extract_mm_nes
[generic]               143171  341997  41.9% -lh5- 8ddb Jan 16 00:38 extract_parallaction
[generic]                35723   88653  40.3% -lh5- 27c1 Jan 16 00:38 extract_scumm_mac
[generic]                35451   88120  40.2% -lh5- 7b28 Jan 16 00:38 extract_zak_c64
[generic]                 3067    9949  30.8% -lh5- 47a2 Jan 16 00:38 readme
---------- ----------- ------- ------- ------ ---------- ------------ -------------
 Total        28 files 2245209 5494462  40.9%            Mar 28 10:24