[Scummvm-cvs-logs] CVS: docs/docbook manual.html,1.12,1.13 manual.pdf,1.12,1.13 manual.txt,1.11,1.12 manual.xml,1.14,1.15

Max Horn fingolfin at users.sourceforge.net
Fri Dec 24 15:13:01 CET 2004


Update of /cvsroot/scummvm/docs/docbook
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv9248

Modified Files:
	manual.html manual.pdf manual.txt manual.xml 
Log Message:
Some more stuff from the README

Index: manual.html
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- manual.html	22 Dec 2004 19:06:40 -0000	1.12
+++ manual.html	24 Dec 2004 23:12:33 -0000	1.13
@@ -67,43 +67,49 @@
 <dt>3.3. <a href="#AEN370">Hot Keys</a></dt>
 <dt>3.4. <a href="#AEN373">Saving and loading</a></dt>
 <dt>3.5. <a href="#AEN376">Using Macintosh games</a></dt>
-<dt>3.6. <a href="#AEN379">Multi-CD Games</a></dt></dl></dd>
-<dt>4. <a href="#AEN382">Configuration</a></dt>
+<dt>3.6. <a href="#AEN379">Multi-CD Games</a></dt>
 <dd>
 <dl>
-<dt>4.1. <a href="#AEN384">Using the launcher</a></dt>
-<dt>4.2. <a href="#AEN387">All config file switches in
+<dt>3.6.1. <a href="#AEN385">The Curse of Monkey Island</a></dt>
+<dt>3.6.2. <a href="#AEN389">Broken Sword 1</a></dt>
+<dt>3.6.3. <a href="#AEN394">Broken Sword
+2</a></dt></dl></dd></dl></dd>
+<dt>4. <a href="#AEN399">Configuration</a></dt>
+<dd>
+<dl>
+<dt>4.1. <a href="#AEN401">Using the launcher</a></dt>
+<dt>4.2. <a href="#AEN404">All config file switches in
 detail</a></dt>
-<dt>4.3. <a href="#AEN390">Graphics Filters</a></dt>
-<dt>4.4. <a href="#AEN448">Music and Sound</a></dt>
+<dt>4.3. <a href="#AEN407">Graphics Filters</a></dt>
+<dt>4.4. <a href="#AEN465">Music and Sound</a></dt>
 <dd>
 <dl>
-<dt>4.4.1. <a href="#AEN451">Music drivers</a></dt>
-<dt>4.4.2. <a href="#AEN454">Using compressed audiofiles</a></dt>
-<dt>4.4.3. <a href="#AEN457">Volume settings</a></dt>
-<dt>4.4.4. <a href="#AEN460">Output sample
+<dt>4.4.1. <a href="#AEN468">Music drivers</a></dt>
+<dt>4.4.2. <a href="#AEN471">Using compressed audiofiles</a></dt>
+<dt>4.4.3. <a href="#AEN474">Volume settings</a></dt>
+<dt>4.4.4. <a href="#AEN477">Output sample
 rate</a></dt></dl></dd></dl></dd>
 <dt>A. <a href="#sec.supported-games">Supported Games</a></dt>
 <dd>
 <dl>
-<dt>A.1. <a href="#AEN470">LucasArts Games</a></dt>
-<dt>A.2. <a href="#AEN473">Humongous Games</a></dt>
-<dt>A.3. <a href="#AEN476">Adventure Soft Games</a></dt>
-<dt>A.4. <a href="#AEN479">Revolution Games</a></dt>
-<dt>A.5. <a href="#AEN482">Interactive Binary Illusions
+<dt>A.1. <a href="#AEN487">LucasArts Games</a></dt>
+<dt>A.2. <a href="#AEN490">Humongous Games</a></dt>
+<dt>A.3. <a href="#AEN493">Adventure Soft Games</a></dt>
+<dt>A.4. <a href="#AEN496">Revolution Games</a></dt>
+<dt>A.5. <a href="#AEN499">Interactive Binary Illusions
 Games</a></dt>
-<dt>A.6. <a href="#AEN485">Other Games</a></dt></dl></dd>
-<dt>B. <a href="#AEN488">Tools</a></dt>
+<dt>A.6. <a href="#AEN502">Other Games</a></dt></dl></dd>
+<dt>B. <a href="#AEN505">Tools</a></dt>
 <dd>
 <dl>
