[Scummvm-cvs-logs] CVS: docs/docbook manual.html,1.7,1.8 manual.xml,1.9,1.10 manual.pdf,1.7,1.8 manual.txt,1.6,1.7
Max Horn
fingolfin at users.sourceforge.net
Sun Dec 19 17:46:12 CET 2004
Update of /cvsroot/scummvm/docs/docbook
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14350
Modified Files:
manual.html manual.xml manual.pdf manual.txt
Log Message:
Some more doc work
Index: manual.html
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- manual.html 20 Dec 2004 01:30:57 -0000 1.7
+++ manual.html 20 Dec 2004 01:45:46 -0000 1.8
@@ -57,53 +57,66 @@
<dd>
<dl>
<dt>3.1. <a href="#AEN105">The launcher</a></dt>
-<dt>3.2. <a href="#AEN108">Command line options</a></dt>
-<dt>3.3. <a href="#AEN305">Hot Keys</a></dt>
-<dt>3.4. <a href="#AEN308">Saving and loading</a></dt>
-<dt>3.5. <a href="#AEN311">Using Macintosh games</a></dt>
-<dt>3.6. <a href="#AEN314">Multi-CD Games</a></dt></dl></dd>
-<dt>4. <a href="#AEN317">Configuration</a></dt>
<dd>
<dl>
-<dt>4.1. <a href="#AEN319">Using the launcher</a></dt>
-<dt>4.2. <a href="#AEN322">All config file switches in
+<dt>3.1.1. <a href="#AEN108">Adding/editing/removing a
+game</a></dt>
+<dt>3.1.2. <a href="#AEN111">The (global) options
+dialog</a></dt></dl></dd>
+<dt>3.2. <a href="#AEN114">Command line options</a></dt>
+<dt>3.3. <a href="#AEN311">Hot Keys</a></dt>
+<dt>3.4. <a href="#AEN314">Saving and loading</a></dt>
+<dt>3.5. <a href="#AEN317">Using Macintosh games</a></dt>
+<dt>3.6. <a href="#AEN320">Multi-CD Games</a></dt></dl></dd>
+<dt>4. <a href="#AEN323">Configuration</a></dt>
+<dd>
+<dl>
+<dt>4.1. <a href="#AEN325">Using the launcher</a></dt>
+<dt>4.2. <a href="#AEN328">All config file switches in
detail</a></dt>
-<dt>4.3. <a href="#AEN325">Graphics Filters</a></dt>
-<dt>4.4. <a href="#AEN383">Music and Sound</a></dt></dl></dd>
+<dt>4.3. <a href="#AEN331">Graphics Filters</a></dt>
+<dt>4.4. <a href="#AEN389">Music and Sound</a></dt>
+<dd>
+<dl>
+<dt>4.4.1. <a href="#AEN392">Music drivers</a></dt>
+<dt>4.4.2. <a href="#AEN395">Using compressed audiofiles</a></dt>
+<dt>4.4.3. <a href="#AEN398">Volume settings</a></dt>
+<dt>4.4.4. <a href="#AEN401">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="#AEN389">LucasArts Games</a></dt>
-<dt>A.2. <a href="#AEN392">Humongous Games</a></dt>
-<dt>A.3. <a href="#AEN395">Adventure Soft Games</a></dt>
-<dt>A.4. <a href="#AEN398">Revolution Games</a></dt>
-<dt>A.5. <a href="#AEN401">Interactive Binary Illusions
+<dt>A.1. <a href="#AEN411">LucasArts Games</a></dt>
+<dt>A.2. <a href="#AEN414">Humongous Games</a></dt>
+<dt>A.3. <a href="#AEN417">Adventure Soft Games</a></dt>
+<dt>A.4. <a href="#AEN420">Revolution Games</a></dt>
+<dt>A.5. <a href="#AEN423">Interactive Binary Illusions
Games</a></dt>
-<dt>A.6. <a href="#AEN404">Other Games</a></dt></dl></dd>
-<dt>B. <a href="#AEN407">Tools</a></dt>
+<dt>A.6. <a href="#AEN426">Other Games</a></dt></dl></dd>
+<dt>B. <a href="#AEN429">Tools</a></dt>
<dd>
<dl>
-<dt>B.1. <a href="#AEN410">compress_san</a></dt>
-<dt>B.2. <a href="#AEN426">extract</a></dt>
-<dt>B.3. <a href="#AEN431">queenrebuild</a></dt>
-<dt>B.4. <a href="#AEN436">simon2mp3</a></dt>
-<dt>B.5. <a href="#AEN441">sword1mp3</a></dt>
-<dt>B.6. <a href="#AEN446">sword2mp3</a></dt></dl></dd>
-<dt>C. <a href="#AEN452">Credits</a></dt>
-<dt><a href="#AEN623">Glossary</a></dt>
-<dt><a href="#AEN646">Index</a></dt></dl></div>
+<dt>B.1. <a href="#AEN432">compress_san</a></dt>
+<dt>B.2. <a href="#AEN448">extract</a></dt>
+<dt>B.3. <a href="#AEN453">queenrebuild</a></dt>
+<dt>B.4. <a href="#AEN458">simon2mp3</a></dt>
+<dt>B.5. <a href="#AEN463">sword1mp3</a></dt>
+<dt>B.6. <a href="#AEN468">sword2mp3</a></dt></dl></dd>
+<dt>C. <a href="#AEN474">Credits</a></dt>
+<dt><a href="#AEN645">Glossary</a></dt>
+<dt><a href="#AEN668">Index</a></dt></dl></div>
<div class="LOT">
<dl class="LOT">
<dt><b>List of Examples</b></dt>
-<dt>3-1. <a href="#AEN293">Running Monkey Island, fullscreen, from
+<dt>3-1. <a href="#AEN299">Running Monkey Island, fullscreen, from
a hard disk (Win32)</a></dt>
-<dt>3-2. <a href="#AEN296">Running Full Throttle from CD,
+<dt>3-2. <a href="#AEN302">Running Full Throttle from CD,
fullscreen and with subtitles enabled (Win32)</a></dt>
-<dt>3-3. <a href="#AEN299">Running Monkey Island, fullscreen, from
+<dt>3-3. <a href="#AEN305">Running Monkey Island, fullscreen, from
a hard disk (Unix)</a></dt>
-<dt>3-4. <a href="#AEN302">Running Full Throttle from CD,
+<dt>3-4. <a href="#AEN308">Running Full Throttle from CD,
fullscreen and with subtitles enabled (Unix)</a></dt>
-<dt>B-1. <a href="#AEN422">Using compress_san</a></dt></dl></div>
+<dt>B-1. <a href="#AEN444">Using compress_san</a></dt></dl></div>
<div class="chapter">
<hr>
<h1><a name="AEN7"></a>Chapter 1. Introduction</h1>
@@ -198,7 +211,9 @@
ScummVM</a></h2>
<div class="section">
<h3 class="section"><a name="AEN56">2.1.1. Binaries</a></h3>
-<p>TODO: list supported platforms</p></div>
+<p>TODO: list supported platforms; where to get binaries; list
+requirments (in terms of required/optional libraries, CPU power,
+memory, ...</p></div>
<div class="section">
<hr>
<h3 class="section"><a name="AEN59">2.1.2. Compiling from
@@ -212,7 +227,9 @@
<div class="section">
<hr>
<h2 class="section"><a name="AEN62">2.2. Installation</a></h2>
-<p>TODO</p>
+<p>TODO: Not sure whether we really need this section; most of it
+should already be covered by the above section "How to get
+ScummVM", I think?</p>
<div class="section">
<hr>
<h3 class="section"><a name="AEN65">2.2.1. Unix-like (Linux, *BSD,
@@ -269,11 +286,23 @@
<div class="section">
<h2 class="section"><a name="AEN105">3.1. The launcher</a></h2>
<p>TODO: Explain the launcher and how to use it (even though I hope
-that it's pretty much straightforward); including
-screenshots?</p></div>
+that it's pretty much straightforward); including screenshots?</p>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN108">3.2. Command line
+<h3 class="section"><a name="AEN108">3.1.1. Adding/editing/removing
+a game</a></h3>
+<p>TODO: Explain how to add a new game, how to edit its settings;
+maybe explain what those setting means, with refs to the
+corresponding sections. All with screenshots.</p></div>
+<div class="section">
+<hr>
+<h3 class="section"><a name="AEN111">3.1.2. The (global) options
+dialog</a></h3>
+<p>Explain the various settings in this dialog, with
+screenshots.</p></div></div>
+<div class="section">
+<hr>
+<h2 class="section"><a name="AEN114">3.2. Command line
options</a></h2>
<p><b class="command">scummvm</b> [<tt class=
"replaceable"><i>OPTIONS</i></tt>...] <tt class=
@@ -401,28 +430,28 @@
and game names at <a href=
"http://www.scummvm.org/compatibility.php" target=
"_top">http://www.scummvm.org/compatibility.php</a></p>
-<div class="example"><a name="AEN293"></a>
+<div class="example"><a name="AEN299"></a>
<p><b>Example 3-1. Running Monkey Island, fullscreen, from a hard
disk (Win32)</b></p>
<pre class="screen">
C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ monkey
</pre>
</div>
-<div class="example"><a name="AEN296"></a>
+<div class="example"><a name="AEN302"></a>
<p><b>Example 3-2. Running Full Throttle from CD, fullscreen and
with subtitles enabled (Win32)</b></p>
<pre class="screen">
C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft
</pre>
</div>
-<div class="example"><a name="AEN299"></a>
+<div class="example"><a name="AEN305"></a>
<p><b>Example 3-3. Running Monkey Island, fullscreen, from a hard
disk (Unix)</b></p>
<pre class="screen">
/path/to/scummvm -f -p/games/LucasArts/monkey/ monkey
</pre>
</div>
-<div class="example"><a name="AEN302"></a>
+<div class="example"><a name="AEN308"></a>
<p><b>Example 3-4. Running Full Throttle from CD, fullscreen and
with subtitles enabled (Unix)</b></p>
<pre class="screen">
@@ -431,42 +460,42 @@
</div></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN305">3.3. Hot Keys</a></h2>
+<h2 class="section"><a name="AEN311">3.3. Hot Keys</a></h2>
<p>TODO: This also has to cover platform specific
details...</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN308">3.4. Saving and
+<h2 class="section"><a name="AEN314">3.4. Saving and
loading</a></h2>
<p>TODO: Where savegames are stored; autosaves; how to save/load in
the various games (i.e. F5 in SCUMM games); including screenshots,
maybe?</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN311">3.5. Using Macintosh
+<h2 class="section"><a name="AEN317">3.5. Using Macintosh
games</a></h2>
<p>TODO: How to access the HFS disks from a non-mac; maybe point to
rescumm, although this shouldn't be necessary anymore
now.</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN314">3.6. Multi-CD Games</a></h2>
+<h2 class="section"><a name="AEN320">3.6. Multi-CD Games</a></h2>
<p>TODO</p></div></div>
<div class="chapter">
<hr>
-<h1><a name="AEN317"></a>Chapter 4. Configuration</h1>
+<h1><a name="AEN323"></a>Chapter 4. Configuration</h1>
<div class="section">
-<h2 class="section"><a name="AEN319">4.1. Using the
+<h2 class="section"><a name="AEN325">4.1. Using the
launcher</a></h2>
<p>TODO</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN322">4.2. All config file switches
+<h2 class="section"><a name="AEN328">4.2. All config file switches
in detail</a></h2>
<p>TODO</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN325">4.3. Graphics Filters</a></h2>
+<h2 class="section"><a name="AEN331">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
@@ -533,18 +562,63 @@
scalers will scale to 640x480 or 960x720.</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN383">4.4. Music and Sound</a></h2>
-<p>TODO part 1: Sound/midi drivers: list them all, with desc, and
-explanations (current sections 7.0-7.5) part 2: Using compressed
-audiofiles (7.6.x) --> Intro-section which briefly mentions
-pros/cons of compressing your audio data; and compares the
-different encoding schemes. It would also caution the user to check
-that their ScummVM build actually supports that particular encoding
---> sections for: CD tracks; SCUMM; Simon; BS1; BS2 right now we
-have multiple near-identical sections for CD MP3; CD Ogg; CD Flac;
-MONSTER.SOU MP3; ... etc. you get the idea. I'd prefer if we joined
-these, to reduce duplications... part 3: Output sample
-rate</p></div></div>
+<h2 class="section"><a name="AEN389">4.4. Music and Sound</a></h2>
+<p>TODO</p>
+<div class="section">
+<hr>
+<h3 class="section"><a name="AEN392">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="AEN395">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;
+and compares the different encoding schemes. It would also caution
+the user to check that their ScummVM build actually supports that
+particular encoding --> sections for: CD tracks; SCUMM; Simon;
+BS1; BS2 right now we have multiple near-identical sections for CD
+MP3; CD Ogg; CD Flac; MONSTER.SOU MP3; ... etc. you get the idea.
+I'd prefer if we joined these, to reduce duplications...</p></div>
+<div class="section">
+<hr>
+<h3 class="section"><a name="AEN398">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="AEN401">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
+said on this subject, but most of it would be irrelevant here. The
+short version is that for most games 22050 Hz is fine, but in some
+cases 44100 Hz is preferable. On extremely low-end systems you may
+want to use 11025 Hz, but it's unlikely that you have to worry
+about that.</p>
+<p>
To elaborate, most of the sounds ScummVM has to play were
+sampled at either 22050 Hz or 11025 Hz. Using a higher sample rate
+will not magically improve the quality of these sounds. Hence,
+22050 Hz is fine.</p>
+<p>
Some games use CD audio. If you use compressed files for
+this, they are probably sampled at 44100 Hz, so for these games
+that may be a better choice of sample rate.</p>
+<p>
When using the Adlib, FM Towns, PC Speaker or IBM PCjr
+music drivers, ScummVM is responsible for generating the samples.
+Usually 22050 Hz will be plenty for these, but there is at least
+one piece of Adlib music in Beneath a Steeel Sky that will sound a
+lot better at 44100 Hz.</p>
+<p>
Using frequencies in between is not recommended. For one
+thing, your sound card may not support it. In theory, ScummVM
+should fall back on a sensible frequency in that case, but don't
+count on it. More importantly, ScummVM has to resample all sounds
+to its output frequency. This is much easier to do well if the
+output frequency is a multiple of the original
+frequency.</p></div></div></div>
<div class="appendix">
<hr>
<h1><a name="sec.supported-games"></a>Appendix A. Supported
@@ -554,44 +628,44 @@
supported precisely, where to get cutscene packs etc.</p>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN389">A.1. LucasArts Games</a></h2>
+<h2 class="section"><a name="AEN411">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="AEN392">A.2. Humongous Games</a></h2>
+<h2 class="section"><a name="AEN414">A.2. Humongous Games</a></h2>
<p>TODO</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN395">A.3. Adventure Soft
+<h2 class="section"><a name="AEN417">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="AEN398">A.4. Revolution Games</a></h2>
+<h2 class="section"><a name="AEN420">A.4. Revolution Games</a></h2>
<p>TODO: BASS, BS1, BS2</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN401">A.5. Interactive Binary
+<h2 class="section"><a name="AEN423">A.5. Interactive Binary
Illusions Games</a></h2>
<p>TODO: FOTAQ</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN404">A.6. Other Games</a></h2>
+<h2 class="section"><a name="AEN426">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="AEN407"></a>Appendix B. Tools</h1>
+<h1><a name="AEN429"></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>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN410">B.1. compress_san</a></h2>
+<h2 class="section"><a name="AEN432">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=
@@ -601,7 +675,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="AEN422"></a>
+<div class="example"><a name="AEN444"></a>
<p><b>Example B-1. Using compress_san</b></p>
<pre class="screen">
compress_san opening.san uncomp comp
@@ -614,7 +688,7 @@
been built with Ogg support enabled.</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN426">B.2. extract</a></h2>
+<h2 class="section"><a name="AEN448">B.2. extract</a></h2>
<p>TODO</p>
<p>Used to compress .sou files to .so3 (MP3), .sog (Vorbis), or
.sof (FLAC).</p>
@@ -656,7 +730,7 @@
</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN431">B.3. queenrebuild</a></h2>
+<h2 class="section"><a name="AEN453">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>
@@ -674,7 +748,7 @@
</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN436">B.4. simon2mp3</a></h2>
+<h2 class="section"><a name="AEN458">B.4. simon2mp3</a></h2>
<p>TODO</p>
<p>Compresses Simon voc/wav files to MP3/Ogg/FLAC.</p>
<pre class="screen">
@@ -716,7 +790,7 @@
</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN441">B.5. sword1mp3</a></h2>
+<h2 class="section"><a name="AEN463">B.5. sword1mp3</a></h2>
<p>TODO</p>
<p>Used to compress Broken Sword 1's music and speech files using
mp3 or vorbis.</p>
@@ -740,7 +814,7 @@
</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN446">B.6. sword2mp3</a></h2>
+<h2 class="section"><a name="AEN468">B.6. sword2mp3</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>
@@ -785,8 +859,8 @@
</div></div>
<div class="appendix">
<hr>
-<h1><a name="AEN452"></a>Appendix C. Credits</h1>
-<div class="informaltable"><a name="AEN454"></a>
+<h1><a name="AEN474"></a>Appendix C. Credits</h1>
+<div class="informaltable"><a name="AEN476"></a>
<table border="0" frame="void" rules="none" class="CALSTABLE">
<col width="19" title="start">
<col width="151" title="name">
@@ -1015,7 +1089,7 @@
reimplement that it is today. Feel free to drop us a line and tell
us what you think, guys!</p></div>
<div class="GLOSSARY">
-<h1><a name="AEN623"></a>Glossary</h1>
+<h1><a name="AEN645"></a>Glossary</h1>
<p>TODO: (explaining abbreviations etc.). Like SCUMM, FOTAQ, COMI,
FOA, ITE, ...</p>
<dl>
@@ -1038,7 +1112,7 @@
<p>TODO</p></dd></dl></div>
<div class="index">
<hr>
-<h1><a name="AEN646"></a>Index</h1>
+<h1><a name="AEN668"></a>Index</h1>
<p>TODO: Note that docbook can be used to automate the generation
of an index!</p></div></div>
</body>
Index: manual.xml
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- manual.xml 20 Dec 2004 01:30:56 -0000 1.9
+++ manual.xml 20 Dec 2004 01:45:46 -0000 1.10
@@ -118,7 +118,8 @@
<title>How to get ScummVM</title>
<section>
<title>Binaries</title>
- <para>TODO: list supported platforms</para>
+ <para>TODO: list supported platforms; where to get binaries; list requirments
+ (in terms of required/optional libraries, CPU power, memory, ...</para>
</section>
<section>
@@ -137,7 +138,9 @@
<section>
<title>Installation</title>
- <para>TODO</para>
+ <para>TODO: Not sure whether we really need this section;
+ most of it should already be covered by the above section
+ "How to get ScummVM", I think?</para>
<section>
<title>Unix-like (Linux, *BSD, Solaris, etc.)</title>
<para>TODO</para>
@@ -241,6 +244,18 @@
<title>The launcher</title>
<para>TODO: Explain the launcher and how to use it (even though I hope
that it's pretty much straightforward); including screenshots?</para>
+
+ <section>
+ <title>Adding/editing/removing a game</title>
+ <para>TODO: Explain how to add a new game, how to edit its settings;
+ maybe explain what those setting means, with refs to the corresponding
+ sections. All with screenshots.</para>
+ </section>
+
+ <section>
+ <title>The (global) options dialog</title>
+ <para>Explain the various settings in this dialog, with screenshots.</para>
+ </section>
</section>
<section>
@@ -663,9 +678,18 @@
<section>
<title>Music and Sound</title>
<para>TODO
- part 1: Sound/midi drivers: list them all, with desc, and explanations
- (current sections 7.0-7.5)
- part 2: Using compressed audiofiles (7.6.x)
+ </para>
+ <section>
+ <title>Music drivers</title>
+ <para>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.
+ </para>
+ </section>
+
+ <section>
+ <title>Using compressed audiofiles</title>
+ <para>TODO: Corresponds to current section 7.6.
--> Intro-section which briefly mentions pros/cons of compressing
your audio data; and compares the different encoding schemes.
It would also caution the user to check that their ScummVM
@@ -674,8 +698,50 @@
right now we have multiple near-identical sections for
CD MP3; CD Ogg; CD Flac; MONSTER.SOU MP3; ... etc. you get the
idea. I'd prefer if we joined these, to reduce duplications...
- part 3: Output sample rate
- </para>
+ </para>
+ </section>
+
+ <section>
+ <title>Volume settings</title>
+ <para>TODO: Explain about the volume settings, what the values mean, etc.
+ The launcher, command line, config file sections all would refer to here.
+ </para>
+ </section>
+
+ <section>
+ <title>Output sample rate</title>
+ <para>
+ The output sample rate tells ScummVM how many sound samples to play per channel
+ per second. There is much that could be said on this subject, but most of it
+ would be irrelevant here. The short version is that for most games 22050 Hz is
+ fine, but in some cases 44100 Hz is preferable. On extremely low-end systems
+ you may want to use 11025 Hz, but it's unlikely that you have to worry about
+ that.
+ </para>
+ <para>
+ To elaborate, most of the sounds ScummVM has to play were sampled at either
+ 22050 Hz or 11025 Hz. Using a higher sample rate will not magically improve the
+ quality of these sounds. Hence, 22050 Hz is fine.
+ </para>
+ <para>
+ Some games use CD audio. If you use compressed files for this, they are
+ probably sampled at 44100 Hz, so for these games that may be a better choice of
+ sample rate.
+ </para>
+ <para>
+ When using the Adlib, FM Towns, PC Speaker or IBM PCjr music drivers, ScummVM
+ is responsible for generating the samples. Usually 22050 Hz will be plenty for
+ these, but there is at least one piece of Adlib music in Beneath a Steeel Sky
+ that will sound a lot better at 44100 Hz.
+ </para>
+ <para>
+ Using frequencies in between is not recommended. For one thing, your sound card
+ may not support it. In theory, ScummVM should fall back on a sensible frequency
+ in that case, but don't count on it. More importantly, ScummVM has to resample
+ all sounds to its output frequency. This is much easier to do well if the
+ output frequency is a multiple of the original frequency.
+ </para>
+ </section>
</section>
</chapter>
Index: manual.pdf
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.pdf,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- manual.pdf 20 Dec 2004 01:31:01 -0000 1.7
+++ manual.pdf 20 Dec 2004 01:45:46 -0000 1.8
@@ -156,231 +156,267 @@
(3.1. The launcher)
endobj
105 0 obj
-<< /S /GoTo /D (6.10.1) >>
+<< /S /GoTo /D (6.9.12.2) >>
endobj
108 0 obj
-(3.2. Command line options)
+(3.1.1. Adding/editing/removing a game)
endobj
109 0 obj
[...6990 lines suppressed...]
-0000163729 00000 n
-0000163956 00000 n
+0000169665 00000 n
+0000176561 00000 n
+0000176600 00000 n
+0000176638 00000 n
+0000176865 00000 n
trailer
<<
-/Size 851
-/Root 849 0 R
-/Info 850 0 R
+/Size 907
+/Root 905 0 R
+/Info 906 0 R
>>
startxref
-164111
+177020
%%EOF
Index: manual.txt
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.txt,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- manual.txt 20 Dec 2004 01:31:02 -0000 1.6
+++ manual.txt 20 Dec 2004 01:45:46 -0000 1.7
@@ -52,6 +52,10 @@
3.1. The launcher
+ 3.1.1. Adding/editing/removing a game
+
+ 3.1.2. The (global) options dialog
+
3.2. Command line options
3.3. Hot Keys
@@ -72,6 +76,14 @@
4.4. Music and Sound
+ 4.4.1. Music drivers
+
+ 4.4.2. Using compressed audiofiles
+
+ 4.4.3. Volume settings
+
+ 4.4.4. Output sample rate
+
A. Supported Games
A.1. LucasArts Games
@@ -214,7 +226,8 @@
2.1.1. Binaries
- TODO: list supported platforms
+ TODO: list supported platforms; where to get binaries; list requirments
+ (in terms of required/optional libraries, CPU power, memory, ...
----------------------------------------------------------------------
@@ -230,7 +243,8 @@
2.2. Installation
- TODO
+ TODO: Not sure whether we really need this section; most of it should
+ already be covered by the above section "How to get ScummVM", I think?
----------------------------------------------------------------------
@@ -308,6 +322,20 @@
----------------------------------------------------------------------
+ 3.1.1. Adding/editing/removing a game
+
+ TODO: Explain how to add a new game, how to edit its settings; maybe
+ explain what those setting means, with refs to the corresponding sections.
+ All with screenshots.
+
+ ----------------------------------------------------------------------
+
+ 3.1.2. The (global) options dialog
+
+ Explain the various settings in this dialog, with screenshots.
+
+ ----------------------------------------------------------------------
+
3.2. Command line options
scummvm [OPTIONS...] GAME
@@ -599,16 +627,66 @@
4.4. Music and Sound
- TODO part 1: Sound/midi drivers: list them all, with desc, and
- explanations (current sections 7.0-7.5) part 2: Using compressed
- audiofiles (7.6.x) --> Intro-section which briefly mentions pros/cons of
- compressing your audio data; and compares the different encoding schemes.
- It would also caution the user to check that their ScummVM build actually
- supports that particular encoding --> sections for: CD tracks; SCUMM;
- Simon; BS1; BS2 right now we have multiple near-identical sections for CD
- MP3; CD Ogg; CD Flac; MONSTER.SOU MP3; ... etc. you get the idea. I'd
- prefer if we joined these, to reduce duplications... part 3: Output sample
- rate
+ TODO
+
+ ----------------------------------------------------------------------
+
+ 4.4.1. Music drivers
+
+ 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.
+
+ ----------------------------------------------------------------------
+
+ 4.4.2. Using compressed audiofiles
+
+ TODO: Corresponds to current section 7.6. --> Intro-section which briefly
+ mentions pros/cons of compressing your audio data; and compares the
+ different encoding schemes. It would also caution the user to check that
+ their ScummVM build actually supports that particular encoding -->
+ sections for: CD tracks; SCUMM; Simon; BS1; BS2 right now we have multiple
+ near-identical sections for CD MP3; CD Ogg; CD Flac; MONSTER.SOU MP3; ...
+ etc. you get the idea. I'd prefer if we joined these, to reduce
+ duplications...
+
+ ----------------------------------------------------------------------
+
+ 4.4.3. Volume settings
+
+ TODO: Explain about the volume settings, what the values mean, etc. The
+ launcher, command line, config file sections all would refer to here.
+
+ ----------------------------------------------------------------------
+
+ 4.4.4. Output sample rate
+
+
The output sample rate tells ScummVM how many sound samples to play per
+ channel per second. There is much that could be said on this subject, but
+ most of it would be irrelevant here. The short version is that for most
+ games 22050 Hz is fine, but in some cases 44100 Hz is preferable. On
+ extremely low-end systems you may want to use 11025 Hz, but it's unlikely
+ that you have to worry about that.
+
+
To elaborate, most of the sounds ScummVM has to play were sampled at
+ either 22050 Hz or 11025 Hz. Using a higher sample rate will not magically
+ improve the quality of these sounds. Hence, 22050 Hz is fine.
+
+
Some games use CD audio. If you use compressed files for this, they are
+ probably sampled at 44100 Hz, so for these games that may be a better
+ choice of sample rate.
+
+
When using the Adlib, FM Towns, PC Speaker or IBM PCjr music drivers,
+ ScummVM is responsible for generating the samples. Usually 22050 Hz will
+ be plenty for these, but there is at least one piece of Adlib music in
+ Beneath a Steeel Sky that will sound a lot better at 44100 Hz.
+
+
Using frequencies in between is not recommended. For one thing, your
+ sound card may not support it. In theory, ScummVM should fall back on a
+ sensible frequency in that case, but don't count on it. More importantly,
+ ScummVM has to resample all sounds to its output frequency. This is much
+ easier to do well if the output frequency is a multiple of the original
+ frequency.
----------------------------------------------------------------------
More information about the Scummvm-git-logs
mailing list