aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEugene Sandulenko2006-06-06 21:51:28 +0000
committerEugene Sandulenko2006-06-06 21:51:28 +0000
commitb28aea19f0dabf149741c0517edaaff1e70561f0 (patch)
treeb35271e5e793426624207d3ccfde199199fefd7f /doc
parent506456d0146fd83c16e117ad2d543bdb828223dd (diff)
downloadscummvm-rg350-b28aea19f0dabf149741c0517edaaff1e70561f0.tar.gz
scummvm-rg350-b28aea19f0dabf149741c0517edaaff1e70561f0.tar.bz2
scummvm-rg350-b28aea19f0dabf149741c0517edaaff1e70561f0.zip
Next step of TeX syncing from Joachim
svn-id: r22957
Diffstat (limited to 'doc')
-rw-r--r--doc/audio-adlib.tex3
-rw-r--r--doc/audio-compression.tex11
-rw-r--r--doc/audio-fluidsynth.tex7
-rw-r--r--doc/audio-midi-emulated.tex5
-rw-r--r--doc/audio-midi-native.tex7
-rw-r--r--doc/audio-midi-sequencer.tex3
-rw-r--r--doc/audio-mt32.tex10
-rw-r--r--doc/audio-samplerate.tex4
-rw-r--r--doc/audio.tex7
-rw-r--r--doc/bugs.tex2
-rw-r--r--doc/compiling.tex3
-rw-r--r--doc/config.tex6
-rw-r--r--doc/contact.tex1
-rw-r--r--doc/games-bass.tex1
-rw-r--r--doc/games-comi.tex16
-rw-r--r--doc/games-feeble.tex1
-rw-r--r--doc/games-gob.tex1
-rw-r--r--doc/games-ite.tex1
-rw-r--r--doc/games-kyra.tex1
-rw-r--r--doc/games-problems.tex3
-rw-r--r--doc/games-queen.tex1
-rw-r--r--doc/games-simon.tex1
-rw-r--r--doc/games-sword.tex7
-rw-r--r--doc/games.tex16
-rw-r--r--doc/platforms.tex14
-rw-r--r--doc/readme.tex6
-rw-r--r--doc/running-graphics-filters.tex22
-rw-r--r--doc/running-hotkeys.tex28
-rw-r--r--doc/running-language.tex16
-rw-r--r--doc/running-mac-games.tex2
-rw-r--r--doc/running-multicd.tex10
-rw-r--r--doc/running-options.tex23
-rw-r--r--doc/running.tex15
-rw-r--r--doc/saves.tex21
34 files changed, 160 insertions, 115 deletions
diff --git a/doc/audio-adlib.tex b/doc/audio-adlib.tex
index fa4b0c6649..e2610a51a6 100644
--- a/doc/audio-adlib.tex
+++ b/doc/audio-adlib.tex
@@ -1,9 +1,10 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\subsection{Playing sound with Adlib emulation}
By default an Adlib card will be emulated and ScummVM will output the music
diff --git a/doc/audio-compression.tex b/doc/audio-compression.tex
index 5eada69a00..2670c74bf6 100644
--- a/doc/audio-compression.tex
+++ b/doc/audio-compression.tex
@@ -1,12 +1,14 @@
-%%% Local Variables:
+%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
-%%% End:
+%%% TeX-master: "readme.tex"
+%%% End:
+
\subsection{Using compressed audiofiles (MP3, Ogg Vorbis, Flac)}
\label{sect-compressing-audiofiles}
+
\subsubsection{Using MP3 files for CD audio}
Use LAME or some other MP3 encoder to rip the CD audio tracks to files. Name
@@ -32,6 +34,7 @@ command line with the value after q specifying the desired quality from 0 to 10:
\subsubsection{Using Flac files for CD audio}
+
Use flac or some other flac encoder to encode the audio tracks to files.
Name the files track1.flac track2.flac etc. In your filesystem only allows
three letter extensions, name the files track1.fla track2.fla etc.
@@ -115,6 +118,7 @@ For Flac add --flac and optional parameters, i.e.
Eventually you will have a much smaller *.mp3, *.ogg or *.fla file, copy this
file to your game directory. You can safely remove the old file.
+
\subsubsection{Compressing speech/music in Broken Sword 1}
The compress\_sword1 tool from the scummvm-tools package can encode music and
@@ -139,6 +143,7 @@ Use
%
to get a full list of the options.
+
\subsubsection{Compressing speech/music in Broken Sword 2}
Use our compress\_sword2 util from the scummvm-tools package to perform this
diff --git a/doc/audio-fluidsynth.tex b/doc/audio-fluidsynth.tex
index 4acc95ae2d..ad09db8ef8 100644
--- a/doc/audio-fluidsynth.tex
+++ b/doc/audio-fluidsynth.tex
@@ -1,18 +1,19 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\subsection{Playing sound with FluidSynth MIDI emulation}
-If ScummVM was build with libfluildsynth support it will be able to play MIDI
+If ScummVM was build with libfluidsynth support it will be able to play MIDI
music through the FluidSynth driver. You will have to specify a SoundFont to
use, however.
Since the default output volume from FluidSynth can be fairly low, ScummVM will
set the gain by default to get a stronger signal. This can be further adjusted
-using the --midi-gain command-line option, or the ``midi\_gain'' config file
+using the --midi-gain command-line option, or the "midi\_gain" config file
setting.
The setting can take any value from 0 through 1000, with the default being 100.
diff --git a/doc/audio-midi-emulated.tex b/doc/audio-midi-emulated.tex
index 1c59bc520c..aae0c6b73e 100644
--- a/doc/audio-midi-emulated.tex
+++ b/doc/audio-midi-emulated.tex
@@ -1,12 +1,13 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\subsection{Playing sound with MIDI emulation}
-Some games (such as Sam and Max) only contain MIDI music data. This once
+Some games (such as Sam \& Max) only contain MIDI music data. This once
prevented music for these games from working on platforms that do not support
MIDI, or soundcards that do not provide MIDI drivers (e.g, many soundcards will
not play MIDI under Linux). ScummVM can now emulate MIDI mode using sampled
diff --git a/doc/audio-midi-native.tex b/doc/audio-midi-native.tex
index bd754bf9ee..f62cc5674e 100644
--- a/doc/audio-midi-native.tex
+++ b/doc/audio-midi-native.tex
@@ -1,16 +1,20 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\subsection{Playing sound with Native MIDI}
% FIXME: Hardcoding < and > here produces wrong output
+
Use the appropriate -e<mode> command line option from the list above to
select your preferred MIDI device. For example, if you wish to use the
Windows MIDI driver, use the -ewindows option.
+
\subsubsection{Using MIDI options to customize Native MIDI output}
+
ScummVM supports a variety of MIDI modes, depending on the capabilities
of your MIDI device.
@@ -38,4 +42,3 @@ soundtracks.
Some games contain sound effects that are exclusive to the Adlib soundtrack.
For these games, you may wish to specify --multi-midi in order to combine
MIDI music with Adlib sound effects.
-
diff --git a/doc/audio-midi-sequencer.tex b/doc/audio-midi-sequencer.tex
index 4e8b7d8695..2e0a0b26dc 100644
--- a/doc/audio-midi-sequencer.tex
+++ b/doc/audio-midi-sequencer.tex
@@ -1,9 +1,10 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\subsection{Playing sound with Sequencer MIDI}
If your soundcard driver supports a sequencer, you may set the environment
diff --git a/doc/audio-mt32.tex b/doc/audio-mt32.tex
index 59dc6c48b6..4055a39964 100644
--- a/doc/audio-mt32.tex
+++ b/doc/audio-mt32.tex
@@ -1,19 +1,21 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\subsection{Playing sound with MT-32 emulation}
Some games which contain MIDI music data also have improved tracks designed
-for MT-32 sound module. ScummVM can now emulate this card, however you should
-provide original MT-32 ROMs to make it work.
+for the MT-32 sound module. ScummVM can now emulate this device, however you
+must provide original MT-32 ROMs to make it work:
MT32\_PCM.ROM - IC21 (512KB)
MT32\_CONTROL.ROM - IC26 (32KB) and IC27 (32KB), interleaved byte-wise
-Place these ROMs in the game directory or a directory specified by extrapath.
+Place these ROMs in the game directory, in your extrapath, or in the directory
+where your ScummVM executable resides.
You don't need to specify --native-mt32 with this driver, as it automatically
gets turned on.
diff --git a/doc/audio-samplerate.tex b/doc/audio-samplerate.tex
index 31c95e00ca..805bfc13fb 100644
--- a/doc/audio-samplerate.tex
+++ b/doc/audio-samplerate.tex
@@ -1,8 +1,10 @@
+
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\subsection{Output sample rate}
The output sample rate tells ScummVM how many sound samples to play per channel
diff --git a/doc/audio.tex b/doc/audio.tex
index 477d469936..6a243f3c59 100644
--- a/doc/audio.tex
+++ b/doc/audio.tex
@@ -1,10 +1,12 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\section{Music and Sound} \label{sect-music-and-sound}
+
By default, on most operating systems, ScummVM will automatically use Adlib
emulation. MIDI may not be available on all operating systems or may need
manual configuration. If you ARE using MIDI, you have several different
@@ -31,9 +33,10 @@ choices of output, depending on your operating system and configuration.
To select a sound driver, pass its name via the '-e' option to scummvm,
for example:
\begin{verbatim}
- scummvm -e adlib monkey2
+ scummvm -eadlib monkey2
\end{verbatim}
+
\input {audio-adlib.tex}
\input {audio-fluidsynth.tex}
\input {audio-mt32.tex}
diff --git a/doc/bugs.tex b/doc/bugs.tex
index db12f4ca95..6fd241af69 100644
--- a/doc/bugs.tex
+++ b/doc/bugs.tex
@@ -13,7 +13,7 @@ still occurs in the latest SVN/Daily build version. Also check the known
problems list (below) and the compatibility list on our website for that
game, to ensure the issue is not already known:
- http://www.scummvm.org/compatibility_stable.php
+ \url{http://www.scummvm.org/compatibility_stable.php}
Also do not report bugs on games that are not listed as being completable
in the 'Supported Games' section, or compatibility list. We \textit{know} those
diff --git a/doc/compiling.tex b/doc/compiling.tex
index 1b1e3adfb3..dfcea9c2d1 100644
--- a/doc/compiling.tex
+++ b/doc/compiling.tex
@@ -1,9 +1,10 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\section{Compiling}
You need SDL-1.2.2 or newer (older versions may work, but are unsupported), and
diff --git a/doc/config.tex b/doc/config.tex
index e6696fe1cc..f41a5cd35e 100644
--- a/doc/config.tex
+++ b/doc/config.tex
@@ -1,11 +1,11 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
-\section{Configurations Files}
+\section{Configuration file}
By default, the configuration file is saved in, and loaded from:
%
@@ -137,7 +137,7 @@ Flight of the Amazon Queen adds the following non-standard keywords:\\
sfx\_mute &bool &If true, sound effects are muted\\
\end{tabular}
-Simon the Sorcerer 1 \& 2 add the following non-standard keywords:\\
+Simon the Sorcerer 1 and 2 add the following non-standard keywords:\\
\begin{tabular}[h]{lll}
music\_mute &bool &If true, music is muted\\
sfx\_mute &bool &If true, sound effects are muted\\
diff --git a/doc/contact.tex b/doc/contact.tex
index 692508d67a..34e865db30 100644
--- a/doc/contact.tex
+++ b/doc/contact.tex
@@ -13,4 +13,5 @@ mailing list, or chat with us on IRC (#scummvm on irc.freenode.net)
Please do not ask us to support an unsupported game -- read the FAQ on our
web site first.
+
\input {bugs.tex}
diff --git a/doc/games-bass.tex b/doc/games-bass.tex
index f2c7905273..ba483775a0 100644
--- a/doc/games-bass.tex
+++ b/doc/games-bass.tex
@@ -6,6 +6,7 @@
\subsection{Beneath a Steel Sky notes}
+
Starting with ScummVM 0.8.0 you need the additional 'SKY.CPT' file to run
Beneath a Steel Sky.
diff --git a/doc/games-comi.tex b/doc/games-comi.tex
new file mode 100644
index 0000000000..5ec196d216
--- /dev/null
+++ b/doc/games-comi.tex
@@ -0,0 +1,16 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
+\subsection{The Curse of Monkey Island notes}
+
+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.
+
+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.
diff --git a/doc/games-feeble.tex b/doc/games-feeble.tex
index 9ac2e4159a..e3a90b1cc0 100644
--- a/doc/games-feeble.tex
+++ b/doc/games-feeble.tex
@@ -6,6 +6,7 @@
\subsection{The Feeble Files notes}
+
If you have the Windows version of The Feeble Files, there are two things to
note. First of all, more than 300 files, most of them necessary for the game to
run, are stored in a file called data1.cab. ScummVM does not know how to unpack
diff --git a/doc/games-gob.tex b/doc/games-gob.tex
index 4ef7d4ab26..10e86997fb 100644
--- a/doc/games-gob.tex
+++ b/doc/games-gob.tex
@@ -6,6 +6,7 @@
\subsection{Gobliiins notes}
+
The CD version of Gobliiins contains one big audio track which you need to rip
(See the section on using compressed audio files) and copy into the game
directory if you want to have in-game music without the CD in the drive
diff --git a/doc/games-ite.tex b/doc/games-ite.tex
index 7a8e8456d5..f46df1520f 100644
--- a/doc/games-ite.tex
+++ b/doc/games-ite.tex
@@ -6,6 +6,7 @@
\subsection{Inherit the Earth: Quest for the Orb notes}
+
In order to run the Mac OS X Wyrmkeep re-release of the game you will need to
copy over data from the CD to your hard drive. If you're on a PC then consult:
diff --git a/doc/games-kyra.tex b/doc/games-kyra.tex
index 8c9c3ab50d..13ff624f1f 100644
--- a/doc/games-kyra.tex
+++ b/doc/games-kyra.tex
@@ -6,5 +6,6 @@
\subsection{The Legend of Kyrandia notes}
+
To run The Legend of Kyrandia under ScummVM you need the 'kyra.dat' file,
which can be found in the downloads section of the ScummVM website.
diff --git a/doc/games-problems.tex b/doc/games-problems.tex
index a228fea597..11d4da0a0e 100644
--- a/doc/games-problems.tex
+++ b/doc/games-problems.tex
@@ -72,11 +72,10 @@ Simon the Sorcerer 2:
\end{itemize}
The Feeble Files
\begin{itemize}
- \item Subtitles are often imcomplete, they were always disabled in the
+ \item Subtitles are often incomplete, they were always disabled in the
original game.
\end{itemize}
Humongous Entertainment Games
\begin{itemize}
\item No support for printing images
\end{itemize}
-
diff --git a/doc/games-queen.tex b/doc/games-queen.tex
index 0797ca36ba..423ad06055 100644
--- a/doc/games-queen.tex
+++ b/doc/games-queen.tex
@@ -6,6 +6,7 @@
\subsection{Flight of the Amazon Queen notes}
+
In order to use a non-freeware version of Flight of the Amazon Queen (from
original CD), you will need to place the 'queen.tbl' file (available from the
Compatibility page on our website) in either the directory containing the
diff --git a/doc/games-simon.tex b/doc/games-simon.tex
index e87e341678..c341142273 100644
--- a/doc/games-simon.tex
+++ b/doc/games-simon.tex
@@ -6,6 +6,7 @@
\subsection{Simon the Sorcerer 1 and 2 notes}
+
If you have the dual version of Simon the Sorcerer 1 or 2 on CD, you will
find the Windows version in the main directory of the CD and the DOS version
in the DOS directory of the CD.
diff --git a/doc/games-sword.tex b/doc/games-sword.tex
index 45d519b4d1..4bafd09f65 100644
--- a/doc/games-sword.tex
+++ b/doc/games-sword.tex
@@ -6,13 +6,14 @@
\subsection {Broken Sword notes}
+
Broken Sword 1 and 2 both come with in-game cutscenes compressed using
RAD Game Tools legacy Smacker(tm) format. As RAD is unwilling to open
the older legacy versions of this format to us, and have requested we not
reverse engineer it, Revolution Software has kindly allowed us to provide
re-encoded Broken Sword cutscenes for download on our website:
- http://www.scummvm.org/downloads.php
+ \url{http://www.scummvm.org/downloads.php}
These cutscenes are provided in MPEG2 format with OGG Vorbis audio.
Viewing these cutscenes thus requires a version of ScummVM compiled
@@ -26,7 +27,9 @@ 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.
+
\subsubsection{Broken Sword 1}
+
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
@@ -40,7 +43,9 @@ that it makes little difference.
ScummVM does not support the original cutscene files, so there is no need to
copy them.
+
\subsubsection{Broken Sword 2}
+
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
diff --git a/doc/games.tex b/doc/games.tex
index 72aee249be..d7d4b44b11 100644
--- a/doc/games.tex
+++ b/doc/games.tex
@@ -107,31 +107,19 @@ encounter such a bug in a 'supported' game.
\end{itemize}
-%% next section
+
\input {games-copyprot.tex}
-%% next section
\input {games-c64.tex}
-%% next section
\input {games-mmnes.tex}
-%% next section
\input {running-mac-games.tex}
-%% next section
\input {running-multicd.tex}
-%% next section
+\input {games-comi.tex}
\input {games-sword.tex}
-%% next section
\input {games-bass.tex}
-%% next section
\input {games-queen.tex}
-%% next section
\input {games-gob.tex}
-%next section
\input {games-ite.tex}
-%% next section
\input {games-simon.tex}
-%% next section
\input {games-feeble.tex}
-%% next section
\input {games-kyra.tex}
-%% next section
\input {games-problems.tex}
diff --git a/doc/platforms.tex b/doc/platforms.tex
index 462bb53a78..69c54ac1e8 100644
--- a/doc/platforms.tex
+++ b/doc/platforms.tex
@@ -1,14 +1,16 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\section{Supported Platforms}
+
ScummVM has been ported to run on many platforms and operating systems.
Links to these ports can be found either on the ScummVM web page or by a
Google search. Many thanks to the effort of porters. If you have a port of
-ScummVM and wish to commit it into the main CVS, feel free to contact us!
+ScummVM and wish to commit it into the main SVN, feel free to contact us!
Supported platforms include (but are not limited to):
@@ -27,8 +29,8 @@ RISC OS \\
Symbian \\
\end{tabular}
-The Dreamcast port does not support Curse of Monkey Island, nor The Dig.
-The PalmOS port does not support Curse of Monkey Island, Beneath a Steel
+The Dreamcast port does not support The Curse of Monkey Island, nor The Dig.
+The PalmOS port does not support The Curse of Monkey Island, Beneath a Steel
Sky, nor either Simon the Sorcerer 1 or 2. The Dig will only work on some
Palm devices (those with a large dynamic heap).
@@ -41,13 +43,13 @@ maintainer). In some cases (e.g. Linux), the standard SDL support works
instead.
\begin{tabular}{ll}
+Linux &(includes iPAQs running Linux)\\
MorphOS\\
GP32 \\
-Linux \\
\end{tabular}
We have reports about unofficial ports to the following platforms. Please
-note that this are not made by us, so we neither endorse nor support them.
+note that these are not made by us, so we neither endorse nor support them.
Use at your own risk!
\begin{tabular}{ll}
diff --git a/doc/readme.tex b/doc/readme.tex
index c3e3ca7087..4ee39064be 100644
--- a/doc/readme.tex
+++ b/doc/readme.tex
@@ -1,10 +1,12 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: t
+%%% TeX-master: "readme.tex"
%%% End:
+
+
\documentclass [a4paper]{article}
-%\author {Hannes Niederhausen}
+%\author {The ScummVM Team}
\title {ScummVM ReadMe}
\usepackage{hyperref}
diff --git a/doc/running-graphics-filters.tex b/doc/running-graphics-filters.tex
index 43e8598fe8..a78817355d 100644
--- a/doc/running-graphics-filters.tex
+++ b/doc/running-graphics-filters.tex
@@ -1,17 +1,19 @@
+
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
-\subsection {Graphics filters} \label{sect-gfx-filters}
+\subsection{Graphics filters} \label{sect-gfx-filters}
+
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 graphics, and scale it by a
+MAME. These filters take the original game graphics, and scale it by a
certain fixed factor (usually 2x or 3x) before displaying them to you.
So for example, if the game originally run at a resolution of 320x200
(typical for most of the SCUMM games), then using a filter with scale
-factor 2x will effectively yield 640x400 graphics. Likewise with a
+factor 2x will effectively yield 640x400 graphics. Likewise with a
3x filter you'll get 960x600.
They are:\\
@@ -19,9 +21,9 @@ They are:\\
1x & No filtering, no scaling. Fastest.\\
2x & No filtering, factor 2x (default for non 640x480 games).\\
3x & No filtering, factor 3x.\\
- 2xsai & 2xsai filter, factor 2x.\\
- super2xsai & Enhanced 2xsai filtering, factor 2x.\\
- supereagle & Less blurry than 2xsai, but slower. Factor 2x.\\
+ 2xsai & 2xSAI filter, factor 2x.\\
+ super2xsai & Enhanced 2xSAI filtering, factor 2x.\\
+ supereagle & Less blurry than 2xSAI, but slower. Factor 2x.\\
advmame2x & Doesn't rely on blurring like 2xSAI, fast. Factor 2x.\\
advmame3x & Doesn't rely on blurring like 2xSAI, fast. Factor 3x.\\
hq2x & Very nice high quality filter but slow. Factor 2x.\\
@@ -34,7 +36,7 @@ To select a graphics filter, pass its name via the '-g' option to scummvm,
for example:
\begin{verbatim}
- scummvm -g advmame2x monkey2
+ scummvm -gadvmame2x monkey2
\end{verbatim}
\begin{enumerate}
\item [Note \#1] Not all backends support all or any filters. The ones
@@ -42,7 +44,7 @@ for example:
\item [Note \#2] Filters can be very slow when ScummVM is compiled in a
debug configuration without optimizations. And there is always a
speed impact when using any form of anti-aliasing/linear filtering.
-\item [Note \#3] The FM-TOWNS version of Zak uses an
- original resolution of 320x240 -- hence for this game scalers will
+\item [Note \#3] The FM-TOWNS version of Zak McKracken uses an
+ original resolution of 320x240, hence for this game scalers will
scale to 640x480 or 960x720.
\end{enumerate}
diff --git a/doc/running-hotkeys.tex b/doc/running-hotkeys.tex
index 511d136904..a1f3ffbb5c 100644
--- a/doc/running-hotkeys.tex
+++ b/doc/running-hotkeys.tex
@@ -1,12 +1,15 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\subsection{Hot Keys}
-ScummVM supports various in game hotkeys. They differ between the SCUMM and
+
+ScummVM supports various in game hotkeys. They differ between SCUMM games and
other games.
+
\begin{itemize}
\item Common:\\
\begin{tabular}{ll}
@@ -26,13 +29,13 @@ other games.
& instead, or a multiple thereof\\
Alt-Enter & Toggles full screen/windowed\\
\end{tabular}
-\item Scumm:\\
+\item SCUMM:\\
\begin{tabular}{ll}
Ctrl 0-9 and Alt 0-9 & Load and save game state\\
- Ctrl-g & Runs in really REALLY fast mode\\
Ctrl-d & Starts the debugger\\
- Ctrl-t & Switch between 'Speech only', 'Speech and Subtitles'\\
- & and 'Subtitles only'\\
+ Ctrl-g & Runs in really REALLY fast mode\\
+ Ctrl-t & Switch between 'Speech only',\\
+ & 'Speech and Subtitles' and 'Subtitles only'\\
Tilde \verb#~# & Show/hide the debugging console\\
Ctrl-s & Shows memory consumption\\
$[$ and $]$ & Music volume, down/up\\
@@ -70,7 +73,7 @@ other games.
Escape & Skips cutscenes\\
Space & Skips current line of text\\
\end{tabular}
-\item Simon the Sorcerer 1 \& 2:\\
+\item Simon the Sorcerer 1 and 2:\\
\begin{tabular}{ll}
Ctrl 0-9 and Alt 0-9 & Load and save game state\\
Ctrl-d & Starts the debugger\\
@@ -84,7 +87,7 @@ other games.
p & Pauses\\
t & Switch between speech and subtitles\\
v & Switch between subtitles only and\\
- & combined speech \& subtitles\\
+ & combined speech and subtitles\\
& (Simon the Sorcerer 2 only)\\
\end{tabular}
\item The Feeble Files:\\
@@ -97,7 +100,7 @@ other games.
p & Pauses\\
t & Switch between speech and subtitles\\
v & Switch between subtitles only and\\
- & combined speech \& subtitles\\
+ & combined speech and subtitles\\
& (Simon the Sorcerer 2 only)\\
\end{tabular}
\item The Legend of Kyrandia:\\
@@ -106,11 +109,8 @@ other games.
Ctrl-d & Starts the debugger\\
\end{tabular}
\end{itemize}
+
Note that using ctrl-f and ctrl-g are not recommended: games can crash when
-being ran faster than their normal speed, as scripts will lose synchronisation.
+being run faster than their normal speed, as scripts will lose synchronisation.
Ctrl-f is not supported by the Broken Sword games.
-%%% Local Variables:
-%%% mode: latex
-%%% TeX-master: "readme"
-%%% End:
diff --git a/doc/running-language.tex b/doc/running-language.tex
index 71f0a61c01..5b9b8205a8 100644
--- a/doc/running-language.tex
+++ b/doc/running-language.tex
@@ -1,7 +1,15 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Language options} \label{sect-languages}
ScummVM includes a language option for Maniac Mansion, Zak McKracken, The Dig,
-Curse of Monkey Island, Beneath a Steel Sky. and Simon the Sorcerer 1 \& 2.
+The Curse of Monkey Island, Beneath a Steel Sky, Broken Sword 1 and
+Simon the Sorcerer 1 and 2.
\begin{itemize}
\item Maniac Mansion and Zak McKracken:
@@ -18,7 +26,7 @@ Curse of Monkey Island, Beneath a Steel Sky. and Simon the Sorcerer 1 \& 2.
\item zh - Chinese
\item kr - Korean
\end{itemize}
-\item Curse of Monkey Island
+\item The Curse of Monkey Island
\begin{itemize}
\item en - English (default)
\item de - German
@@ -33,7 +41,7 @@ Curse of Monkey Island, Beneath a Steel Sky. and Simon the Sorcerer 1 \& 2.
\item Beneath a Steel Sky
\begin{itemize}
\item gb - English (Great Britain) (default)
- \item en - English USA
+ \item en - English (USA)
\item de - German
\item fr - French
\item it - Italian
@@ -51,7 +59,7 @@ Curse of Monkey Island, Beneath a Steel Sky. and Simon the Sorcerer 1 \& 2.
\item pt - Portuguese
\item cz - Czech
\end{itemize}
-\item Simon the Sorcerer 1 \& 2
+\item Simon the Sorcerer 1 and 2
\begin{itemize}
\item en - English (default)
\item de - German
diff --git a/doc/running-mac-games.tex b/doc/running-mac-games.tex
index 41a94f01ec..7fe93c35e6 100644
--- a/doc/running-mac-games.tex
+++ b/doc/running-mac-games.tex
@@ -22,4 +22,4 @@ longer necessary, as ScummVM can now open and understand the format natively.
See also:
- http://wiki.scummvm.org/index.php/HOWTO-Mac_Games
+ \url{http://wiki.scummvm.org/index.php/HOWTO-Mac_Games}
diff --git a/doc/running-multicd.tex b/doc/running-multicd.tex
index b417e319c4..c163129621 100644
--- a/doc/running-multicd.tex
+++ b/doc/running-multicd.tex
@@ -6,6 +6,7 @@
\subsection{Multi-CD games notes}
+
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
@@ -24,12 +25,3 @@ 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.
-
-\subsubsection{The Curse of Monkey Island notes}
-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.
-
-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.
diff --git a/doc/running-options.tex b/doc/running-options.tex
index bf7e87990a..8fbcf9ca63 100644
--- a/doc/running-options.tex
+++ b/doc/running-options.tex
@@ -1,3 +1,10 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Command Line Options}
Usage: scummvm [OPTIONS]... [GAME]\\
@@ -13,7 +20,7 @@ Usage: scummvm [OPTIONS]... [GAME]\\
\\
-c, --config=CONFIG &Use alternate configuration file\\
-p, --path=PATH &Path to where the game is installed\\
- -x, --save-slot[=NUM] &Save game slot to load (default: autosave)\\
+ -x, --save-slot[=NUM] &Savegame slot to load (default: autosave)\\
-f, --fullscreen &Force full-screen mode\\
-F, --no-fullscreen &Force windowed mode\\
-g, --gfx-mode=MODE &Select graphics scaler (see also section \ref{sect-gfx-filters})\\
@@ -21,9 +28,9 @@ Usage: scummvm [OPTIONS]... [GAME]\\
-q, --language=LANG &Select language (see also section \ref{sect-languages})\\
-m, --music-volume=NUM &Set the music volume, 0-255 (default: 192)\\
-s, --sfx-volume=NUM &Set the sfx volume, 0-255 (default: 192)\\
- -r, --speech-volume=NUM &Set the voice volume, 0-255 (default: 192)\\
- --midi-gain &Set the gain for MIDI playback, 0-1000 (default:\\
- &100) (only supported by some MIDI drivers)\\
+ -r, --speech-volume=NUM &Set the voice volume, 0-255 (default: 192)\\
+ --midi-gain &Set the gain for MIDI playback, 0-1000 (default: 100)\\
+ &(only supported by some MIDI drivers)\\
-n, --subtitles &Enable subtitles (use with games that have voice)\\
-b, --boot-param=NUM &Pass number to the boot script (boot param)\\
-d, --debuglevel=NUM &Set debug verbosity level\\
@@ -35,7 +42,7 @@ Usage: scummvm [OPTIONS]... [GAME]\\
--joystick[=NUM] &Enable input with joystick (default: 0 = first\\
&joystick)\\
--platform=WORD &Specify version of game (allowed values: 3do, acorn,\\
- &amiga, atari, c64, fmtowns, nes, mac, pc, segacd,\\
+ &amiga, atari, c64, fmtowns, mac, nes, pc, segacd,\\
&windows)\\
--savepath=PATH &Path to where savegames are stored\\
--multi-midi &Enable combination of Adlib and native MIDI\\
@@ -67,7 +74,7 @@ line is very important. A short list is contained at the top of this
file. You can also get the current list of games and game names at:
\begin{center}
- \url{http://www.scummvm.org/compatibility.php}
+ \url{http://www.scummvm.org/compatibility_stable.php}
\end{center}
Examples:
@@ -91,7 +98,3 @@ C:\Games\scummvm.exe -f -n -pD:\resource\ ft
/path/to/scummvm -f -n -p/cdrom/resource/ ft
\end{verbatim}
\end{itemize}
-%%% Local Variables:
-%%% mode: latex
-%%% TeX-master: "readme"
-%%% End:
diff --git a/doc/running.tex b/doc/running.tex
index ccd82e50fb..eea3b69d83 100644
--- a/doc/running.tex
+++ b/doc/running.tex
@@ -1,17 +1,17 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
\section{Running ScummVM}
-Before you run the engine, you need to put the game's datafiles in a
+Before you run the engine, you need to put the game's data files in a
directory. The filenames must not be in mixed case on *nix systems
-(for example, these are valid names: ``monkey2.000'', ``MONKEY2.000'', while
+(for example, these are valid names: "monkey2.000", "MONKEY2.000", while
this is a bad one: "Monkey2.000"). If you use a game with speech, the file
-monster.sou must reside in the same directory as the datafiles.
+monster.sou must reside in the same directory as the data files.
Please note that by default, ScummVM will save games in the directory
it is executed from, so you should refrain from running it from more than
@@ -19,17 +19,14 @@ one location. Further information, including how to specify a specific save
directory to avoid this issue, are in section 6.0.
ScummVM can be launched directly by running the executable. In this case,
-the in-built launcher will activate. From this, you can add games (click
+the built-in launcher will activate. From this, you can add games (click
'Add Game'), or launch games which have already been configured.
ScummVM can also be launched into a game directly using Command Line
arguments -- see the next section.
-%next section
+
\input {running-options.tex}
-%next section
\input {running-language.tex}
-%next section
\input {running-graphics-filters.tex}
-%next section
\input {running-hotkeys.tex}
diff --git a/doc/saves.tex b/doc/saves.tex
index 4a9b53e6e8..eb2edac24a 100644
--- a/doc/saves.tex
+++ b/doc/saves.tex
@@ -1,4 +1,12 @@
-\section {Savegames}
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
+\section{Savegames}
+
Savegames are by default put in the current directory on some platforms and
preset directories on others. You can specify the save in the config file by
setting the savepath parameter. See the example config file later in this
@@ -25,14 +33,9 @@ Windows example:
\end{verbatim}
-\subsection {Autosaves}
+\subsection{Autosaves}
+
Because ScummVM is still a beta product, it -can- crash and/or hang
occasionally. As such, every five minutes it will save a game in Slot 0. This
-game can be loaded via Ctrl-0, or the F5 menu. This autosaving does not,
+game can be loaded via Ctrl-0, or the F5 menu. This autosaving does not,
however, occur with Simon the Sorcerer 1 and 2, nor with Broken Sword 1 and 2.
-
-
-%%% Local Variables:
-%%% mode: latex
-%%% TeX-master: "readme"
-%%% End: