From 5f0ff73d2a4f1246e542903f9d04299f21cf5bdb Mon Sep 17 00:00:00 2001 From: Max Horn Date: Thu, 6 Apr 2006 22:17:37 +0000 Subject: Renamed even more LaTeX files (those names might not be the best, but the section structure isn't very logical to start with ) svn-id: r21652 --- doc/05_01.tex | 98 ------------------------------------- doc/05_02.tex | 65 ------------------------ doc/05_03.tex | 48 ------------------ doc/05_04.tex | 103 --------------------------------------- doc/05_05.tex | 17 ------- doc/05_06.tex | 69 -------------------------- doc/running-graphics-filters.tex | 48 ++++++++++++++++++ doc/running-hotkeys.tex | 103 +++++++++++++++++++++++++++++++++++++++ doc/running-language.tex | 65 ++++++++++++++++++++++++ doc/running-mac-games.tex | 17 +++++++ doc/running-multicd.tex | 69 ++++++++++++++++++++++++++ doc/running-options.tex | 98 +++++++++++++++++++++++++++++++++++++ doc/running.tex | 12 ++--- 13 files changed, 406 insertions(+), 406 deletions(-) delete mode 100644 doc/05_01.tex delete mode 100644 doc/05_02.tex delete mode 100644 doc/05_03.tex delete mode 100644 doc/05_04.tex delete mode 100644 doc/05_05.tex delete mode 100644 doc/05_06.tex create mode 100644 doc/running-graphics-filters.tex create mode 100644 doc/running-hotkeys.tex create mode 100644 doc/running-language.tex create mode 100644 doc/running-mac-games.tex create mode 100644 doc/running-multicd.tex create mode 100644 doc/running-options.tex (limited to 'doc') diff --git a/doc/05_01.tex b/doc/05_01.tex deleted file mode 100644 index 212fcbbc78..0000000000 --- a/doc/05_01.tex +++ /dev/null @@ -1,98 +0,0 @@ -\subsection{Command Line Options} - -Usage: scummvm [OPTIONS]... [GAME]\\ -\begin{tabular}{ll} - [GAME] &Short name of game to load. For example, 'monkey'\\ - &for Monkey Island. This can be either a built-in\\ - &gameid, or a user configured target.\\ -\\ - -v, --version &Display ScummVM version information and exit\\ - -h, --help &Display a brief help text and exit\\ - -z, --list-games &Display list of supported games and exit\\ - -t, --list-targets &Display list of configured targets and exit\\ -\\ - -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)\\ - -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})\\ - -e, --music-driver=MODE &Select music driver (see also section \ref{sect-music-and-sound})\\ - -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)\\ - -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\\ - -u, --dump-scripts &Enable script dumping if a directory called\\ - &'dumps' exists in the current directory\\ -\\ - --cdrom=NUM &CD drive to play CD audio from\\ - &(default: 0 = first drive)\\ - --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,\\ - &windows)\\ - --savepath=PATH &Path to where savegames are stored\\ - --multi-midi &Enable combination of Adlib and native MIDI\\ - --soundfont &Select the SoundFont for MIDI playback. (Only\\ - &supported by some MIDI drivers.)\\ - --native-mt32 &True Roland MT-32 (disable GM emulation)\\ - --enable-gs &Enable Roland GS mode for MIDI playback\\ - --output-rate=RATE &Select output sample rate in Hz (e.g. 22050)\\ - --aspect-ratio &Enable aspect ratio correction\\ - --render-mode=MODE &Enable additional render modes (cga, ega, hercGreen,\\ - &hercAmber, amiga)\\ -\\ - --force-1x-overlay &Make inner GUI 320x200\\ - --alt-intro &Use alternative intro for CD versions of Beneath a\\ - &Steel Sky and Flight of the Amazon Queen\\ - --copy-protection &Enable copy protection in games, when\\ - &ScummVM disables it by default.\\ - --demo-mode &Start demo mode of Maniac Mansion (Classic version)\\ - --tempo=NUM &Set music tempo (in percent, 50-200) for SCUMM\\ - &games (default: 100)\\ - --talkspeed=NUM &Set talk speed for games\\ -\end{tabular} - -The meaning of most long options can be inverted by prefixing them with "no-", -e.g. --no-aspect-ratio. This is useful if you want to override a setting in the -configuration file. - -The short game name ('game target') you see at the end of the command -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} -\end{center} - -Examples: -\begin{itemize} -\item Win32:\\ -Running Monkey Island, fullscreen, from a hard disk: -\begin{verbatim} -C:\Games\scummvm.exe -f -pC:\Games\monkey\ monkey -\end{verbatim} - Running Full Throttle from CD, fullscreen and with subtitles enabled: -\begin{verbatim} -C:\Games\scummvm.exe -f -n -pD:\resource\ ft -\end{verbatim} - \item Unix:\\ - Running Monkey Island, fullscreen, from a hard disk: -\begin{verbatim} -/path/to/scummvm -f -p/games/LucasArts/monkey/ monkey -\end{verbatim} - Running Full Throttle from CD, fullscreen and with subtitles enabled: -\begin{verbatim} -/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/05_02.tex b/doc/05_02.tex deleted file mode 100644 index 71f0a61c01..0000000000 --- a/doc/05_02.tex +++ /dev/null @@ -1,65 +0,0 @@ -\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. - -\begin{itemize} -\item Maniac Mansion and Zak McKracken: - \begin{itemize} - \item en - English (default) - \item de - German - \item fr - French - \item it - Italian - \item es - Spanish - \end{itemize} -\item The Dig - \begin{itemize} - \item jp - Japanese - \item zh - Chinese - \item kr - Korean - \end{itemize} -\item Curse of Monkey Island - \begin{itemize} - \item en - English (default) - \item de - German - \item fr - French - \item it - Italian - \item pt - Portuguese - \item es - Spanish - \item jp - Japanese - \item zh - Chinese - \item kr - Korean - \end{itemize} -\item Beneath a Steel Sky - \begin{itemize} - \item gb - English (Great Britain) (default) - \item en - English USA - \item de - German - \item fr - French - \item it - Italian - \item pt - Portuguese - \item es - Spanish - \item se - Swedish - \end{itemize} -\item Broken Sword 1 - \begin{itemize} - \item en - English (default) - \item de - German - \item fr - French - \item it - Italian - \item es - Spanish - \item pt - Portuguese - \item cz - Czech - \end{itemize} -\item Simon the Sorcerer 1 \& 2 - \begin{itemize} - \item en - English (default) - \item de - German - \item fr - French - \item it - Italian - \item es - Spanish - \item hb - Hebrew - \item pl - Polish - \item ru - Russian - \end{itemize} -\end{itemize} diff --git a/doc/05_03.tex b/doc/05_03.tex deleted file mode 100644 index 43e8598fe8..0000000000 --- a/doc/05_03.tex +++ /dev/null @@ -1,48 +0,0 @@ -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: - - -\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 -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 -3x filter you'll get 960x600. - -They are:\\ -\begin{tabular}[h]{ll} - 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.\\ - 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.\\ - hq3x & Very nice high quality filter but slow. Factor 3x.\\ - tv2x & Interlace filter, tries to emulate a TV. Factor 2x.\\ - dotmatrix & Dot matrix effect. Factor 2x.\\ -\end{tabular} - -To select a graphics filter, pass its name via the '-g' option to scummvm, -for example: - -\begin{verbatim} - scummvm -g advmame2x monkey2 -\end{verbatim} -\begin{enumerate} -\item [Note \#1] Not all backends support all or any filters. The ones - listed above are for the default SDL backend. -\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 - scale to 640x480 or 960x720. -\end{enumerate} diff --git a/doc/05_04.tex b/doc/05_04.tex deleted file mode 100644 index 9dc51b30b2..0000000000 --- a/doc/05_04.tex +++ /dev/null @@ -1,103 +0,0 @@ - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: - -\subsection{Hot Keys} -ScummVM supports various in game hotkeys. They differ between the SCUMM and -other games. -\begin{itemize} -\item Common:\\ - \begin{tabular}{ll} - Cmd-q & Quit (Mac OS X)\\ - Ctrl-q & Quit (other unices including Linux)\\ - Ctrl-z OR Alt-x & Quit (other platforms)\\ - Keyboard Arrow Keys & Simulate mouse movement\\ - Ctrl-f & Toggle fast mode\\ - Ctrl-m & Toggle mouse capture\\ - Ctrl-Alt 1-8 & Switch between graphics filters\\ - Ctrl-Alt + and - & Increase/Decrease the scale factor\\ - Ctrl-Alt a & Toggle aspect-ratio correction on/off\\ - & Most of the games use a 320x200 pixel\\ - & resolution, which may look squashed on\\ - & modern monitors. Aspect-ratio correction\\ - & stretches the image to use 320x240 pixels\\ - & instead, or a multiple thereof\\ - Alt-Enter & Toggles full screen/windowed\\ - \end{tabular} -\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'\\ - Tilde \verb#~# & Show/hide the debugging console\\ - Ctrl-s & Shows memory consumption\\ - $[$ and $]$ & Music volume, down/up\\ - - and + & Text speed, slower/faster\\ - F5 & Displays a save/load box\\ - Space & Pauses\\ - Period (.) & Skips current line of text in some games\\ - Enter & Simulate left mouse button press\\ - Tab & Simulate right mouse button press\\ - \end{tabular} -\item Beneath a Steel Sky:\\ - \begin{tabular}{ll} - Ctrl-d & Starts the debugger\\ - Ctrl-g & Runs in really REALLY fast mode\\ - F5 & Displays a save/load box\\ - Escape & Skips the game intro\\ - Period (.) & Skips current line of text\\ - \end{tabular} -\item Broken Sword 1:\\ - \begin{tabular}{ll} - F5 or ESC & Displays save/load box\\ - \end{tabular} -\item Broken Sword 2:\\ - \begin{tabular}{ll} - Ctrl-d & Starts the debugger\\ - c & Displays the credits\\ - p & Pauses\\ - \end{tabular} -\item Flight of the Amazon Queen: - \begin{tabular}{ll} - Ctrl-d & Starts the debugger\\ - F1 & Displays save/load box\\ - F11 & Quicksave\\ - F12 & Quickload\\ - Escape & Skips cutscenes\\ - Space & Skips current line of text\\ - \end{tabular} -\item The Legend of Kyrandia:\\ - \begin{tabular}{ll} - Ctrl 0-9 and Alt 0-9 & Load and save game state\\ - Ctrl-d & Starts the debugger\\ - \end{tabular} -\item Simon the Sorcerer 1 \& 2:\\ - \begin{tabular}{ll} - Ctrl 0-9 and Alt 0-9 & Load and save game state\\ - Ctrl-d & Starts the debugger\\ - F1 - F3 & Text speed, faster - slower\\ - F10 & Shows all characters and objects you can \\ - & interact with\\ - - and + & Music volume, down/up\\ - m & Music on/off\\ - s & Sound effects on/off\\ - b & Background sounds on/off\\ - p & Pauses\\ - t & Switch between speech and subtitles\\ - v & Switch between subtitles only and\\ - & combined speech \& subtitles\\ - & (Simon the Sorcerer 2 only)\\ - \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. - -Ctrl-f is not supported by the Broken Sword games. -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: diff --git a/doc/05_05.tex b/doc/05_05.tex deleted file mode 100644 index 920cf09115..0000000000 --- a/doc/05_05.tex +++ /dev/null @@ -1,17 +0,0 @@ -\subsection {Using data files from Macintosh game versions} -All LucasArts SCUMM based adventures except CMI also exist in versions for the -Macintosh. ScummVM can use most (all?) of them, however, in some case some -additional work is required. First off, if you are not using a Macintosh for -this, accessing the CD/floppy data might be tricky, since the mac uses a -special disk format called HFS which other systems usually do not support. -However, there are various free tools on the net which allow reading such HFS -volumes (for example "HFVExplorer" for Windows and "hfsutils" for Linux and -other Unix-like operating systems). - -Secondly, most of the newer games shipped only with a single data file on the -Macintosh. You used to have to manually convert that data file, but this is no -longer necessary, as ScummVM can now open and understand the format natively. -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: diff --git a/doc/05_06.tex b/doc/05_06.tex deleted file mode 100644 index ceab5649a6..0000000000 --- a/doc/05_06.tex +++ /dev/null @@ -1,69 +0,0 @@ - -\subsection{Multi-CD Games} -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. - -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. - -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. - -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{The Curse of Monkey Island} -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. - -\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 speech2.clu for CD 1 and 2 -respectively. - -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. - -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 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. - -In addition, you will need the cd.bin, cd.inf and startup.inf files -from the sword2 directory on CD 1. - -ScummVM does not support the original cutscene files, so there is no -need to copy them. diff --git a/doc/running-graphics-filters.tex b/doc/running-graphics-filters.tex new file mode 100644 index 0000000000..43e8598fe8 --- /dev/null +++ b/doc/running-graphics-filters.tex @@ -0,0 +1,48 @@ +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: + + +\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 +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 +3x filter you'll get 960x600. + +They are:\\ +\begin{tabular}[h]{ll} + 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.\\ + 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.\\ + hq3x & Very nice high quality filter but slow. Factor 3x.\\ + tv2x & Interlace filter, tries to emulate a TV. Factor 2x.\\ + dotmatrix & Dot matrix effect. Factor 2x.\\ +\end{tabular} + +To select a graphics filter, pass its name via the '-g' option to scummvm, +for example: + +\begin{verbatim} + scummvm -g advmame2x monkey2 +\end{verbatim} +\begin{enumerate} +\item [Note \#1] Not all backends support all or any filters. The ones + listed above are for the default SDL backend. +\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 + scale to 640x480 or 960x720. +\end{enumerate} diff --git a/doc/running-hotkeys.tex b/doc/running-hotkeys.tex new file mode 100644 index 0000000000..9dc51b30b2 --- /dev/null +++ b/doc/running-hotkeys.tex @@ -0,0 +1,103 @@ + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: + +\subsection{Hot Keys} +ScummVM supports various in game hotkeys. They differ between the SCUMM and +other games. +\begin{itemize} +\item Common:\\ + \begin{tabular}{ll} + Cmd-q & Quit (Mac OS X)\\ + Ctrl-q & Quit (other unices including Linux)\\ + Ctrl-z OR Alt-x & Quit (other platforms)\\ + Keyboard Arrow Keys & Simulate mouse movement\\ + Ctrl-f & Toggle fast mode\\ + Ctrl-m & Toggle mouse capture\\ + Ctrl-Alt 1-8 & Switch between graphics filters\\ + Ctrl-Alt + and - & Increase/Decrease the scale factor\\ + Ctrl-Alt a & Toggle aspect-ratio correction on/off\\ + & Most of the games use a 320x200 pixel\\ + & resolution, which may look squashed on\\ + & modern monitors. Aspect-ratio correction\\ + & stretches the image to use 320x240 pixels\\ + & instead, or a multiple thereof\\ + Alt-Enter & Toggles full screen/windowed\\ + \end{tabular} +\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'\\ + Tilde \verb#~# & Show/hide the debugging console\\ + Ctrl-s & Shows memory consumption\\ + $[$ and $]$ & Music volume, down/up\\ + - and + & Text speed, slower/faster\\ + F5 & Displays a save/load box\\ + Space & Pauses\\ + Period (.) & Skips current line of text in some games\\ + Enter & Simulate left mouse button press\\ + Tab & Simulate right mouse button press\\ + \end{tabular} +\item Beneath a Steel Sky:\\ + \begin{tabular}{ll} + Ctrl-d & Starts the debugger\\ + Ctrl-g & Runs in really REALLY fast mode\\ + F5 & Displays a save/load box\\ + Escape & Skips the game intro\\ + Period (.) & Skips current line of text\\ + \end{tabular} +\item Broken Sword 1:\\ + \begin{tabular}{ll} + F5 or ESC & Displays save/load box\\ + \end{tabular} +\item Broken Sword 2:\\ + \begin{tabular}{ll} + Ctrl-d & Starts the debugger\\ + c & Displays the credits\\ + p & Pauses\\ + \end{tabular} +\item Flight of the Amazon Queen: + \begin{tabular}{ll} + Ctrl-d & Starts the debugger\\ + F1 & Displays save/load box\\ + F11 & Quicksave\\ + F12 & Quickload\\ + Escape & Skips cutscenes\\ + Space & Skips current line of text\\ + \end{tabular} +\item The Legend of Kyrandia:\\ + \begin{tabular}{ll} + Ctrl 0-9 and Alt 0-9 & Load and save game state\\ + Ctrl-d & Starts the debugger\\ + \end{tabular} +\item Simon the Sorcerer 1 \& 2:\\ + \begin{tabular}{ll} + Ctrl 0-9 and Alt 0-9 & Load and save game state\\ + Ctrl-d & Starts the debugger\\ + F1 - F3 & Text speed, faster - slower\\ + F10 & Shows all characters and objects you can \\ + & interact with\\ + - and + & Music volume, down/up\\ + m & Music on/off\\ + s & Sound effects on/off\\ + b & Background sounds on/off\\ + p & Pauses\\ + t & Switch between speech and subtitles\\ + v & Switch between subtitles only and\\ + & combined speech \& subtitles\\ + & (Simon the Sorcerer 2 only)\\ + \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. + +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 new file mode 100644 index 0000000000..71f0a61c01 --- /dev/null +++ b/doc/running-language.tex @@ -0,0 +1,65 @@ +\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. + +\begin{itemize} +\item Maniac Mansion and Zak McKracken: + \begin{itemize} + \item en - English (default) + \item de - German + \item fr - French + \item it - Italian + \item es - Spanish + \end{itemize} +\item The Dig + \begin{itemize} + \item jp - Japanese + \item zh - Chinese + \item kr - Korean + \end{itemize} +\item Curse of Monkey Island + \begin{itemize} + \item en - English (default) + \item de - German + \item fr - French + \item it - Italian + \item pt - Portuguese + \item es - Spanish + \item jp - Japanese + \item zh - Chinese + \item kr - Korean + \end{itemize} +\item Beneath a Steel Sky + \begin{itemize} + \item gb - English (Great Britain) (default) + \item en - English USA + \item de - German + \item fr - French + \item it - Italian + \item pt - Portuguese + \item es - Spanish + \item se - Swedish + \end{itemize} +\item Broken Sword 1 + \begin{itemize} + \item en - English (default) + \item de - German + \item fr - French + \item it - Italian + \item es - Spanish + \item pt - Portuguese + \item cz - Czech + \end{itemize} +\item Simon the Sorcerer 1 \& 2 + \begin{itemize} + \item en - English (default) + \item de - German + \item fr - French + \item it - Italian + \item es - Spanish + \item hb - Hebrew + \item pl - Polish + \item ru - Russian + \end{itemize} +\end{itemize} diff --git a/doc/running-mac-games.tex b/doc/running-mac-games.tex new file mode 100644 index 0000000000..920cf09115 --- /dev/null +++ b/doc/running-mac-games.tex @@ -0,0 +1,17 @@ +\subsection {Using data files from Macintosh game versions} +All LucasArts SCUMM based adventures except CMI also exist in versions for the +Macintosh. ScummVM can use most (all?) of them, however, in some case some +additional work is required. First off, if you are not using a Macintosh for +this, accessing the CD/floppy data might be tricky, since the mac uses a +special disk format called HFS which other systems usually do not support. +However, there are various free tools on the net which allow reading such HFS +volumes (for example "HFVExplorer" for Windows and "hfsutils" for Linux and +other Unix-like operating systems). + +Secondly, most of the newer games shipped only with a single data file on the +Macintosh. You used to have to manually convert that data file, but this is no +longer necessary, as ScummVM can now open and understand the format natively. +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: diff --git a/doc/running-multicd.tex b/doc/running-multicd.tex new file mode 100644 index 0000000000..ceab5649a6 --- /dev/null +++ b/doc/running-multicd.tex @@ -0,0 +1,69 @@ + +\subsection{Multi-CD Games} +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. + +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. + +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. + +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{The Curse of Monkey Island} +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. + +\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 speech2.clu for CD 1 and 2 +respectively. + +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. + +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 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. + +In addition, you will need the cd.bin, cd.inf and startup.inf files +from the sword2 directory on CD 1. + +ScummVM does not support the original cutscene files, so there is no +need to copy them. diff --git a/doc/running-options.tex b/doc/running-options.tex new file mode 100644 index 0000000000..212fcbbc78 --- /dev/null +++ b/doc/running-options.tex @@ -0,0 +1,98 @@ +\subsection{Command Line Options} + +Usage: scummvm [OPTIONS]... [GAME]\\ +\begin{tabular}{ll} + [GAME] &Short name of game to load. For example, 'monkey'\\ + &for Monkey Island. This can be either a built-in\\ + &gameid, or a user configured target.\\ +\\ + -v, --version &Display ScummVM version information and exit\\ + -h, --help &Display a brief help text and exit\\ + -z, --list-games &Display list of supported games and exit\\ + -t, --list-targets &Display list of configured targets and exit\\ +\\ + -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)\\ + -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})\\ + -e, --music-driver=MODE &Select music driver (see also section \ref{sect-music-and-sound})\\ + -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)\\ + -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\\ + -u, --dump-scripts &Enable script dumping if a directory called\\ + &'dumps' exists in the current directory\\ +\\ + --cdrom=NUM &CD drive to play CD audio from\\ + &(default: 0 = first drive)\\ + --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,\\ + &windows)\\ + --savepath=PATH &Path to where savegames are stored\\ + --multi-midi &Enable combination of Adlib and native MIDI\\ + --soundfont &Select the SoundFont for MIDI playback. (Only\\ + &supported by some MIDI drivers.)\\ + --native-mt32 &True Roland MT-32 (disable GM emulation)\\ + --enable-gs &Enable Roland GS mode for MIDI playback\\ + --output-rate=RATE &Select output sample rate in Hz (e.g. 22050)\\ + --aspect-ratio &Enable aspect ratio correction\\ + --render-mode=MODE &Enable additional render modes (cga, ega, hercGreen,\\ + &hercAmber, amiga)\\ +\\ + --force-1x-overlay &Make inner GUI 320x200\\ + --alt-intro &Use alternative intro for CD versions of Beneath a\\ + &Steel Sky and Flight of the Amazon Queen\\ + --copy-protection &Enable copy protection in games, when\\ + &ScummVM disables it by default.\\ + --demo-mode &Start demo mode of Maniac Mansion (Classic version)\\ + --tempo=NUM &Set music tempo (in percent, 50-200) for SCUMM\\ + &games (default: 100)\\ + --talkspeed=NUM &Set talk speed for games\\ +\end{tabular} + +The meaning of most long options can be inverted by prefixing them with "no-", +e.g. --no-aspect-ratio. This is useful if you want to override a setting in the +configuration file. + +The short game name ('game target') you see at the end of the command +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} +\end{center} + +Examples: +\begin{itemize} +\item Win32:\\ +Running Monkey Island, fullscreen, from a hard disk: +\begin{verbatim} +C:\Games\scummvm.exe -f -pC:\Games\monkey\ monkey +\end{verbatim} + Running Full Throttle from CD, fullscreen and with subtitles enabled: +\begin{verbatim} +C:\Games\scummvm.exe -f -n -pD:\resource\ ft +\end{verbatim} + \item Unix:\\ + Running Monkey Island, fullscreen, from a hard disk: +\begin{verbatim} +/path/to/scummvm -f -p/games/LucasArts/monkey/ monkey +\end{verbatim} + Running Full Throttle from CD, fullscreen and with subtitles enabled: +\begin{verbatim} +/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 d68e763790..d52a5ae367 100644 --- a/doc/running.tex +++ b/doc/running.tex @@ -26,14 +26,14 @@ ScummVM can also be launched into a game directly using Command Line arguments -- see the next section. %next section -\input {05_01.tex} +\input {running-options.tex} %next section -\input {05_02.tex} +\input {running-language.tex} %next section -\input {05_03.tex} +\input {running-graphics-filters.tex} %next section -\input {05_04.tex} +\input {running-hotkeys.tex} %next section -\input {05_05.tex} +\input {running-mac-games.tex} %next section -\input {05_06.tex} +\input {running-multicd.tex} -- cgit v1.2.3