diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 158 |
1 files changed, 126 insertions, 32 deletions
@@ -39,10 +39,12 @@ Table of Contents: * 5.1 Command Line Options * 5.2 Language Options * 5.3 Graphics Filters - * 5.4 Hotkeys + * 5.4 Global Menu + * 5.5 Hotkeys 6.0) Savegames * 6.1 Autosaves * 6.2 Converting savegames + * 6.3 Viewing/Loading savegames from the command line 7.0) Music and Sound * 7.1 Adlib emulation * 7.2 FluidSynth MIDI emulation @@ -182,17 +184,23 @@ GOB Games by Coktel Vision: Gobliiins [gob1] Gobliins 2 [gob2] Goblins 3 [gob3] + Lost in Time [lostintime] + The Bizarre Adventures of Woodruff + and the Schnibble [woodruff] Ween: The Prophecy [ween] Other Games: Beneath a Steel Sky [sky] Broken Sword 1: The Shadow of the Templars [sword1] Broken Sword 2: The Smoking Mirror [sword2] + Drascula: The Vampire Strikes Back [drascula] Flight of the Amazon Queen [queen] Future Wars [fw] Inherit the Earth: Quest for the Orb [ite] Nippon Safes Inc. [nippon] The Legend of Kyrandia [kyra1] + The Legend of Kyrandia: The Hand of Fate [kyra2] + The Legend of Kyrandia: Malcolm's Revenge [kyra3] Touche: The Adventures of the Fifth Musketeer [touche] @@ -781,6 +789,7 @@ arguments -- see the next section. -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 + --list-saves=TARGET Display a list of savegames for the game (TARGET) specified -c, --config=CONFIG Use alternate configuration file -p, --path=PATH Path to where the game is installed @@ -968,7 +977,38 @@ Likewise, games that originally were using 640x480 (such as COMI or Broken Sword will be scaled to 1280x960 and 1920x1440. -5.4) Hot Keys: +5.4) Global Menu: +---- ------------ + +The Global Menu is a general menu which is available to all of the game engines +by pressing F6. From this menu there are the following buttons: Resume, +Options, About, Return to Launcher, and Quit. Selecting 'Options' will display +a dialog where basic audio settings, such as volume levels, can be adjusted. +Selecting 'Return to Launcher' will close the current game and return the user +back to the ScummVM Launcher, where another game may be selected to play. + +Note: Returning to the Launcher is not supported by all of the engines, + and the button will be disabled in the Global Menu if it is not supported. + +Engines which currently support Returning to the Launcher are: + + AGI + AGOS + CINE + GOB + KYRA + LURE + PARALLACTION + QUEEN + SAGA + SCUMM + SKY + SWORD1 + SWORD2 + TOUCHE + + +5.5) Hot Keys: ---- --------- TODO TODO: Rework this section to clearly state which hotkeys are implemented in *all* @@ -982,6 +1022,7 @@ ScummVM supports various in-game hotkeys. They differ between SCUMM games and other games. Common: + F6 - Displays the Global Menu Cmd-q - Quit (Mac OS X) Ctrl-q - Quit (other unices including Linux) Ctrl-z OR Alt-x - Quit (other platforms) @@ -1138,45 +1179,93 @@ The platforms that currently have a different default directory are: 6.1) Autosaves: ---- ---------- -For some games (namely "Beneath a Steel Sky", "Flight of the Amazon -Queen" and all SCUMM games), ScummVM will by default automatically -save the current state every five minutes (adjustable via the -"autosave_period" config setting). For the SCUMM engine, it will save -in Slot 0. This savestate can then be loaded again via Ctrl-0, or the -F5 menu. +For some games, (namely "Beneath a Steel Sky", "Flight of the Amazon Queen", +all AGI games, and all SCUMM games), ScummVM will by default automatically +save the current state every five minutes (adjustable via the "autosave_period" +config setting). For the AGI and SCUMM engines, it will save in Slot 0. For the +SCUMM engine, this savestate can then be loaded again via Ctrl-0, or the F5 +menu. 6.2) Converting Savegames: ----- ---------- -Using savegames from original versions, isn't supported by all game engines. Only -the following games, can use savedgames from their original versions. +---- --------------------- +Using savegames from original versions, isn't supported by all game engines. +Only the following games, can use savegames from their original versions. Elvira 1 - - Add 8 bytes (savedgame name) to the start of the savegame file - - Rename the savedgame to 'elvira1.xxx' + - Add 8 bytes (savegame name) to the start of the savegame file + - Rename the savegame to 'elvira1.xxx' Elvira 2 - - Add 8 bytes (savedgame name) to the start of the savegame file - - Rename the savedgame to 'elvira2-pc.xxx' (DOS version) or + - Add 8 bytes (savegame name) to the start of the savegame file + - Rename the savegame to 'elvira2-pc.xxx' (DOS version) or 'elvira2.xxx' (Other versions) Waxworks - - Add 8 bytes (savedgame name) to the start of the savegame file - - Rename the savedgame to 'waxworks-pc.xxx' (DOS version) or + - Add 8 bytes (savegame name) to the start of the savegame file + - Rename the savegame to 'waxworks-pc.xxx' (DOS version) or 'waxworks.xxx' (Other versions) Simon the Sorcerer 1 - - Rename the savedgame to 'simon1.xxx' + - Rename the savegame to 'simon1.xxx' Simon the Sorcerer 1 - - Rename the savedgame to 'simon2.xxx' + - Rename the savegame to 'simon2.xxx' The Feeble Files - - Rename the savedgame to 'feeble.xxx' + - Rename the savegame to 'feeble.xxx' Where 'xxx' is exact the saved game slot (ie 001) under ScummVM +6.3) Viewing/Loading savegames from the command line: +---- ------------------------------------------------ + +--list-saves: + + This switch may be used to display a list of the current savegames + of the specified target game and their corresponding save slots. + + Usage: --list-saves=[TARGET], where [TARGET] is the target game. + + Engines which currently support --list-saves are: + + AGI + AGOS + CINE + KYRA + LURE + PARALLACTION + QUEEN + SAGA + SCUMM + SKY + SWORD1 + SWORD2 + TOUCHE + +--save-slot/-x: + + This switch may be used to load a savegame directly from the command line. + + Usage: --save-slot[SLOT] or -x[SLOT], where [SLOT] is the save slot number. + + Engines which currently support --save-slot/-x are: + + AGI + CINE + KYRA + LURE + PARALLACTION + QUEEN + SAGA + SCUMM + SKY + SWORD1 + SWORD2 + TOUCHE + + 7.0) Music and Sound: ---- ---------------- @@ -1322,34 +1411,39 @@ sequencer support does not work, you can always fall back on Adlib emulation. 7.6.1) Playing sound with ALSA sequencer: [UNIX ONLY] ------ ---------------------------------- -If you have installed the ALSA driver with the sequencer support, then -set the environment variable SCUMMVM_PORT or the config file parameter -alsa_port to your sequencer port. The default is "65:0". +If you have installed the ALSA driver with the sequencer support, then set the +environment variable SCUMMVM_PORT or the config file parameter alsa_port to +your sequencer port. The default is to try both "65:0" and "17:0". Here is a little howto on how to use the ALSA sequencer with your soundcard. In all cases, to have a list of all the sequencer ports you have, try the command "aconnect -o -l". This should give output similar to: -client 64: 'External MIDI 0' [type=kernel] - 0 'MIDI 0-0 ' -client 65: 'Emu10k1 WaveTable' [type=kernel] + +client 14: 'Midi Through' [type=kernel] + 0 'Midi Through Port-0' +client 16: 'SBLive! Value [CT4832]' [type=kernel] + 0 'EMU10K1 MPU-401 (UART)' +client 17: 'Emu10k1 WaveTable' [type=kernel] 0 'Emu10k1 Port 0 ' 1 'Emu10k1 Port 1 ' 2 'Emu10k1 Port 2 ' 3 'Emu10k1 Port 3 ' -client 128: 'Client-128' [type=user] +client 128: 'TiMidity' [type=user] 0 'TiMidity port 0 ' 1 'TiMidity port 1 ' + 2 'TiMidity port 2 ' + 3 'TiMidity port 3 ' -This means the external MIDI output of the sound card is located on the -port 64:0, four WaveTable MIDI outputs in 65:0, 65:1, 65:2 -and 65:3, and two TiMidity ports, located at 128:0 and 128:1. +The most important bit here is that there are four WaveTable MIDI outputs +located at 17:0, 17:1, 17:2 and 17:3, and four TiMidity ports located at 128:0, +128:1, 128:2 and 128:3. If you have a FM-chip on your card, like the SB16, then you have to load the SoundFonts using the sbiload software. Example: - sbiload -p 65:0 /etc/std.o3 /etc/drums.o3 + sbiload -p 17:0 /etc/std.o3 /etc/drums.o3 If you have a WaveTable capable sound card, you have to load a sbk or sf2 -SoundFont using the sfxload software. Example: +SoundFont using the sfxload or asfxload software. Example: sfxload /path/to/8mbgmsfx.sf2 If you don't have a MIDI capable soundcard, there are two options: FluidSynth |