-<dt>B.1. <a href="#AEN491">compress_san</a></dt>
-<dt>B.2. <a href="#AEN507">extract</a></dt>
-<dt>B.3. <a href="#AEN512">queenrebuild</a></dt>
-<dt>B.4. <a href="#AEN517">simon2mp3</a></dt>
-<dt>B.5. <a href="#AEN522">sword1mp3</a></dt>
-<dt>B.6. <a href="#AEN527">sword2mp3</a></dt></dl></dd>
-<dt>C. <a href="#AEN533">Credits</a></dt>
-<dt><a href="#AEN724">Glossary</a></dt></dl></div>
+<dt>B.1. <a href="#AEN508">compress_san</a></dt>
+<dt>B.2. <a href="#AEN524">compress_scumm_sou</a></dt>
+<dt>B.3. <a href="#AEN529">queenrebuild</a></dt>
+<dt>B.4. <a href="#AEN534">compress_simon</a></dt>
+<dt>B.5. <a href="#AEN539">compress_sword1</a></dt>
+<dt>B.6. <a href="#AEN544">compress_sword2</a></dt></dl></dd>
+<dt>C. <a href="#AEN550">Credits</a></dt>
+<dt><a href="#AEN741">Glossary</a></dt></dl></div>
 <div class="LOT">
 <dl class="LOT">
 <dt><b>List of Examples</b></dt>
@@ -115,7 +121,7 @@
 a hard disk (Unix)</a></dt>
 <dt>3-4. <a href="#AEN367">Running Full Throttle from CD,
 fullscreen and with subtitles enabled (Unix)</a></dt>
-<dt>B-1. <a href="#AEN503">Using compress_san</a></dt></dl></div>
+<dt>B-1. <a href="#AEN520">Using compress_san</a></dt></dl></div>
 <div class="chapter">
 <hr>
 <h1><a name="AEN5"></a>Chapter 1. Introduction</h1>
@@ -548,22 +554,87 @@
 <div class="section">
 <hr>
 <h2 class="section"><a name="AEN379">3.6. Multi-CD Games</a></h2>
-<p>TODO</p></div></div>
+<p>
 In general, ScummVM does not deal very well with multi-CD
+games. This is because ScummVM assumes everything about a game can
+be found in one directory. Even if ScummVM does make some
+provisions for asking the user to change CD, the original games
+usually install a small number of files to hard disk. Unless these
+files can be found on all the CDs, ScummVM will be in trouble.</p>
+<p>
 Fortunately, ScummVM has no problems running the games
+entirely from hard disk, if you create a directory with the correct
+combination of files. Usually, when a file appears on more than one
+CD you can pick either of them.</p>
+<p>
 These instructions are written for the PC versions (which
+in some case is the only version) of the games. Windows and DOS use
+case-insensitive file systems, so if one CD has a file called
+MONKEY.DAT and another has a file called monkey.dat, they are the
+same files. These instructions give file names in all lower-case
+names, even if that's not always how they appear on the CDs. In
+fact, on case-sensitive file systems you will have to make sure
+that all filenames use either all upper- or all lower-case letters
+for ScummVM to be able to find the files.</p>
+<p>
 The instructions for the Broken Sword games are for the
+Sold-Out Software versions, which are the ones you are probably
+most likely to find in stores now.</p>
+<div class="section">
+<hr>
+<h3 class="section"><a name="AEN385">3.6.1. The Curse of Monkey
+Island</a></h3>
+<p>
 For this game, you'll need the comi.la0, comi.la1 and
+comi.la2 files. The comi.la0 file can be found on either CD, but
+since they are identical it doesn't matter which one of them you
+use.</p>
+<p>
 In addition, you'll need a resource subdirectory with all
+of the files from the resource subdirectories on both CDs. Some of
+the files appear on both CDs, but again they're
+identical.</p></div>
+<div class="section">
+<hr>
+<h3 class="section"><a name="AEN389">3.6.2. Broken Sword 1</a></h3>
+<p>
 For this game, you'll need all of the files from the
+clusters directories on both CDs. You will also need the speech.clu
+files from the speech directories, but since they are not identical
+you'll need to rename them speech1.clu and speech2.clu for CD 1 and
+2 respectively.</p>
+<p>
 In addition, you will need a music subdirectory with all
