DOCS: Initial commit of doc portal drafts

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)

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 -->

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
+
+````

doc/docportal/advanced_options/graphic_filters.rst

@@ -0,0 +1,4 @@
+============================================
+Graphic filters
+============================================
+This is a dummy page

doc/docportal/advanced_options/render_modes.rst

@@ -0,0 +1,4 @@
+=============
+Render modes
+=============
+This is a dummy page

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']}

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
+

doc/docportal/getting_started/android.rst

@@ -0,0 +1,5 @@
+
+===============
+Android
+===============
+

doc/docportal/getting_started/ios.rst

@@ -0,0 +1,5 @@
+
+==============
+iOS
+==============
+

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>`!

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>`!

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>`!

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 <#>`__

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
+
+,,,,,,,,,,

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)
+
+,,,,,,,,,,,,,

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

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.