306
edits
Difference between revisions of "User Manual"
More copy & paste from manual.xml: command line & macintosh games
Spookypeanut (talk | contribs) (→Multi-CD games: Finished copy and paste from docbook) |
Spookypeanut (talk | contribs) (More copy & paste from manual.xml: command line & macintosh games) |
||
| Line 171: | Line 171: | ||
==== The (global) options dialog (this will point to the "Configuration" section) ==== | ==== The (global) options dialog (this will point to the "Configuration" section) ==== | ||
=== Command line options === | === Command line options === | ||
<code>scummvm [OPTIONS] ''GAME''</code> | |||
;-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 <xref linkend="sec.graphics-filter"/>) | |||
;--gui-theme=''THEME'':Select GUI theme (default, modern, classic) | |||
;--themepath=''PATH'':Path to where GUI themes are stored | |||
;-e, --music-driver=''MODE'':Select music driver (see also <xref linkend="sec.music-driver"/>) | |||
;-q, --language=''LANG'':Select language (see also section TODO) | |||
;-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=''NUM'':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 joystick input (default: 0 = first joystick) | |||
;--platform=''WORD'':Specify version of game (allowed values: 3do, acorn, 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 | |||
;--native-mt32:True Roland MT-32 (disable GM emulation) | |||
;--output-rate=''RATE'':Select output sample rate in Hz (e.g. 22050) | |||
;--aspect-ratio:Enable aspect ratio correction | |||
<!-- TODO: Explain this either here or link to an explanation --> | |||
;--render-mode=''MODE'':Enable additional render modes (cga, ega, hercGreen, hercAmber, amiga) | |||
<!-- TODO: Explain this either here or link to an explanation --> | |||
;--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 SCUMM games, when ScummVM disables it by default. | |||
<!-- TODO: Add link to the copy protection section --> | |||
;--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 SCUMM games | |||
The meaning of most long options (that is, those options starting with a | |||
double-dash) can be inverted by prefixing them with "no-". For example, | |||
--no-aspect-ratio will turn aspectio ratio correction off. 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 specifies which game is started. It either corresponds to an arbitrary | |||
user defined target (from the configuration file), or to a built-in gameid. | |||
A brief list of the latter can be found in the supported games section. | |||
==== Examples of Command Line Usage ==== | |||
;Running Monkey Island, fullscreen, from a hard disk (Win32):<code>C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ monkey</code> | |||
;Running Full Throttle from CD, fullscreen and with subtitles enabled (Win32):<code>C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft</code> | |||
;Running Monkey Island, fullscreen, from a hard disk (Unix):<code>/path/to/scummvm -f -p/games/LucasArts/monkey/ monkey</code> | |||
;Running Full Throttle from CD, fullscreen and with subtitles enabled (Unix):<code>/path/to/scummvm -f -n -p/cdrom/resource/ ft</code> | |||
=== Hotkeys === | === Hotkeys === | ||
=== Saving and loading === | === Saving and loading === | ||
=== Macintosh games: Accesing HFS filesystems === | === Macintosh games: Accesing HFS filesystems === | ||
You will need the "Windows Installer" from the download page. To copy the game data file from the CD to your hard disc, you will need [http://home.earthlink.net/~gamba2/pc2mac.html HFVExplorer]. Make sure you get the "HFV Explorer installer" rather than the zip file. When you choose to download the zip file, make sure you read the readme included with HFVExplorer, to set it up properly. Run the HFVExplorer installer and allow it to use its defaults. | |||
Start up HFVExplorer; if you don't have a shortcut for it, find it in "C:\Program Files\HFVExplorer". It should open the HFS (Macintosh filesystem) CD-ROM automatically when you insert the disc. Make sure HFVExplorer is displaying hidden files: Select View->Options and enable "Show invisible Mac files" on the "File attributes" tab. | |||
Now, look for the data file in the right pane. It will probably end with the word "Data" and will be the largest file on the volume. For instance (using Sam & Max Hit the Road as an example), it is called "Sam & Max Data" on the "Sam & Max" CD-ROM. Select the data file and copy it (use Ctrl+C or Edit->Copy). In the left HFVExplorer pane, navigate to the directory where you want the game to reside on your hard disc. We recommend selecting drive C: and creating a new folder called "SamNMax" or a name that better reflects your particular game. | |||
Paste the data file (with Ctrl+V or Edit->Paste) and allow HFVExplorer to choose the copy mode. Now, wait while the program copies several hundred megabytes from the CD. When the file is copied, close HFVExplorer. | |||
TODO: Mention extract_scumm_mac or link to a section containing it | |||
=== Multi-CD games === | === 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. | 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. | ||