+of the files from the music subdirectories on both CDs. Some of
+these files appear on both CDs, but in these cases they are either
+identical or, in one case, so nearly identical that it makes little
+difference.</p>
+<p>
 ScummVM does not support the original cutscene files (with
+file extension .smk) for legal reasons, so there is no need to copy
+them.</p></div>
+<div class="section">
+<hr>
+<h3 class="section"><a name="AEN394">3.6.3. Broken Sword 2</a></h3>
+<p>
 For this game, you'll need all of the files from the
+clusters directories on both CDs. (Actually, a few of them may not
+be strictly necessary, but the ones that I'm uncertain about are
+all fairly small.) You will need to rename the speech.clu and
+music.clu files speech1.clu, speech2.clu, music1.clu and music2.clu
+so that ScummVM can tell which ones are from CD 1 and which ones
+are from CD 2. Any other files that appear in both cluster
+directories are identical. Use whichever you like.</p>
+<p>
 In addition, you will need the cd.bin, cd.inf and
+startup.inf files from the sword2 directory on CD 1.</p>
+<p>
 ScummVM does not support the original cutscene files (with
+file extension .smk) for legal reasons, so there is no need to copy
+them.</p></div></div></div>
 <div class="chapter">
 <hr>
-<h1><a name="AEN382"></a>Chapter 4. Configuration</h1>
+<h1><a name="AEN399"></a>Chapter 4. Configuration</h1>
 <div class="section">
-<h2 class="section"><a name="AEN384">4.1. Using the
+<h2 class="section"><a name="AEN401">4.1. Using the
 launcher</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN387">4.2. All config file switches
+<h2 class="section"><a name="AEN404">4.2. All config file switches
 in detail</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN390">4.3. Graphics Filters</a></h2>
+<h2 class="section"><a name="AEN407">4.3. Graphics Filters</a></h2>
 <p>
 ScummVM offers several anti-aliasing filters to attempt to
 improve visual quality. These are the same filters used in many
 other emulators, such as MAME. These filters take the original game
@@ -630,17 +701,17 @@
 scalers will scale to 640x480 or 960x720.</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN448">4.4. Music and Sound</a></h2>
+<h2 class="section"><a name="AEN465">4.4. Music and Sound</a></h2>
 <p>TODO</p>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN451">4.4.1. Music drivers</a></h3>
+<h3 class="section"><a name="AEN468">4.4.1. Music drivers</a></h3>
 <p>TODO: Music/midi drivers: list them all, with desc, and
 explanations (current sections 7.0-7.5). Try to help the user in
 choosing the "best" driver.</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN454">4.4.2. Using compressed
+<h3 class="section"><a name="AEN471">4.4.2. Using compressed
 audiofiles</a></h3>
 <p>TODO: Corresponds to current section 7.6. --> Intro-section
 which briefly mentions pros/cons of compressing your audio data;
@@ -652,14 +723,14 @@
 I'd prefer if we joined these, to reduce duplications...</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN457">4.4.3. Volume
+<h3 class="section"><a name="AEN474">4.4.3. Volume
 settings</a></h3>
 <p>TODO: Explain about the volume settings, what the values mean,
 etc. The launcher, command line, config file sections all would
 refer to here.</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN460">4.4.4. Output sample
+<h3 class="section"><a name="AEN477">4.4.4. Output sample
 rate</a></h3>
 <p>
 The output sample rate tells ScummVM how many sound
 samples to play per channel per second. There is much that could be
@@ -696,44 +767,45 @@
 supported precisely, where to get cutscene packs etc.</p>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN470">A.1. LucasArts Games</a></h2>
