[Scummvm-git-logs] scummvm master -> 39988d5762b1ce45877d6c5c554dbc7881c3ff3d
sev-
sev at scummvm.org
Sun Oct 4 16:29:24 UTC 2020
This automated email contains information about 28 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
9c2404c0b3 DOCS: Initial commit of doc portal drafts
dce5303263 DOCS: adds first draft to iOS quickstart page
57156ac604 DOCS: First draft for Android page
3074636e03 DOCS: adds info about cloud functionality
bc48829f1a DOCS: updates screenshots
9b27296ed3 DOCS: adds cloud info to android page
985aa07c15 DOCS: moves adding_games to using_scummvm section
863faf0364 DOCS: updates screenshots
cc31d41ee7 DOCS: adds/updates game/global settings
ed6e16f3f3 DOCS: updates links to screenshots
07be4ff7be DOCS: corrects audio settings descriptions
563c2354c7 DOCS: corrects audio settings descriptions
5e60adb139 DOCS: adds refs to config keywords
8a117e2874 DOCS: reformats keywords into table
dde4138985 DOCS: reformats CLI options into table
c54a4431d9 DOCS: adds config file paths + readability edits
1fb5055bb1 DOCS: replaced with .rst file
d64ed59aeb DOCS: adds refs for some settings
286e918d24 DOCS: adds tabs extension
1ac9044f4c DOCS: adds screenshots for graphics page
c73f20cfcd DOCS: first draft graphics page
78e7577fb1 DOCS: adds requirement for RTD to enable tabs
842f5a47d4 DOCS: adds aspect ratio screenshots
35d980d2cd DOCS: removes outdated pages
5e6f9ca851 DOCS: reformats keyboard shortcuts into tables
7a9cfd67f8 DOCS: adds reference to graphics page
df0b88a77b DOCS: corrects ref to keyboard shortcut
39988d5762 DOCS: updates index page links
Commit: 9c2404c0b3df97c18123796c28a993dd52a001fd
https://github.com/scummvm/scummvm/commit/9c2404c0b3df97c18123796c28a993dd52a001fd
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: Initial commit of doc portal drafts
Changed paths:
A doc/docportal/Makefile
A doc/docportal/advanced_options/command_line.md
A doc/docportal/advanced_options/configuration_file.md
A doc/docportal/advanced_options/graphic_filters.rst
A doc/docportal/advanced_options/render_modes.rst
A doc/docportal/conf.py
A doc/docportal/getting_started/adding_games.rst
A doc/docportal/getting_started/android.rst
A doc/docportal/getting_started/ios.rst
A doc/docportal/getting_started/linux.rst
A doc/docportal/getting_started/mac.rst
A doc/docportal/getting_started/windows.rst
A doc/docportal/images/Launcher/Configdone.png
A doc/docportal/images/Launcher/Generalmenu.png
A doc/docportal/images/Launcher/Graphicstab.png
A doc/docportal/images/Launcher/InterfaceMainWindow.png
A doc/docportal/images/Launcher/Loadlist.png
A doc/docportal/images/Launcher/Quicksearch.png
A doc/docportal/images/Launcher/ScummHelpDialog.png
A doc/docportal/images/RaspberryPi/adding_game_rpi.gif
A doc/docportal/images/RaspberryPi/adding_games_rpi.jpg
A doc/docportal/images/RaspberryPi/blank_launcher_rpi.jpg
A doc/docportal/images/RaspberryPi/game_info_rpi.jpg
A doc/docportal/images/RaspberryPi/launch_commandline.gif
A doc/docportal/images/RaspberryPi/launch_game.gif
A doc/docportal/images/RaspberryPi/launch_launcher.gif
A doc/docportal/images/RaspberryPi/launch_scummvm_rpi.jpg
A doc/docportal/images/RaspberryPi/load_game.gif
A doc/docportal/images/RaspberryPi/open_launcher.gif
A doc/docportal/images/RaspberryPi/settings.gif
A doc/docportal/images/RaspberryPi/start_game_rpi.jpg
A doc/docportal/index.rst
A doc/docportal/using_scummvm/game_settings.rst
A doc/docportal/using_scummvm/global_settings.rst
A doc/docportal/using_scummvm/keyboard_shortcuts.rst
A doc/docportal/using_scummvm/the_launcher.rst
diff --git a/doc/docportal/Makefile b/doc/docportal/Makefile
new file mode 100644
index 0000000000..d4bb2cbb9e
--- /dev/null
+++ b/doc/docportal/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/docportal/advanced_options/command_line.md b/doc/docportal/advanced_options/command_line.md
new file mode 100755
index 0000000000..0b219ab607
--- /dev/null
+++ b/doc/docportal/advanced_options/command_line.md
@@ -0,0 +1,217 @@
+# Command line interface
+
+## Launching ScummVM
+
+### Usage
+
+````bash
+scummvm [OPTIONS] [GAME]
+````
+
+### [GAME]
+
+[GAME] is the game id of the game you wish to launch. For example, 'monkey' for Monkey Island.
+
+The game id may be the default game id, or a user configured id set either directly in the game-specific section of the configuration file or in the Launcher [game settings window](using/game_settings).
+
+### [OPTIONS]
+
+[OPTIONS] refers to any of the following options:
+
+````bash
+-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
+--list-saves=TARGET Display a list of saved games for the game (TARGET) specified
+-a, --add Add all games from current or specified directory.
+ If --game=ID is passed only the game with id ID is added. See also --detect
+ Use --path=PATH before -a, --add to specify a directory.
+--detect Display a list of games with their ID from current or
+ specified directory without adding it to the config.
+ Use --path=PATH before --detect to specify a directory.
+--game=ID In combination with --add or --detect only adds or attempts to
+ detect the game with id ID.
+--auto-detect Display a list of games from current or specified directory
+ and start the first one. Use --path=PATH before --auto-detect
+ to specify a directory.
+--recursive In combination with --add or --detect recurse down all subdirectories
+
+-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 (1x,2x,3x,2xsai,super2xsai,
+ supereagle,advmame2x,advmame3x,hq2x,hq3x,tv2x,
+ dotmatrix)
+--filtering Force filtered graphics mode
+--no-filtering Force unfiltered graphics mode
+--gui-theme=THEME Select GUI theme
+--themepath=PATH Path to where GUI themes are stored
+--list-themes Display list of all usable GUI themes
+-e, --music-driver=MODE Select music driver (see README for details)
+--list-audio-devices List all available audio devices
+-q, --language=LANG Select language (en,de,fr,it,pt,es,jp,zh,kr,se,gb,
+ hb,ru,cz)
+-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 speech 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
+--debugflags=FLAGS Enable engine specific debug flags
+ (separated by commas)
+--debug-channels-only Show only the specified debug channels
+-u, --dump-scripts Enable script dumping if a directory called 'dumps'
+ exists in the current directory
+
+--cdrom=DRIVE CD drive to play CD audio from; can either be a
+ drive, path, or numeric index (default: 0 = best
+ choice drive)
+--joystick[=NUM] Enable joystick input (default: 0 = first joystick)
+--platform=WORD Specify platform of game (allowed values: 2gs, 3do,
+ acorn, amiga, atari, c64, fmtowns, nes, mac, pc, pc98,
+ pce, segacd, wii, windows)
+--savepath=PATH Path to where saved games are stored
+--extrapath=PATH Extra path to additional game data
+--soundfont=FILE Select the SoundFont for MIDI playback (only
+ supported by some MIDI drivers)
+--multi-midi Enable combination AdLib and native MIDI
+--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)
+--opl-driver=DRIVER Select AdLib (OPL) emulator (db, mame)
+--aspect-ratio Enable aspect ratio correction
+--render-mode=MODE Enable additional render modes (hercGreen, hercAmber,
+ cga, ega, vga, amiga, fmtowns, pc9821, pc9801, 2gs,
+ atari, macintosh)
+
+--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.
+--talkspeed=NUM Set talk speed for games (default: 60)
+--demo-mode Start demo mode of Maniac Mansion or The 7th Guest
+--tempo=NUM Set music tempo (in percent, 50-200) for SCUMM games
+ (default: 100)
+--dimuse-tempo=NUM Set internal Digital iMuse tempo (10 - 100) per second
+ (default: 10)
+````
+
+The meaning of most long options, which are those options starting with a double-dash, can be inverted by prefixing them with ```no-```. For example, ```--no-aspect-ratio``` will turn aspect ratio correction off. This is useful if you want to override a setting in the configuration file.
+
+## Launching saved games
+
+### --list-saves
+
+This option is used to display a list of the current saved games of the specified target game and the corresponding save slots.
+
+#### Usage
+
+````bash
+scummvm --list-saves=TARGET
+````
+
+Engines which currently support ```--list-saves``` are:
+
+- AGI
+- AGOS
+- BLADERUNNER
+- CGE
+- CINE
+- CRUISE
+- CRYOMNI3D
+- DRACI
+- GROOVIE
+- HUGO
+- KYRA
+- LURE
+- MOHAWK
+- PARALLACTION
+- QUEEN
+- SAGA
+- SCI
+- SCUMM
+- SKY
+- SWORD1
+- SWORD2
+- TEENAGENT
+- TINSEL
+- TITANIC
+- TOON
+- TOUCHE
+- TSAGE
+- TUCKER
+- ZVISION
+
+### --save-slot <a id="save_slot"></a>
+
+This option is used to load a saved game 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``` are:
+
+- AGI
+- BLADERUNNER
+- CGE
+- CINE
+- CRUISE
+- CRYOMNI3D
+- DRACI
+- GROOVIE
+- HUGO
+- KYRA
+- LURE
+- MOHAWK
+- QUEEN
+- SAGA
+- SCI
+- SCUMM
+- SKY
+- SWORD1
+- SWORD2
+- TEENAGENT
+- TINSEL
+- TITANIC
+- TOON
+- TOUCHE
+- TSAGE
+- TUCKER
+- ZVISION
+
+## Examples
+<!-- tabs:start -->
+
+### ** Windows **
+
+Running Monkey Island, fullscreen, from a hard disk:
+
+````bash
+C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\monkey
+````
+
+Running Full Throttle from CD, fullscreen and with subtitles enabled:
+
+````bash
+C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ft
+````
+
+### ** Unix **
+Running Monkey Island, fullscreen, from a hard disk:
+
+````bash
+/path/to/scummvm -f -p/games/LucasArts/monkey/monkey
+````
+
+Running Full Throttle from CD, fullscreen and with subtitles enabled:
+
+````bash
+/path/to/scummvm -f -n -p/cdrom/resource/ft
+````
+<!-- tabs:end -->
diff --git a/doc/docportal/advanced_options/configuration_file.md b/doc/docportal/advanced_options/configuration_file.md
new file mode 100755
index 0000000000..6319cab593
--- /dev/null
+++ b/doc/docportal/advanced_options/configuration_file.md
@@ -0,0 +1,143 @@
+# The configuration file
+
+## Location
+
+The configuration file saves to different default locations depending on the platform on which you are running ScummVM.
+
+| Platform| Config File Path|
+|-|-|
+|
+
+Most settings are also accessible directly from the Launcher. To edit global settings, click **Options**. To edit game-specific settings, highlight a game and then click **Edit Game**.
+For more information, see the [global settings](using/global_settings) and [game settings](using/game_settings) pages.
+
+## Keywords
+
+There are many recognized configuration keywords:
+
+````
+
+path string The path to where a game's data files are
+autosave_period number The seconds between autosaving (default: 300)
+save_slot number The saved game number to load on startup.
+savepath string The path to where a game will store its
+ saved games.
+screenshotpath string The path to where screenshots are saved.
+iconpath string The path to where to look for icons to use as
+ overlay for the ScummVM icon in the Windows
+ taskbar or macOS X Dock when running a game.
+ The icon files should be named after the game
+ ids and be in ico format on Windows or png
+ format on macOS X.
+versioninfo string The version of the ScummVM that created the
+ configuration file.
+
+gameid string The real id of a game. Useful if you have
+ several versions of the same game, and want
+ different aliases for them. See the example.
+description string The description of the game as it will appear
+ in the launcher.
+
+language string Specify language (en, us, de, fr, it, pt, es,
+ jp, zh, kr, se, gb, hb, cz, ru)
+speech_mute bool If true, speech is muted
+subtitles bool Set to true to enable subtitles.
+talkspeed number Text delay in SCUMM games, or text speed in
+ other games.
+
+fullscreen bool Fullscreen mode
+aspect_ratio bool Enable aspect ratio correction
+gfx_mode string Graphics mode (normal, 2x, 3x, 2xsai,
+ super2xsai, supereagle, advmame2x, advmame3x,
+ hq2x, hq3x, tv2x, dotmatrix, opengl)
+filtering bool Enable graphics filtering
+
+confirm_exit bool Ask for confirmation by the user before
+ quitting (SDL backend only).
+console bool Enable the console window (default: enabled)
+ (Windows only).
+cdrom number Number of CD-ROM unit to use for audio. If
+ negative, don't even try to access the CD-ROM.
+joystick_num number Number of joystick device to use for input
+controller_map_db string A custom controller mapping file to load to
+ complete default database (SDL backend only).
+ Otherwise, file gamecontrollerdb.txt will be
+ loaded from extrapath.
+music_driver string The music engine to use.
+opl_driver string The AdLib (OPL) emulator to use.
+output_rate number The output sample rate to use, in Hz. Sensible
+ values are 11025, 22050 and 44100.
+audio_buffer_size number Overrides the size of the audio buffer. The
+ value must be one of: 256 512 1024 2048 4096
+ 8192 16384 32768. The default value is
+ calculated based on the output_rate to keep
+ audio latency below 45ms.
+alsa_port string Port to use for output when using the
+ ALSA music driver.
+music_volume number The music volume setting (0-255)
+multi_midi bool If true, enable combination AdLib and native
+ MIDI.
+soundfont string The SoundFont to use for MIDI playback. (Only
+ supported by some MIDI drivers.)
+native_mt32 bool If true, disable GM emulation and assume that
+ there is a true Roland MT-32 available.
+enable_gs bool If true, enable Roland GS-specific features to
+ enhance GM emulation. If native_mt32 is also
+ true, the GS device will select an MT-32 map
+ to play the correct instruments.
+sfx_volume number The sfx volume setting (0-255)
+tempo number The music tempo (50-200) (default: 100)
+speech_volume number The speech volume setting (0-255)
+midi_gain number The MIDI gain (0-1000) (default: 100) (Only
+ supported by some MIDI drivers.)
+
+copy_protection bool Enable copy protection in certain games, in
+ those cases where ScummVM disables it by
+ default.
+demo_mode bool Start demo in Maniac Mansion
+alt_intro bool Use alternative intro for CD versions of
+ Beneath a Steel Sky and Flight of the Amazon
+ Queen
+
+boot_param number Pass this number to the boot script
+````
+
+## Example file
+
+````
+ [scummvm]
+ gfx_mode=supereagle
+ fullscreen=true
+ savepath=C:\saves\
+
+ [sky]
+ path=C:\games\SteelSky\
+
+ [germansky]
+ gameid=sky
+ language=de
+ path=C:\games\SteelSky\
+ description=Beneath a Steel Sky w/ German subtitles
+
+ [germandott]
+ gameid=tentacle
+ path=C:\german\tentacle\
+ description=German version of DOTT
+
+ [tentacle]
+ path=C:\tentacle\
+ subtitles=true
+ music_volume=40
+ sfx_volume=255
+
+ [loomcd]
+ cdrom=1
+ path=C:\loom\
+ talkspeed=5
+ savepath=C:\loom\saves\
+
+ [monkey2]
+ path=C:\amiga_mi2\
+ music_driver=windows
+
+````
\ No newline at end of file
diff --git a/doc/docportal/advanced_options/graphic_filters.rst b/doc/docportal/advanced_options/graphic_filters.rst
new file mode 100644
index 0000000000..feddd84d6f
--- /dev/null
+++ b/doc/docportal/advanced_options/graphic_filters.rst
@@ -0,0 +1,4 @@
+============================================
+Graphic filters
+============================================
+This is a dummy page
\ No newline at end of file
diff --git a/doc/docportal/advanced_options/render_modes.rst b/doc/docportal/advanced_options/render_modes.rst
new file mode 100644
index 0000000000..3c681998ef
--- /dev/null
+++ b/doc/docportal/advanced_options/render_modes.rst
@@ -0,0 +1,4 @@
+=============
+Render modes
+=============
+This is a dummy page
\ No newline at end of file
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
new file mode 100644
index 0000000000..da25ae3429
--- /dev/null
+++ b/doc/docportal/conf.py
@@ -0,0 +1,60 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'ScummVM Documentation'
+copyright = '2020, CadiH'
+author = 'CadiH'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+
+import sphinx_rtd_theme
+
+extensions = [
+
+ "sphinx_rtd_theme",
+ "recommonmark"
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+master_doc = 'index'
+html_sidebars = {'**': ['localtoc.html']}
\ No newline at end of file
diff --git a/doc/docportal/getting_started/adding_games.rst b/doc/docportal/getting_started/adding_games.rst
new file mode 100644
index 0000000000..caece4d9d6
--- /dev/null
+++ b/doc/docportal/getting_started/adding_games.rst
@@ -0,0 +1,80 @@
+
+=================================
+Adding and playing games
+=================================
+
+Accessing the game files
+------------------------
+
+ScummVM needs access to the data files for each game. A comprehensive list of required data files for each game can be found on the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page. ScummVM can run the game data files from any directory it has access to, including external media.
+
+.. note::
+
+ For ease of use, you can create a dedicated games directory into which subdirectories containing game files can be copied. The resulting directory structure will look somewhat like this::
+
+ mygames
+ |-- myfirstgame
+ | |-- readme.txt
+ | |-- firstgame.cpt
+ | |-- firstgame.dnr
+ | `-- firstgame.dsk
+ `-- mysecondgame
+ |-- secondgame.1c
+ `-- readme.txt
+
+
+
+For games on floppies or CDs:
+
+- If the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above.
+- If the data files are not accessible, run the installer on the platform the game was designed for.
+
+For games downloaded from digital distributors such as `GOG.com <gog.com>`__, `Steam <https://store.steampowered.com>`__, or from various `freeware sources <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games#Freeware_Games>`__ sources:
+
+- Run the installer or
+- If the data files are supplied as a .zip file, extract the archive.
+
+.. _add and play games:
+
+Adding the games to the Launcher
+---------------------------------
+
+1. Run ScummVM to open :doc:`../using_scummvm/the_launcher`.
+
+2. In the Launcher window, click **Add Game**. This opens a file browser. To add multiple games at once, hold :kbd:`Shift` while clicking **Add Game**.
+
+.. image:: ../images/RaspberryPi/blank_launcher_rpi.jpg
+ :class: with-shadow
+
+
+3. Use the file browser to locate the folder containing the game you wish to add. Double click on a folder to open it, and use **Go up** to go back up one level.
+
+4. Once you have selected the folder that contains the data files, click **Choose**.
+
+.. image:: ../images/RaspberryPi/adding_games_rpi.jpg
+ :class: with-shadow
+
+
+
+5. A dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should work at the default settings. Click **Ok**.
+
+.. image:: ../images/RaspberryPi/game_info_rpi.jpg
+ :class: with-shadow
+
+6. Added games are now ready to play! To play, select a game and click **Start** to play.
+
+.. image:: ../images/RaspberryPi/launch_launcher.gif
+ :class: with-shadow
+
+Games can also be launched directly from the command line.
+
+- To launch a game with no additional options, run ``scummvm`` followed by the game id.
+- To launch a game with options, run ``scummvm`` , followed by any desired options, and then the game ID. For more information, see the `Command line options <../advanced_options/command_line>`_ page.
+
+In the following example, Flight of the Amazon Queen will be launched in full screen::
+
+ scummvm -f queen
+
+.. image:: ../images/RaspberryPi/launch_commandline.gif
+ :class: with-shadow
+
diff --git a/doc/docportal/getting_started/android.rst b/doc/docportal/getting_started/android.rst
new file mode 100644
index 0000000000..84d5d9e206
--- /dev/null
+++ b/doc/docportal/getting_started/android.rst
@@ -0,0 +1,5 @@
+
+===============
+Android
+===============
+
diff --git a/doc/docportal/getting_started/ios.rst b/doc/docportal/getting_started/ios.rst
new file mode 100644
index 0000000000..505ddb41fe
--- /dev/null
+++ b/doc/docportal/getting_started/ios.rst
@@ -0,0 +1,5 @@
+
+==============
+iOS
+==============
+
diff --git a/doc/docportal/getting_started/linux.rst b/doc/docportal/getting_started/linux.rst
new file mode 100644
index 0000000000..8146361c34
--- /dev/null
+++ b/doc/docportal/getting_started/linux.rst
@@ -0,0 +1,73 @@
+
+====================================================================
+Linux
+====================================================================
+
+Downloading and installing ScummVM
+===================================
+There are multiple ways to install ScummVM onto a computer running Linux, and all are accessible from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_.
+
+The Snap Store
+---------------
+A Snap is an app that is bundled with its dependencies, which makes the install on any Linux operating system very easy. Snap comes pre-installed on Debian and Ubuntu-based distributions, but can be installed on any Linux distribution by following the instructions on the `Snapcraft website <https://snapcraft.io/>`_.
+
+The ScummVM Snap comes with a selection of freeware games and demos pre-loaded.
+
+Enter the following on the command line (using your preferred Terminal application) to install the ScummVM Snap:
+
+.. code:: bash
+
+ sudo snap install scummvm
+
+To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
+
+Flathub
+----------
+Flathub is another way to easily install apps for Linux by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
+
+Once Flatpak has been installed, enter the following on the command line to install ScummVM:
+
+.. code:: bash
+
+ flatpak install flathub org.scummvm.ScummVM
+
+To run ScummVM, enter the following on the command line:
+
+.. code:: bash
+
+ flatpak run org.scummvm.ScummVM
+
+.. note::
+
+ The Flatpak version of ScummVM is sandboxed, meaning that any games will need to be copied into the Documents folders to be accessible by ScummVM.
+
+ :doc:`Command line arguments <../advanced_options/command_line>` can still be passed by adding them after the Flatpak run command.
+
+Some distributions have the option to install Flatpaks via the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog will appear; choose the **Open with Software Install (default)** option, and click **OK**. You will then be guided through the install process.
+
+Software Repository
+--------------------
+
+ScummVM can be found in the software repositories of many Linux distributions. Please note that these may not contain the most up to date version of ScummVM.
+
+If you are unsure how to install software packages from the software repository for your distribution, you may find `this article <https://www.maketecheasier.com/install-software-in-various-linux-distros/>`_ useful.
+
+To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**
+
+
+Installing release binaries
+----------------------------
+
+At this time, binary packages are only released for Debian and Ubuntu. Find and download the ScummVM version that corresponds to your operating system and architecture. To install a ``.deb`` package:
+
+.. code:: bash
+
+ sudo apt install /path/to/package/name.deb
+
+In this situation, replace the ``/path/to/package/name.deb`` with the actual path to the downloaded ``.deb`` package. The APT software manager will handle the installation.
+
+To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
+
+**Congratulations!**
+
+ScummVM is now installed and ready for you to :doc:`add your games <../getting_started/adding_games>`!
diff --git a/doc/docportal/getting_started/mac.rst b/doc/docportal/getting_started/mac.rst
new file mode 100644
index 0000000000..e70b61176b
--- /dev/null
+++ b/doc/docportal/getting_started/mac.rst
@@ -0,0 +1,16 @@
+
+====================================================================
+Mac OSX
+====================================================================
+
+Downloading and installing ScummVM
+-----------------------------------
+Download the Disk Image from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_. Once the download has completed, double click the file to mount the Disk Image.
+
+A dialog will open with the ScummVM icon. Drag this icon into your Applications folder to install ScummVM.
+
+To run ScummVM, click on the icon in the Applications folder.
+
+**Congratulations!**
+
+ScummVM is now installed and ready for you to :doc:`add your games <../getting_started/adding_games>`!
diff --git a/doc/docportal/getting_started/windows.rst b/doc/docportal/getting_started/windows.rst
new file mode 100644
index 0000000000..d3e8bec392
--- /dev/null
+++ b/doc/docportal/getting_started/windows.rst
@@ -0,0 +1,21 @@
+
+====================================================================
+Windows
+====================================================================
+
+System Requirements
+--------------------
+
+A system running Windows XP or newer
+
+Downloading and installing ScummVM
+-----------------------------------
+The easiest way to install ScummVM is to download the Windows installer on the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_. This installer will guide you through the install process, as well as adding a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
+
+To run ScummVM, navigate to desktop and double click the ScummVM shortcut, or click for later Windows versions **Start > All Apps > ScummVM** or for Windows XP **Start > All Programs > Games > ScummVM**
+
+Alternatively, you can download the Windows zipped file appropriate to your operating system (32bit or 64bit). To unzip the contents, right-click the folder, select Extract All, and then follow the instructions. To run ScummVM from this folder, find the ``scummvm.exe`` file and double click it.
+
+**Congratulations!**
+
+ScummVM is now installed and ready for you to :doc:`add your games <../getting_started/adding_games>`!
diff --git a/doc/docportal/images/Launcher/Configdone.png b/doc/docportal/images/Launcher/Configdone.png
new file mode 100755
index 0000000000..926000b9f5
Binary files /dev/null and b/doc/docportal/images/Launcher/Configdone.png differ
diff --git a/doc/docportal/images/Launcher/Generalmenu.png b/doc/docportal/images/Launcher/Generalmenu.png
new file mode 100755
index 0000000000..3301eadff5
Binary files /dev/null and b/doc/docportal/images/Launcher/Generalmenu.png differ
diff --git a/doc/docportal/images/Launcher/Graphicstab.png b/doc/docportal/images/Launcher/Graphicstab.png
new file mode 100755
index 0000000000..31350a9602
Binary files /dev/null and b/doc/docportal/images/Launcher/Graphicstab.png differ
diff --git a/doc/docportal/images/Launcher/InterfaceMainWindow.png b/doc/docportal/images/Launcher/InterfaceMainWindow.png
new file mode 100755
index 0000000000..7cb2e5c638
Binary files /dev/null and b/doc/docportal/images/Launcher/InterfaceMainWindow.png differ
diff --git a/doc/docportal/images/Launcher/Loadlist.png b/doc/docportal/images/Launcher/Loadlist.png
new file mode 100755
index 0000000000..1e6d30edc2
Binary files /dev/null and b/doc/docportal/images/Launcher/Loadlist.png differ
diff --git a/doc/docportal/images/Launcher/Quicksearch.png b/doc/docportal/images/Launcher/Quicksearch.png
new file mode 100755
index 0000000000..1cd3c62653
Binary files /dev/null and b/doc/docportal/images/Launcher/Quicksearch.png differ
diff --git a/doc/docportal/images/Launcher/ScummHelpDialog.png b/doc/docportal/images/Launcher/ScummHelpDialog.png
new file mode 100755
index 0000000000..0fc59b175b
Binary files /dev/null and b/doc/docportal/images/Launcher/ScummHelpDialog.png differ
diff --git a/doc/docportal/images/RaspberryPi/adding_game_rpi.gif b/doc/docportal/images/RaspberryPi/adding_game_rpi.gif
new file mode 100755
index 0000000000..58b1ca2cf7
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/adding_game_rpi.gif differ
diff --git a/doc/docportal/images/RaspberryPi/adding_games_rpi.jpg b/doc/docportal/images/RaspberryPi/adding_games_rpi.jpg
new file mode 100755
index 0000000000..78c5fb8d85
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/adding_games_rpi.jpg differ
diff --git a/doc/docportal/images/RaspberryPi/blank_launcher_rpi.jpg b/doc/docportal/images/RaspberryPi/blank_launcher_rpi.jpg
new file mode 100755
index 0000000000..625b63a3a5
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/blank_launcher_rpi.jpg differ
diff --git a/doc/docportal/images/RaspberryPi/game_info_rpi.jpg b/doc/docportal/images/RaspberryPi/game_info_rpi.jpg
new file mode 100755
index 0000000000..f0ea728c66
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/game_info_rpi.jpg differ
diff --git a/doc/docportal/images/RaspberryPi/launch_commandline.gif b/doc/docportal/images/RaspberryPi/launch_commandline.gif
new file mode 100755
index 0000000000..76cfc142e4
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/launch_commandline.gif differ
diff --git a/doc/docportal/images/RaspberryPi/launch_game.gif b/doc/docportal/images/RaspberryPi/launch_game.gif
new file mode 100755
index 0000000000..3509ed6c69
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/launch_game.gif differ
diff --git a/doc/docportal/images/RaspberryPi/launch_launcher.gif b/doc/docportal/images/RaspberryPi/launch_launcher.gif
new file mode 100755
index 0000000000..e8992fa705
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/launch_launcher.gif differ
diff --git a/doc/docportal/images/RaspberryPi/launch_scummvm_rpi.jpg b/doc/docportal/images/RaspberryPi/launch_scummvm_rpi.jpg
new file mode 100755
index 0000000000..f111757da3
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/launch_scummvm_rpi.jpg differ
diff --git a/doc/docportal/images/RaspberryPi/load_game.gif b/doc/docportal/images/RaspberryPi/load_game.gif
new file mode 100755
index 0000000000..f352814ce0
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/load_game.gif differ
diff --git a/doc/docportal/images/RaspberryPi/open_launcher.gif b/doc/docportal/images/RaspberryPi/open_launcher.gif
new file mode 100755
index 0000000000..c3d0879ba2
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/open_launcher.gif differ
diff --git a/doc/docportal/images/RaspberryPi/settings.gif b/doc/docportal/images/RaspberryPi/settings.gif
new file mode 100755
index 0000000000..f4eb876dfa
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/settings.gif differ
diff --git a/doc/docportal/images/RaspberryPi/start_game_rpi.jpg b/doc/docportal/images/RaspberryPi/start_game_rpi.jpg
new file mode 100755
index 0000000000..a6695b721c
Binary files /dev/null and b/doc/docportal/images/RaspberryPi/start_game_rpi.jpg differ
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
new file mode 100644
index 0000000000..4e3581b564
--- /dev/null
+++ b/doc/docportal/index.rst
@@ -0,0 +1,98 @@
+.. toctree::
+ :glob:
+ :caption: Getting Started
+ :maxdepth: 2
+ :hidden:
+
+ getting_started/mac
+ getting_started/linux
+ getting_started/windows
+ getting_started/ios
+ getting_started/android
+ getting_started/adding_games
+
+
+.. toctree::
+ :caption: Installing ScummVM
+ :glob:
+ :maxdepth: 2
+ :hidden:
+
+ installing_scummvm/*
+
+.. toctree::
+ :caption: Using ScummVM
+ :glob:
+ :hidden:
+
+ using_scummvm/game_settings
+ using_scummvm/*
+
+.. toctree::
+ :caption: Advanced Options
+ :glob:
+ :hidden:
+
+ advanced_options/*
+
+====================
+Welcome to ScummVM!
+====================
+
+ScummVM is a program that allows you to run classic graphical point-and-click adventure games, provided you already have the game data files. ScummVM replaces the executable files shipped with the games, which means they can be played on systems they were never designed for!
+
+SCUMM (Script Creation Utility for Maniac Mansion) is a utility that was used to create many of the famous LucasArts adventure games, such as Maniac Mansion and Monkey Island. It is the namesake of ScummVM, with VM meaning Virtual Machine.
+
+While ScummVM was originally designed to run LucasArts' SCUMM games, over time support has been added for many other games.
+
+First steps
+================
+We have guides available to show you how to get your games up and running with ScummVM on many different platforms:
+
+- **Computers**: :doc:`getting_started/windows` | :doc:`getting_started/mac` | :doc:`getting_started/linux`
+- **Phones and Tablets**: :doc:`getting_started/ios` | :doc:`getting_started/android`
+- **Other Platforms:**
+
+
+How do I...?
+=============
+
+If you have ScummVM installed, but you have questions about how to use it, our **Using ScummVM** section has lots of useful information to help you out:
+
+- **Understanding the interface**: :doc:`using_scummvm/the_launcher`
+- **Changing settings**: :doc:`using_scummvm/global_settings` | :doc:`using_scummvm/game_settings`
+- **Shortcuts**: :doc:`using_scummvm/keyboard_shortcuts`
+
+
+Advanced features
+============================
+
+For our more experienced users, ScummVM has many cool advanced options.
+But don't worry, even if you're a beginner, our documentation will take you through how to optimize your game playing experience.
+
+- **Advanced settings**: :doc:`advanced_options/configuration_file` | :doc:`advanced_options/render_modes` | :doc:`advanced_options/graphic_filters`
+- **The command line interface**: :doc:`advanced_options/command_line`
+
+
+Getting help
+=============
+
+ScummVM is still under development. While we do our best to make sure that as many games as possible can be completed with no major bugs, crashes can happen and we offer no warranty.
+
+If you are having problems with any aspect of ScummVM, take a look at our help section.
+
+- **Games**: `Compatibility <https://www.scummvm.org/compatibility/>`__
+- **Frequently Asked Questions**: `FAQ <#>`__
+- **Bugs**: `Known problems <#>`__ | `Reporting a Bug <#>`__
+- **How to contact us**: `Contact page <#>`__
+
+
+The ScummVM Project
+===================
+ScummVM is an open-source project.
+
+If you enjoy ScummVM, feel free to donate using the PayPal button on the `ScummVM homepage <https://www.scummvm.org>`__. This will help us buy the utilities to develop ScummVM faster and more efficiently.
+
+If you cannot donate but you have the skills, you can help us by contributing a patch!
+
+- **Contributing Guidelines**: `Code <#>`__ | `Documentation <#>`__
diff --git a/doc/docportal/using_scummvm/game_settings.rst b/doc/docportal/using_scummvm/game_settings.rst
new file mode 100644
index 0000000000..cd306d2395
--- /dev/null
+++ b/doc/docportal/using_scummvm/game_settings.rst
@@ -0,0 +1,568 @@
+=============
+Game settings
+=============
+
+Each game can be configured to run using settings other than the :doc:`global_settings`
+
+To open the game settings window, highlight a game in the main Launcher
+window, and click on **Edit Game**. This window also opens any time a
+game is added to the Launcher.
+
+There are many settings, and they are separated into tabs:
+
+`Game tab`_ | `Engine tab`_ | `Graphics tab`_ | `Audio tab`_ | `Volume tab`_ | `Midi tab`_ | `Paths tab`_ |
+
+
+_`Game tab`
+------------
+
+Use the game tab to display and change information about how the game is
+identified by ScummVM.
+
+,,,,,,,
+
+**ID**
+ This field shows the short name of the game. This ID can be used for launching the game from Fullscreen modethe command line.
+
+**Name**
+ This field shows the full title of the game, as well as some basic information such as original platform and language.
+
+**Language**
+ This option is only applicable to Maniac Mansion, Zak McKracken, The Dig, The Curse of Monkey Island, Beneath a Steel Sky, Broken Sword 1, and Simon the Sorcerer 1 and 2. With the exception of Beneath a Steel Sky, Broken Sword 1, and multilanguage versions of Goblins games and Nippon Safes Inc., using this option does not change the language of the game, which is usually hardcoded, but rather is only used to select the appropriate font. For example, for a German version of a game, a font with umlauts. The Dig and The Curse of Monkey Island are another exception: the non-English versions of these games can be set to English, which only affect the language of subtitles. The game speech will remain the same.
+
+**Platform**
+ Specify the original platform of the game.
+
+,,,,,,,
+
+
+
+_`Graphics tab`
+-----------------
+
+Use the graphics tab to change how the game looks when it is played.
+
+,,,,,,,
+
+**Override global graphic settings**
+
+ Check this box to make the game use custom settings instead of global settings.
+
+
+**Graphics mode**
+ Changes the graphic filter the game uses. This option has to be used to enable a graphic filter for a game with an original resolution higher than 320x200 or 320x240, because the corresponding global settings does not apply.
+
+
+
+**Render mode**
+ Changes the render mode the game uses.
+
+
+**Aspect ratio correction**
+ Most games supported by ScummVM were designed to be played at a screen resolution of 320x200 using rectangular pixels (higher than they were wide). Most modern systems use square pixels, which means that the image appears to be squeezed vertically and the characters look wider and shorter than they should. If this option is checked, ScummVM corrects for this by stretching the game window to a resolution of 320x240, which looks the same as 320x200 on old monitors. As with Graphic filters, this takes a little processing power to achieve. Aspect ratio correction can be combined with a Graphic filter.
+
+**Fullscreen mode**
+ Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt + F5` while in a game.
+
+,,,,,
+
+
+_`Audio tab`
+--------------------
+
+Use the audio tab to change the sound output in the game.
+
+For more information about any of the audio settings, see the `Music and
+sound <page>`__ page.
+
+,,,,,,,
+
+**Override global audio settings**
+ Check this box to make the game use custom settings instead of global settings.
+
+
+
+**Music driver**
+ The method ScummVM uses to output MIDI music. For more details, see the section on music drivers.
+
+
+
+**AdLib Emulator**
+ The emulator used by ScummVM to generate the music when the AdLib music driver is selected. Two emulators are currently available: MAME OPL emulator was the emulator that was used up to version 0.13.1, and the DOSBox OPL emulator has been added but is still experimental.
+
+**Output rate**
+ The sample rate at which ScummVM plays sounds, including music if using an emulation music driver such as the AdLib music driver.
+
+**Text and Speech**
+ For games with digitized speech, setting allows the user to decide whether to play the game with speech and without any subtitles, or with subtitles displaying the words spoken in the digitized speech but not the speech, or with both.
+
+
+
+**Subtitle speed**
+ Adjusts the length of time that the subtitles are displayed on screen: the lower the speed is set, the longer the subtitles are displayed.
+
+,,,,,,
+
+_`Volume tab`
+-----------------
+Use the volume tab to set the relative volumes for various sounds in the game.
+
+,,,,,,,
+
+**Override global volume settings**
+ Check this box to make the game use custom settings instead of the global ones.
+
+
+
+**Music volume**
+ Adjusts the volume of the music played back in the game. This is usually MIDI music played back with one of the music drivers, but some games use digitized music.
+
+
+**SFX volume**
+ Adjusts the volume of the sound effects within the game.
+
+
+**Speech volume**
+ Adjusts the volume of the digitized speech in the game, if it has any.
+
+,,,,,,
+
+
+_`MIDI tab`
+---------------
+
+Use the MIDI tab to change settings about the MIDI music in the game.
+
+,,,,,,,
+
+**Override global MIDI settings**
+ Check this box to make the game use custom settings instead of the global settings.
+
+
+**Soundfont**
+ Some music drivers require you to provide them with a Soundfont, which contains samples of instruments for the device to play back. This setting allows you to choose one.
+
+
+**Mixed AdLib/MIDI mode**
+ Some games contain sound effects that are exclusive to the AdLib soundtrack. For these games, you may wish to use this mode in order to combine MIDI music with AdLib sound effects.
+
+
+**MIDI gain**
+ Adjusts the relative volume of the general MIDI music. This is only supported by some of the music drivers.
+
+
+_`MT-32 tab`
+---------------
+
+Override global MT-32 settings
+ Check this box to make the game use custom settings instead of the global settings.
+
+MT-32 Device
+ **Find out about this?**
+
+**True Roland MT-32 (disable GM emulation)**
+ ScummVM will treat your device as a real MT-32. Because the instrument mappings and system exclusive commands of the MT-32 vary from those of General MIDI devices, you should only enable this option if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500, or GS device with an MT-32 map.
+
+
+
+**Roland GS device (enable MT-32 mappings)**
+ ScummVM will initialize your GS-compatible device with settings that mimic the MT-32's reverb, (lack of) chorus, pitch bend sensitivity, etc. If it is specified in conjunction with True Roland MT-32 (above), ScummVM will select the MT-32-compatible map and drumset on your GS device. This setting works better than default GM or GS emulation with games that do not have custom instrument mappings (Loom and The Secret of Monkey Island). You should only specify both settings if you are using a GS device that has an MT-32 map, e.g. SC-55, SC-88, SC-8820, etc. Please note that Roland GS Mode is automatically disabled in both Day of the Tentacle and Sam & Max Hit the Road, since they use General MIDI natively. If neither of the above settings is enabled, ScummVM will initialize your device in General MIDI mode and use GM emulation in games with MT-32 soundtracks
+
+
+
+,,,,,
+
+
+_`Paths tab`
+--------------
+
+Use the paths tab to tell ScummVM where to look for particular files of
+the game.
+
+,,,,,,,
+
+**Save Path**
+ The folder in which ScummVM will store the game's saved games. If this is not set, the saved games will be stored in the default directory.
+
+
+
+**Extra Path**
+ This is the folder that ScummVM will look in for various extra files. These could include one or more of:
+
+ * Additional datafiles required for certain games (for example, kyra.dat)
+ * Soundfonts (see MIDI tab)
+ * MT-32 ROMs (see MT-32 emulation)
+
+
+
+**Game Path**
+ The folder in which the game’s data files are stored.
+
+
+,,,,,,,
+
+_`Engine tab`
+--------------
+
+Some settings are unique to a particular game or game engine. Conversely, some settings may be greyed out if they are not applicable.
+
+To find out which engine powers your game, have a look at the Supported Games `Wiki page
+<https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_
+
+Engines: ADL_ | AGI_ | BLADERUNNER_ | CGE_ | CINE_ | DRASCULA_ | DREAMWEB_ | HDB_ | HOPKINS_ | KYRA_ | LURE_ | MADS_ | NEVERHOOD_ | SCI_ | SCUMM_ | SHERLOCK_ | SKY_ | SUPERNOVA_ | TOLTECS_ | WINTERMUTE_ | XEEN_ |
+
+,,,,,,,
+
+.. _ADL:
+
+**ADL**
+=================
+
+TV emulation
+ Emulate composite output to an NTSC TV.
+
+Color Graphics
+ Use color graphics instead of monochrome.
+
+Show scanlines
+ Darken every other scanline to mimic the look of CRT.
+
+Always use sharp monochrome text
+ Do not emulate NTSC artifacts for text
+
+,,,,,,,,,
+
+.. _AGI:
+
+**AGI**
+=================
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+Use an alternative palette
+ Use an alternative palette, common for all Amiga games. This was the old behavior
+
+Mouse support
+ Enables mouse support. Allows to use mouse for movement and in game menus.
+
+Use Hercules hires font
+ Uses Hercules hires font, when font file is available.
+
+Pause when entering commands
+ Shows a command prompt window and pauses the game (like in SCI) instead of a real-time prompt.
+
+Add speed menu
+ Add game speed menu (similar to PC version)
+
+,,,,,,
+
+.. _BLADERUNNER:
+
+**BLADERUNNER**
+=================
+
+Sitcom mode
+ Game will add laughter after actor's line or narration
+
+Shorty mode
+ Game will shrink the actors and make their voices high pitched
+
+Frame limiter high performance mode
+ This mode may result in high CPU usage! It avoids use of delayMillis() function.
+
+Max frames per second limit
+ This mode targets a maximum of 120 fps. When disabled, the game targets 60 fps
+
+Disable McCoy's quick stamina drain
+ When running, McCoy won't start slowing down as soon as the player stops clicking the mouse
+
+,,,,,,,,
+
+.. _CGE:
+
+**CGE**
+=================
+
+Color Blind Mode
+ Enable Color Blind Mode by default
+
+,,,,,,
+
+.. _CINE:
+
+**CINE**
+=================
+
+Use original save/load screen
+ Use the original save/load screens instead of the ScummVM one
+
+Use transparent dialog boxes in 16 color scenes
+ Use transparent dialog boxes in 16 color scenes even if the original game version did not support them
+
+,,,,,,,,,
+
+.. _DRASCULA:
+
+**DRASCULA**
+=================
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+,,,,,,,,,,
+
+.. _DREAMWEB:
+
+**DREAMWEB**
+=================
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+Use bright palette mode
+ Display graphics using the game's bright palette
+
+,,,,,,,,,,
+
+.. _HDB:
+
+**HDB**
+=================
+
+Enable cheat mode
+ Debug info and level selection becomes available
+
+,,,,,,,,,,
+
+.. _HOPKINS:
+
+**HOPKINS**
+=================
+
+Gore Mode
+ Enable Gore Mode when available
+
+,,,,,,,,,,
+
+.. _KYRA:
+
+**KYRA**
+=================
+
+Enable studio audience
+ Studio audience adds an applause and cheering sounds whenever Malcolm makes a joke
+
+Skip support
+ This option allows the user to skip text and cutscenes.
+
+Enable helium mode
+ Helium mode makes people sound like they've inhaled Helium.
+
+Enable smooth scrolling when walking
+ When enabled, this option makes scrolling smoother when changing from one screen to another.
+
+Enable floating cursors
+ When enabled, this option changes the cursor when it floats to the edge of the screen to a directional arrow. The player can then click to walk towards that direction.
+
+Suggest save names
+ When enabled, this option will fill in an autogenerated savegame escription into the input prompt.
+
+HP bar graphs
+ Enable hit point bar graphs
+
+Fight Button L/R Swap
+ Left button to attack, right button to pick up items
+
+,,,,,,,,,,
+
+.. _LURE:
+
+**LURE**
+=================
+
+TTS Narrator
+ Use TTS to read the descriptions (if TTS is available)
+
+,,,,,,,,,,
+
+.. _MADS:
+
+**MADS**
+=================
+
+Easy mouse interface
+ Shows object names when hovering the mouse over them
+
+Animated inventory items
+ Animated inventory items
+
+Animated game interface
+ Animated game interface
+
+Naughty game mode
+ Naughty game mode
+
+Graphics dithering
+ Graphics dithering
+
+,,,,,,,,,,
+
+.. _NEVERHOOD:
+
+**NEVERHOOD**
+=================
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+Skip the Hall of Records storyboard scenes
+ Allows the player to skip past the Hall of Records storyboard scenes
+
+Scale the making of videos to full screen
+ Scale the making of videos, so that they use the whole screen
+
+,,,,,,,,,,
+
+.. _SCI:
+
+**SCI**
+=================
+
+Skip EGA dithering pass (full color backgrounds)
+ Skip dithering pass in EGA games, graphics are shown with full colors
+
+Enable high resolution graphics
+ Enable high resolution graphics/content
+
+Enable black-lined video
+ Draw black lines over videos to increase their apparent sharpness
+
+Use high-quality video scaling
+ Use linear interpolation when upscaling videos, where possible
+
+Use high-quality "LarryScale" cel scaling
+ Use special cartoon scaler for drawing character sprites
+
+Prefer digital sound effects
+ Prefer digital sound effects instead of synthesized ones
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+Use IMF/Yamaha FB-01 for MIDI output
+ Use an IBM Music Feature card or a Yamaha FB-01 FM synth module for MIDI output
+
+Use CD audio
+ Use CD audio instead of in-game audio, if available
+
+Use Windows cursors
+ Use the Windows cursors (smaller and monochrome) instead of the DOS ones
+
+Use silver cursors
+ Use the alternate set of silver cursors instead of the normal golden ones
+
+Upscale videos
+ Upscale videos to double their size
+
+,,,,,,,,,,
+
+.. _SCUMM:
+
+**SCUMM**
+=================
+
+Show Object Line
+ Show the names of objects at the bottom of the screen
+
+Use NES Classic Palette
+ Use a more neutral color palette that closely emulates the NES Classic
+
+,,,,,,,,,,
+
+.. _SHERLOCK:
+
+**SHERLOCK**
+=================
+
+Enable content censoring
+ Enable the game's built-in optional content censoring
+
+Upscale videos
+ Upscale videos to double their size
+
+Pixellated scene transitions
+ When changing scenes, a randomized pixel transition is done
+
+Don't show hotspots when moving mouse
+ Only show hotspot names after you actually click on a hotspot or action button
+
+Show character portraits
+ Show portraits for the characters when conversing
+
+Slide dialogs into view
+ Slide UI dialogs into view, rather than simply showing them immediately
+
+Transparent windows
+ Show windows with a partially transparent background
+
+TTS Narrator
+ Use TTS to read the descriptions (if TTS is available)
+
+,,,,,,,,,,
+
+.. _SKY:
+
+**SKY**
+=================
+
+Floppy intro
+ Use the floppy version's intro (CD version only)
+
+,,,,,,,,,,
+
+.. _SUPERNOVA:
+
+**SUPERNOVA**
+=================
+
+Improved mode
+ Improved mode
+
+,,,,,,,,,,
+
+.. _TOLTECS:
+
+**TOLTECS**
+=================
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+,,,,,,,,,,
+
+.. _WINTERMUTE:
+
+**WINTERMUTE**
+=================
+
+Show FPS-counter
+ Show the current number of frames per second in the upper left corner
+
+Sprite bilinear filtering (SLOW)
+ Apply bilinear filtering to individual sprites
+
+,,,,,,,,,,
+
+.. _XEEN:
+
+**XEEN**
+=================
+
+Show item costs in standard inventory mode
+ Shows item costs in standard inventory mode, allowing the value of items to be compared
+
+More durable armor
+ Armor won't break until character is at -80HP, rather than merely -10HP
+
+,,,,,,,,,,
diff --git a/doc/docportal/using_scummvm/global_settings.rst b/doc/docportal/using_scummvm/global_settings.rst
new file mode 100644
index 0000000000..b5979a357d
--- /dev/null
+++ b/doc/docportal/using_scummvm/global_settings.rst
@@ -0,0 +1,150 @@
+===============
+Global settings
+===============
+
+Games will follow the global game settings unless `game-specific
+settings <using/game_settings>`__ are applied.
+
+To open the global settings window, click **Options** in the main
+Launcher window.
+
+There are many settings, and they are separated into tabs:
+
+Graphics tab
+---------------
+
+Use the graphics tab to change how games look when they are played.
+
+,,,,,,,
+
+Graphics mode
+ Changes the graphics filter that ScummVM uses, for example, to scale the game to a higher resolution. The option has no effect on games with an original resolution higher than 320x200 or 320x240. Such games should be configured separately.
+
+Render mode
+ Changes the render mode that ScummVM uses.
+
+Aspect ratio correction
+ Most games supported by ScummVM were designed to be played at a screen resolution of 320x200 using rectangular pixels (higher than they were wide). Most modern systems use square pixels, which means that the image appears to be squeezed vertically and the characters look wider and shorter than they should. If this option is checked, ScummVM corrects for this by stretching the game window to a resolution of 320x240, which looks the same as 320x200 on old monitors. As with Graphic filters, this takes a little processing power to achieve. Aspect ratio correction can be combined with a Graphic filter.
+
+Fullscreen mode
+ Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt+Enter` while in a game.
+
+
+,,,,,,,,,,,,,,,,,,
+
+Audio tab
+-------------------
+
+Use the audio tab to change the sound output for games. For more
+information about any of the audio settings, see the `Music and
+sound <page>`__ page.
+
+,,,,,,,,,,,,,,,,
+
+Music driver
+ The method that ScummVM uses to output MIDI music.
+AdLib Emulator
+ The emulator used by ScummVM to generate the music when the AdLib music driver is selected. Two emulators are currently available: MAME OPL emulator was the emulator that was used up to version 0.13.1, and the DOSBox OPL emulator has been added, but is still experimental.
+Output rate
+ The sample rate at which ScummVM plays sounds, including music if using an emulation music driver such as the AdLib music driver)
+
+Text and Speech
+ For games with digitized speech, this setting allows the user to decide whether to play the game with speech and without any subtitles, or with subtitles displaying the words spoken in the digitized speech but not the speech, or with both.
+Subtitle speed
+ Adjusts the length of time that the subtitles are displayed on screen. The lower the speed is set, the longer the subtitles are displayed.
+
+,,,,,,,,,,,,,,,
+
+Volume tab
+-----------
+
+Use the volume tab to set the relative volumes for various sounds.
+
+,,,,,,,,,,,,,
+
+Music volume
+ Adjusts the volume of the music played back in games. This is usually MIDI music played back with one of the music drivers, but some games use digitized music.
+
+SFX volume
+ Adjusts the volume of the sound effects within the games.
+
+Speech volume
+ Adjusts the volume of the digitized speech in the game, if it has any.
+
+Mute All
+ Mutes all sounds.
+
+,,,,,,,,,,,,,,,,,,
+
+
+MIDI tab
+----------------
+
+Use the MIDI tab to change settings about the MIDI music.
+
+,,,,,,,,,,,,,
+
+Soundfont
+ Some music drivers require you to provide them with a Soundfont, which contains samples of instruments for the device to play back. This setting allows you to choose one.|
+Mixed AdLib/MIDI mode
+ Some games contain sound effects that are exclusive to the AdLib soundtrack. For these games, you may wish to use this mode in order to combine MIDI music with AdLib sound effects.
+True Roland MT-32 (disable GM emulation)
+ ScummVM will treat your device as a real MT-32. Because the instrument mappings and system exclusive commands of the MT-32 vary from those of general MIDI devices, you should only enable this option if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500, or GS device with an MT-32 map.
+
+Enable Roland GS Mode
+ ScummVM will initialize your GS-compatible device with settings that mimic the MT-32's reverb, (lack of) chorus, pitch bend sensitivity, etc. If it is specified in conjunction with True Roland MT-32 (above), ScummVM will select the MT-32-compatible map and drumset on your GS device. This setting works better than default GM or GS emulation with games that do not have custom instrument mappings (Loom and The Secret of Monkey Island). You should only specify both settings if you are using a GS device that has an MT-32 map, e.g. SC-55, SC-88, SC-8820, etc. Please note that Roland GS Mode is automatically disabled in both Day of the Tentacle and Sam & Max Hit the Road, since they use General MIDI natively.If neither of the above settings is enabled, ScummVM will initialize your device in General MIDI mode and use GM emulation in games with MT-32 soundtracks.
+
+MIDI gain
+ Adjusts the relative volume of the general MIDI music. This is only supported by some of the music drivers.|
+
+,,,,,,,,,,,,,,,
+
+Paths tab
+-----------
+
+Use the paths tab to tell ScummVM where to look for particular files.
+
+,,,,,,,,,,,,,,,,,
+
+Save Path
+ The default folder in which ScummVM will store saved games. If this is not set, saved games will generally be stored in the current directory. Exceptions to this include:
+
+ * Windows Vista and up ``\Users\username\AppData\Roaming\ScummVM\Saved games\``
+
+ * Windows 2000 and XP ``\Documents and Settings\username\ApplicationData\ScummVM\Saved games\``
+
+ * Mac OS X ``$HOME/Documents/ScummVM Savegames/``
+
+ * Other UNIX variants ``$HOME/.scummvm/``
+
+ * iPhone ``/private/var/mobile/Library/ScummVM/Savegames``
+
+Extra Path
+ This is the folder that ScummVM will look in for various extra files. These could include one or more of:
+
+ * Additional datafiles required for certain games (e.g. kyra.dat)
+ * Soundfonts (see MIDI tab)
+ * MT-32 ROMs (see MT-32 emulation)
+
+Theme Path
+ The folder that additional themes for the ScummVM Launcher are stored in.
+
+,,,,,,,,,,,,,,
+
+Misc tab
+----------------------
+
+The Misc tab contains options that don’t belong on any of the other tabs.
+
+,,,,,,,,,,,,,,,
+
+Theme
+ Changes the visual appearance of the ScummVM Launcher
+
+GUI Renderer
+ Defines how the ScummVM GUI is rendered; normal or antialiased.
+
+Autosave
+ In some games (namely Beneath a Steel Sky, Flight of the Amazon Queen, and all SCUMM games), Adjusts the time period that ScummVM waits between autosaves. The default setting is 5 minutes. Note that this is only available in some games (Beneath a Steel Sky, Flight of the Amazon Queen, and all SCUMM games)
+
+,,,,,,,,,,,,,
diff --git a/doc/docportal/using_scummvm/keyboard_shortcuts.rst b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
new file mode 100755
index 0000000000..5f3c5d7fef
--- /dev/null
+++ b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
@@ -0,0 +1,259 @@
+===================
+Keyboard Shortcuts
+===================
+
+ScummVM supports various in-game keyboard shortcuts.
+
+.. note::
+
+ Using Ctrl+f or Ctrl+g is not recommended. Games can crash when being run faster than their normal speed, as scripts will lose synchronisation.
+
+
+
+Common::
+
+ Ctrl+F5 - Displays the Global Menu
+ Cmd+q - Quit (Mac OS X)
+ Ctrl+q - Quit (other unices including Linux)
+ Alt+F4 - Quit (Windows)
+ Ctrl+z - Quit (other platforms)
+ Ctrl+u - Mute all sounds
+ 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
+ Ctrl+Alt f - Enable/disable graphics filtering
+ Ctrl+Alt s - Cycle through scaling modes
+ Alt+Enter - Toggles full screen/windowed
+ Alt+s - Make a screenshot (SDL backend only)
+ Ctrl+F7 - Open virtual keyboard (if enabled)
+ This can also be triggered by a long press
+ of the middle mouse button or wheel.
+
+SCUMM games::
+ Alt+x - Quit
+ Ctrl 0-9 and Alt 0-9 - Load and save game state
+ Ctrl+d - Starts the debugger
+ Ctrl+f - Toggle fast mode
+ Ctrl+g - Runs in really REALLY fast mode
+ Ctrl+t - Switch between 'Speech only',
+ 'Speech and Subtitles' and 'Subtitles only'
+ Tilde (~) - Show/hide the debugging console
+ [ and ] - Music volume, down/up
+ - and + - Text speed, slower/faster
+ F5 - Displays a save/load box
+ Alt+F5 - Displays the original save/load box, if the
+ game has one. You can save and load games using
+ this, however it is not intended for this purpose,
+ and may even crash ScummVM in some games.
+ Space - Pauses
+ Period (.) - Skips current line of text in some games
+ Enter - Simulate left mouse button press
+ Tab - Simulate right mouse button press
+
+Beneath a Steel Sky::
+
+ Ctrl+d - Starts the debugger
+ Ctrl+f - Toggle fast mode
+ 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
+
+Blade Runner::
+
+ Ctrl+d - Starts the debugger
+ Space - Toggle combat mode
+ Enter or Escape - Skips a video or a line of dialogue
+ Escape - Show game menu
+ Tab - Activate last database
+ F1 - Online help
+ F2 - Save game menu
+ F3 - Load game menu
+ F4 - Crime scene database
+ F5 - Suspect database
+ F6 - Clue database
+ F10 - Quit game
+
+Broken Sword::
+
+ F5 or Escape - Displays save/load box
+
+Broken Sword II::
+
+ Ctrl+d - Starts the debugger
+ Ctrl+f - Toggle fast mode
+ p - Pauses
+
+Dragon History::
+ F5 - Displays the Global Menu
+ left click - Walk, explore
+ right click - Use, talk
+ move mouse up, i - Inventory
+ move mouse down, m - Map
+ Escape - Skip the intro, exit map/inventory
+ any click - Skip the currently dubbed sentence
+ q - Quick walking on/off
+
+Flight of the Amazon Queen::
+
+ Ctrl+d - Starts the debugger
+ Ctrl+f - Toggle fast mode
+ F1 - Use Journal (saving/loading)
+ F11 - Quicksave
+ F12 - Quickload
+ Escape - Skips cutscenes
+ Space - Skips current line of text
+
+Future Wars::
+ F1 - Examine
+ F2 - Take
+ F3 - Inventory
+ F4 - Use
+ F5 - Activate
+ F6 - Speak
+ F9 - "Activate" menu
+ F10 - "Use" menu
+ Escape - Bring on command menu
+
+Indiana Jones and the Fate of Atlantis::
+
+ i - Displays IQ points
+
+Indiana Jones and the Last Crusade::
+
+ i - Displays IQ points
+
+Nippon Safes::
+
+ Ctrl+d - Starts the debugger
+ l - Load game
+ s - Save game
+
+Simon the Sorcerer 1 and 2::
+ Ctrl 0-9 and Alt 0-9 - Load and save game state
+ Ctrl+d - Starts the debugger
+ Ctrl+f - Toggle fast mode
+ F1 - F3 - Text speed, faster - slower
+ F10 - Shows all characters and objects you can
+ interact with
+ Escape - Skip cutscenes
+ - and + - Music volume, down/up
+ m - Music on/off
+ s - Sound effects on/off
+ b - Background sounds on/off
+ [Simon the Sorcerer 2 only]
+ Pause - Pauses
+ t - Switch between speech only and
+ combined speech and subtitles
+ [Simon the Sorcerer 1 CD (other than
+ English and German) and Simon the
+ Sorcerer 2 CD (all languages)]
+ v - Switch between subtitles only and
+ combined speech and subtitles
+ [Simon the Sorcerer 2 CD only]
+
+Simon the Sorcerer's Puzzle Pack::
+
+ Ctrl+d - Starts the debugger
+ Ctrl+f - Toggle fast mode
+ F12 - High speed mode on/off in Swampy Adventures
+ - and + - Music volume, down/up
+ m - Music on/off
+ s - Sound effects on/off
+ Pause - Pauses
+
+Starship Titanic::
+
+ Ctrl+c - Open up the developer's cheat room
+ Ctrl+d - Open up the ScummVM Debugger
+ Left click - Move action
+ Shift-Left click - Edit room glyph chevrons and
+ quick movement transitions
+ Right click - Edit room glyph chevrons
+ and quick transitions
+ Mouse wheel - Scroll through items (inventory, etc)
+ and conversation log
+ Arrow keys - Movement. Down arrow/back is only available if the
+ given view explicitly has a backwards movement
+ available.
+ F1 - Switch to Chat-O-Mat
+ F2 - Switch to Personal Baggage
+ F3 - Switch to Remote Thingummy
+ F4 - Switch to Designer Room Numbers (chevron list)
+ F5 - GMM save menu
+ F6 - Switch to Real Life
+ F7 - GMM restore menu
+
+Starship Titanic (Starfield Puzzle)::
+
+ Tab - Toggle between starmap and skyscape
+ Mouse click: - skyscape star selection and
+ starmap star fast travel
+ Mouse movement - starmap orientation
+ SPACE - starmap stop movement
+ z - starmap turn left
+ x - starmap turn right
+ Single quote (') - starmap turn up
+ Forward slash (/) - starmap turn down
+ Semicolon (;) - starmap move forward
+ Period (.) - starmap move backward
+ l - starmap lock coordinate
+ d - starmap unlock coordinate
+
+The Feeble Files::
+
+ Ctrl+d - Starts the debugger
+ Ctrl+f - Toggle fast mode
+ F7 - Switch characters
+ F9 - Hitbox names on/off
+ s - Sound effects on/off
+ Pause - Pauses
+ t - Switch between speech only and
+ combined speech and subtitles
+ v - Switch between subtitles only and
+ combined speech and subtitles
+
+The Legend of Kyrandia::
+
+ Ctrl 0-9 and Alt 0-9 - Load and save game state
+ Ctrl-d - Starts the debugger
+
+TeenAgent::
+ F5 - Displays the Global Menu
+
+Touche: The Adventures of the Fifth Musketeer::
+
+ Ctrl+f - Toggle fast mode
+ F5 - Displays options
+ F9 - Turn fast walk mode on
+ F10 - Turn fast walk mode off
+ Escape - Quit
+ Space - Skips current line of text
+ t - Switch between 'Voice only',
+ 'Voice and Text' and 'Text only'
+
+Zork: Grand Inquisitor::
+ Ctrl+s - Save
+ Ctrl+r - Restore
+ Ctrl+q - Quit
+ Ctrl+p - Preferences
+ F1 - Help
+ F5 - Inventory
+ F6 - Spellbook
+ F7 - Score
+ F8 - Put away current object/forget spell
+ F9 - Extract coin (must have the coin bag)
+ Space - Skips movies
+
+Zork Nemesis: The Forbidden Lands::
+ Ctrl+s - Save
+ Ctrl+r - Restore
+ Ctrl+q - Quit
+ Ctrl+p - Preferences
+ Space - Skips movies
diff --git a/doc/docportal/using_scummvm/the_launcher.rst b/doc/docportal/using_scummvm/the_launcher.rst
new file mode 100755
index 0000000000..994a4f0dcd
--- /dev/null
+++ b/doc/docportal/using_scummvm/the_launcher.rst
@@ -0,0 +1,110 @@
+==============
+The Launcher
+==============
+.. image:: ../images/Launcher/InterfaceMainWindow.png
+ :class: with-shadow
+
+The main ScummVM window is called the Launcher. The Launcher opens whenever you start ScummVM without launching a game directly.
+
+The games list
+===============
+
+The pane on the left lists the games you have added to ScummVM. This list usually offers some additional information about each game, such as original platform and language. To highlight any game on the list, type the first letter(s) of its title, or click on it.
+
+Quick search
+=============
+.. image:: ../images/Launcher/Quicksearch.png
+ :class: with-shadow
+
+
+Quick search allows you to filter the list of added games.
+The quick search input is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, press the **C** button next to the input box.
+
+There are many ways to filter games. For instance, you can type "Monkey Island" to quickly locate all "Monkey Island" games on the list, or you can type "German" if you wish to play a game in German.
+
+The buttons
+============
+To the right of the games list there are a number of buttons. Their functions are as follows:
+
+Start
+-----
+Launches the highlighted game.
+
+Load
+----
+.. image:: ../images/Launcher/Loadlist.png
+ :class: with-shadow
+
+
+Opens the Load window, from which you can run a previously saved state without having to start the game first.
+
+The pane on the left displays a list of your saved states. Click on a saved state to highlight it. On the right, information about the highlighted state such as timestamps, screenshots and playtime is displayed. When you have located the desired saved game:
+
+- Click **Load** to launch the game using that state.
+- Click **Delete** to delete the saved state.
+
+.. caution::
+ There are games that do not support this feature at all, or whose saved states lack information such as playtime or screenshots.
+
+Add Game
+---------
+.. image:: ../images/RaspberryPi/adding_games_rpi.jpg
+ :class: with-shadow
+
+
+Opens a file browser. Use this file browser to locate the folder containing the game you wish to add. Double click on a folder to open it, and use **Go up** to go back up one level.
+
+Once you have selected the folder that contains the game data files, click **Choose**.
+
+To add more than one game at a time, hold :kbd:`Shift` while clicking **Add Game**
+
+Edit Game
+----------
+.. image:: ../images/Launcher/Configdone.png
+ :class: with-shadow
+
+Opens the game settings window. This window also opens whenever a game is added from the Launcher.
+
+Use this window to configure a game individually by overriding the default global game settings you have set via the **Options** window. You can also change the game's language and original platform, if applicable. For more information, see the :doc:`game_settings` page.
+
+Remove Game
+-----------
+
+Removes the highlighted game from the list.
+
+
+Options
+-------
+.. image:: ../images/Launcher/Graphicstab.png
+ :class: with-shadow..
+
+Opens the global settings window. Use this window to define global game settings, as well as change a number of the ScummVM Launcher settings. For more details on how to fine-tune ScummVM, see the :doc:`global_settings` page.
+
+
+About
+-----
+Shows credits and miscellaneous information about your version of ScummVM.
+
+Quit
+-------
+Closes the Launcher and quits the ScummVM application.
+
+The Global Main Menu
+=====================
+.. image:: ../images/Launcher/Generalmenu.png
+ :class: with-shadow
+
+
+The Global Menu (or GMM for Global Main Menu) is available while playing any game by pressing :kbd:`Crtl` + :kbd:`F5`, and provides the following features:
+
+- **Resume:** Closes the GMM and resume the game.
+- **Load:** Loads a game state. This is not available for all games.
+- **Save:** Saves a game state. This is not available for all games.
+- **Options:** Changes some options to play the game, such as music volume or subtitle speed.
+- **About:** Displays the ScummVM About box. This is also available from the The Launcher.
+- **Help:** Displays a list of key commands. This not available in all engines.
+- **Return to Launcher:** Quits the game and returns to The Launcher. This is not available in all engines.
+- **Quit:** Quits the game and ScummVM, and returns to the Operating System.
+
+.. caution::
+ In some games you can still access the original game menu by using :kbd:`Alt`+:kbd:`F5`. You can save and load games using this, however it is not intended for this purpose, and may even crash ScummVM in some games.
Commit: dce530326303be68aa4cfb6009387bf4bd0aacef
https://github.com/scummvm/scummvm/commit/dce530326303be68aa4cfb6009387bf4bd0aacef
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds first draft to iOS quickstart page
Changed paths:
A doc/docportal/images/ios/ios_transfer_files.gif
A doc/docportal/images/ios/ios_xcode_build.gif
doc/docportal/getting_started/ios.rst
diff --git a/doc/docportal/getting_started/ios.rst b/doc/docportal/getting_started/ios.rst
index 505ddb41fe..65ce7290b9 100644
--- a/doc/docportal/getting_started/ios.rst
+++ b/doc/docportal/getting_started/ios.rst
@@ -3,3 +3,165 @@
iOS
==============
+There are two methods to install ScummVM onto your iOS device, and the method you use depends on whether or not your device is jailbroken.
+
+No Jailbreak
+==============
+
+This method is a little complex, however it is currently the only way to install ScummVM to an iOS device that is not jailbroken. While a rudimentary knowledge of the command line would be useful, the following instructions, if followed carefully, can be completed by anyone.
+
+Prerequisites
+****************
+
+- A computer running MacOSX with Xcode installed. Xcode is a free App, available from the Mac App Store.
+- An Apple Developer account. You can sign up for a free account on the `Apple Developer Member Center <https://developer.apple.com/membercenter/>`_ with your Apple ID.
+- The ScummVM `iOS Libraries <https://www.scummvm.org/frs/build/scummvm-ios7-libs-v2.zip>`_ downloaded.
+
+.. note::
+
+ If you have a free Apple developer account, each build will only be valid for 7 days, which means you will need to repeat these steps and re-install ScummVM every week.
+
+Creating the Xcode project
+***************************
+
+The first step is to download the repository containing the code we'll need to build the app with. The easiest way to do this is from the command line. Go to **Applications > Utilities > Terminal** and enter the following:
+
+.. code-block:: bash
+
+ git clone https://github.com/scummvm/scummvm.git
+
+.. note::
+ The default branch of the ScummVM repository will be the master branch. To build a specific version, checkout the appropriate branch. For example, to build version 2.1.1, use the following command:
+
+ .. code-block::
+
+ git checkout branch-2-1-1
+
+If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time will also install the command line tools we require for the next steps.
+
+The next step changes our present working directory and then generates the tools we need to create the Xcode project.
+
+.. code-block:: bash
+
+ cd scummvm/devtools/create_project/xcode
+ xcodebuild
+
+Now we move back a few directories, to create a new build directory at the same level as the repository.
+
+.. code-block:: bash
+
+ cd ../../../..
+ mkdir build
+ cd build
+
+Your present working directory will now be the new ``build`` directory. Unzip the downloaded iOS libraries package into the build folder by using the following command:
+
+.. code-block:: bash
+
+ unzip ~/Downloads/scummvm-ios7-libs-v2.zip
+
+
+Generating the Xcode project
+*****************************
+
+It's time to generate the Xcode project. Ensure your present working directory is still the ``build`` directory, and then run the following on the command line:
+
+.. code::
+
+ ../scummvm/devtools/create_project/xcode/build/Release/create_project ../scummvm --xcode --enable-fluidsynth --disable-nasm --disable-opengl --disable-theora --disable-taskbar --disable-tts --disable-fribidi
+
+The resulting directory structure will look like this:
+
+.. code-block:: bash
+
+ Home
+ |--scummvm
+ '--build
+ |-- include
+ |-- lib
+ |-- engines
+ '-- scummvm.xcodeproj
+
+.. tip::
+
+ To view the Home directory in the Finder, click on **Go** in the top menu bar, and then click **Home**, or alternatively use the keyboard shortcut :kbd:`shift` + :kbd:`command` + :kbd:`H`.
+
+Open the ``scummvm.xcodeproj`` file from the Finder, or via the command line:
+
+.. code-block:: bash
+
+ open scummvm.xcodeproj
+
+Building ScummVM
+*****************
+
+Once Xcode is open, connect the device you are installing ScummVM onto. At the top of the window, select **ScummVM-iOS** and then the device you connected. You will need to trust the device before it will show up on the list of connected devices.
+
+The last step before building the app is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** you should see a field labeled **Bundle Identifier**. Here you will need to input a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
+
+Next to **General**, click on **Signing & Capabilities**. Under **Signing**, tick the **Automatically manage signing** box, and select your developer account from the **Team** dropdown menu. If you have not added your developer account to Xcode, do this now by clicking **Add an Account...** in the dropdown menu.
+
+In the upper left-hand corner, press the play button to start building ScummVM. When the build has finished, it will launch on your connected device.
+
+.. image:: ../images/ios/ios_xcode_build.gif
+ :class: with-shadow
+
+
+Transferring game files to your device
+*****************************************
+
+The easiest way to transfer files to your device is by using the Finder. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag and drop the folder containing the game files into the **ScummVM** folder.
+
+.. image:: ../images/ios/ios_transfer_files.gif
+ :class: with-shadow
+
+Alternatively, upload game folders to your iCloud Drive, or to any other cloud sharing service. On your iOS device, use the Files app to copy these folders into the ScummVM folder located on the device.
+
+For more information on which files ScummVM requires, and how to add and play games, see `adding and playing games <adding_games>`_.
+
+
+Jailbreak
+==========
+
+How to jailbreak an iOS device is outside the scope of this documentation. However, should you have a device that is jailbroken, iOS .deb and .ipa packages are available for install from the `ScummVM downloads page <https://www.scummvm.org/downloads>`_.
+
+Prerequisites
+***************
+
+- A jailbroken iOS device
+- A file manager app such as Filza on your iOS device
+- The openSSH app on your iOS device
+- An SFTP client such as Cyberduck, installed on your computer
+
+Installing ScummVM
+*******************
+
+Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended .deb package. Your device will ask how to open the file. Choose Filza.
+
+Ensure the .deb package is saved somewhere in the ``/var/mobile`` directory. It should default to ``/var/mobile/Documents``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
+
+The .ipa package can be installed in the same way.
+
+You will need to restart your device for the install to complete.
+
+Transferring game files to your device
+**************************************
+
+Open Cyberduck on your computer. Click on **Open Connection** at the top left corner of the window. Select **SFTP (SSH File Transfer Protocol)** from the dropdown menu. Next to **Server:**, type in the IP address of your iOS device. You can find this information on your iOS device by going to **Settings > Wi-Fi** and then tapping on the **i** symbol next to your Wi-Fi network name. The IP address is listed next to **IP Address**.
+
+Enter ``root`` as the Username, and unless you have changed it, ``Alpine`` as the Password. Click **Connect**. Once you are connected, you will be able to see all the files and directories on your connected device.
+
+ScummVM on the iOS device can access the directory containing its Savegames, which in this case should be ``/var/mobile/Documents``. Drag and drop folders containing game files into this directory.
+
+For more information on which files ScummVM requires, and how to add and play games, see :doc:`adding_games`.
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/docportal/images/ios/ios_transfer_files.gif b/doc/docportal/images/ios/ios_transfer_files.gif
new file mode 100644
index 0000000000..acc3fa86a2
Binary files /dev/null and b/doc/docportal/images/ios/ios_transfer_files.gif differ
diff --git a/doc/docportal/images/ios/ios_xcode_build.gif b/doc/docportal/images/ios/ios_xcode_build.gif
new file mode 100644
index 0000000000..d8776dc169
Binary files /dev/null and b/doc/docportal/images/ios/ios_xcode_build.gif differ
Commit: 57156ac604bd1f5f8efe40bf5b2e86f62ebd226d
https://github.com/scummvm/scummvm/commit/57156ac604bd1f5f8efe40bf5b2e86f62ebd226d
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: First draft for Android page
Changed paths:
doc/docportal/getting_started/android.rst
diff --git a/doc/docportal/getting_started/android.rst b/doc/docportal/getting_started/android.rst
index 84d5d9e206..8b9082bee3 100644
--- a/doc/docportal/getting_started/android.rst
+++ b/doc/docportal/getting_started/android.rst
@@ -3,3 +3,54 @@
Android
===============
+Downloading and installing ScummVM
+====================================
+
+There are multiple ways to install ScummVM on your Android device depending on what version of Android you have.
+
+
+Google Play Store
+*********************
+For Android 7 (Nougat) or earlier, the easiest way to install ScummVM is by downloading it from the Google Play Store. You will be guided through the installation.
+
+.. caution::
+
+ Currently the Google Play version of ScummVM will not work on Android versions 8.0 and later. If your version of Android is not compatible with the app on the Google Play store, follow the instructions for installing ScummVM using the APK package.
+
+APK package install
+**********************
+
+On your device, use a web browser app to navigate to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_. The recommended download section on the page should suggest the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
+
+.. tip::
+
+ To find the correct package for your device, you will need to know whether you are running a 32 or 64-bit operating system, and which chipset your device has. A quick internet search using your device model number should allow you to find these details.
+
+Click on the correct package to start the download. Once it has downloaded, go to the file and tap on it to start the install process. Do this by using either a file manager app and navigating to the Downloads folder, or by selecting the file directly from the web browser downloads. The file manager or the web browser will ask for permission to install the package, and once permission has been granted, will return you to the install.
+
+.. note::
+
+ The downloaded APK package is treated as an app from an unknown source, since it doesn't originate in the Google Play store. If you are having any problems with the install, you will need to allow unknown apps.
+ - For Android 7 or earlier, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
+ - For Android 8 or later, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
+
+Transferring game files to your device
+*****************************************
+
+You will need to transfer all the required game data files to your device, into a folder accessible by the ScummVM app.
+
+There are a few options:
+ - Copying the files directly onto the microSD card, if your device has one.
+ - USB transfer from a computer. To complete file transfer via USB cable, tap the **Charging this device via USB notification** when the device is connected. Select **Use USB for** and then **File Transfer**. An Android File Transfer window will open.
+ - Uploading the files to a cloud service such as Dropbox, and then downloading them to your device.
+ - Downloading games such as freeware games or those from digital distributors such `GOG.com <gog.com>`_ or `Steam <steam.steampowered.com>`_ directly to the device.
+
+For more information on which files ScummVM requires, and how to add and play games, see `adding and playing games <adding_games>`_.
+
+
+
+
+
+
+
+
Commit: 3074636e03029a599f5b45385cec44fec9c01c4b
https://github.com/scummvm/scummvm/commit/3074636e03029a599f5b45385cec44fec9c01c4b
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds info about cloud functionality
Changed paths:
doc/docportal/getting_started/ios.rst
diff --git a/doc/docportal/getting_started/ios.rst b/doc/docportal/getting_started/ios.rst
index 65ce7290b9..8c9e1b9795 100644
--- a/doc/docportal/getting_started/ios.rst
+++ b/doc/docportal/getting_started/ios.rst
@@ -107,17 +107,6 @@ In the upper left-hand corner, press the play button to start building ScummVM.
:class: with-shadow
-Transferring game files to your device
-*****************************************
-
-The easiest way to transfer files to your device is by using the Finder. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag and drop the folder containing the game files into the **ScummVM** folder.
-
-.. image:: ../images/ios/ios_transfer_files.gif
- :class: with-shadow
-
-Alternatively, upload game folders to your iCloud Drive, or to any other cloud sharing service. On your iOS device, use the Files app to copy these folders into the ScummVM folder located on the device.
-
-For more information on which files ScummVM requires, and how to add and play games, see `adding and playing games <adding_games>`_.
Jailbreak
@@ -130,8 +119,7 @@ Prerequisites
- A jailbroken iOS device
- A file manager app such as Filza on your iOS device
-- The openSSH app on your iOS device
-- An SFTP client such as Cyberduck, installed on your computer
+
Installing ScummVM
*******************
@@ -145,15 +133,22 @@ The .ipa package can be installed in the same way.
You will need to restart your device for the install to complete.
Transferring game files to your device
-**************************************
+=======================================
+There are multiple ways to transfer game files to your iOS device.
+
+ScummVM has built-in Cloud functionality, which allows you to connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`cloud_and_lan` page.
-Open Cyberduck on your computer. Click on **Open Connection** at the top left corner of the window. Select **SFTP (SSH File Transfer Protocol)** from the dropdown menu. Next to **Server:**, type in the IP address of your iOS device. You can find this information on your iOS device by going to **Settings > Wi-Fi** and then tapping on the **i** symbol next to your Wi-Fi network name. The IP address is listed next to **IP Address**.
+.. note:
+ ScummVM's Cloud functionality does not currently support iCloud, however it is possible to upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder.
-Enter ``root`` as the Username, and unless you have changed it, ``Alpine`` as the Password. Click **Connect**. Once you are connected, you will be able to see all the files and directories on your connected device.
+Another way to transfer files to your device is by using the Finder while your device is connected to your Mac. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag and drop the folder containing the game files into the **ScummVM** folder.
+
+.. image:: ../images/ios/ios_transfer_files.gif
+ :class: with-shadow
+
+For more information on which files ScummVM requires, and how to add and play games, see `adding and playing games <adding_games>`_.
-ScummVM on the iOS device can access the directory containing its Savegames, which in this case should be ``/var/mobile/Documents``. Drag and drop folders containing game files into this directory.
-For more information on which files ScummVM requires, and how to add and play games, see :doc:`adding_games`.
Commit: bc48829f1a880686c619857c3384c5cdfdd9f9f2
https://github.com/scummvm/scummvm/commit/bc48829f1a880686c619857c3384c5cdfdd9f9f2
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: updates screenshots
Changed paths:
A doc/docportal/images/Launcher/add_game.jpg
A doc/docportal/images/Launcher/choose_directory.jpg
A doc/docportal/images/Launcher/choose_game_directory.jpg
A doc/docportal/images/Launcher/edit_game.jpg
A doc/docportal/images/Launcher/global_settings.jpg
A doc/docportal/images/Launcher/gmm.jpg
A doc/docportal/images/Launcher/gmm_help.jpg
A doc/docportal/images/Launcher/gmm_options.jpg
A doc/docportal/images/Launcher/options.jpg
A doc/docportal/images/Launcher/quicksearch.jpg
A doc/docportal/images/Launcher/remove_game.jpg
A doc/docportal/images/Launcher/save_game.jpg
A doc/docportal/images/Launcher/save_game_desc.jpg
A doc/docportal/images/Launcher/save_game_list.jpg
A doc/docportal/images/Launcher/save_game_tile.jpg
A doc/docportal/images/Launcher/start_game.jpg
A doc/docportal/images/Launcher/start_game_cli.jpg
A doc/docportal/images/Launcher/the_launcher.jpg
A doc/docportal/images/Launcher/the_launcher.png
R doc/docportal/images/Launcher/Configdone.png
R doc/docportal/images/Launcher/Generalmenu.png
R doc/docportal/images/Launcher/Graphicstab.png
R doc/docportal/images/Launcher/InterfaceMainWindow.png
R doc/docportal/images/Launcher/Loadlist.png
R doc/docportal/images/Launcher/Quicksearch.png
R doc/docportal/images/Launcher/ScummHelpDialog.png
R doc/docportal/images/RaspberryPi/adding_game_rpi.gif
R doc/docportal/images/RaspberryPi/adding_games_rpi.jpg
R doc/docportal/images/RaspberryPi/blank_launcher_rpi.jpg
R doc/docportal/images/RaspberryPi/game_info_rpi.jpg
R doc/docportal/images/RaspberryPi/launch_commandline.gif
R doc/docportal/images/RaspberryPi/launch_game.gif
R doc/docportal/images/RaspberryPi/launch_launcher.gif
R doc/docportal/images/RaspberryPi/launch_scummvm_rpi.jpg
R doc/docportal/images/RaspberryPi/load_game.gif
R doc/docportal/images/RaspberryPi/open_launcher.gif
R doc/docportal/images/RaspberryPi/settings.gif
R doc/docportal/images/RaspberryPi/start_game_rpi.jpg
diff --git a/doc/docportal/images/Launcher/Configdone.png b/doc/docportal/images/Launcher/Configdone.png
deleted file mode 100755
index 926000b9f5..0000000000
Binary files a/doc/docportal/images/Launcher/Configdone.png and /dev/null differ
diff --git a/doc/docportal/images/Launcher/Generalmenu.png b/doc/docportal/images/Launcher/Generalmenu.png
deleted file mode 100755
index 3301eadff5..0000000000
Binary files a/doc/docportal/images/Launcher/Generalmenu.png and /dev/null differ
diff --git a/doc/docportal/images/Launcher/Graphicstab.png b/doc/docportal/images/Launcher/Graphicstab.png
deleted file mode 100755
index 31350a9602..0000000000
Binary files a/doc/docportal/images/Launcher/Graphicstab.png and /dev/null differ
diff --git a/doc/docportal/images/Launcher/InterfaceMainWindow.png b/doc/docportal/images/Launcher/InterfaceMainWindow.png
deleted file mode 100755
index 7cb2e5c638..0000000000
Binary files a/doc/docportal/images/Launcher/InterfaceMainWindow.png and /dev/null differ
diff --git a/doc/docportal/images/Launcher/Loadlist.png b/doc/docportal/images/Launcher/Loadlist.png
deleted file mode 100755
index 1e6d30edc2..0000000000
Binary files a/doc/docportal/images/Launcher/Loadlist.png and /dev/null differ
diff --git a/doc/docportal/images/Launcher/Quicksearch.png b/doc/docportal/images/Launcher/Quicksearch.png
deleted file mode 100755
index 1cd3c62653..0000000000
Binary files a/doc/docportal/images/Launcher/Quicksearch.png and /dev/null differ
diff --git a/doc/docportal/images/Launcher/ScummHelpDialog.png b/doc/docportal/images/Launcher/ScummHelpDialog.png
deleted file mode 100755
index 0fc59b175b..0000000000
Binary files a/doc/docportal/images/Launcher/ScummHelpDialog.png and /dev/null differ
diff --git a/doc/docportal/images/Launcher/add_game.jpg b/doc/docportal/images/Launcher/add_game.jpg
new file mode 100755
index 0000000000..0751390681
Binary files /dev/null and b/doc/docportal/images/Launcher/add_game.jpg differ
diff --git a/doc/docportal/images/Launcher/choose_directory.jpg b/doc/docportal/images/Launcher/choose_directory.jpg
new file mode 100644
index 0000000000..8dcba776d7
Binary files /dev/null and b/doc/docportal/images/Launcher/choose_directory.jpg differ
diff --git a/doc/docportal/images/Launcher/choose_game_directory.jpg b/doc/docportal/images/Launcher/choose_game_directory.jpg
new file mode 100644
index 0000000000..ebf97412cc
Binary files /dev/null and b/doc/docportal/images/Launcher/choose_game_directory.jpg differ
diff --git a/doc/docportal/images/Launcher/edit_game.jpg b/doc/docportal/images/Launcher/edit_game.jpg
new file mode 100644
index 0000000000..4d46f31544
Binary files /dev/null and b/doc/docportal/images/Launcher/edit_game.jpg differ
diff --git a/doc/docportal/images/Launcher/global_settings.jpg b/doc/docportal/images/Launcher/global_settings.jpg
new file mode 100644
index 0000000000..1aeaca0f99
Binary files /dev/null and b/doc/docportal/images/Launcher/global_settings.jpg differ
diff --git a/doc/docportal/images/Launcher/gmm.jpg b/doc/docportal/images/Launcher/gmm.jpg
new file mode 100644
index 0000000000..bcf1991d58
Binary files /dev/null and b/doc/docportal/images/Launcher/gmm.jpg differ
diff --git a/doc/docportal/images/Launcher/gmm_help.jpg b/doc/docportal/images/Launcher/gmm_help.jpg
new file mode 100644
index 0000000000..b88174bf32
Binary files /dev/null and b/doc/docportal/images/Launcher/gmm_help.jpg differ
diff --git a/doc/docportal/images/Launcher/gmm_options.jpg b/doc/docportal/images/Launcher/gmm_options.jpg
new file mode 100644
index 0000000000..e131040dbe
Binary files /dev/null and b/doc/docportal/images/Launcher/gmm_options.jpg differ
diff --git a/doc/docportal/images/Launcher/options.jpg b/doc/docportal/images/Launcher/options.jpg
new file mode 100644
index 0000000000..8d692eb7d6
Binary files /dev/null and b/doc/docportal/images/Launcher/options.jpg differ
diff --git a/doc/docportal/images/Launcher/quicksearch.jpg b/doc/docportal/images/Launcher/quicksearch.jpg
new file mode 100644
index 0000000000..e364f2e57d
Binary files /dev/null and b/doc/docportal/images/Launcher/quicksearch.jpg differ
diff --git a/doc/docportal/images/Launcher/remove_game.jpg b/doc/docportal/images/Launcher/remove_game.jpg
new file mode 100644
index 0000000000..9594504721
Binary files /dev/null and b/doc/docportal/images/Launcher/remove_game.jpg differ
diff --git a/doc/docportal/images/Launcher/save_game.jpg b/doc/docportal/images/Launcher/save_game.jpg
new file mode 100644
index 0000000000..25da469bbd
Binary files /dev/null and b/doc/docportal/images/Launcher/save_game.jpg differ
diff --git a/doc/docportal/images/Launcher/save_game_desc.jpg b/doc/docportal/images/Launcher/save_game_desc.jpg
new file mode 100644
index 0000000000..740ae46d91
Binary files /dev/null and b/doc/docportal/images/Launcher/save_game_desc.jpg differ
diff --git a/doc/docportal/images/Launcher/save_game_list.jpg b/doc/docportal/images/Launcher/save_game_list.jpg
new file mode 100644
index 0000000000..8437ac9f97
Binary files /dev/null and b/doc/docportal/images/Launcher/save_game_list.jpg differ
diff --git a/doc/docportal/images/Launcher/save_game_tile.jpg b/doc/docportal/images/Launcher/save_game_tile.jpg
new file mode 100644
index 0000000000..bacfab59b8
Binary files /dev/null and b/doc/docportal/images/Launcher/save_game_tile.jpg differ
diff --git a/doc/docportal/images/Launcher/start_game.jpg b/doc/docportal/images/Launcher/start_game.jpg
new file mode 100644
index 0000000000..434b6239af
Binary files /dev/null and b/doc/docportal/images/Launcher/start_game.jpg differ
diff --git a/doc/docportal/images/Launcher/start_game_cli.jpg b/doc/docportal/images/Launcher/start_game_cli.jpg
new file mode 100755
index 0000000000..f6cf5a0ae6
Binary files /dev/null and b/doc/docportal/images/Launcher/start_game_cli.jpg differ
diff --git a/doc/docportal/images/Launcher/the_launcher.jpg b/doc/docportal/images/Launcher/the_launcher.jpg
new file mode 100644
index 0000000000..f050761a6d
Binary files /dev/null and b/doc/docportal/images/Launcher/the_launcher.jpg differ
diff --git a/doc/docportal/images/Launcher/the_launcher.png b/doc/docportal/images/Launcher/the_launcher.png
new file mode 100644
index 0000000000..c1ebf35dae
Binary files /dev/null and b/doc/docportal/images/Launcher/the_launcher.png differ
diff --git a/doc/docportal/images/RaspberryPi/adding_game_rpi.gif b/doc/docportal/images/RaspberryPi/adding_game_rpi.gif
deleted file mode 100755
index 58b1ca2cf7..0000000000
Binary files a/doc/docportal/images/RaspberryPi/adding_game_rpi.gif and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/adding_games_rpi.jpg b/doc/docportal/images/RaspberryPi/adding_games_rpi.jpg
deleted file mode 100755
index 78c5fb8d85..0000000000
Binary files a/doc/docportal/images/RaspberryPi/adding_games_rpi.jpg and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/blank_launcher_rpi.jpg b/doc/docportal/images/RaspberryPi/blank_launcher_rpi.jpg
deleted file mode 100755
index 625b63a3a5..0000000000
Binary files a/doc/docportal/images/RaspberryPi/blank_launcher_rpi.jpg and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/game_info_rpi.jpg b/doc/docportal/images/RaspberryPi/game_info_rpi.jpg
deleted file mode 100755
index f0ea728c66..0000000000
Binary files a/doc/docportal/images/RaspberryPi/game_info_rpi.jpg and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/launch_commandline.gif b/doc/docportal/images/RaspberryPi/launch_commandline.gif
deleted file mode 100755
index 76cfc142e4..0000000000
Binary files a/doc/docportal/images/RaspberryPi/launch_commandline.gif and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/launch_game.gif b/doc/docportal/images/RaspberryPi/launch_game.gif
deleted file mode 100755
index 3509ed6c69..0000000000
Binary files a/doc/docportal/images/RaspberryPi/launch_game.gif and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/launch_launcher.gif b/doc/docportal/images/RaspberryPi/launch_launcher.gif
deleted file mode 100755
index e8992fa705..0000000000
Binary files a/doc/docportal/images/RaspberryPi/launch_launcher.gif and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/launch_scummvm_rpi.jpg b/doc/docportal/images/RaspberryPi/launch_scummvm_rpi.jpg
deleted file mode 100755
index f111757da3..0000000000
Binary files a/doc/docportal/images/RaspberryPi/launch_scummvm_rpi.jpg and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/load_game.gif b/doc/docportal/images/RaspberryPi/load_game.gif
deleted file mode 100755
index f352814ce0..0000000000
Binary files a/doc/docportal/images/RaspberryPi/load_game.gif and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/open_launcher.gif b/doc/docportal/images/RaspberryPi/open_launcher.gif
deleted file mode 100755
index c3d0879ba2..0000000000
Binary files a/doc/docportal/images/RaspberryPi/open_launcher.gif and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/settings.gif b/doc/docportal/images/RaspberryPi/settings.gif
deleted file mode 100755
index f4eb876dfa..0000000000
Binary files a/doc/docportal/images/RaspberryPi/settings.gif and /dev/null differ
diff --git a/doc/docportal/images/RaspberryPi/start_game_rpi.jpg b/doc/docportal/images/RaspberryPi/start_game_rpi.jpg
deleted file mode 100755
index a6695b721c..0000000000
Binary files a/doc/docportal/images/RaspberryPi/start_game_rpi.jpg and /dev/null differ
Commit: 9b27296ed3dab38e7a41d37169d7efa8315a082b
https://github.com/scummvm/scummvm/commit/9b27296ed3dab38e7a41d37169d7efa8315a082b
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds cloud info to android page
Changed paths:
doc/docportal/getting_started/android.rst
diff --git a/doc/docportal/getting_started/android.rst b/doc/docportal/getting_started/android.rst
index 8b9082bee3..d4949f82b8 100644
--- a/doc/docportal/getting_started/android.rst
+++ b/doc/docportal/getting_started/android.rst
@@ -39,11 +39,13 @@ Transferring game files to your device
You will need to transfer all the required game data files to your device, into a folder accessible by the ScummVM app.
-There are a few options:
+ScummVM has built-in Cloud functionality, which allows you to connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`cloud_and_lan` page.
+
+There are a few other options for transferring the game files:
+
- Copying the files directly onto the microSD card, if your device has one.
- USB transfer from a computer. To complete file transfer via USB cable, tap the **Charging this device via USB notification** when the device is connected. Select **Use USB for** and then **File Transfer**. An Android File Transfer window will open.
- - Uploading the files to a cloud service such as Dropbox, and then downloading them to your device.
- - Downloading games such as freeware games or those from digital distributors such `GOG.com <gog.com>`_ or `Steam <steam.steampowered.com>`_ directly to the device.
+ - Downloading games such as freeware games or those from digital distributors such `GOG.com <gog.com>`_ or `Steam <steam.steampowered.com>`_ directly to your device.
For more information on which files ScummVM requires, and how to add and play games, see `adding and playing games <adding_games>`_.
Commit: 985aa07c15dcb11640355a98d49080a4240945b4
https://github.com/scummvm/scummvm/commit/985aa07c15dcb11640355a98d49080a4240945b4
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: moves adding_games to using_scummvm section
Changed paths:
A doc/docportal/using_scummvm/adding_games.rst
R doc/docportal/getting_started/adding_games.rst
doc/docportal/index.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 4e3581b564..ab4dc4261b 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -9,7 +9,7 @@
getting_started/windows
getting_started/ios
getting_started/android
- getting_started/adding_games
+
.. toctree::
diff --git a/doc/docportal/getting_started/adding_games.rst b/doc/docportal/using_scummvm/adding_games.rst
similarity index 82%
rename from doc/docportal/getting_started/adding_games.rst
rename to doc/docportal/using_scummvm/adding_games.rst
index caece4d9d6..a2bcb3eddc 100644
--- a/doc/docportal/getting_started/adding_games.rst
+++ b/doc/docportal/using_scummvm/adding_games.rst
@@ -43,38 +43,44 @@ Adding the games to the Launcher
2. In the Launcher window, click **Add Game**. This opens a file browser. To add multiple games at once, hold :kbd:`Shift` while clicking **Add Game**.
-.. image:: ../images/RaspberryPi/blank_launcher_rpi.jpg
+.. image:: ../images/Launcher/add_game.jpg
:class: with-shadow
3. Use the file browser to locate the folder containing the game you wish to add. Double click on a folder to open it, and use **Go up** to go back up one level.
+.. image:: ../images/Launcher/choose_directory.jpg
+ :class: with-shadow
+
+
4. Once you have selected the folder that contains the data files, click **Choose**.
-.. image:: ../images/RaspberryPi/adding_games_rpi.jpg
+.. image:: ../images/Launcher/choose_game_directory.jpg
:class: with-shadow
5. A dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should work at the default settings. Click **Ok**.
-.. image:: ../images/RaspberryPi/game_info_rpi.jpg
+.. image:: ../images/Launcher/add_game_settings.jpg
:class: with-shadow
6. Added games are now ready to play! To play, select a game and click **Start** to play.
-.. image:: ../images/RaspberryPi/launch_launcher.gif
+.. image:: ../images/Launcher/start_game.jpg
:class: with-shadow
Games can also be launched directly from the command line.
- To launch a game with no additional options, run ``scummvm`` followed by the game id.
-- To launch a game with options, run ``scummvm`` , followed by any desired options, and then the game ID. For more information, see the `Command line options <../advanced_options/command_line>`_ page.
+- To launch a game with options, run ``scummvm``, followed by any desired options, and then the game id. For more information, see the `Command line options <../advanced_options/command_line>`_ page.
+
+In the following example, Flight of the Amazon Queen will be launched in full screen:
-In the following example, Flight of the Amazon Queen will be launched in full screen::
+.. code::
- scummvm -f queen
+ scummvm -f queen
-.. image:: ../images/RaspberryPi/launch_commandline.gif
+.. image:: ../images/Launcher/start_game_cli.jpg
:class: with-shadow
Commit: 863faf036476784c87c697eda3621446b92d96c2
https://github.com/scummvm/scummvm/commit/863faf036476784c87c697eda3621446b92d96c2
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: updates screenshots
Changed paths:
doc/docportal/images/Launcher/the_launcher.jpg
diff --git a/doc/docportal/images/Launcher/the_launcher.jpg b/doc/docportal/images/Launcher/the_launcher.jpg
index f050761a6d..c3cdcfc6c0 100644
Binary files a/doc/docportal/images/Launcher/the_launcher.jpg and b/doc/docportal/images/Launcher/the_launcher.jpg differ
Commit: cc31d41ee750ea4361011963885feb27c8e44eb9
https://github.com/scummvm/scummvm/commit/cc31d41ee750ea4361011963885feb27c8e44eb9
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds/updates game/global settings
Changed paths:
doc/docportal/using_scummvm/game_settings.rst
doc/docportal/using_scummvm/global_settings.rst
diff --git a/doc/docportal/using_scummvm/game_settings.rst b/doc/docportal/using_scummvm/game_settings.rst
index cd306d2395..82a3714ba0 100644
--- a/doc/docportal/using_scummvm/game_settings.rst
+++ b/doc/docportal/using_scummvm/game_settings.rst
@@ -8,10 +8,12 @@ To open the game settings window, highlight a game in the main Launcher
window, and click on **Edit Game**. This window also opens any time a
game is added to the Launcher.
+
There are many settings, and they are separated into tabs:
`Game tab`_ | `Engine tab`_ | `Graphics tab`_ | `Audio tab`_ | `Volume tab`_ | `Midi tab`_ | `Paths tab`_ |
+Settings may also be edited directly in the configuration file. These configuration keywords are listed below in italics. For more information, see :doc:`../advanced_options/configuration_file` .
_`Game tab`
------------
@@ -22,17 +24,25 @@ identified by ScummVM.
,,,,,,,
**ID**
- This field shows the short name of the game. This ID can be used for launching the game from Fullscreen modethe command line.
+ This field shows the short name of the game. This ID can be used for launching the game from the command line.
+
+ *gameid* (string)
**Name**
This field shows the full title of the game, as well as some basic information such as original platform and language.
+
+ *description* (string)
**Language**
- This option is only applicable to Maniac Mansion, Zak McKracken, The Dig, The Curse of Monkey Island, Beneath a Steel Sky, Broken Sword 1, and Simon the Sorcerer 1 and 2. With the exception of Beneath a Steel Sky, Broken Sword 1, and multilanguage versions of Goblins games and Nippon Safes Inc., using this option does not change the language of the game, which is usually hardcoded, but rather is only used to select the appropriate font. For example, for a German version of a game, a font with umlauts. The Dig and The Curse of Monkey Island are another exception: the non-English versions of these games can be set to English, which only affect the language of subtitles. The game speech will remain the same.
+ For multi-language games, this option changes the language of the game. However, for games that have the language hardcoded, this option only changes the font of the subtitles. For instance, selecting German will add an umlaut to German subtitles, and selecting Spanish will add the tilde in Spanish subtitles.
+
+ *language* (string)
+
**Platform**
Specify the original platform of the game.
+ *platform* (string)
,,,,,,,
@@ -40,7 +50,7 @@ identified by ScummVM.
_`Graphics tab`
-----------------
-Use the graphics tab to change how the game looks when it is played.
+Use the graphics tab to change how the game looks when it is played. For more information including comprehensive explanation of the graphics settings, see the :doc:`../advanced_options/graphics` page.
,,,,,,,
@@ -50,20 +60,37 @@ Use the graphics tab to change how the game looks when it is played.
**Graphics mode**
- Changes the graphic filter the game uses. This option has to be used to enable a graphic filter for a game with an original resolution higher than 320x200 or 320x240, because the corresponding global settings does not apply.
+ Changes the resolution of the game. For example, a 2x graphics mode will take a 320x200 resolution game and scale it up to 640x400.
+ *gfx_mode* (string)
+
**Render mode**
- Changes the render mode the game uses.
+ Changes how the game is rendered, which affects how the game looks.
+
+ *render_mode* (string)
+
+**Stretch mode**
+ Changes the way the game is displayed in relation to the window size.
+
+ *stretch_mode* (string)
**Aspect ratio correction**
- Most games supported by ScummVM were designed to be played at a screen resolution of 320x200 using rectangular pixels (higher than they were wide). Most modern systems use square pixels, which means that the image appears to be squeezed vertically and the characters look wider and shorter than they should. If this option is checked, ScummVM corrects for this by stretching the game window to a resolution of 320x240, which looks the same as 320x200 on old monitors. As with Graphic filters, this takes a little processing power to achieve. Aspect ratio correction can be combined with a Graphic filter.
+ If ticked, corrects the aspect ratio so that games appear the same as they would on original 320x200 resolution displays.
+
+ *aspect_ratio* (boolean)
**Fullscreen mode**
Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt + F5` while in a game.
+ *fullscreen* (boolean)
+
+**Filter graphics**
+ If ticked, uses bilinear interpolation instead of nearest neighbor resampling for the aspect ratio correction and stretch mode. It does not affect the graphics mode.
+
+ *filtering* (boolean)
,,,,,
@@ -72,8 +99,8 @@ _`Audio tab`
Use the audio tab to change the sound output in the game.
-For more information about any of the audio settings, see the `Music and
-sound <page>`__ page.
+For more information including comprehensive explanation of the audio settings, see the :doc:`../advanced_options/audio` page.
+
,,,,,,,
@@ -82,24 +109,27 @@ sound <page>`__ page.
-**Music driver**
- The method ScummVM uses to output MIDI music. For more details, see the section on music drivers.
-
+**Music device**
+ The method ScummVM uses to output MIDI music.
+ *music_driver* (string)
**AdLib Emulator**
- The emulator used by ScummVM to generate the music when the AdLib music driver is selected. Two emulators are currently available: MAME OPL emulator was the emulator that was used up to version 0.13.1, and the DOSBox OPL emulator has been added but is still experimental.
+ The emulator used by ScummVM to generate the music when the AdLib music driver is selected.
-**Output rate**
- The sample rate at which ScummVM plays sounds, including music if using an emulation music driver such as the AdLib music driver.
+ *opl_driver* (string)
**Text and Speech**
- For games with digitized speech, setting allows the user to decide whether to play the game with speech and without any subtitles, or with subtitles displaying the words spoken in the digitized speech but not the speech, or with both.
-
+ For games with digitized speech, this setting allows the user to decide whether to play the game with speech and without any subtitles, or with subtitles displaying the words spoken in the digitized speech but without the speech, or with both.
+ *speech_mute* (boolean)
+ *subtitles* (boolean)
+
**Subtitle speed**
- Adjusts the length of time that the subtitles are displayed on screen: the lower the speed is set, the longer the subtitles are displayed.
+ Adjusts the length of time that the subtitles are displayed on screen. The lower the speed is set, the longer the subtitles are displayed.
+
+ *talkspeed* (number)
,,,,,,
@@ -115,40 +145,61 @@ Use the volume tab to set the relative volumes for various sounds in the game.
**Music volume**
- Adjusts the volume of the music played back in the game. This is usually MIDI music played back with one of the music drivers, but some games use digitized music.
+ Adjusts the volume of the music played back in the game.
+ *music_volume* (number)
**SFX volume**
Adjusts the volume of the sound effects within the game.
+ *sfx_volume* (number)
+
**Speech volume**
Adjusts the volume of the digitized speech in the game, if it has any.
+ *speech_volume* (number)
+
+**Mute All**
+ Mutes all game audio.
+
+ *mute* (boolean)
+
,,,,,,
_`MIDI tab`
---------------
-Use the MIDI tab to change settings about the MIDI music in the game.
+Use the MIDI tab to change settings of the MIDI music in the game.
,,,,,,,
**Override global MIDI settings**
Check this box to make the game use custom settings instead of the global settings.
+**GM Device**
+ Choose which software synthesizer (general midi device) to use to play midi music.
+
+ *gm_device*
**Soundfont**
- Some music drivers require you to provide them with a Soundfont, which contains samples of instruments for the device to play back. This setting allows you to choose one.
+ Some midi devices require you to provide a soundfont, which contains samples of instruments for the device to play back. This setting allows you to choose a soundfont.
+
+ *soundfont* (string - path)
**Mixed AdLib/MIDI mode**
- Some games contain sound effects that are exclusive to the AdLib soundtrack. For these games, you may wish to use this mode in order to combine MIDI music with AdLib sound effects.
+ Some games contain sound effects that are exclusive to the AdLib soundtrack. For these games, use this mode to combine MIDI music with AdLib sound effects.
+ *multi_midi* (boolean)
**MIDI gain**
- Adjusts the relative volume of the general MIDI music. This is only supported by some of the music drivers.
+ Adjusts the relative volume of the general MIDI music. This is only supported by some music devices.
+
+ *midi_gain* (number)
+
+
_`MT-32 tab`
@@ -158,17 +209,14 @@ Override global MT-32 settings
Check this box to make the game use custom settings instead of the global settings.
MT-32 Device
- **Find out about this?**
+ ++Find reference for this
**True Roland MT-32 (disable GM emulation)**
- ScummVM will treat your device as a real MT-32. Because the instrument mappings and system exclusive commands of the MT-32 vary from those of General MIDI devices, you should only enable this option if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500, or GS device with an MT-32 map.
-
+ Enable this option if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500, or a GS device with an MT-32 map.
**Roland GS device (enable MT-32 mappings)**
- ScummVM will initialize your GS-compatible device with settings that mimic the MT-32's reverb, (lack of) chorus, pitch bend sensitivity, etc. If it is specified in conjunction with True Roland MT-32 (above), ScummVM will select the MT-32-compatible map and drumset on your GS device. This setting works better than default GM or GS emulation with games that do not have custom instrument mappings (Loom and The Secret of Monkey Island). You should only specify both settings if you are using a GS device that has an MT-32 map, e.g. SC-55, SC-88, SC-8820, etc. Please note that Roland GS Mode is automatically disabled in both Day of the Tentacle and Sam & Max Hit the Road, since they use General MIDI natively. If neither of the above settings is enabled, ScummVM will initialize your device in General MIDI mode and use GM emulation in games with MT-32 soundtracks
-
-
+ Enable this if you are using a GS device that has an MT-32 map, such as a SC-55, SC-88 or SC-8820. Roland GS mode may be disabled for games that use General MIDI natively.
,,,,,
@@ -176,29 +224,28 @@ MT-32 Device
_`Paths tab`
--------------
-Use the paths tab to tell ScummVM where to look for particular files of
-the game.
+Use the paths tab to tell ScummVM where to look for particular game files.
,,,,,,,
**Save Path**
- The folder in which ScummVM will store the game's saved games. If this is not set, the saved games will be stored in the default directory.
-
+ The folder in which ScummVM will store the saved games. If this is not set, the saved games will be stored in the default directory.
+ *savepath* (string)
**Extra Path**
- This is the folder that ScummVM will look in for various extra files. These could include one or more of:
-
- * Additional datafiles required for certain games (for example, kyra.dat)
- * Soundfonts (see MIDI tab)
- * MT-32 ROMs (see MT-32 emulation)
+ This is the folder that ScummVM will look for various extra files. These could include one or more of:
+ * Additional datafiles required for certain games
+ * Soundfonts
+ * MT-32 ROMs
+ *extrapath* (string)
**Game Path**
The folder in which the game’s data files are stored.
-
+ *gamepath* (string)
,,,,,,,
_`Engine tab`
@@ -215,21 +262,25 @@ Engines: ADL_ | AGI_ | BLADERUNNER_ | CGE_ | CINE_ | DRASCULA_ | DREAMWEB_ | HDB
.. _ADL:
-**ADL**
-=================
+ADL
+******
TV emulation
Emulate composite output to an NTSC TV.
+ *ntsc* (boolean)
Color Graphics
Use color graphics instead of monochrome.
+ *color* (boolean)
Show scanlines
Darken every other scanline to mimic the look of CRT.
+ *scanlines* (boolean)
Always use sharp monochrome text
Do not emulate NTSC artifacts for text
+ *monotext* (boolean)
,,,,,,,,,
.. _AGI:
@@ -240,22 +291,32 @@ Always use sharp monochrome text
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
+ *originalsaveload* (boolean)
+
Use an alternative palette
Use an alternative palette, common for all Amiga games. This was the old behavior
+ *altamigapalette* (boolean)
+
Mouse support
Enables mouse support. Allows to use mouse for movement and in game menus.
+ *mousesupport* (boolean)
+
Use Hercules hires font
- Uses Hercules hires font, when font file is available.
+ Uses Hercules hi-res font, when font file is available.
+
+ *herculesfont*
Pause when entering commands
Shows a command prompt window and pauses the game (like in SCI) instead of a real-time prompt.
+ *commandpromptwindow* (boolean)
Add speed menu
Add game speed menu (similar to PC version)
-,,,,,,
+ *apple2gs_speedmenu* (boolean)
+,,,,,,
.. _BLADERUNNER:
@@ -265,18 +326,26 @@ Add speed menu
Sitcom mode
Game will add laughter after actor's line or narration
+ *sitcom* (boolean)
+
Shorty mode
Game will shrink the actors and make their voices high pitched
+ *shorty* (boolean)
Frame limiter high performance mode
This mode may result in high CPU usage! It avoids use of delayMillis() function.
+ *nodelaymillisfl* (boolean)
+
Max frames per second limit
This mode targets a maximum of 120 fps. When disabled, the game targets 60 fps
+ *frames_per_secondfl* (boolean)
+
Disable McCoy's quick stamina drain
When running, McCoy won't start slowing down as soon as the player stops clicking the mouse
+ *disable_stamina_drain* (boolean)
,,,,,,,,
.. _CGE:
@@ -287,6 +356,7 @@ Disable McCoy's quick stamina drain
Color Blind Mode
Enable Color Blind Mode by default
+ *enable_color_blind* (boolean)
,,,,,,
.. _CINE:
@@ -297,9 +367,11 @@ Color Blind Mode
Use original save/load screen
Use the original save/load screens instead of the ScummVM one
+ *originalsaveload* (boolean)
Use transparent dialog boxes in 16 color scenes
Use transparent dialog boxes in 16 color scenes even if the original game version did not support them
+ *transparentdialogboxes* (boolean)
,,,,,,,,,
.. _DRASCULA:
@@ -310,6 +382,7 @@ Use transparent dialog boxes in 16 color scenes
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
+ *originalsaveload* (boolean)
,,,,,,,,,,
.. _DREAMWEB:
@@ -320,9 +393,12 @@ Use original save/load screens
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
+ *originalsaveload* (boolean)
+
Use bright palette mode
Display graphics using the game's bright palette
+ *bright_palette* (boolean)
,,,,,,,,,,
.. _HDB:
@@ -333,6 +409,7 @@ Use bright palette mode
Enable cheat mode
Debug info and level selection becomes available
+ *hypercheat* (boolean)
,,,,,,,,,,
.. _HOPKINS:
@@ -343,6 +420,7 @@ Enable cheat mode
Gore Mode
Enable Gore Mode when available
+ *enable_gore* (boolean)
,,,,,,,,,,
.. _KYRA:
@@ -353,27 +431,36 @@ Gore Mode
Enable studio audience
Studio audience adds an applause and cheering sounds whenever Malcolm makes a joke
+ *studio_audience* (boolean)
Skip support
This option allows the user to skip text and cutscenes.
+ *skip_support* (boolean)
Enable helium mode
Helium mode makes people sound like they've inhaled Helium.
+ *helium_mode* (boolean)
Enable smooth scrolling when walking
When enabled, this option makes scrolling smoother when changing from one screen to another.
+ *smooth_scrolling* (boolean)
+
Enable floating cursors
When enabled, this option changes the cursor when it floats to the edge of the screen to a directional arrow. The player can then click to walk towards that direction.
+ *floating_cursors* (boolean)
Suggest save names
When enabled, this option will fill in an autogenerated savegame escription into the input prompt.
+ *auto_savenames* (boolean)
HP bar graphs
Enable hit point bar graphs
+ *hpbargraphs* (boolean)
Fight Button L/R Swap
Left button to attack, right button to pick up items
+ *mousebtswap* (boolean)
,,,,,,,,,,
.. _LURE:
@@ -382,7 +469,9 @@ Fight Button L/R Swap
=================
TTS Narrator
- Use TTS to read the descriptions (if TTS is available)
+ Use text-to-speech to read the descriptions, if test-to-speech is available)
+
+ *tts_narrator* (boolean)
,,,,,,,,,,
@@ -394,18 +483,25 @@ TTS Narrator
Easy mouse interface
Shows object names when hovering the mouse over them
+ *EasyMouse* (boolean)
Animated inventory items
Animated inventory items
+ *InvObjectsAnimated* (boolean)
Animated game interface
Animated game interface
+ *TextWindowAnimated* (boolean)
+
Naughty game mode
Naughty game mode
+ *NaughtyMode* (boolean)
+
Graphics dithering
Graphics dithering
+ *GraphicsDithering* (boolean)
,,,,,,,,,,
.. _NEVERHOOD:
@@ -416,14 +512,28 @@ Graphics dithering
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
+ *originalsaveload* (boolean)
+
Skip the Hall of Records storyboard scenes
Allows the player to skip past the Hall of Records storyboard scenes
+ *skiphallofrecordsscenes* (boolean)
Scale the making of videos to full screen
Scale the making of videos, so that they use the whole screen
+ *scalemakingofvideos* (boolean)
,,,,,,,,,,
+.. _QUEEN:
+**QUEEN**
+==========
+
+Alternate intro
+ Plays the alternate intro for Flight of the Amazon Queen.
+
+ *alt_intro* (boolean)
+
+,,,,,,,,,,,,,,,
.. _SCI:
**SCI**
@@ -432,39 +542,66 @@ Scale the making of videos to full screen
Skip EGA dithering pass (full color backgrounds)
Skip dithering pass in EGA games, graphics are shown with full colors
+ *disable_dithering* (boolean)
+
Enable high resolution graphics
Enable high resolution graphics/content
+ *enable_high_resolution_graphics* (boolean)
+
Enable black-lined video
Draw black lines over videos to increase their apparent sharpness
+ *enable_black_lined_video* (boolean)
+
Use high-quality video scaling
Use linear interpolation when upscaling videos, where possible
+ *enable_hq_video* (boolean)
Use high-quality "LarryScale" cel scaling
Use special cartoon scaler for drawing character sprites
+ *enable_larryscale*
+
Prefer digital sound effects
Prefer digital sound effects instead of synthesized ones
+ *prefer_digitalsfx*
+
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
+ *originalsaveload* (boolean)
+
Use IMF/Yamaha FB-01 for MIDI output
Use an IBM Music Feature card or a Yamaha FB-01 FM synth module for MIDI output
+ *native_fb01* (boolean)
+
Use CD audio
Use CD audio instead of in-game audio, if available
+ *use_cdaudio* (boolean)
+
Use Windows cursors
Use the Windows cursors (smaller and monochrome) instead of the DOS ones
+ *windows_cursors* (boolean)
+
Use silver cursors
Use the alternate set of silver cursors instead of the normal golden ones
+ *silver_cursors* (boolean)
+
Upscale videos
Upscale videos to double their size
+ *enable_video_upscale* (boolean)
+
+Enable content censoring
+ Enable the game's built-in optional content censoring"),
+
+ *enable_censoring* (boolean)
,,,,,,,,,,
.. _SCUMM:
@@ -475,40 +612,52 @@ Upscale videos
Show Object Line
Show the names of objects at the bottom of the screen
+ *object_labels* (boolean)
+
Use NES Classic Palette
Use a more neutral color palette that closely emulates the NES Classic
+ *mm_nes_classic_palette* (boolean)
,,,,,,,,,,
.. _SHERLOCK:
**SHERLOCK**
=================
-
-Enable content censoring
- Enable the game's built-in optional content censoring
-
-Upscale videos
- Upscale videos to double their size
+Use original load/save screens
+ Use the original save/load screens instead of the ScummVM ones"),
+
+ *originalsaveload* (boolean)
Pixellated scene transitions
When changing scenes, a randomized pixel transition is done
+ *fade_style* (boolean)
+
Don't show hotspots when moving mouse
Only show hotspot names after you actually click on a hotspot or action button
+ *help_style* (boolean)
+
Show character portraits
Show portraits for the characters when conversing
+ *portraits_on* (boolean)
+
Slide dialogs into view
Slide UI dialogs into view, rather than simply showing them immediately
+ *window_style* (boolean)
+
Transparent windows
Show windows with a partially transparent background
+ *transparent_windows* (boolean)
+
TTS Narrator
- Use TTS to read the descriptions (if TTS is available)
+ Use text-to-speech to read the descriptions, if text-to-speech is available.
+ *tts_narrator*
,,,,,,,,,,
.. _SKY:
@@ -519,6 +668,7 @@ TTS Narrator
Floppy intro
Use the floppy version's intro (CD version only)
+ *alt_intro* (boolean)
,,,,,,,,,,
.. _SUPERNOVA:
@@ -527,8 +677,9 @@ Floppy intro
=================
Improved mode
- Improved mode
+ Removes some repetitive actions, adds possibility to change verbs by keyboard.
+ *improved* (boolean)
,,,,,,,,,,
.. _TOLTECS:
@@ -539,6 +690,7 @@ Improved mode
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
+ *originalsaveload* (boolean)
,,,,,,,,,,
.. _WINTERMUTE:
@@ -549,9 +701,13 @@ Use original save/load screens
Show FPS-counter
Show the current number of frames per second in the upper left corner
+ *show_fps* (boolean)
+
Sprite bilinear filtering (SLOW)
Apply bilinear filtering to individual sprites
+ *bilinear_filtering* (boolean)
+
,,,,,,,,,,
.. _XEEN:
@@ -562,7 +718,10 @@ Sprite bilinear filtering (SLOW)
Show item costs in standard inventory mode
Shows item costs in standard inventory mode, allowing the value of items to be compared
+ *ShowItemCosts* (boolean)
+
More durable armor
Armor won't break until character is at -80HP, rather than merely -10HP
+ *DurableArmor* (boolean)
,,,,,,,,,,
diff --git a/doc/docportal/using_scummvm/global_settings.rst b/doc/docportal/using_scummvm/global_settings.rst
index b5979a357d..980236dc0a 100644
--- a/doc/docportal/using_scummvm/global_settings.rst
+++ b/doc/docportal/using_scummvm/global_settings.rst
@@ -10,97 +10,252 @@ Launcher window.
There are many settings, and they are separated into tabs:
-Graphics tab
+`Graphics tab`_ | `Audio tab`_ | `Volume tab`_ | `Midi tab`_ | `MT-32 tab`_ | `Paths tab`_ | `Misc tab`_ | `Cloud tab`_ | `LAN tab`_ | `Accessibility tab`_ |
+
+Settings may also be edited directly in the configuration file. These configuration keywords are listed below in italics. For more information, see :doc:`../advanced_options/configuration_file` .
+
+_`Graphics tab`
---------------
Use the graphics tab to change how games look when they are played.
,,,,,,,
-Graphics mode
- Changes the graphics filter that ScummVM uses, for example, to scale the game to a higher resolution. The option has no effect on games with an original resolution higher than 320x200 or 320x240. Such games should be configured separately.
+Use the graphics tab to change how the game looks when it is played. For more information including comprehensive explanation of the graphics settings, see the :doc:`../advanced_options/graphics` page.
+
+,,,,,,,
+
+**Override global graphic settings**
+ Check this box to make the game use custom settings instead of global settings.
+
+
+**Graphics mode**
+ Changes the resolution of the game. For example, a 2x graphics mode will take a 320x200 resolution game and scale it up to 640x400.
+
+ *gfx_mode* (string)
+
+
+
+**Render mode**
+ Changes how the game is rendered, which affects how the game looks.
+
+ *render_mode* (string)
+
+
+**Stretch mode**
+ Changes the way the game is displayed in relation to the window size.
+
+ *stretch_mode* (string)
+
+**Aspect ratio correction**
+ If ticked, corrects the aspect ratio so that games appear the same as they would on original 320x200 resolution displays.
-Render mode
- Changes the render mode that ScummVM uses.
+ *aspect_ratio* (boolean)
-Aspect ratio correction
- Most games supported by ScummVM were designed to be played at a screen resolution of 320x200 using rectangular pixels (higher than they were wide). Most modern systems use square pixels, which means that the image appears to be squeezed vertically and the characters look wider and shorter than they should. If this option is checked, ScummVM corrects for this by stretching the game window to a resolution of 320x240, which looks the same as 320x200 on old monitors. As with Graphic filters, this takes a little processing power to achieve. Aspect ratio correction can be combined with a Graphic filter.
+**Fullscreen mode**
+ Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt + F5` while in a game.
-Fullscreen mode
- Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt+Enter` while in a game.
+ *fullscreen* (boolean)
+
+**Filter graphics**
+ If ticked, uses bilinear interpolation instead of nearest neighbor resampling for the aspect ratio correction and stretch mode. It does not affect the graphics mode.
+
+ *filtering* (boolean)
,,,,,,,,,,,,,,,,,,
-Audio tab
+_`Audio tab`
-------------------
-Use the audio tab to change the sound output for games. For more
-information about any of the audio settings, see the `Music and
-sound <page>`__ page.
+Use the audio tab to change the sound output for games.
+
+For more information including comprehensive explanation of the audio settings, see the :doc:`../advanced_options/audio` page.
,,,,,,,,,,,,,,,,
-Music driver
- The method that ScummVM uses to output MIDI music.
-AdLib Emulator
- The emulator used by ScummVM to generate the music when the AdLib music driver is selected. Two emulators are currently available: MAME OPL emulator was the emulator that was used up to version 0.13.1, and the DOSBox OPL emulator has been added, but is still experimental.
-Output rate
- The sample rate at which ScummVM plays sounds, including music if using an emulation music driver such as the AdLib music driver)
+**Music device**
+ The method ScummVM uses to output MIDI music.
+
+ *music_driver* (string)
+
+**AdLib Emulator**
+ The emulator used by ScummVM to generate the music when the AdLib music driver is selected.
+
+ *opl_driver* (string)
+
+**Text and Speech**
+ For games with digitized speech, this setting allows the user to decide whether to play the game with speech and without any subtitles, or with subtitles displaying the words spoken in the digitized speech but without the speech, or with both.
-Text and Speech
- For games with digitized speech, this setting allows the user to decide whether to play the game with speech and without any subtitles, or with subtitles displaying the words spoken in the digitized speech but not the speech, or with both.
-Subtitle speed
+ *speech_mute* (boolean)
+
+ *subtitles* (boolean)
+
+**Subtitle speed**
Adjusts the length of time that the subtitles are displayed on screen. The lower the speed is set, the longer the subtitles are displayed.
+ *talkspeed* (number)
,,,,,,,,,,,,,,,
-Volume tab
------------
+_`Volume tab`
+---------------
Use the volume tab to set the relative volumes for various sounds.
,,,,,,,,,,,,,
-Music volume
- Adjusts the volume of the music played back in games. This is usually MIDI music played back with one of the music drivers, but some games use digitized music.
+**Music volume**
+ Adjusts the volume of the music played back in the game.
+
+ *music_volume* (number)
+
+**SFX volume**
+ Adjusts the volume of the sound effects within the game.
-SFX volume
- Adjusts the volume of the sound effects within the games.
+ *sfx_volume* (number)
-Speech volume
+
+**Speech volume**
Adjusts the volume of the digitized speech in the game, if it has any.
-Mute All
- Mutes all sounds.
+ *speech_volume* (number)
+
+**Mute All**
+ Mutes all game audio.
+
+ *mute* (boolean)
,,,,,,,,,,,,,,,,,,
-MIDI tab
+_`MIDI tab`
----------------
Use the MIDI tab to change settings about the MIDI music.
,,,,,,,,,,,,,
-Soundfont
- Some music drivers require you to provide them with a Soundfont, which contains samples of instruments for the device to play back. This setting allows you to choose one.|
-Mixed AdLib/MIDI mode
- Some games contain sound effects that are exclusive to the AdLib soundtrack. For these games, you may wish to use this mode in order to combine MIDI music with AdLib sound effects.
-True Roland MT-32 (disable GM emulation)
- ScummVM will treat your device as a real MT-32. Because the instrument mappings and system exclusive commands of the MT-32 vary from those of general MIDI devices, you should only enable this option if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500, or GS device with an MT-32 map.
+**GM Device**
+ Choose which software synthesizer (general midi device) to use to play midi music.
+
+ *gm_device*
+
+**Soundfont**
+ Some midi devices require you to provide a soundfont, which contains samples of instruments for the device to play back. This setting allows you to choose a soundfont.
+
+ *soundfont* (string - path)
+
+
+**Mixed AdLib/MIDI mode**
+ Some games contain sound effects that are exclusive to the AdLib soundtrack. For these games, use this mode to combine MIDI music with AdLib sound effects.
+
+ *multi_midi* (boolean)
+
+**MIDI gain**
+ Adjusts the relative volume of the general MIDI music. This is only supported by some music devices.
+
+ *midi_gain* (number)
+
+FluidSynth settings
+ Opens a new dialog, with three further tabs:
+ `Reverb`_ | `Chorus`_ | `Misc`_
+
+,,,,,,,,,,,,,,,,,,
+
+_`Reverb`
+*************
+
+Reverberation, or reverb, describes the pattern of echoes and reflections that occur when a sound is heard in an enclosed closed space, such as a room or a concert hall.
+
+Active
+ If ticked, reverb is added to the software synthesizer output.
+
+ *fluidsynth_reverb_activate* (boolean)
+
+Room
+ Sets the room size, which determines how much reverb there is.
+
+ *fluidsynth_reverb_roomsize* (number)
+
+Damp
+ Dampens higher-frequency reverb, which produces a warmer sound.
+
+ *fluidsynth_reverb_damping* (number)
+
+Width
+ Sets the stereo spread of the reverb signal.
+
+ *fluidsynth_reverb_width* (number)
+
+Level
+ Sets the reverb output amplitude.
+
+ *fluidsynth_reverb_level*
+
+,,,,,,,,,,,,,,,,,
+
+_`Chorus`
+**********
+The chorus effect thickens and colors the audio signal so that it sounds as if there are a chorus of instruments playing one part.
+
+Active
+ If ticked, chorus effects are added to the software synthesizer output.
+
+ *fluidsynth_chorus_activate* (boolean)
-Enable Roland GS Mode
- ScummVM will initialize your GS-compatible device with settings that mimic the MT-32's reverb, (lack of) chorus, pitch bend sensitivity, etc. If it is specified in conjunction with True Roland MT-32 (above), ScummVM will select the MT-32-compatible map and drumset on your GS device. This setting works better than default GM or GS emulation with games that do not have custom instrument mappings (Loom and The Secret of Monkey Island). You should only specify both settings if you are using a GS device that has an MT-32 map, e.g. SC-55, SC-88, SC-8820, etc. Please note that Roland GS Mode is automatically disabled in both Day of the Tentacle and Sam & Max Hit the Road, since they use General MIDI natively.If neither of the above settings is enabled, ScummVM will initialize your device in General MIDI mode and use GM emulation in games with MT-32 soundtracks.
+N
+ Sets the voice count of the chorus, in other words, how many instruments are playing one part.
-MIDI gain
- Adjusts the relative volume of the general MIDI music. This is only supported by some of the music drivers.|
+ *fluidsynth_chorus_nr* (number)
+Level
+ Specifies the output amplitude of the chorus signal.
+
+ *fluidsynth_chorus_level* (number)
+
+Speed
+ Sets the modulation speed of the output, in Hz.
+
+ *fluidsynth_chorus_speed* (number)
+
+Depth
+ Specifies the modulation depth of the chorus.
+
+ *fluidsynth_chorus_depth* (number)
+
+Type
+ ++Find reference for this
+
+ *fluidsynth_chorus_waveform* (string)
+
+,,,,,,,,,,,,,
+
+_`Misc`
+*********
+Interpolation
+ Sets the interpolation method used by the software synthesizer.
+
+ *fluidsynth_misc_interpolation* (string)
,,,,,,,,,,,,,,,
-Paths tab
------------
+
+_`MT-32 tab`
+---------------
+
+MT-32 Device
+ ++Clarify? Would an external MIDI synthesizer listed below show up here??
+
+**True Roland MT-32 (disable GM emulation)**
+ Enable this option if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500, or a GS device with an MT-32 map.
+
+
+**Roland GS device (enable MT-32 mappings)**
+ Enable this if you are using a GS device that has an MT-32 map, such as a SC-55, SC-88 or SC-8820. Roland GS mode may be disabled for games that use General MIDI natively.
+
+,,,,,
+
+_`Paths tab`
+--------------------
Use the paths tab to tell ScummVM where to look for particular files.
@@ -118,20 +273,26 @@ Save Path
* Other UNIX variants ``$HOME/.scummvm/``
* iPhone ``/private/var/mobile/Library/ScummVM/Savegames``
+
+ *savepath* (string - path)
+
+Theme Path
+ The folder that additional themes for the ScummVM Launcher are stored in.
+
+ *themepath* (string - path)
Extra Path
This is the folder that ScummVM will look in for various extra files. These could include one or more of:
- * Additional datafiles required for certain games (e.g. kyra.dat)
- * Soundfonts (see MIDI tab)
- * MT-32 ROMs (see MT-32 emulation)
+ * Additional datafiles required for certain games
+ * Soundfonts
+ * MT-32 ROMs
-Theme Path
- The folder that additional themes for the ScummVM Launcher are stored in.
+ *extrapath* (string - path)
,,,,,,,,,,,,,,
-Misc tab
+_`Misc tab`
----------------------
The Misc tab contains options that don’t belong on any of the other tabs.
@@ -141,10 +302,85 @@ The Misc tab contains options that don’t belong on any of the other tabs.
Theme
Changes the visual appearance of the ScummVM Launcher
+ *gui_theme* (string)
+
GUI Renderer
Defines how the ScummVM GUI is rendered; normal or antialiased.
+ *gui_renderer* (string)
+
Autosave
- In some games (namely Beneath a Steel Sky, Flight of the Amazon Queen, and all SCUMM games), Adjusts the time period that ScummVM waits between autosaves. The default setting is 5 minutes. Note that this is only available in some games (Beneath a Steel Sky, Flight of the Amazon Queen, and all SCUMM games)
+ Adjusts the time period that ScummVM waits between autosaves. The default setting is 5 minutes. This is not available for all games.
+
+ *autosave_period* (number)
+
+GUI Language
+ Choose the language of the ScummVM Launcher
+
+ *gui_language* (string)
+
+Switch the GUI language to the game language
+ If ticked, the Launcher language will be the same as the game language.
+
+ *gui_use_game_language* (boolean)
,,,,,,,,,,,,,
+
+_`Cloud tab`
+--------------
+
+The Cloud tab contains options for connecting Cloud-based services to enable a sync of games and saved states across multiple devices. This tab may not be available on all platforms.
+
+,,,,,,,,,,,,,,,,,,,,,,,,,,
+
+Active storage
+ Choose from Dropbox, OneDrive, Google Drive, or Box.
+
+For more information on how to connect a Cloud storage service to ScummVM, see the :doc:`cloud_and_lan` page.
+
+Once a Cloud service has been selected, further options are available.
+
+Sync Now
+ Manually sync saved games with the Cloud service. Saved games automatically sync on launch, after saving, on on game load.
+
+Download game files
+ Use this option to download game files from your Cloud ScummVM folder.
+
+Disconnect
+ Use this option to disconnect the Cloud storage account. To change accounts, disconnect and connect again.
+
+,,,,,,,,,,,,,,,,,,,,,,,
+
+_`LAN tab`
+----------
+
+The LAN tab contains options for starting a local network web server which allows browser-based file management, including uploading and downloading game files. The web server will only run while the Options window remains open.
+
+For more information, see the :doc:`cloud_and_lan` page.
+
+,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+
+Run server
+ Starts the web server. Once running, this displays the URL at which the web server can be accessed.
+
+Server's port
+ The port on which the web server is available.
+
+ *local_server_port* (number)
+
+/root/ Path
+ Allows you to specify the root path. Any sub-directories will be accessible.
+
+ *rootpath* (string - path)
+
+,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+
+_`Accessibility tab`
+--------------------
+
+Use Text to Speech
+ If ticked, enables text to speech. As the cursor hovers over any text field in the Launcher it is converted to speech. Choose from a variety of voices.
+
+ *tts_enabled* (boolean)
+
+,,,,,,,,,,,,,,,,,,,,,
\ No newline at end of file
Commit: ed6e16f3f3fc9eb48f73a679a1cac0307edd59c6
https://github.com/scummvm/scummvm/commit/ed6e16f3f3fc9eb48f73a679a1cac0307edd59c6
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: updates links to screenshots
Changed paths:
doc/docportal/using_scummvm/the_launcher.rst
diff --git a/doc/docportal/using_scummvm/the_launcher.rst b/doc/docportal/using_scummvm/the_launcher.rst
index 994a4f0dcd..2cbd9b9b4d 100755
--- a/doc/docportal/using_scummvm/the_launcher.rst
+++ b/doc/docportal/using_scummvm/the_launcher.rst
@@ -1,27 +1,28 @@
==============
The Launcher
==============
-.. image:: ../images/Launcher/InterfaceMainWindow.png
- :class: with-shadow
-The main ScummVM window is called the Launcher. The Launcher opens whenever you start ScummVM without launching a game directly.
+The main ScummVM window is called the Launcher. The Launcher opens whenever you start ScummVM, unless you launch a game directly from the command line.
The games list
===============
The pane on the left lists the games you have added to ScummVM. This list usually offers some additional information about each game, such as original platform and language. To highlight any game on the list, type the first letter(s) of its title, or click on it.
-Quick search
-=============
-.. image:: ../images/Launcher/Quicksearch.png
+.. image:: ../images/Launcher/the_launcher.jpg
:class: with-shadow
+Quick search
+=============
Quick search allows you to filter the list of added games.
-The quick search input is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, press the **C** button next to the input box.
+The quick search input is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, select the **X** button next to the input box.
There are many ways to filter games. For instance, you can type "Monkey Island" to quickly locate all "Monkey Island" games on the list, or you can type "German" if you wish to play a game in German.
+.. image:: ../images/Launcher/quicksearch.jpg
+ :class: with-shadow
+
The buttons
============
To the right of the games list there are a number of buttons. Their functions are as follows:
@@ -30,43 +31,60 @@ Start
-----
Launches the highlighted game.
+.. image:: ../images/Launcher/start_game.jpg
+
Load
----
-.. image:: ../images/Launcher/Loadlist.png
- :class: with-shadow
-
Opens the Load window, from which you can run a previously saved state without having to start the game first.
-The pane on the left displays a list of your saved states. Click on a saved state to highlight it. On the right, information about the highlighted state such as timestamps, screenshots and playtime is displayed. When you have located the desired saved game:
+There are two views: list view and tile view. Toggle between the two by clicking the list and tile icons at the bottom left of the window.
+
+In list view, the pane on the left displays a list of your saved states. Click on a saved state to highlight it. On the right, information about the highlighted state such as timestamps, screenshots and playtime is displayed.
+
+When you have located the desired saved game:
- Click **Load** to launch the game using that state.
- Click **Delete** to delete the saved state.
+In tile view, each tile shows a screenshot of the saved state, as well as the description and save slot number. Click on the tile to load that saved state.
+
.. caution::
- There are games that do not support this feature at all, or whose saved states lack information such as playtime or screenshots.
+ There are games that do not support the save game feature, or whose saved states lack information such as playtime or screenshots.
-Add Game
----------
-.. image:: ../images/RaspberryPi/adding_games_rpi.jpg
+.. image:: ../images/Launcher/save_game_list.jpg
+ :class: with-shadow
+
+.. image:: ../images/Launcher/save_game_tile.jpg
:class: with-shadow
-Opens a file browser. Use this file browser to locate the folder containing the game you wish to add. Double click on a folder to open it, and use **Go up** to go back up one level.
+
+Add Game
+---------
+
+On some platforms, the Add Game button opens the default system dialog to allow you to choose the folder containing the game files. On other platforms, the custom ScummVM file browser opens. Use this file browser to locate the folder containing the game you wish to add. Double click on a folder to open it, and use **Go up** to go back up one level.
Once you have selected the folder that contains the game data files, click **Choose**.
-To add more than one game at a time, hold :kbd:`Shift` while clicking **Add Game**
+.. image:: ../images/Launcher/choose_game_directory.jpg
+ :class: with-shadow
+
+To add more than one game at a time, hold :kbd:`Shift` while clicking **Add Game**.
+
+For more information, see the :doc:`adding_games` page.
Edit Game
----------
-.. image:: ../images/Launcher/Configdone.png
- :class: with-shadow
+
Opens the game settings window. This window also opens whenever a game is added from the Launcher.
Use this window to configure a game individually by overriding the default global game settings you have set via the **Options** window. You can also change the game's language and original platform, if applicable. For more information, see the :doc:`game_settings` page.
+.. image:: ../images/Launcher/edit_game.jpg
+ :class: with-shadow
+
Remove Game
-----------
@@ -75,11 +93,11 @@ Removes the highlighted game from the list.
Options
-------
-.. image:: ../images/Launcher/Graphicstab.png
- :class: with-shadow..
Opens the global settings window. Use this window to define global game settings, as well as change a number of the ScummVM Launcher settings. For more details on how to fine-tune ScummVM, see the :doc:`global_settings` page.
+.. image:: ../images/Launcher/options.jpg
+ :class: with-shadow..
About
-----
@@ -91,20 +109,28 @@ Closes the Launcher and quits the ScummVM application.
The Global Main Menu
=====================
-.. image:: ../images/Launcher/Generalmenu.png
- :class: with-shadow
+The Global Main Menu (GMM) is available while playing any game by pressing :kbd:`Ctrl` + :kbd:`F5`, or :kbd:`Ctrl` + :kbd:`fn` + :kbd:`F5` on a Mac. It provides the following options:
-The Global Menu (or GMM for Global Main Menu) is available while playing any game by pressing :kbd:`Crtl` + :kbd:`F5`, and provides the following features:
+.. image:: ../images/Launcher/gmm.jpg
+ :class: with-shadow
- **Resume:** Closes the GMM and resume the game.
-- **Load:** Loads a game state. This is not available for all games.
+- **Load:** Loads a saved game state. This is not available for all games.
- **Save:** Saves a game state. This is not available for all games.
-- **Options:** Changes some options to play the game, such as music volume or subtitle speed.
+- **Options:** Provides gameplay options, such as sound volume and subtitle settings.
+
+.. image:: ../images/Launcher/gmm_options.jpg
+ :class: with-shadow
+
- **About:** Displays the ScummVM About box. This is also available from the The Launcher.
-- **Help:** Displays a list of key commands. This not available in all engines.
-- **Return to Launcher:** Quits the game and returns to The Launcher. This is not available in all engines.
+- **Help:** Displays a list of keyboard shortcuts for the game. This not available for all games.
+
+.. image:: ../images/Launcher/gmm_help.jpg
+- **Return to Launcher:** Quits the game and returns to The Launcher. This is not available for all games.
- **Quit:** Quits the game and ScummVM, and returns to the Operating System.
+
.. caution::
- In some games you can still access the original game menu by using :kbd:`Alt`+:kbd:`F5`. You can save and load games using this, however it is not intended for this purpose, and may even crash ScummVM in some games.
+ In some games you can still access the original game menu by using :kbd:`Alt` + :kbd:`F5`. You can save and load games this way, however it is not intended for this purpose and may crash ScummVM in some games.
+
Commit: 07be4ff7be078090714adb7da5d8f02c7daa2104
https://github.com/scummvm/scummvm/commit/07be4ff7be078090714adb7da5d8f02c7daa2104
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: corrects audio settings descriptions
Changed paths:
doc/docportal/using_scummvm/game_settings.rst
doc/docportal/using_scummvm/global_settings.rst
diff --git a/doc/docportal/using_scummvm/game_settings.rst b/doc/docportal/using_scummvm/game_settings.rst
index 82a3714ba0..30191b8793 100644
--- a/doc/docportal/using_scummvm/game_settings.rst
+++ b/doc/docportal/using_scummvm/game_settings.rst
@@ -107,20 +107,18 @@ For more information including comprehensive explanation of the audio settings,
**Override global audio settings**
Check this box to make the game use custom settings instead of global settings.
-
-
**Music device**
- The method ScummVM uses to output MIDI music.
+ Specifies the device ScummVM uses to output audio. When set to <default>, ScummVM will automatically choose the most appropriate option for the played game. If set to an MT-32 or a MIDI device, or if ScummVM chooses one of these automatically, the global settings on the MT-32 or MIDI tabs also apply. See the :doc:`global_settings` page for more information.
*music_driver* (string)
**AdLib Emulator**
- The emulator used by ScummVM to generate the music when the AdLib music driver is selected.
+ Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the preferred device.
*opl_driver* (string)
**Text and Speech**
- For games with digitized speech, this setting allows the user to decide whether to play the game with speech and without any subtitles, or with subtitles displaying the words spoken in the digitized speech but without the speech, or with both.
+ For games with digitized speech, this setting allows the user to decide whether to play the game with speech only, subtitles only, or both.
*speech_mute* (boolean)
diff --git a/doc/docportal/using_scummvm/global_settings.rst b/doc/docportal/using_scummvm/global_settings.rst
index 980236dc0a..c2aabd7c56 100644
--- a/doc/docportal/using_scummvm/global_settings.rst
+++ b/doc/docportal/using_scummvm/global_settings.rst
@@ -74,18 +74,18 @@ For more information including comprehensive explanation of the audio settings,
,,,,,,,,,,,,,,,,
-**Music device**
- The method ScummVM uses to output MIDI music.
+**Preferred device**
+ Specifies the device ScummVM uses to output audio. When set to <default>, ScummVM will automatically choose the most appropriate option for the played game. If set to an MT-32 or a MIDI device, or if ScummVM chooses one of these automatically, the settings on the MT-32 or MIDI tabs also apply.
*music_driver* (string)
**AdLib Emulator**
- The emulator used by ScummVM to generate the music when the AdLib music driver is selected.
+ Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the preferred device.
*opl_driver* (string)
**Text and Speech**
- For games with digitized speech, this setting allows the user to decide whether to play the game with speech and without any subtitles, or with subtitles displaying the words spoken in the digitized speech but without the speech, or with both.
+ For games with digitized speech, this setting allows the user to decide whether to play the game with speech only, subtitles only, or both.
*speech_mute* (boolean)
@@ -131,28 +131,28 @@ Use the volume tab to set the relative volumes for various sounds.
_`MIDI tab`
----------------
-Use the MIDI tab to change settings about the MIDI music.
+Use the MIDI tab to change the settings of General MIDI devices.
,,,,,,,,,,,,,
**GM Device**
- Choose which software synthesizer (general midi device) to use to play midi music.
+ Specifies a preferred General MIDI (GM) device, which ScummVM uses whenever General MIDI playback is required.
*gm_device*
**Soundfont**
- Some midi devices require you to provide a soundfont, which contains samples of instruments for the device to play back. This setting allows you to choose a soundfont.
+ Specifies the path to a soundfont file, if this is required by the GM device.
*soundfont* (string - path)
**Mixed AdLib/MIDI mode**
- Some games contain sound effects that are exclusive to the AdLib soundtrack. For these games, use this mode to combine MIDI music with AdLib sound effects.
+ Combines MIDI music with AdLib sound effects.
*multi_midi* (boolean)
**MIDI gain**
- Adjusts the relative volume of the general MIDI music. This is only supported by some music devices.
+ Adjusts the relative volume of the MIDI music. This is only supported by some music devices.
*midi_gain* (number)
@@ -224,7 +224,7 @@ Depth
*fluidsynth_chorus_depth* (number)
Type
- ++Find reference for this
+ Specifies the chorus modulation waveform type.
*fluidsynth_chorus_waveform* (string)
@@ -241,16 +241,19 @@ Interpolation
_`MT-32 tab`
---------------
+Use the MT-32 tab to change the settings of MT-32 devices.
+
+,,,,,,,,,,,,,
MT-32 Device
- ++Clarify? Would an external MIDI synthesizer listed below show up here??
+ Specifies a preferred MT-32 device, which ScummVM uses whenever MT-32 playback is required.
**True Roland MT-32 (disable GM emulation)**
- Enable this option if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500, or a GS device with an MT-32 map.
+ Enable this option only if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500 or other MT-32 compatible device. Note that this cannot be used in conjuntion with the Roland GS device option.
**Roland GS device (enable MT-32 mappings)**
- Enable this if you are using a GS device that has an MT-32 map, such as a SC-55, SC-88 or SC-8820. Roland GS mode may be disabled for games that use General MIDI natively.
+ Enable this option if you are using a GS device that has an MT-32 map, such as an SC-55, SC-88 or SC-8820. Note that this cannot be used in conjunction with the True Roland MT-32 option.
,,,,,
Commit: 563c2354c7cfe22585522a03fea38ba3237ac96b
https://github.com/scummvm/scummvm/commit/563c2354c7cfe22585522a03fea38ba3237ac96b
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: corrects audio settings descriptions
Changed paths:
doc/docportal/using_scummvm/game_settings.rst
diff --git a/doc/docportal/using_scummvm/game_settings.rst b/doc/docportal/using_scummvm/game_settings.rst
index 30191b8793..fb7796571e 100644
--- a/doc/docportal/using_scummvm/game_settings.rst
+++ b/doc/docportal/using_scummvm/game_settings.rst
@@ -11,7 +11,7 @@ game is added to the Launcher.
There are many settings, and they are separated into tabs:
-`Game tab`_ | `Engine tab`_ | `Graphics tab`_ | `Audio tab`_ | `Volume tab`_ | `Midi tab`_ | `Paths tab`_ |
+`Game tab`_ | `Engine tab`_ | `Graphics tab`_ | `Audio tab`_ | `Volume tab`_ | `Midi tab`_ | `MT-32 tab`_ | `Paths tab`_ |
Settings may also be edited directly in the configuration file. These configuration keywords are listed below in italics. For more information, see :doc:`../advanced_options/configuration_file` .
@@ -40,7 +40,7 @@ identified by ScummVM.
**Platform**
- Specify the original platform of the game.
+ Specifies the original platform of the game.
*platform* (string)
,,,,,,,
@@ -108,7 +108,7 @@ For more information including comprehensive explanation of the audio settings,
Check this box to make the game use custom settings instead of global settings.
**Music device**
- Specifies the device ScummVM uses to output audio. When set to <default>, ScummVM will automatically choose the most appropriate option for the played game. If set to an MT-32 or a MIDI device, or if ScummVM chooses one of these automatically, the global settings on the MT-32 or MIDI tabs also apply. See the :doc:`global_settings` page for more information.
+ Specifies the device ScummVM uses to output audio. When set to <default>, ScummVM will automatically choose the most appropriate option for the played game. If set to an MT-32 or a General MIDI device, or if ScummVM chooses one of these automatically, the settings on the MT-32 or MIDI tabs also apply.
*music_driver* (string)
@@ -169,7 +169,7 @@ Use the volume tab to set the relative volumes for various sounds in the game.
_`MIDI tab`
---------------
-Use the MIDI tab to change settings of the MIDI music in the game.
+Use the MIDI tab to change the settings of General MIDI devices. This tab will only be available for games that use MIDI.
,,,,,,,
@@ -177,44 +177,44 @@ Use the MIDI tab to change settings of the MIDI music in the game.
Check this box to make the game use custom settings instead of the global settings.
**GM Device**
- Choose which software synthesizer (general midi device) to use to play midi music.
+ Specifies the preferred General MIDI (GM) device for the game.
*gm_device*
**Soundfont**
- Some midi devices require you to provide a soundfont, which contains samples of instruments for the device to play back. This setting allows you to choose a soundfont.
+ Specifies the path to a soundfont file, if this is required by the GM device.
*soundfont* (string - path)
**Mixed AdLib/MIDI mode**
- Some games contain sound effects that are exclusive to the AdLib soundtrack. For these games, use this mode to combine MIDI music with AdLib sound effects.
+ Combines MIDI music with AdLib sound effects.
*multi_midi* (boolean)
**MIDI gain**
- Adjusts the relative volume of the general MIDI music. This is only supported by some music devices.
+ Adjusts the relative volume of the MIDI audio. This is only supported by some music devices.
*midi_gain* (number)
-
_`MT-32 tab`
---------------
-Override global MT-32 settings
- Check this box to make the game use custom settings instead of the global settings.
+Use the MT-32 tab to change the settings of MT-32 devices. This tab will only be available for games that use MIDI.
+
+,,,,,,,,,,,,,
MT-32 Device
- ++Find reference for this
+ Specifies the preferred MT-32 device for the game.
**True Roland MT-32 (disable GM emulation)**
- Enable this option if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500, or a GS device with an MT-32 map.
+ Enable this option only if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500 or other MT-32 compatible device. Note that this cannot be used in conjuntion with the Roland GS device option.
**Roland GS device (enable MT-32 mappings)**
- Enable this if you are using a GS device that has an MT-32 map, such as a SC-55, SC-88 or SC-8820. Roland GS mode may be disabled for games that use General MIDI natively.
+ Enable this option if you are using a GS device that has an MT-32 map, such as an SC-55, SC-88 or SC-8820. Note that this cannot be used in conjunction with the True Roland MT-32 option.
,,,,,
@@ -227,12 +227,12 @@ Use the paths tab to tell ScummVM where to look for particular game files.
,,,,,,,
**Save Path**
- The folder in which ScummVM will store the saved games. If this is not set, the saved games will be stored in the default directory.
+ Chooses the folder in which ScummVM will store the saved games. If this is not set, the saved games will be stored in the default directory.
*savepath* (string)
**Extra Path**
- This is the folder that ScummVM will look for various extra files. These could include one or more of:
+ Chooses the folder that ScummVM will in look for various extra files. These could include one or more of:
* Additional datafiles required for certain games
* Soundfonts
@@ -241,7 +241,7 @@ Use the paths tab to tell ScummVM where to look for particular game files.
*extrapath* (string)
**Game Path**
- The folder in which the game’s data files are stored.
+ Chooses folder in which the game’s data files are stored.
*gamepath* (string)
,,,,,,,
@@ -722,4 +722,4 @@ More durable armor
Armor won't break until character is at -80HP, rather than merely -10HP
*DurableArmor* (boolean)
-,,,,,,,,,,
+
Commit: 5e60adb139f246944421edc61ea0612a3eed302e
https://github.com/scummvm/scummvm/commit/5e60adb139f246944421edc61ea0612a3eed302e
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds refs to config keywords
Changed paths:
doc/docportal/using_scummvm/game_settings.rst
doc/docportal/using_scummvm/global_settings.rst
diff --git a/doc/docportal/using_scummvm/game_settings.rst b/doc/docportal/using_scummvm/game_settings.rst
index fb7796571e..c2d9fe78f3 100644
--- a/doc/docportal/using_scummvm/game_settings.rst
+++ b/doc/docportal/using_scummvm/game_settings.rst
@@ -23,26 +23,32 @@ identified by ScummVM.
,,,,,,,
+.. _gameid:
+
**ID**
This field shows the short name of the game. This ID can be used for launching the game from the command line.
- *gameid* (string)
+ *gameid*
**Name**
This field shows the full title of the game, as well as some basic information such as original platform and language.
- *description* (string)
+ *description*
+
+.. _lang:
**Language**
For multi-language games, this option changes the language of the game. However, for games that have the language hardcoded, this option only changes the font of the subtitles. For instance, selecting German will add an umlaut to German subtitles, and selecting Spanish will add the tilde in Spanish subtitles.
- *language* (string)
+ *language*
+.. _platform:
**Platform**
Specifies the original platform of the game.
- *platform* (string)
+ *platform*
+
,,,,,,,
@@ -62,35 +68,35 @@ Use the graphics tab to change how the game looks when it is played. For more in
**Graphics mode**
Changes the resolution of the game. For example, a 2x graphics mode will take a 320x200 resolution game and scale it up to 640x400.
- *gfx_mode* (string)
+ *gfx_mode*
**Render mode**
Changes how the game is rendered, which affects how the game looks.
- *render_mode* (string)
+ *render_mode*
**Stretch mode**
Changes the way the game is displayed in relation to the window size.
- *stretch_mode* (string)
+ *stretch_mode*
**Aspect ratio correction**
If ticked, corrects the aspect ratio so that games appear the same as they would on original 320x200 resolution displays.
- *aspect_ratio* (boolean)
+ *aspect_ratio*
**Fullscreen mode**
Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt + F5` while in a game.
- *fullscreen* (boolean)
+ *fullscreen*
**Filter graphics**
If ticked, uses bilinear interpolation instead of nearest neighbor resampling for the aspect ratio correction and stretch mode. It does not affect the graphics mode.
- *filtering* (boolean)
+ *filtering*
,,,,,
@@ -110,24 +116,24 @@ For more information including comprehensive explanation of the audio settings,
**Music device**
Specifies the device ScummVM uses to output audio. When set to <default>, ScummVM will automatically choose the most appropriate option for the played game. If set to an MT-32 or a General MIDI device, or if ScummVM chooses one of these automatically, the settings on the MT-32 or MIDI tabs also apply.
- *music_driver* (string)
+ *music_driver*
**AdLib Emulator**
Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the preferred device.
- *opl_driver* (string)
+ *opl_driver*
**Text and Speech**
For games with digitized speech, this setting allows the user to decide whether to play the game with speech only, subtitles only, or both.
- *speech_mute* (boolean)
+ *speech_mute*
- *subtitles* (boolean)
+ *subtitles*
**Subtitle speed**
Adjusts the length of time that the subtitles are displayed on screen. The lower the speed is set, the longer the subtitles are displayed.
- *talkspeed* (number)
+ *talkspeed*
,,,,,,
@@ -145,23 +151,23 @@ Use the volume tab to set the relative volumes for various sounds in the game.
**Music volume**
Adjusts the volume of the music played back in the game.
- *music_volume* (number)
+ *music_volume*
**SFX volume**
Adjusts the volume of the sound effects within the game.
- *sfx_volume* (number)
+ *sfx_volume*
**Speech volume**
Adjusts the volume of the digitized speech in the game, if it has any.
- *speech_volume* (number)
+ *speech_volume*
**Mute All**
Mutes all game audio.
- *mute* (boolean)
+ *mute*
,,,,,,
@@ -184,18 +190,18 @@ Use the MIDI tab to change the settings of General MIDI devices. This tab will o
**Soundfont**
Specifies the path to a soundfont file, if this is required by the GM device.
- *soundfont* (string - path)
+ *soundfont*
**Mixed AdLib/MIDI mode**
Combines MIDI music with AdLib sound effects.
- *multi_midi* (boolean)
+ *multi_midi*
**MIDI gain**
Adjusts the relative volume of the MIDI audio. This is only supported by some music devices.
- *midi_gain* (number)
+ *midi_gain*
@@ -229,7 +235,7 @@ Use the paths tab to tell ScummVM where to look for particular game files.
**Save Path**
Chooses the folder in which ScummVM will store the saved games. If this is not set, the saved games will be stored in the default directory.
- *savepath* (string)
+ *savepath*
**Extra Path**
Chooses the folder that ScummVM will in look for various extra files. These could include one or more of:
@@ -238,12 +244,15 @@ Use the paths tab to tell ScummVM where to look for particular game files.
* Soundfonts
* MT-32 ROMs
- *extrapath* (string)
+ *extrapath*
+
+.. _gamepath:
**Game Path**
Chooses folder in which the game’s data files are stored.
- *gamepath* (string)
+ *gamepath*
+
,,,,,,,
_`Engine tab`
@@ -262,23 +271,34 @@ Engines: ADL_ | AGI_ | BLADERUNNER_ | CGE_ | CINE_ | DRASCULA_ | DREAMWEB_ | HDB
ADL
******
+.. _ntsc:
TV emulation
Emulate composite output to an NTSC TV.
- *ntsc* (boolean)
+ *ntsc*
+
+.. _color:
+
Color Graphics
Use color graphics instead of monochrome.
- *color* (boolean)
+ *color*
+
+.. _scan:
+
Show scanlines
Darken every other scanline to mimic the look of CRT.
- *scanlines* (boolean)
+ *scanlines*
+
+.. _mono:
+
Always use sharp monochrome text
Do not emulate NTSC artifacts for text
- *monotext* (boolean)
+ *monotext*
+
,,,,,,,,,
.. _AGI:
@@ -286,34 +306,47 @@ Always use sharp monochrome text
**AGI**
=================
+.. _osl:
+
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
- *originalsaveload* (boolean)
+ *originalsaveload*
+
+.. _altamiga:
Use an alternative palette
Use an alternative palette, common for all Amiga games. This was the old behavior
- *altamigapalette* (boolean)
+ *altamigapalette*
+
+.. _support:
Mouse support
Enables mouse support. Allows to use mouse for movement and in game menus.
- *mousesupport* (boolean)
+ *mousesupport*
+
+.. _herc:
Use Hercules hires font
Uses Hercules hi-res font, when font file is available.
*herculesfont*
+.. _cmd:
+
Pause when entering commands
Shows a command prompt window and pauses the game (like in SCI) instead of a real-time prompt.
- *commandpromptwindow* (boolean)
+ *commandpromptwindow*
+
+.. _2gs:
+
Add speed menu
Add game speed menu (similar to PC version)
- *apple2gs_speedmenu* (boolean)
+ *apple2gs_speedmenu*
,,,,,,
.. _BLADERUNNER:
@@ -321,29 +354,40 @@ Add speed menu
**BLADERUNNER**
=================
+.. _sitcom:
+
Sitcom mode
Game will add laughter after actor's line or narration
- *sitcom* (boolean)
+ *sitcom*
+
+.. _shorty:
Shorty mode
Game will shrink the actors and make their voices high pitched
- *shorty* (boolean)
+ *shorty*
+
+.. _nodelay:
+
Frame limiter high performance mode
This mode may result in high CPU usage! It avoids use of delayMillis() function.
- *nodelaymillisfl* (boolean)
+ *nodelaymillisfl*
+
+.. _fpsfl:
Max frames per second limit
This mode targets a maximum of 120 fps. When disabled, the game targets 60 fps
- *frames_per_secondfl* (boolean)
+ *frames_per_secondfl*
+
+.. _stamina:
Disable McCoy's quick stamina drain
When running, McCoy won't start slowing down as soon as the player stops clicking the mouse
- *disable_stamina_drain* (boolean)
+ *disable_stamina_drain*
,,,,,,,,
.. _CGE:
@@ -351,10 +395,13 @@ Disable McCoy's quick stamina drain
**CGE**
=================
+.. _blind:
+
Color Blind Mode
Enable Color Blind Mode by default
- *enable_color_blind* (boolean)
+ *enable_color_blind*
+
,,,,,,
.. _CINE:
@@ -365,11 +412,15 @@ Color Blind Mode
Use original save/load screen
Use the original save/load screens instead of the ScummVM one
- *originalsaveload* (boolean)
+ *originalsaveload*
+
+.. _transparentdialog:
+
Use transparent dialog boxes in 16 color scenes
Use transparent dialog boxes in 16 color scenes even if the original game version did not support them
- *transparentdialogboxes* (boolean)
+ *transparentdialogboxes*
+
,,,,,,,,,
.. _DRASCULA:
@@ -380,7 +431,7 @@ Use transparent dialog boxes in 16 color scenes
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
- *originalsaveload* (boolean)
+ *originalsaveload*
,,,,,,,,,,
.. _DREAMWEB:
@@ -391,12 +442,14 @@ Use original save/load screens
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
- *originalsaveload* (boolean)
+ *originalsaveload*
+
+.. _bright:
Use bright palette mode
Display graphics using the game's bright palette
- *bright_palette* (boolean)
+ *bright_palette*
,,,,,,,,,,
.. _HDB:
@@ -404,10 +457,13 @@ Use bright palette mode
**HDB**
=================
+.. _hyper:
+
Enable cheat mode
Debug info and level selection becomes available
- *hypercheat* (boolean)
+ *hypercheat*
+
,,,,,,,,,,
.. _HOPKINS:
@@ -415,10 +471,13 @@ Enable cheat mode
**HOPKINS**
=================
+.. _gore:
+
Gore Mode
Enable Gore Mode when available
- *enable_gore* (boolean)
+ *enable_gore*
+
,,,,,,,,,,
.. _KYRA:
@@ -426,39 +485,58 @@ Gore Mode
**KYRA**
=================
+.. _studio:
+
Enable studio audience
Studio audience adds an applause and cheering sounds whenever Malcolm makes a joke
- *studio_audience* (boolean)
+ *studio_audience*
+
+.. _skip:
+
Skip support
This option allows the user to skip text and cutscenes.
- *skip_support* (boolean)
+ *skip_support*
+
+.. _helium:
+
Enable helium mode
Helium mode makes people sound like they've inhaled Helium.
- *helium_mode* (boolean)
+ *helium_mode*
+
+.. _smooth:
+
Enable smooth scrolling when walking
When enabled, this option makes scrolling smoother when changing from one screen to another.
- *smooth_scrolling* (boolean)
+ *smooth_scrolling*
+
+.. _floating:
Enable floating cursors
When enabled, this option changes the cursor when it floats to the edge of the screen to a directional arrow. The player can then click to walk towards that direction.
- *floating_cursors* (boolean)
+ *floating_cursors*
Suggest save names
When enabled, this option will fill in an autogenerated savegame escription into the input prompt.
- *auto_savenames* (boolean)
+ *auto_savenames*
+.. _hp:
+
HP bar graphs
Enable hit point bar graphs
- *hpbargraphs* (boolean)
+ *hpbargraphs*
+
+.. _btswap:
+
Fight Button L/R Swap
Left button to attack, right button to pick up items
- *mousebtswap* (boolean)
+ *mousebtswap*
+
,,,,,,,,,,
.. _LURE:
@@ -466,10 +544,12 @@ Fight Button L/R Swap
**LURE**
=================
+.. _ttsnarrator:
+
TTS Narrator
Use text-to-speech to read the descriptions, if test-to-speech is available)
- *tts_narrator* (boolean)
+ *tts_narrator*
,,,,,,,,,,
@@ -478,28 +558,41 @@ TTS Narrator
**MADS**
=================
+.. _easy:
+
Easy mouse interface
Shows object names when hovering the mouse over them
- *EasyMouse* (boolean)
+ *EasyMouse*
+
+.. _objanimated:
+
Animated inventory items
Animated inventory items
- *InvObjectsAnimated* (boolean)
+ *InvObjectsAnimated*
+
+.. _windowanimated:
+
Animated game interface
Animated game interface
- *TextWindowAnimated* (boolean)
+ *TextWindowAnimated*
+
+.. _naughty:
Naughty game mode
Naughty game mode
- *NaughtyMode* (boolean)
+ *NaughtyMode*
+
+.. _gdither:
Graphics dithering
Graphics dithering
- *GraphicsDithering* (boolean)
+ *GraphicsDithering*
+
,,,,,,,,,,
.. _NEVERHOOD:
@@ -510,16 +603,22 @@ Graphics dithering
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
- *originalsaveload* (boolean)
+ *originalsaveload*
+
+.. _skiphall:
Skip the Hall of Records storyboard scenes
Allows the player to skip past the Hall of Records storyboard scenes
- *skiphallofrecordsscenes* (boolean)
+ *skiphallofrecordsscenes*
+
+.. _scale:
+
Scale the making of videos to full screen
Scale the making of videos, so that they use the whole screen
- *scalemakingofvideos* (boolean)
+ *scalemakingofvideos*
+
,,,,,,,,,,
.. _QUEEN:
@@ -529,38 +628,52 @@ Scale the making of videos to full screen
Alternate intro
Plays the alternate intro for Flight of the Amazon Queen.
- *alt_intro* (boolean)
+ *alt_intro*
,,,,,,,,,,,,,,,
+
.. _SCI:
**SCI**
=================
+.. _dither:
+
Skip EGA dithering pass (full color backgrounds)
Skip dithering pass in EGA games, graphics are shown with full colors
- *disable_dithering* (boolean)
+ *disable_dithering*
+
+.. _hires:
Enable high resolution graphics
Enable high resolution graphics/content
- *enable_high_resolution_graphics* (boolean)
+ *enable_high_resolution_graphics*
+
+.. _blackline:
Enable black-lined video
Draw black lines over videos to increase their apparent sharpness
- *enable_black_lined_video* (boolean)
+ *enable_black_lined_video*
+
+.. _hq:
Use high-quality video scaling
Use linear interpolation when upscaling videos, where possible
- *enable_hq_video* (boolean)
+ *enable_hq_video*
+
+.. _larry:
+
Use high-quality "LarryScale" cel scaling
Use special cartoon scaler for drawing character sprites
*enable_larryscale*
+.. _dsfx:
+
Prefer digital sound effects
Prefer digital sound effects instead of synthesized ones
@@ -569,37 +682,50 @@ Prefer digital sound effects
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
- *originalsaveload* (boolean)
+ *originalsaveload*
+
+.. _fb01:
Use IMF/Yamaha FB-01 for MIDI output
Use an IBM Music Feature card or a Yamaha FB-01 FM synth module for MIDI output
- *native_fb01* (boolean)
+ *native_fb01*
+
+.. _cd:
Use CD audio
Use CD audio instead of in-game audio, if available
- *use_cdaudio* (boolean)
+ *use_cdaudio*
+
+.. _wincursors:
Use Windows cursors
Use the Windows cursors (smaller and monochrome) instead of the DOS ones
- *windows_cursors* (boolean)
+ *windows_cursors*
+
+.. _silver:
Use silver cursors
Use the alternate set of silver cursors instead of the normal golden ones
- *silver_cursors* (boolean)
+ *silver_cursors*
+
+.. _upscale:
Upscale videos
Upscale videos to double their size
- *enable_video_upscale* (boolean)
+ *enable_video_upscale*
+
+.. _censor:
Enable content censoring
Enable the game's built-in optional content censoring"),
- *enable_censoring* (boolean)
+ *enable_censoring*
+
,,,,,,,,,,
.. _SCUMM:
@@ -607,15 +733,20 @@ Enable content censoring
**SCUMM**
=================
+.. _labels:
+
Show Object Line
Show the names of objects at the bottom of the screen
- *object_labels* (boolean)
+ *object_labels*
+
+.. _classic:
Use NES Classic Palette
Use a more neutral color palette that closely emulates the NES Classic
- *mm_nes_classic_palette* (boolean)
+ *mm_nes_classic_palette*
+
,,,,,,,,,,
.. _SHERLOCK:
@@ -625,32 +756,42 @@ Use NES Classic Palette
Use original load/save screens
Use the original save/load screens instead of the ScummVM ones"),
- *originalsaveload* (boolean)
+ *originalsaveload*
+
+.. _fade:
Pixellated scene transitions
When changing scenes, a randomized pixel transition is done
- *fade_style* (boolean)
+ *fade_style*
+
+.. _help:
Don't show hotspots when moving mouse
Only show hotspot names after you actually click on a hotspot or action button
- *help_style* (boolean)
+ *help_style*
+
+.. _portraits:
Show character portraits
Show portraits for the characters when conversing
- *portraits_on* (boolean)
+ *portraits_on*
+
+.. _style:
Slide dialogs into view
Slide UI dialogs into view, rather than simply showing them immediately
- *window_style* (boolean)
+ *window_style*
+
+.. _transparentwindows:
Transparent windows
Show windows with a partially transparent background
- *transparent_windows* (boolean)
+ *transparent_windows*
TTS Narrator
Use text-to-speech to read the descriptions, if text-to-speech is available.
@@ -662,22 +803,25 @@ TTS Narrator
**SKY**
=================
+.. _altintro:
Floppy intro
Use the floppy version's intro (CD version only)
- *alt_intro* (boolean)
+ *alt_intro*
,,,,,,,,,,
.. _SUPERNOVA:
**SUPERNOVA**
=================
+.. _improved:
Improved mode
Removes some repetitive actions, adds possibility to change verbs by keyboard.
- *improved* (boolean)
+ *improved*
+
,,,,,,,,,,
.. _TOLTECS:
@@ -688,7 +832,8 @@ Improved mode
Use original save/load screens
Use the original save/load screens instead of the ScummVM ones
- *originalsaveload* (boolean)
+ *originalsaveload*
+
,,,,,,,,,,
.. _WINTERMUTE:
@@ -696,15 +841,19 @@ Use original save/load screens
**WINTERMUTE**
=================
+.. _fps:
+
Show FPS-counter
Show the current number of frames per second in the upper left corner
- *show_fps* (boolean)
+ *show_fps*
+
+.. _bilinear:
Sprite bilinear filtering (SLOW)
Apply bilinear filtering to individual sprites
- *bilinear_filtering* (boolean)
+ *bilinear_filtering*
,,,,,,,,,,
@@ -713,13 +862,17 @@ Sprite bilinear filtering (SLOW)
**XEEN**
=================
+.. _cost:
+
Show item costs in standard inventory mode
Shows item costs in standard inventory mode, allowing the value of items to be compared
- *ShowItemCosts* (boolean)
+ *ShowItemCosts*
+
+.. _durable:
More durable armor
Armor won't break until character is at -80HP, rather than merely -10HP
- *DurableArmor* (boolean)
+ *DurableArmor*
diff --git a/doc/docportal/using_scummvm/global_settings.rst b/doc/docportal/using_scummvm/global_settings.rst
index c2aabd7c56..f239610efb 100644
--- a/doc/docportal/using_scummvm/global_settings.rst
+++ b/doc/docportal/using_scummvm/global_settings.rst
@@ -21,46 +21,48 @@ Use the graphics tab to change how games look when they are played.
,,,,,,,
-Use the graphics tab to change how the game looks when it is played. For more information including comprehensive explanation of the graphics settings, see the :doc:`../advanced_options/graphics` page.
+.. _gfxmode:
-,,,,,,,
-
-**Override global graphic settings**
- Check this box to make the game use custom settings instead of global settings.
-
-
-**Graphics mode**
+Graphics mode
Changes the resolution of the game. For example, a 2x graphics mode will take a 320x200 resolution game and scale it up to 640x400.
- *gfx_mode* (string)
+ *gfx_mode*
+.. _render:
-**Render mode**
+Render mode
Changes how the game is rendered, which affects how the game looks.
- *render_mode* (string)
+ *render_mode*
+.. _stretchmode:
-**Stretch mode**
+Stretch mode
Changes the way the game is displayed in relation to the window size.
- *stretch_mode* (string)
+ *stretch_mode*
+
+.. _ratio:
-**Aspect ratio correction**
+Aspect ratio correction
If ticked, corrects the aspect ratio so that games appear the same as they would on original 320x200 resolution displays.
- *aspect_ratio* (boolean)
+ *aspect_ratio*
+
+.. _fullscreen:
-**Fullscreen mode**
+Fullscreen mode
Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt + F5` while in a game.
- *fullscreen* (boolean)
+ *fullscreen*
-**Filter graphics**
+.. _filtering:
+
+Filter graphics
If ticked, uses bilinear interpolation instead of nearest neighbor resampling for the aspect ratio correction and stretch mode. It does not affect the graphics mode.
- *filtering* (boolean)
+ *filtering*
,,,,,,,,,,,,,,,,,,
@@ -74,27 +76,36 @@ For more information including comprehensive explanation of the audio settings,
,,,,,,,,,,,,,,,,
+.. _device:
+
**Preferred device**
Specifies the device ScummVM uses to output audio. When set to <default>, ScummVM will automatically choose the most appropriate option for the played game. If set to an MT-32 or a MIDI device, or if ScummVM chooses one of these automatically, the settings on the MT-32 or MIDI tabs also apply.
- *music_driver* (string)
+ *music_driver*
+
+.. _opl:
**AdLib Emulator**
Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the preferred device.
- *opl_driver* (string)
+ *opl_driver*
+
+.. _speechmute:
**Text and Speech**
For games with digitized speech, this setting allows the user to decide whether to play the game with speech only, subtitles only, or both.
- *speech_mute* (boolean)
+ *speech_mute*
+
+ *subtitles*
+
+.. _talkspeed:
- *subtitles* (boolean)
-
**Subtitle speed**
Adjusts the length of time that the subtitles are displayed on screen. The lower the speed is set, the longer the subtitles are displayed.
- *talkspeed* (number)
+ *talkspeed*
+
,,,,,,,,,,,,,,,
_`Volume tab`
@@ -104,26 +115,30 @@ Use the volume tab to set the relative volumes for various sounds.
,,,,,,,,,,,,,
+.. _music:
+
**Music volume**
Adjusts the volume of the music played back in the game.
- *music_volume* (number)
+ *music_volume*
**SFX volume**
Adjusts the volume of the sound effects within the game.
- *sfx_volume* (number)
+ *sfx_volume*
**Speech volume**
Adjusts the volume of the digitized speech in the game, if it has any.
- *speech_volume* (number)
+ *speech_volume*
+
+.. _mute:
**Mute All**
Mutes all game audio.
- *mute* (boolean)
+ *mute*
,,,,,,,,,,,,,,,,,,
@@ -135,6 +150,8 @@ Use the MIDI tab to change the settings of General MIDI devices.
,,,,,,,,,,,,,
+.. _gm:
+
**GM Device**
Specifies a preferred General MIDI (GM) device, which ScummVM uses whenever General MIDI playback is required.
@@ -143,18 +160,21 @@ Use the MIDI tab to change the settings of General MIDI devices.
**Soundfont**
Specifies the path to a soundfont file, if this is required by the GM device.
- *soundfont* (string - path)
+ *soundfont*
+.. _multi:
**Mixed AdLib/MIDI mode**
Combines MIDI music with AdLib sound effects.
- *multi_midi* (boolean)
+ *multi_midi*
+
+.. _gain:
**MIDI gain**
Adjusts the relative volume of the MIDI music. This is only supported by some music devices.
- *midi_gain* (number)
+ *midi_gain*
FluidSynth settings
Opens a new dialog, with three further tabs:
@@ -167,25 +187,35 @@ _`Reverb`
Reverberation, or reverb, describes the pattern of echoes and reflections that occur when a sound is heard in an enclosed closed space, such as a room or a concert hall.
+.. _revact:
+
Active
If ticked, reverb is added to the software synthesizer output.
- *fluidsynth_reverb_activate* (boolean)
+ *fluidsynth_reverb_activate*
+
+.. _revroom:
Room
Sets the room size, which determines how much reverb there is.
- *fluidsynth_reverb_roomsize* (number)
+ *fluidsynth_reverb_roomsize*
+
+.. _revdamp:
Damp
Dampens higher-frequency reverb, which produces a warmer sound.
- *fluidsynth_reverb_damping* (number)
+ *fluidsynth_reverb_damping*
+
+.. _revwidth:
Width
Sets the stereo spread of the reverb signal.
- *fluidsynth_reverb_width* (number)
+ *fluidsynth_reverb_width*
+
+.. _revlevel:
Level
Sets the reverb output amplitude.
@@ -198,44 +228,59 @@ _`Chorus`
**********
The chorus effect thickens and colors the audio signal so that it sounds as if there are a chorus of instruments playing one part.
+.. _chact:
+
Active
If ticked, chorus effects are added to the software synthesizer output.
- *fluidsynth_chorus_activate* (boolean)
+ *fluidsynth_chorus_activate*
+
+.. _chnr:
N
Sets the voice count of the chorus, in other words, how many instruments are playing one part.
- *fluidsynth_chorus_nr* (number)
+ *fluidsynth_chorus_nr*
+
+.. _chlevel:
Level
Specifies the output amplitude of the chorus signal.
- *fluidsynth_chorus_level* (number)
+ *fluidsynth_chorus_level*
+
+.. _chspeed:
Speed
Sets the modulation speed of the output, in Hz.
- *fluidsynth_chorus_speed* (number)
+ *fluidsynth_chorus_speed*
+
+.. _chdepth:
Depth
Specifies the modulation depth of the chorus.
- *fluidsynth_chorus_depth* (number)
+ *fluidsynth_chorus_depth*
+
+.. _chwave:
Type
Specifies the chorus modulation waveform type.
- *fluidsynth_chorus_waveform* (string)
+ *fluidsynth_chorus_waveform*
,,,,,,,,,,,,,
_`Misc`
*********
+.. _interp:
+
Interpolation
Sets the interpolation method used by the software synthesizer.
- *fluidsynth_misc_interpolation* (string)
+ *fluidsynth_misc_interpolation*
+
,,,,,,,,,,,,,,,
@@ -245,12 +290,21 @@ Use the MT-32 tab to change the settings of MT-32 devices.
,,,,,,,,,,,,,
+.. _mt32:
+
MT-32 Device
Specifies a preferred MT-32 device, which ScummVM uses whenever MT-32 playback is required.
+ *mt32_device*
+
+.. _nativemt32:
+
**True Roland MT-32 (disable GM emulation)**
Enable this option only if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500 or other MT-32 compatible device. Note that this cannot be used in conjuntion with the Roland GS device option.
+ *native_mt32*
+
+.. _gs:
**Roland GS device (enable MT-32 mappings)**
Enable this option if you are using a GS device that has an MT-32 map, such as an SC-55, SC-88 or SC-8820. Note that this cannot be used in conjunction with the True Roland MT-32 option.
@@ -264,6 +318,8 @@ Use the paths tab to tell ScummVM where to look for particular files.
,,,,,,,,,,,,,,,,,
+.. _savepath:
+
Save Path
The default folder in which ScummVM will store saved games. If this is not set, saved games will generally be stored in the current directory. Exceptions to this include:
@@ -277,12 +333,16 @@ Save Path
* iPhone ``/private/var/mobile/Library/ScummVM/Savegames``
- *savepath* (string - path)
+ *savepath*
+
+.. _themepath:
Theme Path
The folder that additional themes for the ScummVM Launcher are stored in.
- *themepath* (string - path)
+ *themepath*
+
+.. _extra:
Extra Path
This is the folder that ScummVM will look in for various extra files. These could include one or more of:
@@ -291,7 +351,7 @@ Extra Path
* Soundfonts
* MT-32 ROMs
- *extrapath* (string - path)
+ *extrapath*
,,,,,,,,,,,,,,
@@ -305,27 +365,27 @@ The Misc tab contains options that don’t belong on any of the other tabs.
Theme
Changes the visual appearance of the ScummVM Launcher
- *gui_theme* (string)
+ *gui_theme*
GUI Renderer
Defines how the ScummVM GUI is rendered; normal or antialiased.
- *gui_renderer* (string)
+ *gui_renderer*
Autosave
Adjusts the time period that ScummVM waits between autosaves. The default setting is 5 minutes. This is not available for all games.
- *autosave_period* (number)
+ *autosave_period*
GUI Language
Choose the language of the ScummVM Launcher
- *gui_language* (string)
+ *gui_language*
Switch the GUI language to the game language
If ticked, the Launcher language will be the same as the game language.
- *gui_use_game_language* (boolean)
+ *gui_use_game_language*
,,,,,,,,,,,,,
@@ -366,24 +426,30 @@ For more information, see the :doc:`cloud_and_lan` page.
Run server
Starts the web server. Once running, this displays the URL at which the web server can be accessed.
+.. _serverport:
+
Server's port
The port on which the web server is available.
- *local_server_port* (number)
+ *local_server_port*
+
+.. _rootpath:
/root/ Path
Allows you to specify the root path. Any sub-directories will be accessible.
- *rootpath* (string - path)
+ *rootpath*
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
_`Accessibility tab`
--------------------
+.. _ttsenabled:
+
Use Text to Speech
If ticked, enables text to speech. As the cursor hovers over any text field in the Launcher it is converted to speech. Choose from a variety of voices.
- *tts_enabled* (boolean)
+ *tts_enabled*
,,,,,,,,,,,,,,,,,,,,,
\ No newline at end of file
Commit: 8a117e2874ef64e2fc726def375c117b026d4642
https://github.com/scummvm/scummvm/commit/8a117e2874ef64e2fc726def375c117b026d4642
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: reformats keywords into table
Changed paths:
A doc/docportal/advanced_options/configuration_file.rst
R doc/docportal/advanced_options/configuration_file.md
diff --git a/doc/docportal/advanced_options/configuration_file.md b/doc/docportal/advanced_options/configuration_file.md
deleted file mode 100755
index 6319cab593..0000000000
--- a/doc/docportal/advanced_options/configuration_file.md
+++ /dev/null
@@ -1,143 +0,0 @@
-# The configuration file
-
-## Location
-
-The configuration file saves to different default locations depending on the platform on which you are running ScummVM.
-
-| Platform| Config File Path|
-|-|-|
-|
-
-Most settings are also accessible directly from the Launcher. To edit global settings, click **Options**. To edit game-specific settings, highlight a game and then click **Edit Game**.
-For more information, see the [global settings](using/global_settings) and [game settings](using/game_settings) pages.
-
-## Keywords
-
-There are many recognized configuration keywords:
-
-````
-
-path string The path to where a game's data files are
-autosave_period number The seconds between autosaving (default: 300)
-save_slot number The saved game number to load on startup.
-savepath string The path to where a game will store its
- saved games.
-screenshotpath string The path to where screenshots are saved.
-iconpath string The path to where to look for icons to use as
- overlay for the ScummVM icon in the Windows
- taskbar or macOS X Dock when running a game.
- The icon files should be named after the game
- ids and be in ico format on Windows or png
- format on macOS X.
-versioninfo string The version of the ScummVM that created the
- configuration file.
-
-gameid string The real id of a game. Useful if you have
- several versions of the same game, and want
- different aliases for them. See the example.
-description string The description of the game as it will appear
- in the launcher.
-
-language string Specify language (en, us, de, fr, it, pt, es,
- jp, zh, kr, se, gb, hb, cz, ru)
-speech_mute bool If true, speech is muted
-subtitles bool Set to true to enable subtitles.
-talkspeed number Text delay in SCUMM games, or text speed in
- other games.
-
-fullscreen bool Fullscreen mode
-aspect_ratio bool Enable aspect ratio correction
-gfx_mode string Graphics mode (normal, 2x, 3x, 2xsai,
- super2xsai, supereagle, advmame2x, advmame3x,
- hq2x, hq3x, tv2x, dotmatrix, opengl)
-filtering bool Enable graphics filtering
-
-confirm_exit bool Ask for confirmation by the user before
- quitting (SDL backend only).
-console bool Enable the console window (default: enabled)
- (Windows only).
-cdrom number Number of CD-ROM unit to use for audio. If
- negative, don't even try to access the CD-ROM.
-joystick_num number Number of joystick device to use for input
-controller_map_db string A custom controller mapping file to load to
- complete default database (SDL backend only).
- Otherwise, file gamecontrollerdb.txt will be
- loaded from extrapath.
-music_driver string The music engine to use.
-opl_driver string The AdLib (OPL) emulator to use.
-output_rate number The output sample rate to use, in Hz. Sensible
- values are 11025, 22050 and 44100.
-audio_buffer_size number Overrides the size of the audio buffer. The
- value must be one of: 256 512 1024 2048 4096
- 8192 16384 32768. The default value is
- calculated based on the output_rate to keep
- audio latency below 45ms.
-alsa_port string Port to use for output when using the
- ALSA music driver.
-music_volume number The music volume setting (0-255)
-multi_midi bool If true, enable combination AdLib and native
- MIDI.
-soundfont string The SoundFont to use for MIDI playback. (Only
- supported by some MIDI drivers.)
-native_mt32 bool If true, disable GM emulation and assume that
- there is a true Roland MT-32 available.
-enable_gs bool If true, enable Roland GS-specific features to
- enhance GM emulation. If native_mt32 is also
- true, the GS device will select an MT-32 map
- to play the correct instruments.
-sfx_volume number The sfx volume setting (0-255)
-tempo number The music tempo (50-200) (default: 100)
-speech_volume number The speech volume setting (0-255)
-midi_gain number The MIDI gain (0-1000) (default: 100) (Only
- supported by some MIDI drivers.)
-
-copy_protection bool Enable copy protection in certain games, in
- those cases where ScummVM disables it by
- default.
-demo_mode bool Start demo in Maniac Mansion
-alt_intro bool Use alternative intro for CD versions of
- Beneath a Steel Sky and Flight of the Amazon
- Queen
-
-boot_param number Pass this number to the boot script
-````
-
-## Example file
-
-````
- [scummvm]
- gfx_mode=supereagle
- fullscreen=true
- savepath=C:\saves\
-
- [sky]
- path=C:\games\SteelSky\
-
- [germansky]
- gameid=sky
- language=de
- path=C:\games\SteelSky\
- description=Beneath a Steel Sky w/ German subtitles
-
- [germandott]
- gameid=tentacle
- path=C:\german\tentacle\
- description=German version of DOTT
-
- [tentacle]
- path=C:\tentacle\
- subtitles=true
- music_volume=40
- sfx_volume=255
-
- [loomcd]
- cdrom=1
- path=C:\loom\
- talkspeed=5
- savepath=C:\loom\saves\
-
- [monkey2]
- path=C:\amiga_mi2\
- music_driver=windows
-
-````
\ No newline at end of file
diff --git a/doc/docportal/advanced_options/configuration_file.rst b/doc/docportal/advanced_options/configuration_file.rst
new file mode 100755
index 0000000000..15fc0febb5
--- /dev/null
+++ b/doc/docportal/advanced_options/configuration_file.rst
@@ -0,0 +1,288 @@
+
+=======================
+The configuration file
+=======================
+
+The configuration file provides a way to edit both global and game-specific settings by using a text file containing configuration keywords and parameters.
+
+Settings are also accessible directly from :doc:`the Launcher <../using_scummvm/the_launcher>` . To edit global settings, click **Options**. To edit game-specific settings, highlight a game and then click **Edit Game**.
+
+Location
+==========
+The configuration file saves to different default locations depending on the platform ScummVM is running on.
+
+**Mac**:
+
+**Windows**:
+
+**Linux**:
+
+**iOS**:
+
+**Android**:
+
+Using the configuration file
+==================================
+
+Global settings are listed under the ``[scummvm]`` heading. Game settings are listed under the heading for that game, for example ``[queen]`` for Flight of the Amazon Queen. Use the configuration keywords_ to change settings.
+
+
+Example of a configuration file
+=================================
+
+.. code-block::
+
+ [scummvm]
+ gfx_mode=supereagle
+ fullscreen=true
+ savepath=C:\saves\
+
+ [sky]
+ path=C:\games\SteelSky\
+
+ [germansky]
+ gameid=sky
+ language=de
+ path=C:\games\SteelSky\
+ description=Beneath a Steel Sky w/ German subtitles
+
+ [germandott]
+ gameid=tentacle
+ path=C:\german\tentacle\
+ description=German version of DOTT
+
+ [tentacle]
+ path=C:\tentacle\
+ subtitles=true
+ music_volume=40
+ sfx_volume=255
+
+ [loomcd]
+ cdrom=1
+ path=C:\loom\
+ talkspeed=5
+ savepath=C:\loom\saves\
+
+ [monkey2]
+ path=C:\amiga_mi2\
+ music_driver=windows
+
+
+Keywords
+===========
+
+There are many recognized configuration keywords. In the table below, each keyword is linked to its description on either the :doc:`../using_scummvm/global_settings` or :doc:`../using_scummvm/game_settings` page.
+
+.. csv-table::
+ :widths: 25 10 25 40
+ :header-rows: 1
+
+ Keyword,Type,Default,Options
+ ":ref:`alt_intro <altintro>`",Boolean,FALSE,
+ ":ref:`altamigapalette <altamiga>`",Boolean,FALSE,
+ ":ref:`apple2gs_speedmenu <2gs>`",Boolean,FALSE,
+ ":ref:`aspect_ratio <ratio>`",Boolean,FALSE,
+ auto_savenames,Boolean,FALSE,
+ ":ref:`bilinear_filtering <bilinear>`",Boolean,FALSE,
+ ":ref:`bright_palette <bright>`",Boolean,TRUE,
+ ":ref:`color <color>`",Boolean,,
+ ":ref:`commandpromptwindow <cmd>`",Boolean,FALSE,
+ description,String,,
+ ":ref:`disable_dithering <dither>`",Boolean,FALSE,
+ ":ref:`disable_stamina_drain <stamina>`",Boolean,FALSE,
+ ":ref:`DurableArmor <durable>`",Boolean,FALSE,
+ ":ref:`EasyMouse <easy>`",Boolean,TRUE,
+ ":ref:`enable_black_lined_video <blackline>`",,FALSE,
+ ":ref:`enable_censoring <censor>`",Boolean,FALSE,
+ ":ref:`enable_color_blind <blind>`",Boolean,FALSE,
+ ":ref:`enable_gore <gore>`",Boolean,,
+ ":ref:`enable_gs <gs>`",Boolean,,
+ ":ref:`enable_high_resolution_graphics <hires>`",Boolean,TRUE,
+ ":ref:`enable_hq_video <hq>`",Boolean,TRUE,
+ ":ref:`enable_larryscale <larry>`",Boolean,TRUE,
+ ":ref:`enable_video_upscale <upscale>`",Boolean,TRUE,
+ ":ref:`extrapath <extra>`",String,None,Path
+ ":ref:`fade_style <fade>`",Boolean,TRUE,
+ ":ref:`filtering <filtering>`",Boolean,FALSE,
+ ":ref:`floating_cursors <floating>`",Boolean,FALSE,
+ ":ref:`fluidsynth_chorus_activate <chact>`",Boolean,TRUE,
+ ":ref:`fluidsynth_chorus_depth <chdepth>`",Number,80,0 - 210
+ ":ref:`fluidsynth_chorus_level <chlevel>`",Number,100,0 - 100
+ ":ref:`fluidsynth_chorus_nr <chnr>`",Integer,3,0 - 99
+ ":ref:`fluidsynth_chorus_speed <chspeed>`",Number,30,10 - 500
+ ":ref:`fluidsynth_chorus_waveform <chwave>`",String,Sine,"
+ - sine
+ - triangle"
+ ":ref:`fluidsynth_misc_interpolation <interp>`",String,4th,"
+ - none
+ - 4th
+ - 7th
+ - linear"
+ ":ref:`fluidsynth_reverb_activate <revact>`",Boolean,TRUE,
+ ":ref:`fluidsynth_reverb_damping <revdamp>`",Number,0,0 - 1
+ ":ref:`fluidsynth_reverb_level <revlevel>`",Number,90,0 - 100
+ ":ref:`fluidsynth_reverb_roomsize <revroom>`",Number,20,0 - 100
+ ":ref:`fluidsynth_reverb_width <revwidth>`",Number,1,0 - 100
+ ":ref:`frames_per_secondfl <fpsfl>`",Boolean,FALSE,
+ ":ref:`fullscreen <fullscreen>`",Boolean,FALSE,
+ ":ref:`gameid <gameid>`",String,,
+ ":ref:`gamepath <gamepath>`",String,,
+ ":ref:`gfx_mode <gfxmode>` ",String,2x,"
+ - 1x
+ - 2x
+ - 3x
+ - 2xsai
+ - super2xsai
+ - supereagle
+ - advmame2x
+ - advmame3x
+ - hq2x
+ - hq3x
+ - tv2x
+ - dot-matrix
+ - opengl "
+ ":ref:`gm_device <gm>`",String,null,"
+ - auto
+ - alsa_midi Through
+ - seq
+ - sndio
+ - fluidsynth
+ - timidity"
+ ":ref:`GraphicsDithering <gdither>`",,TRUE,
+ ":ref:`helium_mode <helium>`",,FALSE,
+ ":ref:`help_style <help>`",,FALSE,
+ ":ref:`herculesfont <herc>`",,FALSE,
+ ":ref:`hpbargraphs <hp>`",,TRUE,
+ ":ref:`hypercheat <hyper>`",,FALSE,
+ ":ref:`improved <improved>`",,TRUE,
+ ":ref:`InvObjectsAnimated <objanimated>`",,TRUE,
+ ":ref:`language <lang>`",String,,
+ ":ref:`local_server_port <serverport>`",integer,12345,
+ ":ref:`midi_gain <gain>`",Number,,0 - 1000
+ ":ref:`mm_nes_classic_palette <classic>`",Boolean,FALSE,
+ ":ref:`monotext <mono>`",Boolean,TRUE,
+ ":ref:`mousebtswap <btswap>`",Boolean,FALSE,
+ ":ref:`mousesupport <support>`",Boolean,TRUE,
+ ":ref:`mt32_device <mt32>`",String,,"
+ - Auto
+ - alsa_midi Through
+ - seq
+ - sndio
+ - fluidsynth
+ - mt32
+ - timidity "
+ ":ref:`multi_midi <multi>`",Boolean,,
+ ":ref:`music_driver <device>`",String,auto,"
+ - null
+ - auto
+ - alsa_Midi Through
+ - seq
+ - sndio
+ - fluidsynth
+ - mt32
+ - timidity
+ - pcspk
+ - pcjr
+ - cms
+ - adlib "
+ ":ref:`music_volume <music>`",Number,,"
+ - 0-256 "
+ ":ref:`mute <mute>`",Boolean,FALSE,
+ ":ref:`native_fb01 <fb01>`",,FALSE,
+ ":ref:`native_mt32 <nativemt32>`",Boolean,FALSE,
+ ":ref:`NaughtyMode <naughty>`",,TRUE,
+ ":ref:`nodelaymillisfl <nodelay>`",,FALSE,
+ ":ref:`ntsc <ntsc>`",,?,
+ ":ref:`object_labels <labels>`",,TRUE,
+ ":ref:`opl_driver <opl>`",String,,"
+ - auto
+ - mame
+ - db
+ - nuked
+ - alsa
+ - op2lpt
+ - op3lpt "
+ ":ref:`originalsaveload <osl>`",Boolean,FALSE,
+ ":ref:`platform <platform>`",String,,
+ ":ref:`portaits_on, <portraits>`",Boolean,TRUE,
+ ":ref:`prefer_digitalsfx <dsfx>`",Boolean,TRUE,
+ ":ref:`render_mode <render>`",String,,"
+ - hercGreen
+ - hercAmber
+ - cga
+ - ega
+ - vga
+ - amiga
+ - fmtowns
+ - pc9821
+ - pc9801
+ - 2gs
+ - atari
+ - macintosh "
+ ":ref:`rootpath <rootpath>`",string,,
+ ":ref:`savepath <savepath>`",String,,
+ ":ref:`scalemakingofvideos <scale>`",Boolean,FALSE,
+ ":ref:`scanlines <scan>`",Boolean,FALSE,
+ ":ref:`shorty <shorty>`",Boolean,FALSE,
+ ":ref:`show_fps <fps>`",Boolean,FALSE,
+ ":ref:`ShowItemCosts <cost>`",Boolean,FALSE,
+ ":ref:`silver_cursors <silver>`",Boolean,FALSE,
+ ":ref:`sitcom <sitcom>`",Boolean,FALSE,
+ ":ref:`skip_support <skip>`",Boolean,TRUE,
+ ":ref:`skiphallofrecordsscenes <skiphall>`",Boolean,FALSE,
+ ":ref:`smooth_scrolling <smooth>`",Boolean,TRUE,
+ ":ref:`speech_mute <speechmute>`",Boolean,FALSE,
+ ":ref:`stretch_mode <stretchmode>`",String,,"
+ - center
+ - pixel-perfect
+ - fit
+ - stretch
+ - fit_force_aspect "
+ ":ref:`studio_audience <studio>`",Boolean,TRUE,
+ ":ref:`subtitles <speechmute>`",Boolean,FALSE,
+ ":ref:`talkspeed <talkspeed>`",Number,60,
+ " - 0 - 255 "
+ ":ref:`TextWindowAnimated <textanimated>`",Boolean,TRUE,
+ ":ref:`themepath <themepath>`",String,none,
+ ":ref:`transparent_windows <transparentwindows>`",Boolean,TRUE,
+ ":ref:`transparentdialogboxes <transparentdialog>`",Boolean,FALSE,
+ ":ref:`tts_enabled <ttsenabled>`",Boolean,FALSE,
+ ":ref:`tts_narrator <ttsnarrator>`",Boolean,FALSE,
+ ":ref:`use_cdaudio <cd>`",Boolean,TRUE,
+ ":ref:`window_style <style>`",Boolean,TRUE,
+ ":ref:`windows_cursors <wincursors>`",Boolean,FALSE,
+ save_slot,Number,,
+ Savepath,String,,
+ screenshotpath,String,,
+ iconpath,String,,
+ versioninfo,String,,
+ gameid,String,,
+ description,String,,
+ confirm_exit,Boolean,,
+ console,Boolean,TRUE,Windows only
+ cdrom,Number,,
+ joystick_num,Number,,
+ controller_map_db,String,,
+ audio_buffer_size,Number,"Calculated to keep
+ below 45ms","
+ - 256
+ - 512
+ - 1024
+ - 2048
+ - 4096
+ - 8192
+ - 16384
+ - 32768"
+ output_rate,Number,,"
+ - The output sample rate to use, in Hz.
+ - Sensible values are 11025, 22050 or 44100."
+ alsa_port,Number,,"Port to use for output when
+
+ using the ALSA music driver."
+ tempo,Number,100,"
+ - 50-200"
+ copy_protection,boolean,FALSE,
+ demo_mode,,FALSE,Start demo mode in MM
+ boot_param,Number,none,Pass this number to boot script.
+
+
Commit: dde4138985f616fda7ae64db3d7f6f18856826f7
https://github.com/scummvm/scummvm/commit/dde4138985f616fda7ae64db3d7f6f18856826f7
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: reformats CLI options into table
Changed paths:
A doc/docportal/advanced_options/command_line.rst
diff --git a/doc/docportal/advanced_options/command_line.rst b/doc/docportal/advanced_options/command_line.rst
new file mode 100755
index 0000000000..f0ea595ce0
--- /dev/null
+++ b/doc/docportal/advanced_options/command_line.rst
@@ -0,0 +1,145 @@
+
+=======================
+Command line interface
+=======================
+
+Launching ScummVM from the command line allows you to pass a number of options, some of which override the applicable :doc:`global <../using_scummvm/global_settings>` or :doc:`game-specific <../using_scummvm/game_settings>` settings.
+
+Some other options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without opening the Launcher or starting a game.
+
+Short options are listed where they are available.
+
+.. csv-table::
+ :header-rows: 1
+
+ Option,Short,Description
+ \--add,-a,"Add all games from current or specified directory.
+
+ If \--game=ID is passed only the game with id ID is added.
+
+ See also \--detect.
+
+ Use \--path=PATH before -a, \--add to specify a directory."
+ \--alt-intro, ,":ref:`Use alternative intro for CD versions <altintro>`"
+ \--aspect-ratio,,":ref:`Enable aspect ratio correction <ratio>`"
+ \--auto-detect,,"Display a list of games from current or specified directory
+
+ and start the first one.
+
+ Use \--path=PATH before \--auto-detect to specify a directory."
+ \--boot-param=NUM,-b,"Pass number to the boot script (boot param)"
+ \--cdrom=DRIVE,,"CD drive to play CD audio from;
+
+ can either be a drive, path, or numeric index
+
+ (default: 0 = best choice drive)"
+ \--config=FILE,-c,"Use alternate configuration file"
+ \--copy-protection,,"Enable copy protection"
+ \--debug-channels-only,,"Show only the specified debug channels"
+ \--debugflags=FLAGS,,"Enable engine specific debug flags"
+ \--debuglevel=NUM,-d,"Set debug verbosity level"
+ \--demo-mode,,"Start demo mode of Maniac Mansion or The 7th Guest"
+ \--detect,,"Display a list of games with their ID from current or specified directory
+
+ without adding it to the config.
+
+ Use \--path=PATH before \--detect to specify a directory."
+ \--dimuse-tempo=NUM,,"Set internal Digital iMuse tempo (10 - 100) per second (default: 10)"
+ \--dump-scripts,-u,"Enable script dumping if a directory called
+
+ 'dumps' exists in the current directory"
+ \--enable-gs,,"Enable Roland GS mode for MIDI playback"
+ \--extrapath=PATH,,":ref:`Extra path to additional game data <extra>`"
+ \--filtering,,":ref:`Force filtered graphics mode <filtering>`"
+ \--fullscreen,-f,":ref:`Force full-screen mode <fullscreen>`"
+ \--game=ID,,"In combination with \--add or \--detect
+
+ only adds or attempts to detect the game with id ID."
+ \--gfx-mode,-g,":ref:`Select graphics scaler <gfxmode>`"
+ \--gui-theme=THEME,,":ref:`Select GUI theme <theme>`"
+ \--help,-h,"Display a brief help text and exit"
+ \--joystick[=NUM],,"Enable joystick input (default: 0 = first joystick)"
+ \--language,-q,":ref:`Select language <lang>` (en,de,fr,it,
+
+ pt,es,jp,zh,kr,se,gb,hb,ru,cz)"
+ \--list-audio-devices,,"List all available audio devices"
+ \--list-saves=TARGET,,"Display a list of saved games for the game (TARGET) specified"
+ \--list-targets,-t,"Display list of configured targets and exit"
+ \--list-themes,,"Display list of all usable GUI themes"
+ --midi-gain=NUM,,":ref:`Set the gain for MIDI playback <gain>`
+
+ 0-1000 (default: 100)
+
+ Only supported by some MIDI drivers"
+ \--multi-midi,,":ref:`Enable combination AdLib and native MIDI <multi>`"
+ \--music-driver=MODE,-e,":ref:`Select preferred music device <device>`"
+ \--music-volume=NUM,-m,":ref:`Set the music volume <music>`, 0-255 (default: 192)"
+ \--native-mt32,,":ref:`True Roland MT-32 (disable GM emulation) <mt32>`"
+ \--no-filtering,,"Force unfiltered graphics mode"
+ \--no-fullscreen,-F,"Force windowed mode"
+ \--opl-driver=DRIVER,,":ref:`Select AdLib (OPL) emulator <opl>`"
+ \--output-rate=RATE,,"Select output sample rate in Hz"
+ \--path=PATH,-p,"Path to where the game is installed"
+ \--platform=STRING,,":ref:`Specify platform of game <platform>`
+ (allowed values: 2gs, 3do, acorn,
+
+ amiga, atari, c64, fmtowns, nes, mac, pc pc98,
+
+ pce, segacd, wii, windows)"
+ \--recursive,,"In combination with \--add or \--detect recurse down all subdirectories"
+ \--render-mode=MODE,,":ref:`Enable additional render modes <render>`"
+ \--save-slot=NUM,-x,"Save game slot to load (default: autosave)"
+ \--savepath=PATH,,":ref:`Path to where saved games are stored <savepath>`"
+ \--sfx-volume=NUM,-s,":ref:`Set the sfx volume <sfx>`, 0-255 (default: 192)"
+ \--soundfont=FILE,,":ref:`Select the SoundFont for MIDI playback. <soundfont>`
+
+ Only supported by some MIDI drivers."
+ \--speech-volume=NUM,-r,":ref:`Set the speech volume <speechvol>`, 0-255 (default: 192)"
+ \--subtitles,-n,":ref:`Enable subtitles <speechmute>`"
+ \--talkspeed=NUM,,":ref:`Set talk speed for games <talkspeed>` (default: 60)"
+ \--tempo=NUM,,"Set music tempo (in percent, 50-200) for SCUMM games (default: 100)"
+ \--themepath=PATH,,"Path to where GUI themes are stored"
+ \--version,-v,"Display ScummVM version information and exit"
+
+The meaning of most long options can be inverted by prefixing them with ``no-``. For example, ``--no-aspect-ratio`` will turn aspect ratio correction off.
+
+
+Example
+------------
+
+.. tabs::
+
+ .. tab::
+
+ **Windows**
+
+ Running Monkey Island, fullscreen, from a hard disk:
+
+ .. code::
+
+ C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\monkey
+
+
+ Running Full Throttle from CD, fullscreen and with subtitles enabled:
+
+ .. code::
+
+ C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ft
+
+ .. tab::
+
+ **Linux/Unix**
+
+ Running Monkey Island, fullscreen, from a hard disk:
+
+ .. code::
+
+ /path/to/scummvm -f -p/games/LucasArts/monkey/monkey
+
+
+ Running Full Throttle from CD, fullscreen and with subtitles enabled:
+
+ .. code::
+
+ /path/to/scummvm -f -n -p/cdrom/resource/ft
+
Commit: c54a4431d9e634e7a6785f28b0a22d45551442f3
https://github.com/scummvm/scummvm/commit/c54a4431d9e634e7a6785f28b0a22d45551442f3
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds config file paths + readability edits
Changed paths:
doc/docportal/advanced_options/configuration_file.rst
diff --git a/doc/docportal/advanced_options/configuration_file.rst b/doc/docportal/advanced_options/configuration_file.rst
index 15fc0febb5..87876b5147 100755
--- a/doc/docportal/advanced_options/configuration_file.rst
+++ b/doc/docportal/advanced_options/configuration_file.rst
@@ -5,21 +5,51 @@ The configuration file
The configuration file provides a way to edit both global and game-specific settings by using a text file containing configuration keywords and parameters.
-Settings are also accessible directly from :doc:`the Launcher <../using_scummvm/the_launcher>` . To edit global settings, click **Options**. To edit game-specific settings, highlight a game and then click **Edit Game**.
+Settings are also accessible directly from :doc:`the Launcher <../using_scummvm/the_launcher>` . To edit :doc:`global settings <../using_scummvm/global_settings>`, click **Options**. To edit :doc:`game-specific settings <../using_scummvm/game_settings>`, highlight a game and then click **Edit Game**.
Location
==========
-The configuration file saves to different default locations depending on the platform ScummVM is running on.
-**Mac**:
+The configuration file saves to different default locations, depending on the platform.
-**Windows**:
-**Linux**:
-**iOS**:
+.. tabs::
-**Android**:
+ .. tab:: Mac OSX
+
+ ``~/Library/Preferences/ScummVM Preferences``, where ``~`` is your Home directory.
+
+ Note that if an earlier version of ScummVM was installed on your system, the previous default location of ``~/.scummvmrc`` will be kept.
+
+ .. tab:: Windows
+
+ **95/98/ME**:
+ ``<windir>\scummvm.ini``
+
+ **Windows NT4**: ``<windir>\Profiles\username\Application Data\ScummVM\scummvm.ini``
+
+ **Windows 2000/XP**: ``\Documents and Settings\username\Application Data\ScummVM\scummvm.ini``
+
+ **Window 7/Vista**: ``\Users\username\AppData\Roaming\ScummVM\scummvm.ini``
+
+ Note that if an earlier version of ScummVM was installed under Windows, the previous default location of <windir>\scummvm.ini will be kept.
+
+ .. tab:: Linux/Unix
+
+ We follow the XDG Base Directory Specification. This means our configuration can be found in ``$XDG_CONFIG_HOME/scummvm/scummvm.ini``
+
+ If XDG_CONFIG_HOME is not defined or empty, ``~/.config`` will be used, where ``~`` is your Home directory.
+
+ Note that ``.config`` is a hidden directory; to view it use ``ls -a`` on the command line. If you are using a GUI file manager, go to **View > Show Hidden Files**, or use the keyboard shortcut :kbd:`Ctrl + H`.
+
+ .. tab:: iOS
+
+ ``/var/mobile/Library/ScummVM/Preferences`` or ``/Preferences`` for a sandboxed version.
+
+ .. tab:: Other
+
+ ``scummvm.ini`` in the ScummVM directory.
Using the configuration file
==================================
@@ -30,7 +60,7 @@ Global settings are listed under the ``[scummvm]`` heading. Game settings are li
Example of a configuration file
=================================
-.. code-block::
+.. code::
[scummvm]
gfx_mode=supereagle
@@ -71,218 +101,229 @@ Example of a configuration file
Keywords
===========
-There are many recognized configuration keywords. In the table below, each keyword is linked to its description on either the :doc:`../using_scummvm/global_settings` or :doc:`../using_scummvm/game_settings` page.
+There are many recognized configuration keywords. In the table below, each keyword is linked to an explanatory description on either the :doc:`../using_scummvm/global_settings` or :doc:`../using_scummvm/game_settings` page.
.. csv-table::
- :widths: 25 10 25 40
+ :widths: 25, 25, 15, 35
:header-rows: 1
Keyword,Type,Default,Options
- ":ref:`alt_intro <altintro>`",Boolean,FALSE,
- ":ref:`altamigapalette <altamiga>`",Boolean,FALSE,
- ":ref:`apple2gs_speedmenu <2gs>`",Boolean,FALSE,
- ":ref:`aspect_ratio <ratio>`",Boolean,FALSE,
- auto_savenames,Boolean,FALSE,
- ":ref:`bilinear_filtering <bilinear>`",Boolean,FALSE,
- ":ref:`bright_palette <bright>`",Boolean,TRUE,
- ":ref:`color <color>`",Boolean,,
- ":ref:`commandpromptwindow <cmd>`",Boolean,FALSE,
- description,String,,
- ":ref:`disable_dithering <dither>`",Boolean,FALSE,
- ":ref:`disable_stamina_drain <stamina>`",Boolean,FALSE,
- ":ref:`DurableArmor <durable>`",Boolean,FALSE,
- ":ref:`EasyMouse <easy>`",Boolean,TRUE,
- ":ref:`enable_black_lined_video <blackline>`",,FALSE,
- ":ref:`enable_censoring <censor>`",Boolean,FALSE,
- ":ref:`enable_color_blind <blind>`",Boolean,FALSE,
- ":ref:`enable_gore <gore>`",Boolean,,
- ":ref:`enable_gs <gs>`",Boolean,,
- ":ref:`enable_high_resolution_graphics <hires>`",Boolean,TRUE,
- ":ref:`enable_hq_video <hq>`",Boolean,TRUE,
- ":ref:`enable_larryscale <larry>`",Boolean,TRUE,
- ":ref:`enable_video_upscale <upscale>`",Boolean,TRUE,
- ":ref:`extrapath <extra>`",String,None,Path
- ":ref:`fade_style <fade>`",Boolean,TRUE,
- ":ref:`filtering <filtering>`",Boolean,FALSE,
- ":ref:`floating_cursors <floating>`",Boolean,FALSE,
- ":ref:`fluidsynth_chorus_activate <chact>`",Boolean,TRUE,
- ":ref:`fluidsynth_chorus_depth <chdepth>`",Number,80,0 - 210
- ":ref:`fluidsynth_chorus_level <chlevel>`",Number,100,0 - 100
- ":ref:`fluidsynth_chorus_nr <chnr>`",Integer,3,0 - 99
- ":ref:`fluidsynth_chorus_speed <chspeed>`",Number,30,10 - 500
- ":ref:`fluidsynth_chorus_waveform <chwave>`",String,Sine,"
- - sine
- - triangle"
- ":ref:`fluidsynth_misc_interpolation <interp>`",String,4th,"
- - none
- - 4th
- - 7th
- - linear"
- ":ref:`fluidsynth_reverb_activate <revact>`",Boolean,TRUE,
- ":ref:`fluidsynth_reverb_damping <revdamp>`",Number,0,0 - 1
- ":ref:`fluidsynth_reverb_level <revlevel>`",Number,90,0 - 100
- ":ref:`fluidsynth_reverb_roomsize <revroom>`",Number,20,0 - 100
- ":ref:`fluidsynth_reverb_width <revwidth>`",Number,1,0 - 100
- ":ref:`frames_per_secondfl <fpsfl>`",Boolean,FALSE,
- ":ref:`fullscreen <fullscreen>`",Boolean,FALSE,
- ":ref:`gameid <gameid>`",String,,
- ":ref:`gamepath <gamepath>`",String,,
- ":ref:`gfx_mode <gfxmode>` ",String,2x,"
- - 1x
- - 2x
- - 3x
- - 2xsai
- - super2xsai
- - supereagle
- - advmame2x
- - advmame3x
- - hq2x
- - hq3x
- - tv2x
- - dot-matrix
- - opengl "
- ":ref:`gm_device <gm>`",String,null,"
- - auto
- - alsa_midi Through
- - seq
- - sndio
- - fluidsynth
- - timidity"
- ":ref:`GraphicsDithering <gdither>`",,TRUE,
- ":ref:`helium_mode <helium>`",,FALSE,
- ":ref:`help_style <help>`",,FALSE,
- ":ref:`herculesfont <herc>`",,FALSE,
- ":ref:`hpbargraphs <hp>`",,TRUE,
- ":ref:`hypercheat <hyper>`",,FALSE,
- ":ref:`improved <improved>`",,TRUE,
- ":ref:`InvObjectsAnimated <objanimated>`",,TRUE,
- ":ref:`language <lang>`",String,,
+ alsa_port,number,,
+ ":ref:`alt_intro <altintro>`",boolean,false,
+ ":ref:`altamigapalette <altamiga>`",boolean,false,
+ ":ref:`apple2gs_speedmenu <2gs>`",boolean,false,
+ ":ref:`aspect_ratio <ratio>`",boolean,false,
+ audio_buffer_size,number,"Calculated","
+ - 256
+ - 512
+ - 1024
+ - 2048
+ - 4096
+ - 8192
+ - 16384
+ - 32768"
+ auto_savenames,boolean,false,
+
+ ":ref:`bilinear_filtering <bilinear>`",boolean,false,
+ boot_param,number,none,
+ ":ref:`bright_palette <bright>`",boolean,true,
+ cdrom,number,,
+ ":ref:`color <color>`",boolean,,
+ ":ref:`commandpromptwindow <cmd>`",boolean,false,
+ confirm_exit,boolean,,
+ console,boolean,true,
+ controller_map_db,string,,
+ copy_protection,boolean,false,
+ demo_mode,,false,
+ ":ref:`description <description>`",string,,
+ ":ref:`disable_dithering <dither>`",boolean,false,
+ ":ref:`disable_stamina_drain <stamina>`",boolean,false,
+ ":ref:`DurableArmor <durable>`",boolean,false,
+ ":ref:`EasyMouse <easy>`",boolean,true,
+ ":ref:`enable_black_lined_video <blackline>`",,false,
+ ":ref:`enable_censoring <censor>`",boolean,false,
+ ":ref:`enable_color_blind <blind>`",boolean,false,
+ ":ref:`enable_gore <gore>`",boolean,,
+ ":ref:`enable_gs <gs>`",boolean,,
+ ":ref:`enable_high_resolution_graphics <hires>`",boolean,true,
+ ":ref:`enable_hq_video <hq>`",boolean,true,
+ ":ref:`enable_larryscale <larry>`",boolean,true,
+ ":ref:`enable_video_upscale <upscale>`",boolean,true,
+ ":ref:`extrapath <extra>`",string,None," path"
+ ":ref:`fade_style <fade>`",boolean,true,
+ ":ref:`filtering <filtering>`",boolean,false,
+ ":ref:`floating_cursors <floating>`",boolean,false,
+ ":ref:`fluidsynth_chorus_activate <chact>`",boolean,true,
+ ":ref:`fluidsynth_chorus_depth <chdepth>`",number,80,"- 0 - 210"
+ ":ref:`fluidsynth_chorus_level <chlevel>`",number,100,"- 0 - 100"
+ ":ref:`fluidsynth_chorus_nr <chnr>`",integer,3,"- 0 - 99"
+ ":ref:`fluidsynth_chorus_speed <chspeed>`",number,30,"- 10 - 500"
+ ":ref:`fluidsynth_chorus_waveform <chwave>`",string,Sine,"
+ - sine
+ - triangle"
+ ":ref:`fluidsynth_misc_interpolation <interp>`",string,4th,"
+ - none
+ - 4th
+ - 7th
+ - linear."
+ ":ref:`fluidsynth_reverb_activate <revact>`",boolean,true,
+ ":ref:`fluidsynth_reverb_damping <revdamp>`",number,0,"- 0 - 1"
+ ":ref:`fluidsynth_reverb_level <revlevel>`",number,90,"- 0 - 100"
+ ":ref:`fluidsynth_reverb_roomsize <revroom>`",number,20,"- 0 - 100"
+ ":ref:`fluidsynth_reverb_width <revwidth>`",number,1,"- 0 - 100"
+ ":ref:`frames_per_secondfl <fpsfl>`",boolean,false,
+ ":ref:`fullscreen <fullscreen>`",boolean,false,
+ ":ref:`gameid <gameid>`",string,,
+ ":ref:`gamepath <gamepath>`",string,,
+ ":ref:`gfx_mode <gfxmode>`",string,2x,"
+ - 1x
+ - 2x
+ - 3x
+ - 2xsai
+ - super2xsai
+ - supereagle
+ - advmame2x
+ - advmame3x
+ - hq2x
+ - hq3x
+ - tv2x
+ - dot-matrix
+ - opengl"
+ ":ref:`gm_device <gm>`",string,null,"
+ - auto
+ - alsa_midi Through
+ - seq
+ - sndio
+ - fluidsynth
+ - timidity"
+ ":ref:`GraphicsDithering <gdither>`",,true,
+ ":ref:`helium_mode <helium>`",,false,
+ ":ref:`help_style <help>`",,false,
+ ":ref:`herculesfont <herc>`",,false,
+ ":ref:`hpbargraphs <hp>`",,true,
+ ":ref:`hypercheat <hyper>`",,false,
+ iconpath,string,,
+ ":ref:`improved <improved>`",,true,
+ ":ref:`InvObjectsAnimated <objanimated>`",,true,
+ joystick_num,number,,
+ ":ref:`language <lang>`",string,,
":ref:`local_server_port <serverport>`",integer,12345,
- ":ref:`midi_gain <gain>`",Number,,0 - 1000
- ":ref:`mm_nes_classic_palette <classic>`",Boolean,FALSE,
- ":ref:`monotext <mono>`",Boolean,TRUE,
- ":ref:`mousebtswap <btswap>`",Boolean,FALSE,
- ":ref:`mousesupport <support>`",Boolean,TRUE,
- ":ref:`mt32_device <mt32>`",String,,"
- - Auto
- - alsa_midi Through
- - seq
- - sndio
- - fluidsynth
- - mt32
- - timidity "
- ":ref:`multi_midi <multi>`",Boolean,,
- ":ref:`music_driver <device>`",String,auto,"
- - null
- - auto
- - alsa_Midi Through
- - seq
- - sndio
- - fluidsynth
- - mt32
- - timidity
- - pcspk
- - pcjr
- - cms
- - adlib "
- ":ref:`music_volume <music>`",Number,,"
- - 0-256 "
- ":ref:`mute <mute>`",Boolean,FALSE,
- ":ref:`native_fb01 <fb01>`",,FALSE,
- ":ref:`native_mt32 <nativemt32>`",Boolean,FALSE,
- ":ref:`NaughtyMode <naughty>`",,TRUE,
- ":ref:`nodelaymillisfl <nodelay>`",,FALSE,
+ ":ref:`midi_gain <gain>`",number,,"- 0 - 1000"
+ ":ref:`mm_nes_classic_palette <classic>`",boolean,false,
+ ":ref:`monotext <mono>`",boolean,true,
+ ":ref:`mousebtswap <btswap>`",boolean,false,
+ ":ref:`mousesupport <support>`",boolean,true,
+ ":ref:`mt32_device <mt32>`",string,,"
+ - auto
+ - alsa_midi Through
+ - seq
+ - sndio
+ - fluidsynth
+ - mt32
+ - timidity "
+ ":ref:`multi_midi <multi>`",boolean,,
+ ":ref:`music_driver <device>`",string,auto,"
+ - null
+ - auto
+ - alsa_Midi Through
+ - seq
+ - sndio
+ - fluidsynth
+ - mt32
+ - timidity
+ - pcspk
+ - pcjr
+ - cms
+ - adlib "
+ ":ref:`music_volume <music>`",number,,"- 0-256 "
+ ":ref:`mute <mute>`",boolean,false,
+ ":ref:`native_fb01 <fb01>`",,false,
+ ":ref:`native_mt32 <nativemt32>`",boolean,false,
+ ":ref:`NaughtyMode <naughty>`",,true,
+ ":ref:`nodelaymillisfl <nodelay>`",,false,
":ref:`ntsc <ntsc>`",,?,
- ":ref:`object_labels <labels>`",,TRUE,
- ":ref:`opl_driver <opl>`",String,,"
- - auto
- - mame
- - db
- - nuked
- - alsa
- - op2lpt
- - op3lpt "
- ":ref:`originalsaveload <osl>`",Boolean,FALSE,
- ":ref:`platform <platform>`",String,,
- ":ref:`portaits_on, <portraits>`",Boolean,TRUE,
- ":ref:`prefer_digitalsfx <dsfx>`",Boolean,TRUE,
- ":ref:`render_mode <render>`",String,,"
- - hercGreen
- - hercAmber
- - cga
- - ega
- - vga
- - amiga
- - fmtowns
- - pc9821
- - pc9801
- - 2gs
- - atari
- - macintosh "
+ ":ref:`object_labels <labels>`",,true,
+ ":ref:`opl_driver <opl>`",string,,"
+ - auto
+ - mame
+ - db
+ - nuked
+ - alsa
+ - op2lpt
+ - op3lpt "
+ ":ref:`originalsaveload <osl>`",boolean,false,
+ output_rate,number,,"
+ Sensible values are:
+
+ - 11025
+ - 22050
+ - 44100"
+ ":ref:`platform <platform>`",string,,
+ ":ref:`portaits_on, <portraits>`",boolean,true,
+ ":ref:`prefer_digitalsfx <dsfx>`",boolean,true,
+ ":ref:`render_mode <render>`",string,,"
+ - hercGreen
+ - hercAmber
+ - cga
+ - ega
+ - vga
+ - amiga
+ - fmtowns
+ - pc9821
+ - pc9801
+ - 2gs
+ - atari
+ - macintosh "
":ref:`rootpath <rootpath>`",string,,
- ":ref:`savepath <savepath>`",String,,
- ":ref:`scalemakingofvideos <scale>`",Boolean,FALSE,
- ":ref:`scanlines <scan>`",Boolean,FALSE,
- ":ref:`shorty <shorty>`",Boolean,FALSE,
- ":ref:`show_fps <fps>`",Boolean,FALSE,
- ":ref:`ShowItemCosts <cost>`",Boolean,FALSE,
- ":ref:`silver_cursors <silver>`",Boolean,FALSE,
- ":ref:`sitcom <sitcom>`",Boolean,FALSE,
- ":ref:`skip_support <skip>`",Boolean,TRUE,
- ":ref:`skiphallofrecordsscenes <skiphall>`",Boolean,FALSE,
- ":ref:`smooth_scrolling <smooth>`",Boolean,TRUE,
- ":ref:`speech_mute <speechmute>`",Boolean,FALSE,
- ":ref:`stretch_mode <stretchmode>`",String,,"
- - center
- - pixel-perfect
- - fit
- - stretch
- - fit_force_aspect "
- ":ref:`studio_audience <studio>`",Boolean,TRUE,
- ":ref:`subtitles <speechmute>`",Boolean,FALSE,
- ":ref:`talkspeed <talkspeed>`",Number,60,
- " - 0 - 255 "
- ":ref:`TextWindowAnimated <textanimated>`",Boolean,TRUE,
- ":ref:`themepath <themepath>`",String,none,
- ":ref:`transparent_windows <transparentwindows>`",Boolean,TRUE,
- ":ref:`transparentdialogboxes <transparentdialog>`",Boolean,FALSE,
- ":ref:`tts_enabled <ttsenabled>`",Boolean,FALSE,
- ":ref:`tts_narrator <ttsnarrator>`",Boolean,FALSE,
- ":ref:`use_cdaudio <cd>`",Boolean,TRUE,
- ":ref:`window_style <style>`",Boolean,TRUE,
- ":ref:`windows_cursors <wincursors>`",Boolean,FALSE,
- save_slot,Number,,
- Savepath,String,,
- screenshotpath,String,,
- iconpath,String,,
- versioninfo,String,,
- gameid,String,,
- description,String,,
- confirm_exit,Boolean,,
- console,Boolean,TRUE,Windows only
- cdrom,Number,,
- joystick_num,Number,,
- controller_map_db,String,,
- audio_buffer_size,Number,"Calculated to keep
- below 45ms","
- - 256
- - 512
- - 1024
- - 2048
- - 4096
- - 8192
- - 16384
- - 32768"
- output_rate,Number,,"
- - The output sample rate to use, in Hz.
- - Sensible values are 11025, 22050 or 44100."
- alsa_port,Number,,"Port to use for output when
+ ":ref:`savepath <savepath>`",string,,
+ save_slot,number,,
+ ":ref:`scalemakingofvideos <scale>`",boolean,false,
+ ":ref:`scanlines <scan>`",boolean,false,
+ screenshotpath,string,,
+ ":ref:`shorty <shorty>`",boolean,false,
+ ":ref:`show_fps <fps>`",boolean,false,
+ ":ref:`ShowItemCosts <cost>`",boolean,false,
+ ":ref:`silver_cursors <silver>`",boolean,false,
+ ":ref:`sitcom <sitcom>`",boolean,false,
+ ":ref:`skip_support <skip>`",boolean,true,
+ ":ref:`skiphallofrecordsscenes <skiphall>`",boolean,false,
+ ":ref:`smooth_scrolling <smooth>`",boolean,true,
+ ":ref:`speech_mute <speechmute>`",boolean,false,
+ ":ref:`stretch_mode <stretchmode>`",string,,"
+ - center
+ - pixel-perfect
+ - fit
+ - stretch
+ - fit_force_aspect "
+ ":ref:`studio_audience <studio>`",boolean,true,
+ ":ref:`subtitles <speechmute>`",boolean,false,
+ ":ref:`talkspeed <talkspeed>`",number,60,"- 0 - 255 "
+ tempo,number,100,"- 50-200"
+ ":ref:`TextWindowAnimated <textanimated>`",boolean,true,
+ ":ref:`themepath <themepath>`",string,none,
+ ":ref:`transparent_windows <transparentwindows>`",boolean,true,
+ ":ref:`transparentdialogboxes <transparentdialog>`",boolean,false,
+ ":ref:`tts_enabled <ttsenabled>`",boolean,false,
+ ":ref:`tts_narrator <ttsnarrator>`",boolean,false,
+ ":ref:`use_cdaudio <cd>`",boolean,true,
+ versioninfo,string,,
+ ":ref:`window_style <style>`",boolean,true,
+ ":ref:`windows_cursors <wincursors>`",boolean,false,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- using the ALSA music driver."
- tempo,Number,100,"
- - 50-200"
- copy_protection,boolean,FALSE,
- demo_mode,,FALSE,Start demo mode in MM
- boot_param,Number,none,Pass this number to boot script.
Commit: 1fb5055bb163fc2827b9b3c2e20d0da868832ec5
https://github.com/scummvm/scummvm/commit/1fb5055bb163fc2827b9b3c2e20d0da868832ec5
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: replaced with .rst file
Changed paths:
R doc/docportal/advanced_options/command_line.md
diff --git a/doc/docportal/advanced_options/command_line.md b/doc/docportal/advanced_options/command_line.md
deleted file mode 100755
index 0b219ab607..0000000000
--- a/doc/docportal/advanced_options/command_line.md
+++ /dev/null
@@ -1,217 +0,0 @@
-# Command line interface
-
-## Launching ScummVM
-
-### Usage
-
-````bash
-scummvm [OPTIONS] [GAME]
-````
-
-### [GAME]
-
-[GAME] is the game id of the game you wish to launch. For example, 'monkey' for Monkey Island.
-
-The game id may be the default game id, or a user configured id set either directly in the game-specific section of the configuration file or in the Launcher [game settings window](using/game_settings).
-
-### [OPTIONS]
-
-[OPTIONS] refers to any of the following options:
-
-````bash
--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
---list-saves=TARGET Display a list of saved games for the game (TARGET) specified
--a, --add Add all games from current or specified directory.
- If --game=ID is passed only the game with id ID is added. See also --detect
- Use --path=PATH before -a, --add to specify a directory.
---detect Display a list of games with their ID from current or
- specified directory without adding it to the config.
- Use --path=PATH before --detect to specify a directory.
---game=ID In combination with --add or --detect only adds or attempts to
- detect the game with id ID.
---auto-detect Display a list of games from current or specified directory
- and start the first one. Use --path=PATH before --auto-detect
- to specify a directory.
---recursive In combination with --add or --detect recurse down all subdirectories
-
--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 (1x,2x,3x,2xsai,super2xsai,
- supereagle,advmame2x,advmame3x,hq2x,hq3x,tv2x,
- dotmatrix)
---filtering Force filtered graphics mode
---no-filtering Force unfiltered graphics mode
---gui-theme=THEME Select GUI theme
---themepath=PATH Path to where GUI themes are stored
---list-themes Display list of all usable GUI themes
--e, --music-driver=MODE Select music driver (see README for details)
---list-audio-devices List all available audio devices
--q, --language=LANG Select language (en,de,fr,it,pt,es,jp,zh,kr,se,gb,
- hb,ru,cz)
--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 speech 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
---debugflags=FLAGS Enable engine specific debug flags
- (separated by commas)
---debug-channels-only Show only the specified debug channels
--u, --dump-scripts Enable script dumping if a directory called 'dumps'
- exists in the current directory
-
---cdrom=DRIVE CD drive to play CD audio from; can either be a
- drive, path, or numeric index (default: 0 = best
- choice drive)
---joystick[=NUM] Enable joystick input (default: 0 = first joystick)
---platform=WORD Specify platform of game (allowed values: 2gs, 3do,
- acorn, amiga, atari, c64, fmtowns, nes, mac, pc, pc98,
- pce, segacd, wii, windows)
---savepath=PATH Path to where saved games are stored
---extrapath=PATH Extra path to additional game data
---soundfont=FILE Select the SoundFont for MIDI playback (only
- supported by some MIDI drivers)
---multi-midi Enable combination AdLib and native MIDI
---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)
---opl-driver=DRIVER Select AdLib (OPL) emulator (db, mame)
---aspect-ratio Enable aspect ratio correction
---render-mode=MODE Enable additional render modes (hercGreen, hercAmber,
- cga, ega, vga, amiga, fmtowns, pc9821, pc9801, 2gs,
- atari, macintosh)
-
---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.
---talkspeed=NUM Set talk speed for games (default: 60)
---demo-mode Start demo mode of Maniac Mansion or The 7th Guest
---tempo=NUM Set music tempo (in percent, 50-200) for SCUMM games
- (default: 100)
---dimuse-tempo=NUM Set internal Digital iMuse tempo (10 - 100) per second
- (default: 10)
-````
-
-The meaning of most long options, which are those options starting with a double-dash, can be inverted by prefixing them with ```no-```. For example, ```--no-aspect-ratio``` will turn aspect ratio correction off. This is useful if you want to override a setting in the configuration file.
-
-## Launching saved games
-
-### --list-saves
-
-This option is used to display a list of the current saved games of the specified target game and the corresponding save slots.
-
-#### Usage
-
-````bash
-scummvm --list-saves=TARGET
-````
-
-Engines which currently support ```--list-saves``` are:
-
-- AGI
-- AGOS
-- BLADERUNNER
-- CGE
-- CINE
-- CRUISE
-- CRYOMNI3D
-- DRACI
-- GROOVIE
-- HUGO
-- KYRA
-- LURE
-- MOHAWK
-- PARALLACTION
-- QUEEN
-- SAGA
-- SCI
-- SCUMM
-- SKY
-- SWORD1
-- SWORD2
-- TEENAGENT
-- TINSEL
-- TITANIC
-- TOON
-- TOUCHE
-- TSAGE
-- TUCKER
-- ZVISION
-
-### --save-slot <a id="save_slot"></a>
-
-This option is used to load a saved game 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``` are:
-
-- AGI
-- BLADERUNNER
-- CGE
-- CINE
-- CRUISE
-- CRYOMNI3D
-- DRACI
-- GROOVIE
-- HUGO
-- KYRA
-- LURE
-- MOHAWK
-- QUEEN
-- SAGA
-- SCI
-- SCUMM
-- SKY
-- SWORD1
-- SWORD2
-- TEENAGENT
-- TINSEL
-- TITANIC
-- TOON
-- TOUCHE
-- TSAGE
-- TUCKER
-- ZVISION
-
-## Examples
-<!-- tabs:start -->
-
-### ** Windows **
-
-Running Monkey Island, fullscreen, from a hard disk:
-
-````bash
-C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\monkey
-````
-
-Running Full Throttle from CD, fullscreen and with subtitles enabled:
-
-````bash
-C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ft
-````
-
-### ** Unix **
-Running Monkey Island, fullscreen, from a hard disk:
-
-````bash
-/path/to/scummvm -f -p/games/LucasArts/monkey/monkey
-````
-
-Running Full Throttle from CD, fullscreen and with subtitles enabled:
-
-````bash
-/path/to/scummvm -f -n -p/cdrom/resource/ft
-````
-<!-- tabs:end -->
Commit: d64ed59aeb34c3bdce57990192871dbdff13555c
https://github.com/scummvm/scummvm/commit/d64ed59aeb34c3bdce57990192871dbdff13555c
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds refs for some settings
Changed paths:
doc/docportal/using_scummvm/game_settings.rst
doc/docportal/using_scummvm/global_settings.rst
diff --git a/doc/docportal/using_scummvm/game_settings.rst b/doc/docportal/using_scummvm/game_settings.rst
index c2d9fe78f3..58ea2ba678 100644
--- a/doc/docportal/using_scummvm/game_settings.rst
+++ b/doc/docportal/using_scummvm/game_settings.rst
@@ -13,7 +13,7 @@ There are many settings, and they are separated into tabs:
`Game tab`_ | `Engine tab`_ | `Graphics tab`_ | `Audio tab`_ | `Volume tab`_ | `Midi tab`_ | `MT-32 tab`_ | `Paths tab`_ |
-Settings may also be edited directly in the configuration file. These configuration keywords are listed below in italics. For more information, see :doc:`../advanced_options/configuration_file` .
+Settings may also be edited directly in the configuration file. These configuration keywords are listed below in italics. For more information, including a complete list of configuration keywords, see the :doc:`../advanced_options/configuration_file` .
_`Game tab`
------------
@@ -30,6 +30,8 @@ identified by ScummVM.
*gameid*
+.. _description:
+
**Name**
This field shows the full title of the game, as well as some basic information such as original platform and language.
@@ -808,7 +810,7 @@ TTS Narrator
Floppy intro
Use the floppy version's intro (CD version only)
- *alt_intro*
+ *alt_intro*
,,,,,,,,,,
.. _SUPERNOVA:
diff --git a/doc/docportal/using_scummvm/global_settings.rst b/doc/docportal/using_scummvm/global_settings.rst
index f239610efb..b0abba7555 100644
--- a/doc/docportal/using_scummvm/global_settings.rst
+++ b/doc/docportal/using_scummvm/global_settings.rst
@@ -122,11 +122,14 @@ Use the volume tab to set the relative volumes for various sounds.
*music_volume*
+.. _sfx:
+
**SFX volume**
Adjusts the volume of the sound effects within the game.
*sfx_volume*
+.. _speechvol:
**Speech volume**
Adjusts the volume of the digitized speech in the game, if it has any.
@@ -157,6 +160,8 @@ Use the MIDI tab to change the settings of General MIDI devices.
*gm_device*
+.. _soundfont:
+
**Soundfont**
Specifies the path to a soundfont file, if this is required by the GM device.
@@ -362,6 +367,8 @@ The Misc tab contains options that don’t belong on any of the other tabs.
,,,,,,,,,,,,,,,
+.. _theme:
+
Theme
Changes the visual appearance of the ScummVM Launcher
Commit: 286e918d24722b3391d81713803d9f8c69ed39b1
https://github.com/scummvm/scummvm/commit/286e918d24722b3391d81713803d9f8c69ed39b1
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds tabs extension
Changed paths:
doc/docportal/conf.py
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index da25ae3429..b8fa41ff42 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -33,8 +33,10 @@ import sphinx_rtd_theme
extensions = [
"sphinx_rtd_theme",
- "recommonmark"
+ "recommonmark",
+
]
+extensions.append('sphinx_tabs.tabs')
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -55,6 +57,7 @@ html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+
+
master_doc = 'index'
html_sidebars = {'**': ['localtoc.html']}
\ No newline at end of file
Commit: 1ac9044f4c3ee830894fe912f51faf66eafa98bc
https://github.com/scummvm/scummvm/commit/1ac9044f4c3ee830894fe912f51faf66eafa98bc
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds screenshots for graphics page
Changed paths:
A doc/docportal/images/graphics/graphics_mode/1x.png
A doc/docportal/images/graphics/graphics_mode/2x.png
A doc/docportal/images/graphics/graphics_mode/2xsai.png
A doc/docportal/images/graphics/graphics_mode/3x.png
A doc/docportal/images/graphics/graphics_mode/advmame2x.png
A doc/docportal/images/graphics/graphics_mode/advmame3x.png
A doc/docportal/images/graphics/graphics_mode/dotmatrix.png
A doc/docportal/images/graphics/graphics_mode/hq2x.png
A doc/docportal/images/graphics/graphics_mode/hq3x.png
A doc/docportal/images/graphics/graphics_mode/super2xsai.png
A doc/docportal/images/graphics/graphics_mode/supereagle.png
A doc/docportal/images/graphics/graphics_mode/tv2x.png
A doc/docportal/images/graphics/render_mode/amiga.png
A doc/docportal/images/graphics/render_mode/cga.png
A doc/docportal/images/graphics/render_mode/default.png
A doc/docportal/images/graphics/render_mode/ega.png
A doc/docportal/images/graphics/render_mode/herc_amber.png
A doc/docportal/images/graphics/render_mode/herc_green.png
diff --git a/doc/docportal/images/graphics/graphics_mode/1x.png b/doc/docportal/images/graphics/graphics_mode/1x.png
new file mode 100644
index 0000000000..d30afdd9fc
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/1x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/2x.png b/doc/docportal/images/graphics/graphics_mode/2x.png
new file mode 100644
index 0000000000..e9121ba08c
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/2x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/2xsai.png b/doc/docportal/images/graphics/graphics_mode/2xsai.png
new file mode 100644
index 0000000000..024b9d3910
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/2xsai.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/3x.png b/doc/docportal/images/graphics/graphics_mode/3x.png
new file mode 100644
index 0000000000..bcee73ba5a
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/3x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/advmame2x.png b/doc/docportal/images/graphics/graphics_mode/advmame2x.png
new file mode 100644
index 0000000000..11769c4963
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/advmame2x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/advmame3x.png b/doc/docportal/images/graphics/graphics_mode/advmame3x.png
new file mode 100644
index 0000000000..d8ec958df3
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/advmame3x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/dotmatrix.png b/doc/docportal/images/graphics/graphics_mode/dotmatrix.png
new file mode 100644
index 0000000000..47cd6704ac
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/dotmatrix.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/hq2x.png b/doc/docportal/images/graphics/graphics_mode/hq2x.png
new file mode 100644
index 0000000000..f2ac5a9438
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/hq2x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/hq3x.png b/doc/docportal/images/graphics/graphics_mode/hq3x.png
new file mode 100644
index 0000000000..98e819dc48
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/hq3x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/super2xsai.png b/doc/docportal/images/graphics/graphics_mode/super2xsai.png
new file mode 100644
index 0000000000..2b97f56047
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/super2xsai.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/supereagle.png b/doc/docportal/images/graphics/graphics_mode/supereagle.png
new file mode 100644
index 0000000000..31f69f9e5e
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/supereagle.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/tv2x.png b/doc/docportal/images/graphics/graphics_mode/tv2x.png
new file mode 100644
index 0000000000..9bdbb49c47
Binary files /dev/null and b/doc/docportal/images/graphics/graphics_mode/tv2x.png differ
diff --git a/doc/docportal/images/graphics/render_mode/amiga.png b/doc/docportal/images/graphics/render_mode/amiga.png
new file mode 100644
index 0000000000..23f08029fc
Binary files /dev/null and b/doc/docportal/images/graphics/render_mode/amiga.png differ
diff --git a/doc/docportal/images/graphics/render_mode/cga.png b/doc/docportal/images/graphics/render_mode/cga.png
new file mode 100644
index 0000000000..082c546ffd
Binary files /dev/null and b/doc/docportal/images/graphics/render_mode/cga.png differ
diff --git a/doc/docportal/images/graphics/render_mode/default.png b/doc/docportal/images/graphics/render_mode/default.png
new file mode 100644
index 0000000000..e60da9bc87
Binary files /dev/null and b/doc/docportal/images/graphics/render_mode/default.png differ
diff --git a/doc/docportal/images/graphics/render_mode/ega.png b/doc/docportal/images/graphics/render_mode/ega.png
new file mode 100644
index 0000000000..8a9313d8f0
Binary files /dev/null and b/doc/docportal/images/graphics/render_mode/ega.png differ
diff --git a/doc/docportal/images/graphics/render_mode/herc_amber.png b/doc/docportal/images/graphics/render_mode/herc_amber.png
new file mode 100644
index 0000000000..50c0126d83
Binary files /dev/null and b/doc/docportal/images/graphics/render_mode/herc_amber.png differ
diff --git a/doc/docportal/images/graphics/render_mode/herc_green.png b/doc/docportal/images/graphics/render_mode/herc_green.png
new file mode 100644
index 0000000000..69960b772e
Binary files /dev/null and b/doc/docportal/images/graphics/render_mode/herc_green.png differ
Commit: c73f20cfcdadcd350b265c55d88475ad883e5995
https://github.com/scummvm/scummvm/commit/c73f20cfcdadcd350b265c55d88475ad883e5995
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: first draft graphics page
Changed paths:
A doc/docportal/advanced_options/graphics.rst
diff --git a/doc/docportal/advanced_options/graphics.rst b/doc/docportal/advanced_options/graphics.rst
new file mode 100644
index 0000000000..de6168745e
--- /dev/null
+++ b/doc/docportal/advanced_options/graphics.rst
@@ -0,0 +1,135 @@
+
+============================================
+Graphics
+============================================
+
+ScummVM has several ways to adjust the graphics of games, and these settings can be found in the Graphics tabs of both the :doc:`global <../using_scummvm/global_settings>` and :doc:`game-specific <../using_scummvm/game_settings>` settings. They can also be changed directly in the :doc:`configuration file <../advanced_options/configuration_file>`, or passed as an option on the :doc:`command line <../advanced_options/command_line>`.
+
+The graphics mode, aspect ratio, and stretch mode settings work together to change the resolution and display of each game.
+
+Render modes are only applicable to some older games that were designed to be played on multiple systems, and lets us choose which system's graphics to replicate.
+
+
+
+Graphics mode
+---------------
+
+The first setting applied to the image is the graphics mode.
+
+The original game graphics are upscaled using different graphical filters, which are specialized algorithms used to ensure that low resolution pixel-art still looks good when it is displayed at a higher resolution.
+
+If the game originally ran at a resolution of 320x200 - which is typical for most SCUMM games - then using a graphics mode with a scale factor of 2x will yield 640x400 graphics. A 3x scale factor will yield 960x600.
+
+
+Comparison of graphics modes
+******************************
+
+.. figure:: ../images/graphics/graphics_mode/1x.png
+
+ **1x**: No filtering, no scaling. Fastest.
+
+.. figure:: /images/graphics/graphics_mode/2x.png
+
+ **2x**: No filtering, factor 2x. Default for non 640x480 games.
+
+.. figure:: ../images/graphics/graphics_mode/3x.png
+
+ **3x**: No filtering, factor 3x.
+
+.. figure:: ../images/graphics/graphics_mode/2xsai.png
+
+ **2xSaI**: SaI filter, factor 2x.
+
+.. figure:: ../images/graphics/graphics_mode/super2xsai.png
+
+ **Super2xSaI**: Enhanced 2xSAI filtering, factor 2x.
+
+.. figure:: ../images/graphics/graphics_mode/supereagle.png
+
+ **SuperEagle**: Less blurry than 2xSAI, but slower. Factor 2x.
+
+.. figure:: ../images/graphics/graphics_mode/advmame2x.png
+
+ **AdvMAME2x**: Doesn't rely on blurring like 2xSAI, fast. Factor 2x.
+
+.. figure:: ../images/graphics/graphics_mode/advmame3x.png
+
+ **AdvMAME3x**: Doesn't rely on blurring like 2xSAI, fast. Factor 3x.
+
+.. figure:: ../images/graphics/graphics_mode/hq2x.png
+
+ **HQ2x**: Very nice high quality filter, but slow. Factor 2x.
+
+.. figure:: ../images/graphics/graphics_mode/hq3x.png
+
+ **HQ3x**: Very nice high quality filter, but slow. Factor 3x.
+
+.. figure:: ../images/graphics/graphics_mode/tv2x.png
+
+ **TV2x**: Interlace filter, tries to emulate a TV. Factor 2x.
+
+.. figure:: ../images/graphics/graphics_mode/dotmatrix.png
+
+ **DotMatrix**: Dot matrix effect. Factor 2x.
+
+
+
+.. note::
+
+ Not all engines support all, or even any, of the graphics modes.
+
+ There is always a speed penalty when using any form of anti-aliasing/linear filtering.
+
+
+
+Aspect Ratio
+-------------
+The next setting applied to the image is the aspect ratio correction.
+
+Older games were designed to be run at 320x200 pixels, but on systems where each pixel was rectangular instead of square. This means that on modern systems these games look wider and flatter than they are supposed to. Aspect ratio correction duplicates lines of pixels to correct this.
+
+Stretch mode
+----------------
+
+The last setting applied to the image is the stretch mode.
+
+There are five stretch modes:
+
+- Center - centers the image in the window.
+- Pixel-perfect scaling - keeps the image at its resolution.
+- Fit to window - fits the image to the window, but maintains the aspect ratio; does not stretch it to fill the window.
+- Stretch - stretches the image to fill the window
+- Fit to window (4:3) - fits the image to the window, at a 4:3 aspect ratio.
+
+Render mode
+-------------
+
+For most games this setting will have no effect. For some of the older games that could be played on different systems and graphics cards, this control allows us to decide which system we want ScummVM to reproduce.
+
+Below are some of the common render modes, to illustrate how the render mode setting works.
+
+.. figure:: ../images/graphics/render_mode/default.png
+
+ Maniac Mansion with <default> render mode
+
+.. figure:: ../images/graphics/render_mode/herc_green.png
+
+ Maniac Mansion with Hercules Green render mode
+
+.. figure:: ../images/graphics/render_mode/herc_amber.png
+
+ Maniac Mansion with Hercules Amber render mode
+
+.. figure:: ../images/graphics/render_mode/cga.png
+
+ Maniac Mansion with CGA (4 color) render mode
+
+.. figure:: ../images/graphics/render_mode/ega.png
+
+ Maniac Mansion with EGA (16 color) render mode
+
+.. figure:: ../images/graphics/render_mode/amiga.png
+
+ Maniac Mansion with Amiga (32 color) render mode
+
+
Commit: 78e7577fb1b4f699b3ef85123d166d4f868397d3
https://github.com/scummvm/scummvm/commit/78e7577fb1b4f699b3ef85123d166d4f868397d3
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds requirement for RTD to enable tabs
Changed paths:
A doc/docportal/requirements.txt
diff --git a/doc/docportal/requirements.txt b/doc/docportal/requirements.txt
new file mode 100644
index 0000000000..0c4cdeebe6
--- /dev/null
+++ b/doc/docportal/requirements.txt
@@ -0,0 +1 @@
+sphinx-tabs
\ No newline at end of file
Commit: 842f5a47d44e17dcf1bd5aa53b020d9c46f4af21
https://github.com/scummvm/scummvm/commit/842f5a47d44e17dcf1bd5aa53b020d9c46f4af21
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds aspect ratio screenshots
Changed paths:
A doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png
A doc/docportal/images/graphics/aspect_ratio/no_aspect_ratio.png
doc/docportal/advanced_options/graphics.rst
diff --git a/doc/docportal/advanced_options/graphics.rst b/doc/docportal/advanced_options/graphics.rst
index de6168745e..bba9a633e3 100644
--- a/doc/docportal/advanced_options/graphics.rst
+++ b/doc/docportal/advanced_options/graphics.rst
@@ -88,6 +88,14 @@ The next setting applied to the image is the aspect ratio correction.
Older games were designed to be run at 320x200 pixels, but on systems where each pixel was rectangular instead of square. This means that on modern systems these games look wider and flatter than they are supposed to. Aspect ratio correction duplicates lines of pixels to correct this.
+.. figure:: ../images/graphics/aspect_ratio/no_aspect_ratio.png
+
+ No aspect ratio correction applied.
+
+.. figure:: ../images/graphics/aspect_ratio/aspect_ratio.png
+
+ Aspect ratio correction applied.
+
Stretch mode
----------------
diff --git a/doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png b/doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png
new file mode 100644
index 0000000000..1c583ab8cc
Binary files /dev/null and b/doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png differ
diff --git a/doc/docportal/images/graphics/aspect_ratio/no_aspect_ratio.png b/doc/docportal/images/graphics/aspect_ratio/no_aspect_ratio.png
new file mode 100644
index 0000000000..b3ce3b13a5
Binary files /dev/null and b/doc/docportal/images/graphics/aspect_ratio/no_aspect_ratio.png differ
Commit: 35d980d2cdc93f6cc64bdb136d06323e456890e2
https://github.com/scummvm/scummvm/commit/35d980d2cdc93f6cc64bdb136d06323e456890e2
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: removes outdated pages
Changed paths:
R doc/docportal/advanced_options/graphic_filters.rst
R doc/docportal/advanced_options/render_modes.rst
diff --git a/doc/docportal/advanced_options/graphic_filters.rst b/doc/docportal/advanced_options/graphic_filters.rst
deleted file mode 100644
index feddd84d6f..0000000000
--- a/doc/docportal/advanced_options/graphic_filters.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-============================================
-Graphic filters
-============================================
-This is a dummy page
\ No newline at end of file
diff --git a/doc/docportal/advanced_options/render_modes.rst b/doc/docportal/advanced_options/render_modes.rst
deleted file mode 100644
index 3c681998ef..0000000000
--- a/doc/docportal/advanced_options/render_modes.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-=============
-Render modes
-=============
-This is a dummy page
\ No newline at end of file
Commit: 5e6f9ca851291e057d7ba88510ce8bf81021bad8
https://github.com/scummvm/scummvm/commit/5e6f9ca851291e057d7ba88510ce8bf81021bad8
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: reformats keyboard shortcuts into tables
Changed paths:
doc/docportal/using_scummvm/keyboard_shortcuts.rst
diff --git a/doc/docportal/using_scummvm/keyboard_shortcuts.rst b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
index 5f3c5d7fef..05167490ba 100755
--- a/doc/docportal/using_scummvm/keyboard_shortcuts.rst
+++ b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
@@ -2,258 +2,363 @@
Keyboard Shortcuts
===================
-ScummVM supports various in-game keyboard shortcuts.
-
-.. note::
-
- Using Ctrl+f or Ctrl+g is not recommended. Games can crash when being run faster than their normal speed, as scripts will lose synchronisation.
-
-
-
-Common::
-
- Ctrl+F5 - Displays the Global Menu
- Cmd+q - Quit (Mac OS X)
- Ctrl+q - Quit (other unices including Linux)
- Alt+F4 - Quit (Windows)
- Ctrl+z - Quit (other platforms)
- Ctrl+u - Mute all sounds
- 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
- Ctrl+Alt f - Enable/disable graphics filtering
- Ctrl+Alt s - Cycle through scaling modes
- Alt+Enter - Toggles full screen/windowed
- Alt+s - Make a screenshot (SDL backend only)
- Ctrl+F7 - Open virtual keyboard (if enabled)
- This can also be triggered by a long press
- of the middle mouse button or wheel.
-
-SCUMM games::
- Alt+x - Quit
- Ctrl 0-9 and Alt 0-9 - Load and save game state
- Ctrl+d - Starts the debugger
- Ctrl+f - Toggle fast mode
- Ctrl+g - Runs in really REALLY fast mode
- Ctrl+t - Switch between 'Speech only',
- 'Speech and Subtitles' and 'Subtitles only'
- Tilde (~) - Show/hide the debugging console
- [ and ] - Music volume, down/up
- - and + - Text speed, slower/faster
- F5 - Displays a save/load box
- Alt+F5 - Displays the original save/load box, if the
- game has one. You can save and load games using
- this, however it is not intended for this purpose,
- and may even crash ScummVM in some games.
- Space - Pauses
- Period (.) - Skips current line of text in some games
- Enter - Simulate left mouse button press
- Tab - Simulate right mouse button press
-
-Beneath a Steel Sky::
-
- Ctrl+d - Starts the debugger
- Ctrl+f - Toggle fast mode
- 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
-
-Blade Runner::
-
- Ctrl+d - Starts the debugger
- Space - Toggle combat mode
- Enter or Escape - Skips a video or a line of dialogue
- Escape - Show game menu
- Tab - Activate last database
- F1 - Online help
- F2 - Save game menu
- F3 - Load game menu
- F4 - Crime scene database
- F5 - Suspect database
- F6 - Clue database
- F10 - Quit game
-
-Broken Sword::
-
- F5 or Escape - Displays save/load box
-
-Broken Sword II::
-
- Ctrl+d - Starts the debugger
- Ctrl+f - Toggle fast mode
- p - Pauses
-
-Dragon History::
- F5 - Displays the Global Menu
- left click - Walk, explore
- right click - Use, talk
- move mouse up, i - Inventory
- move mouse down, m - Map
- Escape - Skip the intro, exit map/inventory
- any click - Skip the currently dubbed sentence
- q - Quick walking on/off
-
-Flight of the Amazon Queen::
-
- Ctrl+d - Starts the debugger
- Ctrl+f - Toggle fast mode
- F1 - Use Journal (saving/loading)
- F11 - Quicksave
- F12 - Quickload
- Escape - Skips cutscenes
- Space - Skips current line of text
-
-Future Wars::
- F1 - Examine
- F2 - Take
- F3 - Inventory
- F4 - Use
- F5 - Activate
- F6 - Speak
- F9 - "Activate" menu
- F10 - "Use" menu
- Escape - Bring on command menu
-
-Indiana Jones and the Fate of Atlantis::
-
- i - Displays IQ points
-
-Indiana Jones and the Last Crusade::
-
- i - Displays IQ points
-
-Nippon Safes::
-
- Ctrl+d - Starts the debugger
- l - Load game
- s - Save game
-
-Simon the Sorcerer 1 and 2::
- Ctrl 0-9 and Alt 0-9 - Load and save game state
- Ctrl+d - Starts the debugger
- Ctrl+f - Toggle fast mode
- F1 - F3 - Text speed, faster - slower
- F10 - Shows all characters and objects you can
- interact with
- Escape - Skip cutscenes
- - and + - Music volume, down/up
- m - Music on/off
- s - Sound effects on/off
- b - Background sounds on/off
- [Simon the Sorcerer 2 only]
- Pause - Pauses
- t - Switch between speech only and
- combined speech and subtitles
- [Simon the Sorcerer 1 CD (other than
- English and German) and Simon the
- Sorcerer 2 CD (all languages)]
- v - Switch between subtitles only and
- combined speech and subtitles
- [Simon the Sorcerer 2 CD only]
-
-Simon the Sorcerer's Puzzle Pack::
-
- Ctrl+d - Starts the debugger
- Ctrl+f - Toggle fast mode
- F12 - High speed mode on/off in Swampy Adventures
- - and + - Music volume, down/up
- m - Music on/off
- s - Sound effects on/off
- Pause - Pauses
-
-Starship Titanic::
-
- Ctrl+c - Open up the developer's cheat room
- Ctrl+d - Open up the ScummVM Debugger
- Left click - Move action
- Shift-Left click - Edit room glyph chevrons and
- quick movement transitions
- Right click - Edit room glyph chevrons
- and quick transitions
- Mouse wheel - Scroll through items (inventory, etc)
- and conversation log
- Arrow keys - Movement. Down arrow/back is only available if the
- given view explicitly has a backwards movement
- available.
- F1 - Switch to Chat-O-Mat
- F2 - Switch to Personal Baggage
- F3 - Switch to Remote Thingummy
- F4 - Switch to Designer Room Numbers (chevron list)
- F5 - GMM save menu
- F6 - Switch to Real Life
- F7 - GMM restore menu
-
-Starship Titanic (Starfield Puzzle)::
-
- Tab - Toggle between starmap and skyscape
- Mouse click: - skyscape star selection and
- starmap star fast travel
- Mouse movement - starmap orientation
- SPACE - starmap stop movement
- z - starmap turn left
- x - starmap turn right
- Single quote (') - starmap turn up
- Forward slash (/) - starmap turn down
- Semicolon (;) - starmap move forward
- Period (.) - starmap move backward
- l - starmap lock coordinate
- d - starmap unlock coordinate
-
-The Feeble Files::
-
- Ctrl+d - Starts the debugger
- Ctrl+f - Toggle fast mode
- F7 - Switch characters
- F9 - Hitbox names on/off
- s - Sound effects on/off
- Pause - Pauses
- t - Switch between speech only and
- combined speech and subtitles
- v - Switch between subtitles only and
- combined speech and subtitles
-
-The Legend of Kyrandia::
-
- Ctrl 0-9 and Alt 0-9 - Load and save game state
- Ctrl-d - Starts the debugger
-
-TeenAgent::
- F5 - Displays the Global Menu
-
-Touche: The Adventures of the Fifth Musketeer::
-
- Ctrl+f - Toggle fast mode
- F5 - Displays options
- F9 - Turn fast walk mode on
- F10 - Turn fast walk mode off
- Escape - Quit
- Space - Skips current line of text
- t - Switch between 'Voice only',
- 'Voice and Text' and 'Text only'
-
-Zork: Grand Inquisitor::
- Ctrl+s - Save
- Ctrl+r - Restore
- Ctrl+q - Quit
- Ctrl+p - Preferences
- F1 - Help
- F5 - Inventory
- F6 - Spellbook
- F7 - Score
- F8 - Put away current object/forget spell
- F9 - Extract coin (must have the coin bag)
- Space - Skips movies
-
-Zork Nemesis: The Forbidden Lands::
- Ctrl+s - Save
- Ctrl+r - Restore
- Ctrl+q - Quit
- Ctrl+p - Preferences
- Space - Skips movies
+ScummVM supports various in-game keyboard and mouse shortcuts.
+
+Common shortcuts (all games)
+-------------------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + F5` ,Displays the Global Menu
+ :kbd:`Cmd + q` ,Quit (Mac OS X)
+ :kbd:`Ctrl + q` ,Quit (other unices including Linux)
+ :kbd:`Alt + F4`,Quit (Windows)
+ :kbd:`Ctrl + z`,Quit (other platforms)
+ :kbd:`Ctrl + u` ,Mute all sounds
+ :kbd:`Ctrl + m` ,Toggle mouse capture
+ :kbd:`Ctrl + Alt + 1-8` ,Switch between graphics filters
+ :kbd:`Ctrl + Alt` and :kbd:`+` or :kbd:`-`,Increase/Decrease the scale factor
+ :kbd:`Ctrl + Alt + a` ,Toggle aspect-ratio correction on/off
+ :kbd:`Ctrl + Alt + f` ,Enable/disable graphics filtering
+ :kbd:`Ctrl + Alt + s` ,Cycle through scaling modes
+ :kbd:`Alt + Enter` ,Toggles full screen/windowed
+ :kbd:`Alt + s` ,Take a screenshot (SDL backend only)
+ :kbd:`Ctrl + F7` ,"Open virtual keyboard (if enabled).
+ This can also be opened with a long press of the middle mouse button or wheel."
+
+SCUMM games
+----------------
+
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Alt + x` ,Quit
+ :kbd:`Ctrl + 0-9` ,Save game state
+ :kbd:`Alt + 0-9`,Load saved game state
+ :kbd:`Ctrl + d` ,Starts the debugger
+ :kbd:`Ctrl + f` ,Toggle fast mode
+ :kbd:`Ctrl + g` ,Runs in really REALLY fast mode
+ :kbd:`Ctrl + t` ,"Switch between 'Speech only', 'Speech and Subtitles' and 'Subtitles only'"
+ :kbd:`~` ,Show/hide the debugging console
+ :kbd:`[` and :kbd:`]`,"Music volume, down/up"
+ :kbd:`-` and :kbd:`+` ,"Text speed, slower/faster"
+ :kbd:`F5` ,Displays a save/load box
+ :kbd:`Alt + F5` ,"Displays the original save/load box, if the game has one. May crash the game."
+ :kbd:`Space` ,Pause
+ :kbd:`.` ,Skips current line of text in some games
+ :kbd:`Enter` ,Simulate left mouse button press
+ :kbd:`Tab`,Simulate right mouse button press
+
+Beneath a Steel Sky
+---------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + d` ,Starts the debugger
+ :kbd:`Ctrl + f` ,Toggle fast mode
+ :kbd:`Ctrl + g` ,Runs in REALLY fast mode
+ :kbd:`F5` ,Displays a save/load box
+ :kbd:`Esc` ,Skips the game intro
+ :kbd:`.` ,Skips current line of text
+
+
+
+Blade Runner
+---------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + d` ,Starts the debugger
+ :kbd:`Space` ,Toggles combat mode
+ :kbd:`Enter` or :kbd:`Esc` ,Skips a video or a line of dialogue
+ :kbd:`Esc` ,Shows game menu
+ :kbd:`Tab` ,Activates last database
+ :kbd:`F1` ,Online help
+ :kbd:`F2` ,Save game menu
+ :kbd:`F3` ,Load game menu
+ :kbd:`F4` ,Crime scene database
+ :kbd:`F5` ,Suspect database
+ :kbd:`F6` ,Clue database
+ :kbd:`F10` ,Quit game
+
+Broken Sword
+---------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`F5` or `Esc` ,Displays save/load box
+
+Broken Sword II
+-----------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + d` ,Starts the debugger
+ :kbd:`Ctrl + f` ,Toggles fast mode
+ :kbd:`p` ,Pause
+
+Dragon History
+-----------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`F5` ,Displays the Global Main Menu
+ left click ,"Walk, explore"
+ right click,"Use, talk"
+ "move mouse up, :kbd:`i` ",Inventory
+ "move mouse down, :kbd:`m` ",Map
+ :kbd:`Esc` ,"Skip the intro, exit map/inventory"
+ any click ,Skip the currently dubbed sentence
+ :kbd:`q` ,
+
+
+
+Flight of the Amazon Queen
+----------------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + d` ,Starts the debugger
+ :kbd:`Ctrl + f` ,Toggles fast mode
+ :kbd:`F1`,Use Journal (saving/loading)
+ :kbd:`F11` ,Quicksave
+ :kbd:`F12` ,Quickload
+ :kbd:`Esc` ,Skips cutscenes
+ :kbd:`Space` ,Skips current line of text
+
+Future Wars
+--------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`F1` ,Examine
+ :kbd:`F2` ,Take
+ :kbd:`F3`,Inventory
+ :kbd:`F4` ,Use
+ :kbd:`F5` ,Activate
+ :kbd:`F6`,Speak
+ :kbd:`F9` ,"'Activate' menu"
+ :kbd:`F10`,"'Use' menu"
+ :kbd:`Esc`,Command menu
+
+Indiana Jones and the Fate of Atlantis
+--------------------------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`i` ,Displays IQ points
+
+Indiana Jones and the Last Crusade
+------------------------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`i` ,Displays IQ points
+
+Nippon Safes
+---------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + d` ,Starts the debugger
+ :kbd:`l`,Load game
+ :kbd:`s`,Save game
+
+
+Simon the Sorcerer 1 and 2
+---------------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + 0-9` ,Save game state
+ :kbd:`Alt + 0-9`, Load saved game state
+ :kbd:`Ctrl + d` ,Starts the debugger
+ :kbd:`Ctrl + f` ,Toggles fast mode
+ :kbd:`F1` and :kbd:`F3` ,"Text speed, faster - slower"
+ :kbd:`F10` ,Shows all characters and objects you can interact with
+ :kbd:`Esc` ,Skips cutscenes
+ :kbd:`-` and :kbd:`+` ,"Music volume, down/up"
+ :kbd:`m` ,Music on/off
+ :kbd:`s` ,Toggles sound effects on/off
+ :kbd:`b` ,Toggles background sounds on/off
+ :kbd:`t` ,Switches between speech only and combined speech and subtitles
+ :kbd:`v` ,Switches between subtitles only and combined speech and subtitles
+ :kbd:`Ctrl + d` ,Starts the debugger
+ :kbd:`Ctrl + f` ,Toggles fast mode
+ :kbd:`F12` ,Toggles high speed mode on/off in Swampy Adventures
+ :kbd:`-` and :kbd:`+` ,"Music volume, down/up"
+ :kbd:`m` ,Toggles music on/off
+ :kbd:`s` ,Toggles sound effects on/off
+
+Starship Titanic
+-------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + c` ,Opens the developer's cheat room
+ :kbd:`Ctrl + d` ,Starts the debugger
+ Left click ,Move action
+ :kbd:`Shift` + Left click ,Edit room glyph chevrons and quick movement transitions
+ Right click ,Edit room glyph chevrons and quick transitions
+ Mouse wheel ,"Scroll through items such as inventory and conversation log"
+ Arrow keys,Movement. Down arrow/back is only available if the given view explicitly has a backwards movement available.
+ :kbd:`F1` ,Switches to Chat-O-Mat
+ :kbd:`F2`,Switches to Personal Baggage
+ :kbd:`F3` ,Switches to Remote Thingummy
+ :kbd:`F4` ,Switches to Designer Room Numbers (chevron list)
+ :kbd:`F5` ,Opens GMM save menu
+ :kbd:`F6` ,Switches to Real Life
+ :kbd:`F7` ,Opens GMM restore menu
+
+
+Starship Titanic (Starfield Puzzle)
+-------------------------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Tab` ,Toggles between starmap and skyscape
+ Mouse click,Skyscape star selection and starmap star fast travel
+ Mouse movement - ,Starmap orientation
+ :kbd:`Space` ,Starmap stop movement
+ :kbd:`z` ,Starmap turn left
+ :kbd:`x`,Starmap turn right
+ :kbd:`'`,Starmap turn up
+ :kbd:`/`,Starmap turn down
+ :kbd:`;`,Starmap move forward
+ :kbd:`.`,Starmap move backward
+ :kbd:`l`,Starmap lock coordinate
+ :kbd:`d`,Starmap unlock coordinate
+
+The Feeble Files
+-------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + d` ,Starts the debugger
+ :kbd:`Ctrl + f` ,Toggles fast mode
+ :kbd:`F7`,Switches characters
+ :kbd:`F9`,Toggles hitbox names on/off
+ :kbd:`s`,Toggles sound effects on/off
+ :kbd:`Pause`,Pause
+ :kbd:`t` ,Switches between speech only and combined speech and subtitles
+ :kbd:`v`,Switches between subtitles only and combined speech and subtitles
+
+The Legend of Kyrandia
+-----------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + 0-9` ,Save game state
+ :kbd:`Alt + 0-9`, Load saved game state
+ :kbd:`Ctrl + d` ,Starts the debugger
+
+TeenAgent
+----------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`F5`,Displays the Global Main Menu
+
+Touche: The Adventures of the Fifth Musketeer
+----------------------------------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + f` ,Toggles fast mode
+ :kbd:`F5`,Displays options
+ :kbd:`F9`,Turns fast walk mode on
+ :kbd:`F10`,Turns fast walk mode off
+ :kbd:`Esc`,Quit
+ :kbd:`Space`,Skips current line of text
+ :kbd:`t` ,Switches between speech only and combined speech and subtitles
+
+Zork: Grand Inquisitor
+------------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + s` ,Save
+ :kbd:`Ctrl + r` ,Restore
+ :kbd:`Ctrl + p` ,Preferences
+ :kbd:`F1` ,Help
+ :kbd:`F5` ,Inventory
+ :kbd:`F6` ,Spellbook
+ :kbd:`F7` ,Score
+ :kbd:`F8` ,Puts away current object/forget spell
+ :kbd:`F9`,Extracts coin (must have the coin bag)
+ :kbd:`Space` ,Skips movies
+
+
+Zork Nemesis: The Forbidden Lands
+----------------------------------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ :kbd:`Ctrl + s` ,Save
+ :kbd:`Ctrl + r` ,Restore
+ :kbd:`Ctrl + q` ,Quit
+ :kbd:`Ctrl + p` ,Preferences
+ :kbd:`Space` ,Skips movies
\ No newline at end of file
Commit: 7a9cfd67f8be776295a1d904bf7bfab292a8938c
https://github.com/scummvm/scummvm/commit/7a9cfd67f8be776295a1d904bf7bfab292a8938c
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: adds reference to graphics page
Changed paths:
doc/docportal/using_scummvm/global_settings.rst
diff --git a/doc/docportal/using_scummvm/global_settings.rst b/doc/docportal/using_scummvm/global_settings.rst
index b0abba7555..b83f4f660c 100644
--- a/doc/docportal/using_scummvm/global_settings.rst
+++ b/doc/docportal/using_scummvm/global_settings.rst
@@ -17,7 +17,7 @@ Settings may also be edited directly in the configuration file. These configurat
_`Graphics tab`
---------------
-Use the graphics tab to change how games look when they are played.
+Use the graphics tab to change how games look when they are played. For more information including comprehensive explanation of the graphics settings, see the :doc:`../advanced_options/graphics` page.
,,,,,,,
Commit: df0b88a77b58a416fe82cd62178dab29b958c275
https://github.com/scummvm/scummvm/commit/df0b88a77b58a416fe82cd62178dab29b958c275
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: corrects ref to keyboard shortcut
Changed paths:
doc/docportal/using_scummvm/game_settings.rst
diff --git a/doc/docportal/using_scummvm/game_settings.rst b/doc/docportal/using_scummvm/game_settings.rst
index 58ea2ba678..f4f31a3641 100644
--- a/doc/docportal/using_scummvm/game_settings.rst
+++ b/doc/docportal/using_scummvm/game_settings.rst
@@ -91,7 +91,7 @@ Use the graphics tab to change how the game looks when it is played. For more in
*aspect_ratio*
**Fullscreen mode**
- Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt + F5` while in a game.
+ Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt + Enter`.
*fullscreen*
Commit: 39988d5762b1ce45877d6c5c554dbc7881c3ff3d
https://github.com/scummvm/scummvm/commit/39988d5762b1ce45877d6c5c554dbc7881c3ff3d
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-10-04T18:29:01+02:00
Commit Message:
DOCS: updates index page links
Changed paths:
doc/docportal/index.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index ab4dc4261b..b7b0e1ec00 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -59,9 +59,10 @@ How do I...?
If you have ScummVM installed, but you have questions about how to use it, our **Using ScummVM** section has lots of useful information to help you out:
-- **Understanding the interface**: :doc:`using_scummvm/the_launcher`
-- **Changing settings**: :doc:`using_scummvm/global_settings` | :doc:`using_scummvm/game_settings`
-- **Shortcuts**: :doc:`using_scummvm/keyboard_shortcuts`
+- **Understanding the interface**: :doc:`using_scummvm/the_launcher`
+- **Playing games**: :doc:`using_scummvm/adding_games` | :doc:`using_scummvm/save_load_games`
+- **Changing settings**: :doc:`using_scummvm/global_settings` | :doc:`using_scummvm/game_settings` | :doc:`advanced_options/configuration_file`
+- **In-game shortcuts**: :doc:`using_scummvm/keyboard_shortcuts`
Advanced features
@@ -70,7 +71,7 @@ Advanced features
For our more experienced users, ScummVM has many cool advanced options.
But don't worry, even if you're a beginner, our documentation will take you through how to optimize your game playing experience.
-- **Advanced settings**: :doc:`advanced_options/configuration_file` | :doc:`advanced_options/render_modes` | :doc:`advanced_options/graphic_filters`
+- **Advanced settings**: :doc:`advanced_options/graphics` | :doc:`advanced_options/audio`
- **The command line interface**: :doc:`advanced_options/command_line`
More information about the Scummvm-git-logs
mailing list