+<h2 class="section"><a name="AEN487">A.1. LucasArts Games</a></h2>
 <p>TODO: Add a list of all LEC SCUMM games here, with note
 regarding which variants we (don't) support, pointers to special
 problems (how to deal with the mac versions if you are on a PC, for
 example), etc.</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN473">A.2. Humongous Games</a></h2>
+<h2 class="section"><a name="AEN490">A.2. Humongous Games</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN476">A.3. Adventure Soft
+<h2 class="section"><a name="AEN493">A.3. Adventure Soft
 Games</a></h2>
 <p>TODO: Simon 1, Simon 2 (and their many variants)</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN479">A.4. Revolution Games</a></h2>
+<h2 class="section"><a name="AEN496">A.4. Revolution Games</a></h2>
 <p>TODO: BASS, BS1, BS2</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN482">A.5. Interactive Binary
+<h2 class="section"><a name="AEN499">A.5. Interactive Binary
 Illusions Games</a></h2>
 <p>TODO: FOTAQ</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN485">A.6. Other Games</a></h2>
+<h2 class="section"><a name="AEN502">A.6. Other Games</a></h2>
 <p>TODO: Tell people here regarding support for additional games
 (FAQ); maybe point at FreeSCI, Dosbox, others</p></div></div>
 <div class="appendix">
 <hr>
-<h1><a name="AEN488"></a>Appendix B. Tools</h1>
-<p>TODO: Explain sword2mp3, simon2mp3, extract, compress_san, etc.
-; rescumm shouldn't have to be explained anymore; not sure if
-descumm should be explained here, it seems more fit for the dev
-guide, but that's probably debatable...</p>
+<h1><a name="AEN505"></a>Appendix B. Tools</h1>
+<p>TODO: Explain compress_sword2, compress_simon,
+compress_scumm_sou, compress_san, etc. ; rescumm shouldn't have to
+be explained anymore; not sure if descumm should be explained here,
+it seems more fit for the dev guide, but that's probably
+debatable...</p>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN491">B.1. compress_san</a></h2>
+<h2 class="section"><a name="AEN508">B.1. compress_san</a></h2>
 <p>TODO</p>
 <p><b class="command">compress_san</b> <tt class=
 "replaceable"><i>inputfile</i></tt> <tt class=
@@ -743,7 +815,7 @@
 zlib for compressing FOBJ gfx chunks inside a san file. It also can
 create ogg separate file with smush audio track (only COMI
 currently supported).</p>
-<div class="example"><a name="AEN503"></a>
+<div class="example"><a name="AEN520"></a>
 <p><b>Example B-1. Using compress_san</b></p>
 <pre class="screen">
 compress_san opening.san uncomp comp
@@ -756,12 +828,13 @@
 been built with Ogg support enabled.</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN507">B.2. extract</a></h2>
+<h2 class="section"><a name="AEN524">B.2.
+compress_scumm_sou</a></h2>
 <p>TODO</p>
 <p>Used to compress .sou files to .so3 (MP3), .sog (Vorbis), or
 .sof (FLAC).</p>
 <pre class="screen">
-
Usage: ./extract [params] monster.sou
+
Usage: ./compress_scumm_sou [params] monster.sou
 
 Params:
  --mp3        encode to MP3 format (default)
@@ -798,7 +871,7 @@
 </div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN512">B.3. queenrebuild</a></h2>
+<h2 class="section"><a name="AEN529">B.3. queenrebuild</a></h2>
 <p>TODO</p>
 <p>Used to rebuild the datafile of Flight of the Amazon Queen, to
 allow optional MP3/Ogg/FLAC compression.</p>
@@ -816,11 +889,11 @@
 </div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN517">B.4. simon2mp3</a></h2>
+<h2 class="section"><a name="AEN534">B.4. compress_simon</a></h2>
 <p>TODO</p>
 <p>Compresses Simon voc/wav files to MP3/Ogg/FLAC.</p>
 <pre class="screen">
-
Usage: ./simon2mp3 [params] [file | mac]
+
Usage: ./compress_simon [params] [file | mac]
 
 Params:
  --mp3        encode to MP3 format (default)
@@ -858,7 +931,7 @@
 </div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN522">B.5. sword1mp3</a></h2>
+<h2 class="section"><a name="AEN539">B.5. compress_sword1</a></h2>
 <p>TODO</p>
 <p>Used to compress Broken Sword 1's music and speech files using
 mp3 or vorbis.</p>
@@ -882,7 +955,7 @@
 </div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN527">B.6. sword2mp3</a></h2>
+<h2 class="section"><a name="AEN544">B.6. compress_sword2</a></h2>
 <p>TODO</p>
 <p>Used to compress Broken Sword 2's music and speech .clu files to
 .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).</p>
@@ -890,7 +963,7 @@
 file than the original! This is because the original files already
 use lossy compression.</p>
 <pre class="screen">
-
Usage: ./sword2mp3 [params] file.clu
+
Usage: ./compress_sword2 [params] file.clu
 
 Params:
  --mp3        encode to MP3 format (default)
@@ -927,8 +1000,8 @@
 </div></div>
 <div class="appendix">
 <hr>
-<h1><a name="AEN533"></a>Appendix C. Credits</h1>
-<div class="informaltable"><a name="AEN535"></a>
+<h1><a name="AEN550"></a>Appendix C. Credits</h1>
+<div class="informaltable"><a name="AEN552"></a>
 <table border="0" frame="void" rules="none" class="CALSTABLE">
 <col width="19" title="start">
 <col width="151" title="name">
@@ -1179,7 +1252,7 @@
 <tr>
 <td colspan="3"> </td></tr></tbody></table></div></div>
 <div class="GLOSSARY">
-<h1><a name="AEN724"></a>Glossary</h1>
+<h1><a name="AEN741"></a>Glossary</h1>
 <p>TODO: (explaining abbreviations etc.). Like SCUMM, FOTAQ, COMI,
 FOA, ITE, ...</p>
 <dl>

Index: manual.pdf
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.pdf,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- manual.pdf	22 Dec 2004 19:06:41 -0000	1.12
+++ manual.pdf	24 Dec 2004 23:12:33 -0000	1.13
@@ -204,219 +204,237 @@
 (3.6. MultiCD Games)
 endobj
 137 0 obj
-<< /S /GoTo /D (7.0) >>
+<< /S /GoTo /D (6.14.15.2) >>
 endobj
 140 0 obj
-(Chapter 4. Configuration)
+(3.6.1. The Curse of Monkey Island)
 endobj
 141 0 obj
[...8134 lines suppressed...]
+0000217464 00000 n 
+0000217568 00000 n 
+0000224310 00000 n 
+0000232108 00000 n 
+0000232149 00000 n 
+0000232189 00000 n 
+0000232420 00000 n 
 trailer
 <<
-/Size 1014
-/Root 1012 0 R
-/Info 1013 0 R
+/Size 1050
+/Root 1048 0 R
+/Info 1049 0 R
 >>
 startxref
-224480
+232576
 %%EOF

Index: manual.txt
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.txt,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -d -r1.11 -r1.12
--- manual.txt	22 Dec 2004 19:06:45 -0000	1.11
+++ manual.txt	24 Dec 2004 23:12:36 -0000	1.12
@@ -1,792 +1,775 @@
-                              ScummVM User Manual
 
-  
 The ScummVM Team
+ScummVM User Manual
 
-     ----------------------------------------------------------------------
+The ScummVM Team
+     _________________________________________________________
 
    Table of Contents
-
[...1787 lines suppressed...]
 
    SCUMM
-
-           SCUMM, the Script Creation Utility for Maniac Mansion, is a
-           scripting language (and not really an engine! see SPUTM)
-           originally made by LucasArts for creating graphics adventure.
+          SCUMM, the Script Creation Utility for Maniac Mansion,
+          is a scripting language (and not really an engine! see
+          SPUTM) originally made by LucasArts for creating
+          graphics adventure.
 
    Smush
-
-           TODO
+          TODO
 
    SPUTM
-
-           The 'real' name for the engine driving SCUMM games.
+          The 'real' name for the engine driving SCUMM games.

Index: manual.xml
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- manual.xml	22 Dec 2004 17:59:59 -0000	1.14
+++ manual.xml	24 Dec 2004 23:12:37 -0000	1.15
@@ -695,7 +695,88 @@
 
     <section>
       <title>Multi-CD Games</title>
-      <para>TODO</para>
+      <para>
+      In general, ScummVM does not deal very well with multi-CD games. This is
+      because ScummVM assumes everything about a game can be found in one directory.
+      Even if ScummVM does make some provisions for asking the user to change CD, the
+      original games usually install a small number of files to hard disk. Unless
+      these files can be found on all the CDs, ScummVM will be in trouble.
+      </para>
+      <para>
+      Fortunately, ScummVM has no problems running the games entirely from hard disk,
+      if you create a directory with the correct combination of files. Usually, when
+      a file appears on more than one CD you can pick either of them.
+      </para>
+      <para>
+      These instructions are written for the PC versions (which in some case is the
+      only version) of the games. Windows and DOS use case-insensitive file systems,
+      so if one CD has a file called MONKEY.DAT and another has a file called
+      monkey.dat, they are the same files. These instructions give file names in all
+      lower-case names, even if that's not always how they appear on the CDs. In
+      fact, on case-sensitive file systems you will have to make sure that all
+      filenames use either all upper- or all lower-case letters for ScummVM to be
+      able to find the files.
+      </para>
+      <para>
+      The instructions for the Broken Sword games are for the Sold-Out Software
+      versions, which are the ones you are probably most likely to find in stores
+      now.
+      </para>
+      
+      <section>
+        <title>The Curse of Monkey Island</title>
+        <para>
+        For this game, you'll need the comi.la0, comi.la1 and comi.la2 files. The
+        comi.la0 file can be found on either CD, but since they are identical it
+        doesn't matter which one of them you use.
+        </para>
+        <para>
+        In addition, you'll need a resource subdirectory with all of the files from the
+        resource subdirectories on both CDs. Some of the files appear on both CDs, but
+        again they're identical.
+        </para>
+      </section>
+        
+      <section>
+        <title>Broken Sword 1</title>
+        <para>
+        For this game, you'll need all of the files from the clusters directories on
+        both CDs. You will also need the speech.clu files from the speech directories,
+        but since they are not identical you'll need to rename them speech1.clu and
+        speech2.clu for CD 1 and 2 respectively.
+        </para>
+        <para>
+        In addition, you will need a music subdirectory with all of the files from the
+        music subdirectories on both CDs. Some of these files appear on both CDs, but
+        in these cases they are either identical or, in one case, so nearly identical
+        that it makes little difference.
+        </para>
+        <para>
+        ScummVM does not support the original cutscene files (with file extension .smk)
+        for legal reasons, so there is no need to copy them.
+        </para>
+      </section>
+        
+      <section>
+        <title>Broken Sword 2</title>
+        <para>
+        For this game, you'll need all of the files from the clusters directories on
+        both CDs. (Actually, a few of them may not be strictly necessary, but the ones
+        that I'm uncertain about are all fairly small.) You will need to rename the
+        speech.clu and music.clu files speech1.clu, speech2.clu, music1.clu and
+        music2.clu so that ScummVM can tell which ones are from CD 1 and which ones are
+        from CD 2. Any other files that appear in both cluster directories are
+        identical. Use whichever you like.
+        </para>
+        <para>
+        In addition, you will need the cd.bin, cd.inf and startup.inf files from the
+        sword2 directory on CD 1.
+        </para>
+        <para>
+        ScummVM does not support the original cutscene files (with file extension .smk)
+        for legal reasons, so there is no need to copy them.
+        </para>
+      </section>
     </section>
   </chapter>
 
@@ -933,7 +1014,7 @@
   <appendix>
     <title>Tools</title>
     <para>TODO:
-    Explain sword2mp3, simon2mp3, extract, compress_san, etc. ; rescumm
+    Explain compress_sword2, compress_simon, compress_scumm_sou, compress_san, etc. ; rescumm
     shouldn't have to be explained anymore; not sure if descumm should be
     explained here, it seems more fit for the dev guide, but that's probably
     debatable...
@@ -969,12 +1050,12 @@
     </section>
 
     <section>
-      <title>extract</title>
+      <title>compress_scumm_sou</title>
       <para>TODO</para>
       <para>Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
                 or .sof (FLAC).</para>
 <screen>
-Usage: ./extract [params] monster.sou
+Usage: ./compress_scumm_sou [params] monster.sou
 
 Params:
  --mp3        encode to MP3 format (default)
@@ -1030,11 +1111,11 @@
     </section>
 
     <section>
-      <title>simon2mp3</title>
+      <title>compress_simon</title>
       <para>TODO</para>
       <para>Compresses Simon voc/wav files to MP3/Ogg/FLAC.</para>
 <screen>
-Usage: ./simon2mp3 [params] [file | mac]
+Usage: ./compress_simon [params] [file | mac]
 
 Params:
  --mp3        encode to MP3 format (default)
@@ -1072,7 +1153,7 @@
     </section>
 
     <section>
-      <title>sword1mp3</title>
+      <title>compress_sword1</title>
       <para>TODO</para>
       <para>Used to compress Broken Sword 1's music and speech files
                 using mp3 or vorbis.</para>
@@ -1097,7 +1178,7 @@
     </section>
 
     <section>
-      <title>sword2mp3</title>
+      <title>compress_sword2</title>
       <para>TODO</para>
       <para>Used to compress Broken Sword 2's music and speech .clu
       files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
@@ -1108,7 +1189,7 @@
       use lossy compression.
       </para>
 <screen>
-Usage: ./sword2mp3 [params] file.clu
+Usage: ./compress_sword2 [params] file.clu
 
 Params:
  --mp3        encode to MP3 format (default)





More information about the Scummvm-git-logs mailing list