[Scummvm-git-logs] scummvm master -> 2aebeb795b6877364e57c2b27cdc0cbf6453b293
Mataniko
mataniko at gmail.com
Mon Nov 2 10:18:03 UTC 2020
This automated email contains information about 12 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
6f8797784f DOCS: adds second draft - Advanced Options pages
b68c04b805 DOCS: adds first draft Games section pages
3a79ee2cc3 DOCS: changes Getting started section
b31eb824d9 DOCS: updates all screenshots for V2.2.0
601baf679a DOCS: adds first draft Help section pages
da3a3c0d11 DOCS: adds first draft Other platforms pages
f0ce76521d DOCS: adds Release notes section
969bab50cc DOCS: adds first draft Settings pages
f5746a7734 DOCS: second draft - Using ScummVM pages
8d9da4a677 DOCS: keeps index page up to date with all changes
767d6a921e DOCS: adds Guides section
2aebeb795b DOCS: renames files for consistency
Commit: 6f8797784f7582739ed052df7a3d56e93f2a9678
https://github.com/scummvm/scummvm/commit/6f8797784f7582739ed052df7a3d56e93f2a9678
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: adds second draft - Advanced Options pages
Changed paths:
R doc/docportal/advanced_options/graphics.rst
doc/docportal/advanced_options/command_line.rst
doc/docportal/advanced_options/configuration_file.rst
diff --git a/doc/docportal/advanced_options/command_line.rst b/doc/docportal/advanced_options/command_line.rst
index f0ea595ce0..56a6169405 100755
--- a/doc/docportal/advanced_options/command_line.rst
+++ b/doc/docportal/advanced_options/command_line.rst
@@ -3,7 +3,7 @@
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.
+Launching ScummVM from the command line allows you to pass a number of options, some of which override the applicable global or game-specific 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.
@@ -63,7 +63,7 @@ Short options are listed where they are available.
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-saves --game=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>`
@@ -88,7 +88,7 @@ Short options are listed where they are available.
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)"
+ \--save-slot=NUM,-x,"Saved 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>`
diff --git a/doc/docportal/advanced_options/configuration_file.rst b/doc/docportal/advanced_options/configuration_file.rst
index 87876b5147..d99d02b79e 100755
--- a/doc/docportal/advanced_options/configuration_file.rst
+++ b/doc/docportal/advanced_options/configuration_file.rst
@@ -5,7 +5,7 @@ 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 :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**.
+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
==========
@@ -18,7 +18,7 @@ The configuration file saves to different default locations, depending on the pl
.. tab:: Mac OSX
- ``~/Library/Preferences/ScummVM Preferences``, where ``~`` is your Home directory.
+ ``~/Library/Preferences/ScummVM Preferences``, where ``~`` is your Home directory. To see the Libraries folder you will need to view hidden files.
Note that if an earlier version of ScummVM was installed on your system, the previous default location of ``~/.scummvmrc`` will be kept.
@@ -29,11 +29,13 @@ The configuration file saves to different default locations, depending on the pl
**Windows NT4**: ``<windir>\Profiles\username\Application Data\ScummVM\scummvm.ini``
+ ``<windir>`` refers to the Windows directory. Most commonly, this is ``C:\WINDOWS``.
+
**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.
+ 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
@@ -43,18 +45,17 @@ The configuration file saves to different default locations, depending on the pl
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.
+ If ScummVM was installed using Snap, the configuration file can be found at ``~/snap/scummvm/current/.config/scummvm/scummvm.ini``
.. tab:: Other
- ``scummvm.ini`` in the ScummVM directory.
+ See the relevant Platform page for details.
+
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.
+Global settings are listed under the ``[scummvm]`` heading. Global ../settings/keymaps settings are listed under the ``[keymapper]`` heading. Game-specific settings, including keymaps, 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
@@ -101,11 +102,11 @@ Example of a configuration file
Keywords
===========
-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.
+There are many recognized configuration keywords. In the table below, each keyword is linked to an explanatory description in the Settings pages.
.. csv-table::
:widths: 25, 25, 15, 35
- :header-rows: 1
+ :header-rows: 1
Keyword,Type,Default,Options
alsa_port,number,,
@@ -113,7 +114,7 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`altamigapalette <altamiga>`",boolean,false,
":ref:`apple2gs_speedmenu <2gs>`",boolean,false,
":ref:`aspect_ratio <ratio>`",boolean,false,
- audio_buffer_size,number,"Calculated","
+ ":ref:`audio_buffer_size <buffer>`",number,"Calculated","
- 256
- 512
- 1024
@@ -121,9 +122,9 @@ There are many recognized configuration keywords. In the table below, each keywo
- 4096
- 8192
- 16384
- - 32768"
- auto_savenames,boolean,false,
-
+ - 32768"
+ ":ref:`autosave_period <autosave>`", integer, 300s
+ auto_savenames,boolean,false
":ref:`bilinear_filtering <bilinear>`",boolean,false,
boot_param,number,none,
":ref:`bright_palette <bright>`",boolean,true,
@@ -134,7 +135,7 @@ There are many recognized configuration keywords. In the table below, each keywo
console,boolean,true,
controller_map_db,string,,
copy_protection,boolean,false,
- demo_mode,,false,
+ demo_mode,boolean,false,
":ref:`description <description>`",string,,
":ref:`disable_dithering <dither>`",boolean,false,
":ref:`disable_stamina_drain <stamina>`",boolean,false,
@@ -149,6 +150,7 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`enable_hq_video <hq>`",boolean,true,
":ref:`enable_larryscale <larry>`",boolean,true,
":ref:`enable_video_upscale <upscale>`",boolean,true,
+ ":ref:`enable_tts <ttsenabled>`",boolean,false,
":ref:`extrapath <extra>`",string,None," path"
":ref:`fade_style <fade>`",boolean,true,
":ref:`filtering <filtering>`",boolean,false,
@@ -172,9 +174,10 @@ There are many recognized configuration keywords. In the table below, each keywo
":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:`frontpanel_touchpad_mode <frontpanel>`,boolean, false
":ref:`fullscreen <fullscreen>`",boolean,false,
":ref:`gameid <gameid>`",string,,
- ":ref:`gamepath <gamepath>`",string,,
+ gamepath,string,,
":ref:`gfx_mode <gfxmode>`",string,2x,"
- 1x
- 2x
@@ -191,21 +194,68 @@ There are many recognized configuration keywords. In the table below, each keywo
- opengl"
":ref:`gm_device <gm>`",string,null,"
- auto
- - alsa_midi Through
+ - alsa
- 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:`GraphicsDithering <gdither>`",boolean,true,
+ ":ref:`gui_browser_native <guibrowser>`", boolean, true
+ ":ref:`helium_mode <helium>`",boolean,false,
+ ":ref:`help_style <help>`",boolean,false,
+ ":ref:`herculesfont <herc>`",boolean,false,
+ ":ref:`hpbargraphs <hp>`",boolean,true,
+ ":ref:`hypercheat <hyper>`",boolean,false,
iconpath,string,,
- ":ref:`improved <improved>`",,true,
- ":ref:`InvObjectsAnimated <objanimated>`",,true,
+ ":ref:`improved <improved>`",boolean,true,
+ ":ref:`InvObjectsAnimated <objanimated>`",boolean,true,
+ ":ref:`joystick_deadzone <deadzone>`",integer, 3
joystick_num,number,,
+ ":ref:`kbdmouse_speed <mousespeed>`", integer, 10
+ ":doc:`keymap_engine-default_DOWN <../settings/keymaps>`",string,JOY_DOWN
+ ":doc:`keymap_engine-default_LCLK <../settings/keymaps>`",string,MOUSE_LEFT JOY_A
+ ":doc:`keymap_engine-default_LEFT <../settings/keymaps>`",string,JOY_LEFT
+ ":doc:`keymap_engine-default_MCLK <../settings/keymaps>`",string,MOUSE_MIDDLE
+ ":doc:`keymap_engine-default_MENU <../settings/keymaps>`",string,F5 JOY_LEFT_SHOULDER
+ ":doc:`keymap_engine-default_PAUSE <../settings/keymaps>`",string,SPACE
+ ":doc:`keymap_engine-default_PIND <../settings/keymaps>`",string,
+ ":doc:`keymap_engine-default_RCLK <../settings/keymaps>`",string,MOUSE_RIGHT JOY_B
+ ":doc:`keymap_engine-default_RETURN <../settings/keymaps>`",string,RETURN
+ ":doc:`keymap_engine-default_RIGHT <../settings/keymaps>`",string,JOY_RIGHT
+ ":doc:`keymap_engine-default_SKIP <../settings/keymaps>`",string,ESCAPE JOY
+ ":doc:`keymap_engine-default_SKLI <../settings/keymaps>`",string,PERIOD JOY_X
+ ":doc:`keymap_engine-default_UP <../settings/keymaps>`",string,JOY_UP
+ ":doc:`keymap_global_DEBUGGER <../settings/keymaps>`",string,C+A+d
+ ":doc:`keymap_global_MENU <../settings/keymaps>`",string,C+F5 JOY_START
+ ":doc:`keymap_global_MUTE <../settings/keymaps>`",string,C+u
+ ":doc:`keymap_global_QUIT <../settings/keymaps>`",string,C+q
+ ":doc:`keymap_global_VMOUSEDOWN <../settings/keymaps>`",string,JOY_LEFT_STICK_Y+
+ ":doc:`keymap_global_VMOUSELEFT <../settings/keymaps>`",string,JOY_LEFT_STICK_X-
+ ":doc:`keymap_global_VMOUSERIGHT <../settings/keymaps>`",string,JOY_LEFT_STICK_X+
+ ":doc:`keymap_global_VMOUSESLOW <../settings/keymaps>`",string,JOY_RIGHT_SHOULDER
+ ":doc:`keymap_global_VMOUSEUP <../settings/keymaps>`",string,JOY_LEFT_STICK_Y-
+ ":doc:`keymap_gui_CLOS <../settings/keymaps>`",string,ESCAPE JOY_Y
+ ":doc:`keymap_gui_DOWN <../settings/keymaps>`",string,JOY_DOWN
+ ":doc:`keymap_gui_INTRCT <../settings/keymaps>`",string,JOY_A
+ ":doc:`keymap_gui_LEFT <../settings/keymaps>`",string,
+ ":doc:`keymap_gui_RIGHT <../settings/keymaps>`",string,JOY_RIGHT
+ ":doc:`keymap_gui_UP <../settings/keymaps>`",string,JOY_UP
+ ":doc:`keymap_sdl-graphics_ASPT <../settings/keymaps>`",string,C+A+a
+ ":doc:`keymap_sdl-graphics_CAPT <../settings/keymaps>`",string,C+m
+ ":doc:`keymap_sdl-graphics_FILT <../settings/keymaps>`",string,C+A+f
+ ":doc:`keymap_sdl-graphics_FLT1 <../settings/keymaps>`",string,C+A+1
+ ":doc:`keymap_sdl-graphics_FLT2 <../settings/keymaps>`",string,C+A+2
+ ":doc:`keymap_sdl-graphics_FLT3 <../settings/keymaps>`",string,C+A+3
+ ":doc:`keymap_sdl-graphics_FLT4 <../settings/keymaps>`",string,C+A+4
+ ":doc:`keymap_sdl-graphics_FLT5 <../settings/keymaps>`",string,C+A+5
+ ":doc:`keymap_sdl-graphics_FLT6 <../settings/keymaps>`",string, C+A+6
+ ":doc:`keymap_sdl-graphics_FLT7 <../settings/keymaps>`",string,C+A+7
+ ":doc:`keymap_sdl-graphics_FLT8 <../settings/keymaps>`",string,C+A+8
+ ":doc:`keymap_sdl-graphics_FULS <../settings/keymaps>`",string,A+RETURN
+ ":doc:`keymap_sdl-graphics_SCL- <../settings/keymaps>`",string,C+A+MINUS
+ ":doc:`keymap_sdl-graphics_SCL+ <../settings/keymaps>`",string,C+A+PLUS
+ ":doc:`keymap_sdl-graphics_SCRS <../settings/keymaps>`",string,A+s
+ ":doc:`keymap_sdl-graphics_STCH <../settings/keymaps>`",string,C+A+s
":ref:`language <lang>`",string,,
":ref:`local_server_port <serverport>`",integer,12345,
":ref:`midi_gain <gain>`",number,,"- 0 - 1000"
@@ -215,34 +265,53 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`mousesupport <support>`",boolean,true,
":ref:`mt32_device <mt32>`",string,,"
- auto
- - alsa_midi Through
+ - alsa
- seq
- - sndio
- fluidsynth
- mt32
- timidity "
":ref:`multi_midi <multi>`",boolean,,
- ":ref:`music_driver <device>`",string,auto,"
+ ":ref:`music_driver [scummvm] <device>`",string,auto,"
- null
- auto
- - alsa_Midi Through
- - seq
- - sndio
+
+ - seq (Unix)
+ - sndio (Unix)
+ - alsa (Unix)
+ - CAMD (Amiga)
+ - core (Mac)
+ - coremidi (Mac - hardware)
+
+ - windows (Windows)
+
- fluidsynth
- mt32
- - timidity
+ - adlib
- pcspk
- pcjr
- cms
- - adlib "
+ - timidity
+ "
+ "music_driver [game]",string, auto, "
+ The same options as
+
+ ``music_driver in [scummvm]``
+
+ plus:
+
+ - towns
+ - C64
+ - pc98
+ - segacd
+ "
":ref:`music_volume <music>`",number,,"- 0-256 "
":ref:`mute <mute>`",boolean,false,
- ":ref:`native_fb01 <fb01>`",,false,
+ ":ref:`native_fb01 <fb01>`",boolean,false,
":ref:`native_mt32 <nativemt32>`",boolean,false,
- ":ref:`NaughtyMode <naughty>`",,true,
- ":ref:`nodelaymillisfl <nodelay>`",,false,
- ":ref:`ntsc <ntsc>`",,?,
- ":ref:`object_labels <labels>`",,true,
+ ":ref:`NaughtyMode <naughty>`",boolean,true,
+ ":ref:`nodelaymillisfl <nodelay>`",boolean,false,
+ ":ref:`ntsc <ntsc>`",boolean,,
+ ":ref:`object_labels <labels>`",boolean,true,
":ref:`opl_driver <opl>`",string,,"
- auto
- mame
@@ -252,9 +321,9 @@ There are many recognized configuration keywords. In the table below, each keywo
- op2lpt
- op3lpt "
":ref:`originalsaveload <osl>`",boolean,false,
- output_rate,number,,"
+ ":ref:`output_rate <outputrate>`",number,,"
Sensible values are:
-
+
- 11025
- 22050
- 44100"
@@ -299,7 +368,7 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`subtitles <speechmute>`",boolean,false,
":ref:`talkspeed <talkspeed>`",number,60,"- 0 - 255 "
tempo,number,100,"- 50-200"
- ":ref:`TextWindowAnimated <textanimated>`",boolean,true,
+ ":ref:`TextWindowAnimated <windowanimated>`",boolean,true,
":ref:`themepath <themepath>`",string,none,
":ref:`transparent_windows <transparentwindows>`",boolean,true,
":ref:`transparentdialogboxes <transparentdialog>`",boolean,false,
diff --git a/doc/docportal/advanced_options/graphics.rst b/doc/docportal/advanced_options/graphics.rst
deleted file mode 100644
index bba9a633e3..0000000000
--- a/doc/docportal/advanced_options/graphics.rst
+++ /dev/null
@@ -1,143 +0,0 @@
-
-============================================
-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.
-
-.. 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
-----------------
-
-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: b68c04b805bb6be0a9b58cf6d19436fa34ecb458
https://github.com/scummvm/scummvm/commit/b68c04b805bb6be0a9b58cf6d19436fa34ecb458
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: adds first draft Games section pages
Changed paths:
A doc/docportal/games/copy_protection.rst
diff --git a/doc/docportal/games/copy_protection.rst b/doc/docportal/games/copy_protection.rst
new file mode 100644
index 0000000000..408e755d11
--- /dev/null
+++ b/doc/docportal/games/copy_protection.rst
@@ -0,0 +1,26 @@
+
+====================
+Copy protection
+====================
+
+The ScummVM team does not condone piracy. However, there are cases where the game companies themselves bundled 'cracked' executables with their games. In these cases the data files still contain the copy protection scripts, but the interpreter bypasses them - similar to what an illegally cracked version might do, only that here the producer of the game did it. There is no way for us to tell the difference between legitimate and pirated data files, so for the games where we know that a cracked version of the original interpreter was sold at some point, ScummVM has to bypass the copy protection.
+
+In some cases ScummVM still shows the copy protection screen. Try entering any answer; chances are that it will work.
+
+ScummVM skips copy protection in the following games:
+
+- Beneath a Steel Sky. Bypassed with kind permission from Revolution Software.
+- Dreamweb.
+- Inherit the Earth: Quest for the Orb (Floppy version). Bypassed with kind permission from Wyrmkeep Entertainment, since it was bypassed in all CD releases of the game.
+- Loom (EGA DOS)
+- Lure of the Temptress
+- Maniac Mansion
+- Might and Magic: World of Xeen
+- Monkey Island 2: LeChuck's Revenge
+- Rex Nebular and The Cosmic Gender Bender
+- Simon the Sorcerer 1 (Floppy version)
+- Simon the Sorcerer 2 (Floppy version). Bypassed with kind permission from Adventure Soft, since it was bypassed in all CD releases of the game.
+- The Secret of Monkey Island (VGA)
+- Voyeur
+- Waxworks
+- Zak McKracken and the Alien Mindbenders
Commit: 3a79ee2cc34a835f2e59274168d18c8d077cdd15
https://github.com/scummvm/scummvm/commit/3a79ee2cc34a835f2e59274168d18c8d077cdd15
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: changes Getting started section
- removed iOS/Android pages
- Getting started will only cover Mac/Windows/Linux
Changed paths:
A doc/docportal/getting_started/mac_linux_windows.rst
R doc/docportal/getting_started/android.rst
R doc/docportal/getting_started/ios.rst
R doc/docportal/getting_started/linux.rst
R doc/docportal/getting_started/mac.rst
R doc/docportal/getting_started/windows.rst
diff --git a/doc/docportal/getting_started/android.rst b/doc/docportal/getting_started/android.rst
deleted file mode 100644
index d4949f82b8..0000000000
--- a/doc/docportal/getting_started/android.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-
-===============
-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.
-
-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.
- - 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>`_.
-
-
-
-
-
-
-
-
diff --git a/doc/docportal/getting_started/ios.rst b/doc/docportal/getting_started/ios.rst
deleted file mode 100644
index 8c9e1b9795..0000000000
--- a/doc/docportal/getting_started/ios.rst
+++ /dev/null
@@ -1,162 +0,0 @@
-
-==============
-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
-
-
-
-
-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
-
-
-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
-=======================================
-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.
-
-.. 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.
-
-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>`_.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/doc/docportal/getting_started/mac.rst b/doc/docportal/getting_started/mac.rst
deleted file mode 100644
index e70b61176b..0000000000
--- a/doc/docportal/getting_started/mac.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-
-====================================================================
-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/linux.rst b/doc/docportal/getting_started/mac_linux_windows.rst
similarity index 68%
rename from doc/docportal/getting_started/linux.rst
rename to doc/docportal/getting_started/mac_linux_windows.rst
index 8146361c34..8ef2f6fee9 100644
--- a/doc/docportal/getting_started/linux.rst
+++ b/doc/docportal/getting_started/mac_linux_windows.rst
@@ -1,14 +1,26 @@
-====================================================================
-Linux
-====================================================================
+========================
+Mac, Linux or Windows
+========================
-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/>`_.
+All downloads referenced on this page are available from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_.
+
+Mac OSX
+---------
+
+Download the Disk Image. 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.
+
+Linux
+--------
+
+
+There are multiple ways to install ScummVM onto a computer running Linux.
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.
@@ -22,7 +34,8 @@ Enter the following on the command line (using your preferred Terminal applicati
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:
@@ -46,7 +59,7 @@ To run ScummVM, enter the following on the command line:
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.
@@ -56,7 +69,7 @@ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through
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:
@@ -68,6 +81,18 @@ In this situation, replace the ``/path/to/package/name.deb`` with the actual pat
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>`!
+Windows
+---------
+
+ScummVM requires Windows XP or higher.
+
+
+The easiest way to install ScummVM is to download the Windows installer. 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. To run ScummVM from the Start menu, go to **Start > All Apps > ScummVM**. For Windows XP, go to **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.
+
+Next steps...
+-----------------------
+
+ScummVM is now installed and ready for you to :doc:`add your games <../using_scummvm/adding_games>`!
diff --git a/doc/docportal/getting_started/windows.rst b/doc/docportal/getting_started/windows.rst
deleted file mode 100644
index d3e8bec392..0000000000
--- a/doc/docportal/getting_started/windows.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-
-====================================================================
-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>`!
Commit: b31eb824d95185b1c0c2736bfeeb4e8b0031275d
https://github.com/scummvm/scummvm/commit/b31eb824d95185b1c0c2736bfeeb4e8b0031275d
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: updates all screenshots for V2.2.0
Changed paths:
A doc/docportal/images/Launcher/add_game.png
A doc/docportal/images/Launcher/choose_game_directory.png
A doc/docportal/images/Launcher/edit_game.png
A doc/docportal/images/Launcher/game_settings.png
A doc/docportal/images/Launcher/gmm.png
A doc/docportal/images/Launcher/gmm_help.png
A doc/docportal/images/Launcher/gmm_load_save.png
A doc/docportal/images/Launcher/gmm_options_audio.png
A doc/docportal/images/Launcher/gmm_options_keymaps.png
A doc/docportal/images/Launcher/gmm_save.png
A doc/docportal/images/Launcher/load_game_list.png
A doc/docportal/images/Launcher/load_game_tile.png
A doc/docportal/images/Launcher/mass_add.png
A doc/docportal/images/Launcher/options.png
A doc/docportal/images/Launcher/quicksearch.png
A doc/docportal/images/Launcher/remove_game.png
A doc/docportal/images/Launcher/save_game_list.png
A doc/docportal/images/Launcher/save_game_tile.png
A doc/docportal/images/Launcher/save_game_tile_desc.png
A doc/docportal/images/Launcher/start_game.png
A doc/docportal/images/cloud_and_lan/cloud_code.png
A doc/docportal/images/cloud_and_lan/cloud_connect.png
A doc/docportal/images/cloud_and_lan/cloud_enable.png
A doc/docportal/images/cloud_and_lan/cloud_storage.png
A doc/docportal/images/ios/choose_device.gif
A doc/docportal/images/ios/identifier.gif
A doc/docportal/images/ios/signing.gif
A doc/docportal/images/settings/LAN.png
A doc/docportal/images/settings/LAN_server.png
A doc/docportal/images/settings/LAN_server_new.png
A doc/docportal/images/settings/LAN_server_upload.png
A doc/docportal/images/settings/MIDI.png
A doc/docportal/images/settings/MIDI_game.png
A doc/docportal/images/settings/MT32.png
A doc/docportal/images/settings/MT32_game.png
A doc/docportal/images/settings/accessibility.png
A doc/docportal/images/settings/audio.png
A doc/docportal/images/settings/audio_game.png
A doc/docportal/images/settings/cloud.png
A doc/docportal/images/settings/control.png
A doc/docportal/images/settings/engine.png
A doc/docportal/images/settings/fluidsynth.png
A doc/docportal/images/settings/game.png
A doc/docportal/images/settings/graphics.png
A doc/docportal/images/settings/graphics_game.png
A doc/docportal/images/settings/keymaps.png
A doc/docportal/images/settings/keymaps_dropdown.png
A doc/docportal/images/settings/misc.png
A doc/docportal/images/settings/paths.png
A doc/docportal/images/settings/volume.png
A doc/docportal/images/settings/volume_game.png
R doc/docportal/images/Launcher/add_game.jpg
R doc/docportal/images/Launcher/choose_directory.jpg
R doc/docportal/images/Launcher/choose_game_directory.jpg
R doc/docportal/images/Launcher/edit_game.jpg
R doc/docportal/images/Launcher/global_settings.jpg
R doc/docportal/images/Launcher/gmm.jpg
R doc/docportal/images/Launcher/gmm_help.jpg
R doc/docportal/images/Launcher/gmm_options.jpg
R doc/docportal/images/Launcher/options.jpg
R doc/docportal/images/Launcher/quicksearch.jpg
R doc/docportal/images/Launcher/remove_game.jpg
R doc/docportal/images/Launcher/save_game.jpg
R doc/docportal/images/Launcher/save_game_desc.jpg
R doc/docportal/images/Launcher/save_game_list.jpg
R doc/docportal/images/Launcher/save_game_tile.jpg
R doc/docportal/images/Launcher/start_game.jpg
R doc/docportal/images/Launcher/the_launcher.jpg
doc/docportal/images/Launcher/the_launcher.png
doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png
doc/docportal/images/graphics/aspect_ratio/no_aspect_ratio.png
doc/docportal/images/graphics/graphics_mode/1x.png
doc/docportal/images/graphics/graphics_mode/2x.png
doc/docportal/images/graphics/graphics_mode/2xsai.png
doc/docportal/images/graphics/graphics_mode/3x.png
doc/docportal/images/graphics/graphics_mode/advmame2x.png
doc/docportal/images/graphics/graphics_mode/advmame3x.png
doc/docportal/images/graphics/graphics_mode/dotmatrix.png
doc/docportal/images/graphics/graphics_mode/hq2x.png
doc/docportal/images/graphics/graphics_mode/hq3x.png
doc/docportal/images/graphics/graphics_mode/super2xsai.png
doc/docportal/images/graphics/graphics_mode/supereagle.png
doc/docportal/images/graphics/graphics_mode/tv2x.png
doc/docportal/images/graphics/render_mode/amiga.png
doc/docportal/images/graphics/render_mode/cga.png
doc/docportal/images/graphics/render_mode/default.png
doc/docportal/images/graphics/render_mode/ega.png
doc/docportal/images/graphics/render_mode/herc_amber.png
doc/docportal/images/graphics/render_mode/herc_green.png
diff --git a/doc/docportal/images/Launcher/add_game.jpg b/doc/docportal/images/Launcher/add_game.jpg
deleted file mode 100755
index 0751390681..0000000000
Binary files a/doc/docportal/images/Launcher/add_game.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/add_game.png b/doc/docportal/images/Launcher/add_game.png
new file mode 100644
index 0000000000..f45f342cf7
Binary files /dev/null and b/doc/docportal/images/Launcher/add_game.png differ
diff --git a/doc/docportal/images/Launcher/choose_directory.jpg b/doc/docportal/images/Launcher/choose_directory.jpg
deleted file mode 100644
index 8dcba776d7..0000000000
Binary files a/doc/docportal/images/Launcher/choose_directory.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/choose_game_directory.jpg b/doc/docportal/images/Launcher/choose_game_directory.jpg
deleted file mode 100644
index ebf97412cc..0000000000
Binary files a/doc/docportal/images/Launcher/choose_game_directory.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/choose_game_directory.png b/doc/docportal/images/Launcher/choose_game_directory.png
new file mode 100644
index 0000000000..ff30edd2ad
Binary files /dev/null and b/doc/docportal/images/Launcher/choose_game_directory.png differ
diff --git a/doc/docportal/images/Launcher/edit_game.jpg b/doc/docportal/images/Launcher/edit_game.jpg
deleted file mode 100644
index 4d46f31544..0000000000
Binary files a/doc/docportal/images/Launcher/edit_game.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/edit_game.png b/doc/docportal/images/Launcher/edit_game.png
new file mode 100644
index 0000000000..7e253807ee
Binary files /dev/null and b/doc/docportal/images/Launcher/edit_game.png differ
diff --git a/doc/docportal/images/Launcher/game_settings.png b/doc/docportal/images/Launcher/game_settings.png
new file mode 100644
index 0000000000..65ab29e808
Binary files /dev/null and b/doc/docportal/images/Launcher/game_settings.png differ
diff --git a/doc/docportal/images/Launcher/global_settings.jpg b/doc/docportal/images/Launcher/global_settings.jpg
deleted file mode 100644
index 1aeaca0f99..0000000000
Binary files a/doc/docportal/images/Launcher/global_settings.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/gmm.jpg b/doc/docportal/images/Launcher/gmm.jpg
deleted file mode 100644
index bcf1991d58..0000000000
Binary files a/doc/docportal/images/Launcher/gmm.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/gmm.png b/doc/docportal/images/Launcher/gmm.png
new file mode 100644
index 0000000000..e638e6fb5c
Binary files /dev/null and b/doc/docportal/images/Launcher/gmm.png differ
diff --git a/doc/docportal/images/Launcher/gmm_help.jpg b/doc/docportal/images/Launcher/gmm_help.jpg
deleted file mode 100644
index b88174bf32..0000000000
Binary files a/doc/docportal/images/Launcher/gmm_help.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/gmm_help.png b/doc/docportal/images/Launcher/gmm_help.png
new file mode 100644
index 0000000000..ecb7d9731a
Binary files /dev/null and b/doc/docportal/images/Launcher/gmm_help.png differ
diff --git a/doc/docportal/images/Launcher/gmm_load_save.png b/doc/docportal/images/Launcher/gmm_load_save.png
new file mode 100644
index 0000000000..d77445b755
Binary files /dev/null and b/doc/docportal/images/Launcher/gmm_load_save.png differ
diff --git a/doc/docportal/images/Launcher/gmm_options.jpg b/doc/docportal/images/Launcher/gmm_options.jpg
deleted file mode 100644
index e131040dbe..0000000000
Binary files a/doc/docportal/images/Launcher/gmm_options.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/gmm_options_audio.png b/doc/docportal/images/Launcher/gmm_options_audio.png
new file mode 100644
index 0000000000..2ccc187719
Binary files /dev/null and b/doc/docportal/images/Launcher/gmm_options_audio.png differ
diff --git a/doc/docportal/images/Launcher/gmm_options_keymaps.png b/doc/docportal/images/Launcher/gmm_options_keymaps.png
new file mode 100644
index 0000000000..5ff2313361
Binary files /dev/null and b/doc/docportal/images/Launcher/gmm_options_keymaps.png differ
diff --git a/doc/docportal/images/Launcher/gmm_save.png b/doc/docportal/images/Launcher/gmm_save.png
new file mode 100644
index 0000000000..bd85af6906
Binary files /dev/null and b/doc/docportal/images/Launcher/gmm_save.png differ
diff --git a/doc/docportal/images/Launcher/load_game_list.png b/doc/docportal/images/Launcher/load_game_list.png
new file mode 100644
index 0000000000..9c213688d5
Binary files /dev/null and b/doc/docportal/images/Launcher/load_game_list.png differ
diff --git a/doc/docportal/images/Launcher/load_game_tile.png b/doc/docportal/images/Launcher/load_game_tile.png
new file mode 100644
index 0000000000..d8381d32ac
Binary files /dev/null and b/doc/docportal/images/Launcher/load_game_tile.png differ
diff --git a/doc/docportal/images/Launcher/mass_add.png b/doc/docportal/images/Launcher/mass_add.png
new file mode 100644
index 0000000000..28e488a052
Binary files /dev/null and b/doc/docportal/images/Launcher/mass_add.png differ
diff --git a/doc/docportal/images/Launcher/options.jpg b/doc/docportal/images/Launcher/options.jpg
deleted file mode 100644
index 8d692eb7d6..0000000000
Binary files a/doc/docportal/images/Launcher/options.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/options.png b/doc/docportal/images/Launcher/options.png
new file mode 100644
index 0000000000..0ba527c9af
Binary files /dev/null and b/doc/docportal/images/Launcher/options.png differ
diff --git a/doc/docportal/images/Launcher/quicksearch.jpg b/doc/docportal/images/Launcher/quicksearch.jpg
deleted file mode 100644
index e364f2e57d..0000000000
Binary files a/doc/docportal/images/Launcher/quicksearch.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/quicksearch.png b/doc/docportal/images/Launcher/quicksearch.png
new file mode 100644
index 0000000000..fc0f7bdf50
Binary files /dev/null and b/doc/docportal/images/Launcher/quicksearch.png differ
diff --git a/doc/docportal/images/Launcher/remove_game.jpg b/doc/docportal/images/Launcher/remove_game.jpg
deleted file mode 100644
index 9594504721..0000000000
Binary files a/doc/docportal/images/Launcher/remove_game.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/remove_game.png b/doc/docportal/images/Launcher/remove_game.png
new file mode 100644
index 0000000000..18ec67027b
Binary files /dev/null and b/doc/docportal/images/Launcher/remove_game.png differ
diff --git a/doc/docportal/images/Launcher/save_game.jpg b/doc/docportal/images/Launcher/save_game.jpg
deleted file mode 100644
index 25da469bbd..0000000000
Binary files a/doc/docportal/images/Launcher/save_game.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/save_game_desc.jpg b/doc/docportal/images/Launcher/save_game_desc.jpg
deleted file mode 100644
index 740ae46d91..0000000000
Binary files a/doc/docportal/images/Launcher/save_game_desc.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/save_game_list.jpg b/doc/docportal/images/Launcher/save_game_list.jpg
deleted file mode 100644
index 8437ac9f97..0000000000
Binary files a/doc/docportal/images/Launcher/save_game_list.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/save_game_list.png b/doc/docportal/images/Launcher/save_game_list.png
new file mode 100644
index 0000000000..c9f987ecd8
Binary files /dev/null and b/doc/docportal/images/Launcher/save_game_list.png differ
diff --git a/doc/docportal/images/Launcher/save_game_tile.jpg b/doc/docportal/images/Launcher/save_game_tile.jpg
deleted file mode 100644
index bacfab59b8..0000000000
Binary files a/doc/docportal/images/Launcher/save_game_tile.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/save_game_tile.png b/doc/docportal/images/Launcher/save_game_tile.png
new file mode 100644
index 0000000000..31abc8d91a
Binary files /dev/null and b/doc/docportal/images/Launcher/save_game_tile.png differ
diff --git a/doc/docportal/images/Launcher/save_game_tile_desc.png b/doc/docportal/images/Launcher/save_game_tile_desc.png
new file mode 100644
index 0000000000..b2425b0ad1
Binary files /dev/null and b/doc/docportal/images/Launcher/save_game_tile_desc.png differ
diff --git a/doc/docportal/images/Launcher/start_game.jpg b/doc/docportal/images/Launcher/start_game.jpg
deleted file mode 100644
index 434b6239af..0000000000
Binary files a/doc/docportal/images/Launcher/start_game.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/start_game.png b/doc/docportal/images/Launcher/start_game.png
new file mode 100644
index 0000000000..89e60c4b47
Binary files /dev/null and b/doc/docportal/images/Launcher/start_game.png differ
diff --git a/doc/docportal/images/Launcher/the_launcher.jpg b/doc/docportal/images/Launcher/the_launcher.jpg
deleted file mode 100644
index c3cdcfc6c0..0000000000
Binary files a/doc/docportal/images/Launcher/the_launcher.jpg and /dev/null differ
diff --git a/doc/docportal/images/Launcher/the_launcher.png b/doc/docportal/images/Launcher/the_launcher.png
index fa1f0a6e32..db1386f94c 100644
Binary files a/doc/docportal/images/Launcher/the_launcher.png and b/doc/docportal/images/Launcher/the_launcher.png differ
diff --git a/doc/docportal/images/cloud_and_lan/cloud_code.png b/doc/docportal/images/cloud_and_lan/cloud_code.png
new file mode 100644
index 0000000000..fd689d6737
Binary files /dev/null and b/doc/docportal/images/cloud_and_lan/cloud_code.png differ
diff --git a/doc/docportal/images/cloud_and_lan/cloud_connect.png b/doc/docportal/images/cloud_and_lan/cloud_connect.png
new file mode 100644
index 0000000000..34af7747cc
Binary files /dev/null and b/doc/docportal/images/cloud_and_lan/cloud_connect.png differ
diff --git a/doc/docportal/images/cloud_and_lan/cloud_enable.png b/doc/docportal/images/cloud_and_lan/cloud_enable.png
new file mode 100644
index 0000000000..6ecad8ce8c
Binary files /dev/null and b/doc/docportal/images/cloud_and_lan/cloud_enable.png differ
diff --git a/doc/docportal/images/cloud_and_lan/cloud_storage.png b/doc/docportal/images/cloud_and_lan/cloud_storage.png
new file mode 100644
index 0000000000..16baaa6837
Binary files /dev/null and b/doc/docportal/images/cloud_and_lan/cloud_storage.png differ
diff --git a/doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png b/doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png
index 5bd7eea9d3..1c583ab8cc 100644
Binary files a/doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png 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
index cf4f41c361..b3ce3b13a5 100644
Binary files a/doc/docportal/images/graphics/aspect_ratio/no_aspect_ratio.png and b/doc/docportal/images/graphics/aspect_ratio/no_aspect_ratio.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/1x.png b/doc/docportal/images/graphics/graphics_mode/1x.png
index 444b1d9752..d30afdd9fc 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/1x.png 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
index 6cdd557062..e9121ba08c 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/2x.png 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
index fed9e92bba..024b9d3910 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/2xsai.png 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
index 378c70d930..bcee73ba5a 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/3x.png 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
index 55de3ba2b4..11769c4963 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/advmame2x.png 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
index bbebca78af..d8ec958df3 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/advmame3x.png 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
index 4c90ca070e..47cd6704ac 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/dotmatrix.png 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
index 7bb0438f57..f2ac5a9438 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/hq2x.png 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
index 1605973485..98e819dc48 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/hq3x.png 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
index b28047462c..2b97f56047 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/super2xsai.png 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
index 4411e8bf68..31f69f9e5e 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/supereagle.png 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
index c9bd0f6730..9bdbb49c47 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/tv2x.png 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
index 4a9aa825b6..8f53109108 100644
Binary files a/doc/docportal/images/graphics/render_mode/amiga.png 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
index b3ecaf943e..6fc38d1904 100644
Binary files a/doc/docportal/images/graphics/render_mode/cga.png 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
index 32853c1431..e60da9bc87 100644
Binary files a/doc/docportal/images/graphics/render_mode/default.png 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
index 26c97b5ebc..e60da9bc87 100644
Binary files a/doc/docportal/images/graphics/render_mode/ega.png 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
index 084c3f48d7..f06086ae00 100644
Binary files a/doc/docportal/images/graphics/render_mode/herc_amber.png 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
index 3c941e67ac..d684d171dd 100644
Binary files a/doc/docportal/images/graphics/render_mode/herc_green.png and b/doc/docportal/images/graphics/render_mode/herc_green.png differ
diff --git a/doc/docportal/images/ios/choose_device.gif b/doc/docportal/images/ios/choose_device.gif
new file mode 100644
index 0000000000..c25dbf12a7
Binary files /dev/null and b/doc/docportal/images/ios/choose_device.gif differ
diff --git a/doc/docportal/images/ios/identifier.gif b/doc/docportal/images/ios/identifier.gif
new file mode 100644
index 0000000000..4e238051b8
Binary files /dev/null and b/doc/docportal/images/ios/identifier.gif differ
diff --git a/doc/docportal/images/ios/signing.gif b/doc/docportal/images/ios/signing.gif
new file mode 100644
index 0000000000..5361c0ac50
Binary files /dev/null and b/doc/docportal/images/ios/signing.gif differ
diff --git a/doc/docportal/images/settings/LAN.png b/doc/docportal/images/settings/LAN.png
new file mode 100644
index 0000000000..527712f588
Binary files /dev/null and b/doc/docportal/images/settings/LAN.png differ
diff --git a/doc/docportal/images/settings/LAN_server.png b/doc/docportal/images/settings/LAN_server.png
new file mode 100644
index 0000000000..b1a9186b4f
Binary files /dev/null and b/doc/docportal/images/settings/LAN_server.png differ
diff --git a/doc/docportal/images/settings/LAN_server_new.png b/doc/docportal/images/settings/LAN_server_new.png
new file mode 100644
index 0000000000..c9ef83c69e
Binary files /dev/null and b/doc/docportal/images/settings/LAN_server_new.png differ
diff --git a/doc/docportal/images/settings/LAN_server_upload.png b/doc/docportal/images/settings/LAN_server_upload.png
new file mode 100644
index 0000000000..a75c4de243
Binary files /dev/null and b/doc/docportal/images/settings/LAN_server_upload.png differ
diff --git a/doc/docportal/images/settings/MIDI.png b/doc/docportal/images/settings/MIDI.png
new file mode 100644
index 0000000000..d3706e4846
Binary files /dev/null and b/doc/docportal/images/settings/MIDI.png differ
diff --git a/doc/docportal/images/settings/MIDI_game.png b/doc/docportal/images/settings/MIDI_game.png
new file mode 100644
index 0000000000..f50415fb47
Binary files /dev/null and b/doc/docportal/images/settings/MIDI_game.png differ
diff --git a/doc/docportal/images/settings/MT32.png b/doc/docportal/images/settings/MT32.png
new file mode 100644
index 0000000000..77bb9f0eb6
Binary files /dev/null and b/doc/docportal/images/settings/MT32.png differ
diff --git a/doc/docportal/images/settings/MT32_game.png b/doc/docportal/images/settings/MT32_game.png
new file mode 100644
index 0000000000..de9f5c293a
Binary files /dev/null and b/doc/docportal/images/settings/MT32_game.png differ
diff --git a/doc/docportal/images/settings/accessibility.png b/doc/docportal/images/settings/accessibility.png
new file mode 100644
index 0000000000..c077716f13
Binary files /dev/null and b/doc/docportal/images/settings/accessibility.png differ
diff --git a/doc/docportal/images/settings/audio.png b/doc/docportal/images/settings/audio.png
new file mode 100644
index 0000000000..cc6c3e10bc
Binary files /dev/null and b/doc/docportal/images/settings/audio.png differ
diff --git a/doc/docportal/images/settings/audio_game.png b/doc/docportal/images/settings/audio_game.png
new file mode 100644
index 0000000000..10d8cd949b
Binary files /dev/null and b/doc/docportal/images/settings/audio_game.png differ
diff --git a/doc/docportal/images/settings/cloud.png b/doc/docportal/images/settings/cloud.png
new file mode 100644
index 0000000000..e9ad46bd8e
Binary files /dev/null and b/doc/docportal/images/settings/cloud.png differ
diff --git a/doc/docportal/images/settings/control.png b/doc/docportal/images/settings/control.png
new file mode 100644
index 0000000000..eed47c76ab
Binary files /dev/null and b/doc/docportal/images/settings/control.png differ
diff --git a/doc/docportal/images/settings/engine.png b/doc/docportal/images/settings/engine.png
new file mode 100644
index 0000000000..3eb4fb8862
Binary files /dev/null and b/doc/docportal/images/settings/engine.png differ
diff --git a/doc/docportal/images/settings/fluidsynth.png b/doc/docportal/images/settings/fluidsynth.png
new file mode 100644
index 0000000000..11f27093b6
Binary files /dev/null and b/doc/docportal/images/settings/fluidsynth.png differ
diff --git a/doc/docportal/images/settings/game.png b/doc/docportal/images/settings/game.png
new file mode 100644
index 0000000000..b53a9b7f1f
Binary files /dev/null and b/doc/docportal/images/settings/game.png differ
diff --git a/doc/docportal/images/settings/graphics.png b/doc/docportal/images/settings/graphics.png
new file mode 100644
index 0000000000..011de28798
Binary files /dev/null and b/doc/docportal/images/settings/graphics.png differ
diff --git a/doc/docportal/images/settings/graphics_game.png b/doc/docportal/images/settings/graphics_game.png
new file mode 100644
index 0000000000..43925ecb95
Binary files /dev/null and b/doc/docportal/images/settings/graphics_game.png differ
diff --git a/doc/docportal/images/settings/keymaps.png b/doc/docportal/images/settings/keymaps.png
new file mode 100644
index 0000000000..98446ec27d
Binary files /dev/null and b/doc/docportal/images/settings/keymaps.png differ
diff --git a/doc/docportal/images/settings/keymaps_dropdown.png b/doc/docportal/images/settings/keymaps_dropdown.png
new file mode 100644
index 0000000000..93a6ba00ec
Binary files /dev/null and b/doc/docportal/images/settings/keymaps_dropdown.png differ
diff --git a/doc/docportal/images/settings/misc.png b/doc/docportal/images/settings/misc.png
new file mode 100644
index 0000000000..655b9b985b
Binary files /dev/null and b/doc/docportal/images/settings/misc.png differ
diff --git a/doc/docportal/images/settings/paths.png b/doc/docportal/images/settings/paths.png
new file mode 100644
index 0000000000..b626140f8f
Binary files /dev/null and b/doc/docportal/images/settings/paths.png differ
diff --git a/doc/docportal/images/settings/volume.png b/doc/docportal/images/settings/volume.png
new file mode 100644
index 0000000000..3ce9d8f398
Binary files /dev/null and b/doc/docportal/images/settings/volume.png differ
diff --git a/doc/docportal/images/settings/volume_game.png b/doc/docportal/images/settings/volume_game.png
new file mode 100644
index 0000000000..4d535e6ead
Binary files /dev/null and b/doc/docportal/images/settings/volume_game.png differ
Commit: 601baf679a73e2a0abf189d57e8f3146049cb9cc
https://github.com/scummvm/scummvm/commit/601baf679a73e2a0abf189d57e8f3146049cb9cc
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: adds first draft Help section pages
Changed paths:
A doc/docportal/help/contact.rst
A doc/docportal/help/faq.rst
A doc/docportal/help/reporting_bugs.rst
diff --git a/doc/docportal/help/contact.rst b/doc/docportal/help/contact.rst
new file mode 100644
index 0000000000..7df94adb8a
--- /dev/null
+++ b/doc/docportal/help/contact.rst
@@ -0,0 +1,10 @@
+
+==============
+Contact us!
+==============
+
+There are a few ways to become a part of the ScummVM community:
+
+Chatting on the `Discord Channel <https://discord.com/invite/5D8yTtF>`_ or the `IRC Channel <irc://irc.freenode.net/scummvm?key=scummvm>`_ | Posting on the `ScummVM Forum <https://forums.scummvm.org/>`_ | Or by `Reporting a Bug <https://bugs.scummvm.org/>`_
+
+We look forward to meeting you!
\ No newline at end of file
diff --git a/doc/docportal/help/faq.rst b/doc/docportal/help/faq.rst
new file mode 100644
index 0000000000..df3a79477a
--- /dev/null
+++ b/doc/docportal/help/faq.rst
@@ -0,0 +1,152 @@
+
+============================
+Frequently Asked Questions
+============================
+
+General
+==================
+
+About
+*******
+
+Q: Is ScummVM an emulator?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** No. ScummVM replaces the original executable files that shipped with the game. This means that your games can run on many different platforms they were never designed to run on! For an in-depth look at how ScummVM works, see our `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
+
+Q: Is ScummVM free?
+^^^^^^^^^^^^^^^^^^^^
+**A:** ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is freely available and you can do whatever you want with it. If you make modifications and redistribute your work, you must make the source code available.
+
+The ScummVM team would be delighted if you send them your modifications, so that the changes can be merged into the main source code. See :doc:`../contributing/code`.
+
+How do I install ScummVM onto my [device]?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** See :ref:`firststeps`.
+
+On what platform(s) will ScummVM run?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** See our `Platforms list <https://wiki.scummvm.org/index.php/Platforms>`_ wiki page.
+
+Games
+********
+
+Q: Can I only play LucasArts SCUMM games?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the `Supported games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ page on our wiki for a comprehensive list. There is a caveat; not all supported games are playable on all platforms. Sometimes this is because the game is simply too CPU intensive for the device, or there may be many other reasons. If a game is not available on a platform, you will not be able to add it to ScummVM.
+
+.. _getgames:
+
+Q: Where do I get the games?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** See `Where to get the games <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ on our wiki.
+
+.. _installgames:
+
+Q: How do I install games from my floppy discs/CDs?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** Generally speaking, you do not need to install the games. You only need to point ScummVM to the game files contained on these discs. See :doc:`../using_scummvm/adding_games`.
+
+Q: Do I need the original game discs?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** If you do not have any hard copy games, there are some digital options, including some games that have been released as freeware. See :ref:`getgames`.
+
+Q: How do I know if I can play my game using ScummVM?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The best place to check is the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
+
+Q: I have saved games from when I played the original game - can I use these with ScummVM?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** This is only supported for a select number of games. See :ref:`originalsaves`.
+
+Q: How do I launch a game from the game folder?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** Games must be added to and started from :doc:`../using_scummvm/the_launcher`, they cannot be started directly from the game files. See :doc:`../using_scummvm/adding_games`.
+
+
+Troubleshooting
+===================
+
+ScummVM
+***********
+
+Q: ScummVM crashes, but the console window disappears too quickly to see the error message.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**A:** If you are using a computer, you can run ScummVM from the :doc:`command line <../advanced_options/command_line>`. Error messages remain visible even after ScummVM exits.
+
+You can also find error messages in the ScummVM log file. See :ref:`logfile`.
+
+Q: I think I found a bug. What do I do?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** See :doc:`reporting_bugs`.
+
+Games
+********
+
+Q: Help! My game won't run!
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A: First, make sure your game is supported. See the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
+
+Check that you have all the required datafiles. See :doc:`../using_scummvm/adding_games`.
+
+Ask on the forums or on Discord whether your game is supported on the platform you're trying to play it on. See :doc:`contact`.
+
+If you think the game should run, and it doesn't, report it as a bug. See :doc:`reporting_bugs`.
+
+Q: I installed my game but ScummVM can't find it... What do I do?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Installing the game does not necessarily provide ScummVM with the files it needs. See :ref:`installgames`.
+
+Q: Why are the subtitles in my non-English game messed up?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** You need to specify the correct :ref:`language <lang>` in the game-specific settings.
+
+Audio
+*******
+
+.. _nosound:
+
+Q: Help! There's no sound!
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** Sometimes it's worth checking the obvious. Are your speakers on? Are your headphones properly connected? Try playing an audio clip from another source to see if you have sound in general. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM should fall back on an audio setting that works, but if it doesn't, you may need to do so yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
+
+Q: Help! There's no sound on my iPhone/iPad!
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** ScummVM will not play any sound if your device is in Silent Mode. If this is not the problem, see :ref:`nosound`.
+
+Q: I have a "talkie" version of a LucasArts game but I can't hear the voices. What's the problem?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** The original games shipped with an uncompressed ``MONSTER.SOU`` file - this is the voice file. If you have compressed this file to either a ``MONSTER.SO3`` (``.mp3``), ``MONSTER.SOG`` (``.ogg``), or ``MONSTER.SOF`` (``.flac``) format, make sure that the ScummVM you're using has support for those formats.
+
+Q: The audio is really glitchy. What can I do?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** There may be a few things at play here:
+
+- Try to increase the :ref:`audio buffer size <buffer>` in the :doc:`configuration file <../advanced_options/configuration_file>`.
+- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU may not have the processing power to keep up. In this case, you may have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, as long as your platform supports it.
+- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU may not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
+- If you are using the :ref:`adlib` emulator, try selecting the least CPU-intensive option; MAME.
+
+Q: I have a CD version of a game, how do I get the sound to work without running the game from the CD?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** See using :ref:`cd`.
+
+Graphics
+***********
+
+Q: There are so many options... How do I know what to pick?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** Start by checking out our :doc:`../settings/graphics` settings page. It has comprehensive information on how it all works.
+
+Q: Can I just make the image larger (for example, 1 pixel becomes 4 pixels) without any smoothing or antialiasing?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** Yes. Using the **Normal (no scaling)** graphics mode in conjunction with pixel-perfect scaling will result in a larger image without any smoothing. The **2x** and **3x** graphics modes also do not involve any filtering.
+
+Ensure **Filter graphics** is not enabled.
+
+See the :doc:`../settings/graphics` settings for a more detailed explanation.
+
+Q: The game colors are messed up, how do I fix them?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**A:** Ensure the correct game has been detected. For example, with Amiga game files, check that the :ref:`platform <platform>` is set to Amiga.
\ No newline at end of file
diff --git a/doc/docportal/help/reporting_bugs.rst b/doc/docportal/help/reporting_bugs.rst
new file mode 100644
index 0000000000..17264c13d6
--- /dev/null
+++ b/doc/docportal/help/reporting_bugs.rst
@@ -0,0 +1,46 @@
+
+=======================
+Reporting a bug
+=======================
+
+To report a bug, go to the ScummVM `Issue Tracker <https://bugs.scummvm.org/>`_ and log in with your GitHub account.
+
+Please make sure the bug is reproducible, and still occurs in the latest git/Daily build version. Also check the `compatibility list <https://www.scummvm.org/compatibility/>`_ for that game, to ensure the issue is not already known.
+
+Please do not report bugs for games that are not listed as being completeable on the `Supported Games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ wiki page, or on the compatibility list. We know those games have bugs.
+
+Please include the following information in the bug report:
+
+- ScummVM version (PLEASE test the latest git/Daily build)
+- Bug details, including instructions for how to reproduce the bug
+- Language of the game
+- Version of the game (talkie, floppy, and so on)
+- Platform and Compiler (Win32, Linux, FreeBSD, and so on)
+- Attach a saved game if possible
+- If this bug only occurred recently, please note the last version without the bug, and the first version including the bug. That way we can fix it quicker by looking at the changes made.
+
+Finally, please report each issue separately; do not file multiple issues on the same ticket. It gets difficult to track the status of each individual bug when they aren't on their own tickets.
+
+.. _logfile:
+
+The ScummVM log file
+=====================
+
+You can find error messages in the ScummVM log file. The location of this file varies depending on your operating system.
+
+.. tabs::
+
+ .. tab:: Linux
+
+ We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location may vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
+
+
+ .. tab:: Windows
+
+ ``%appdata%\ScummVM\Logs\scummvm.log``
+
+
+ .. tab:: macOS
+ ``~/Library/Logs/scummvm.log``, where ``~`` is your Home directory.
+
+
\ No newline at end of file
Commit: da3a3c0d1172be9c8dfcbde36e554166bd72ff83
https://github.com/scummvm/scummvm/commit/da3a3c0d1172be9c8dfcbde36e554166bd72ff83
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: adds first draft Other platforms pages
Changed paths:
A doc/docportal/other_platforms/android.rst
A doc/docportal/other_platforms/ios.rst
A doc/docportal/other_platforms/nintendo_switch.rst
A doc/docportal/other_platforms/ps_vita.rst
A doc/docportal/other_platforms/psp.rst
diff --git a/doc/docportal/other_platforms/android.rst b/doc/docportal/other_platforms/android.rst
new file mode 100644
index 0000000000..d2db264574
--- /dev/null
+++ b/doc/docportal/other_platforms/android.rst
@@ -0,0 +1,59 @@
+
+===============
+Android
+===============
+
+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
+========================================
+
+You need to transfer all the required game data files to your device, into a folder accessible by the ScummVM app.
+
+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:`../settings/cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../settings/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.
+ - 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>`_.
+
+
+
+
+
+
+
+
diff --git a/doc/docportal/other_platforms/ios.rst b/doc/docportal/other_platforms/ios.rst
new file mode 100644
index 0000000000..07609f57bc
--- /dev/null
+++ b/doc/docportal/other_platforms/ios.rst
@@ -0,0 +1,226 @@
+
+==============
+iOS
+==============
+
+Installing ScummVM
+=====================
+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 Mac computer 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.2.0, use the following command:
+
+ .. code-block::
+
+ git checkout branch-2-2-0
+
+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.
+
+.. figure:: ../images/ios/choose_device.gif
+
+
+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*.
+
+.. figure:: ../images/ios/identifier.gif
+
+
+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.
+
+.. figure:: ../images/ios/signing.gif
+
+
+
+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.
+
+
+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
+
+
+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
+=======================================
+
+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:`../settings/cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../settings/lan` page.
+
+.. 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.
+
+Another way to transfer files (for macOS Catalina and newer) 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
+
+For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
+
+For more information on which files ScummVM requires, and how to add and play games, see `adding and playing games <adding_games>`_.
+
+Controls
+============
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 2
+
+ Game Controller Mapping,
+ Action,Touch screen control
+ Left click,Single tap
+ Right click,"Hold one finger on screen where you want to click, single tap another"
+ Arrow keys,Use a three finger swipe in the direction of the arrow key you want. You can also use the arrow buttons in the bar above the keyboard. You may need to scroll across on smaller screens to see these.
+ ESC,"Hold one finger on screen, double tap another, or use the Esc key in the bar above the keyboard."
+ Tab,The Tab button in the bar above the keyboard.
+ Return,The Return button in the bar above the keyboard.
+ Global Main Menu,"Swipe two fingers down from top to bottom, or the left-most button in the bar above the keyboard."
+ Enable/disable keyboard,"The pinch gesture enables or disables the keyboard. If no external keyboard is connected, this shows and hides the On Screen keyboard. When an external keyboard is connected, instead of showing/hiding the On Screen keyboard this enables/disables inputs from the external keyboard."
+ F 0-9 keys,The F-bar above the keyboard.
+ Pause,Keyboard spacebar
+ Toggle `Click and drag mode`_,Swipe two fingers up from bottom to top.
+ Toggle `Touchpad mode`_,Swipe two fingers from left to right.
+
+Click and drag mode
+^^^^^^^^^^^^^^^^^^^^
+
+In this mode, a mouse click is sent immediately when you touch the screen, drags to wherever you slide your finger, and releases where you lift your finger. If you press down a second finger in this mode, you effectively release the left mouse button, and press down the right one, which is then released when you lift your finger again.
+
+This is especially useful for Monkey Island 3: The Curse of Monkey Island and Full Throttle.
+
+Touchpad mode
+^^^^^^^^^^^^^^^^
+
+In this mode, the cursor doesn't stay underneath your finger, but is rather moved around from its current position depending on the direction of your finger movement, just like a touchpad on a laptop.
+
+Settings
+============
+
+
+Paths
+=======
+
+Saved games
+^^^^^^^^^^^^^^^^^
+
+``/var/mobile/Library/ScummVM/Savegames/`` or ``/ScummVM/Savegames/`` for a sandboxed version.
+
+Configuration file
+^^^^^^^^^^^^^^^^^^^^^^^
+
+``/var/mobile/Library/ScummVM/Preferences`` or ``/Preferences`` for a sandboxed version.
+
+Known issues
+===============
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/docportal/other_platforms/nintendo_switch.rst b/doc/docportal/other_platforms/nintendo_switch.rst
new file mode 100644
index 0000000000..8e05ccbfaa
--- /dev/null
+++ b/doc/docportal/other_platforms/nintendo_switch.rst
@@ -0,0 +1,167 @@
+=============================
+Nintendo Switch
+=============================
+
+Installing ScummVM
+===================
+
+Prerequisites
+****************
+
+- A homebrew-enabled Nintendo Switch console. How to enable homebrew is outside the scope of this documentation.
+- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
+
+Installing ScummVM
+*******************
+
+The Nintendo Switch package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
+
+Download the ``.zip`` archive to a computer, and extract the files.
+
+Copy the extracted ``scummvm`` folder to your Nintendo Switch microSD card, into the ``/switch/`` folder.
+
+
+Transferring game files
+=======================
+
+Copy the folders containing game files into the ``/switch/scummvm/`` folder on the microSD card.
+
+ScummVM on the Nintendo switch supports :ref:`Cloud functionality <howtocloud>`.
+
+For more information on how to add and play games, see the :doc:`../using_scummvm/adding_games` page.
+
+Controls
+=================
+
+Default control mapping
+*********************************
+
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
+
+See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Button,Action
+ Left stick,Mouse
+ R + Left stick,Slow Mouse
+ B,Left mouse button
+ A,Right mouse button
+ DPad,"Keypad 'Cursor' Keys"
+ R + DPad,"Diagonal Keypad 'Cursor' Keys"
+ L Trigger,Game menu (F5)
+ R Trigger,Shift
+ Y,Period
+ R + Y,Space
+ X,Escape
+ R + X,Return
+ Plus,Global main menu (GMM)
+ Minus,Toggle virtual keyboard
+ R + Minus,AGI predictive input dialog
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 2
+
+ "Touch Controls (Touchpad Mouse Mode Off, Default)",
+ Touch,Action
+ Short single finger tap,Move pointer to finger position and left mouse button click
+ Short second finger tap while holding one finger,Move pointer to first finger position and right mouse button click
+ Single finger drag,Move pointer directly with finger
+ `Two finger drag`_ ,Move pointer while left mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
+ `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 2
+
+ Touch Controls (Touchpad Mouse Mode On),
+ Touch,Action
+ Short single finger tap,Left mouse button click
+ Short second finger tap while holding one finger,Right mouse button click
+ Single finger drag,"Move pointer indirectly with finger, pointer speed can be adjusted in control settings"
+ `Two finger drag`_ ,Move pointer while left mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
+ `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
+
+Keyboard and mouse support
+****************************
+Physical USB mice and keyboards work on the Switch and are supported by ScummVM.
+
+- All keyboards work.
+- Not all mice work. A mouse compatibility list is available on this `Google Sheet <https://docs.google.com/spreadsheets/d/1Drbo5-QuSX901MwtOytSMuqRGxeIkq2HELM806I9dj0/edit#gid=0>`_.
+
+Touch support
+***************
+
+For multi-touch gestures, the fingers have to be far enough apart from each other that the Switch will not erroneously recognize them as a single finger, otherwise the pointer will jump around.
+
+The touch control scheme can be switched in the global settings. Go to **Options > Controls > Touchpad mouse mode**.
+
+ - When touchpad mouse mode is off (default), the touch controls are direct. The pointer always jumps to the finger.
+
+ - When touchpad mouse mode is on, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
+ - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
+
+Two finger drag
+^^^^^^^^^^^^^^^^^^^
+
+The two finger drag works in the following way: holding down two fingers for a while initiates a drag and drop feature, where the left mouse button is being held down.
+
+- The first finger affects mouse motion during the drag, the second finger can be removed without affecting the drag.
+- When the last finger is removed, the left mouse button is released and the drag is over.
+- The second finger can be anywhere, it doesn't have to be close to the first finger, and it doesn't have to be put down simultaneously with the first finger.
+
+Typical usage of the two finger drag and drop in Full Throttle:
+ - Hold down one finger over an object.
+ - Hold down a second finger somewhere on the screen for a little bit to initiate a two finger drag. This brings up the action menu.
+ - Let go of the second finger. The two finger drag continues since one finger is still down.
+ - Select an action with the first finger, and let go of the first finger to end the drag.
+
+Three finger drag
+^^^^^^^^^^^^^^^^^^^^
+The three finger drag works in a similar way to the `Two finger drag`_, except that instead of holding down a single second finger, you hold down two extra fingers. Holding down the three fingers for a while initiates a drag and drop feature, where the right mouse button is being held down.
+
+
+Paths
+=======
+
+Saved games
+*******************
+``/switch/scummvm/saves``
+
+Configuration file
+**************************
+``/switch/scummvm/scummvm.ini``
+
+
+Settings
+==========
+
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+Audio
+******
+
+Supported devices:
+
+- MT-32 emulator
+- FluidSynth (General MIDI emulator)
+- AdLib emulator
+
+Supported audio file formats:
+
+- ``.mp3``
+- ``.ogg``
+- ``.flac``
+- Uncompressed audio
+
+Controls
+*********
+
+See the `Touch support`_ section.
+
+Known issues
+==============
+
diff --git a/doc/docportal/other_platforms/ps_vita.rst b/doc/docportal/other_platforms/ps_vita.rst
new file mode 100644
index 0000000000..44c3aaf529
--- /dev/null
+++ b/doc/docportal/other_platforms/ps_vita.rst
@@ -0,0 +1,191 @@
+=====================
+Playstation Vita
+=====================
+
+Installing ScummVM
+=======================
+
+Prerequisites
+*******************
+
+- A homebrew-enabled PS Vita console with `Vitashell <https://github.com/TheOfficialFloW/VitaShell/releases/tag/v2.02>`_ installed. How to enable homebrew is outside the scope of this documentation.
+- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
+
+Installing ScummVM
+*******************
+
+The PS Vita package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
+
+Copy the ``.vpk`` to the PS Vita and install it using VitaShell.
+
+
+Transferring game files
+=======================
+
+There are a few ways to transfer game files to the PS Vita.
+
+Using VitaShell:
+
+ - Transfer over FTP
+ - Transfer via USB
+
+If you're using SD2Vita:
+
+ - Transfer the files directly to the microSD card.
+
+Folders containing game files can be copied into any folder.
+
+ScummVM on the PS Vita supports :ref:`Cloud functionality <howtocloud>`.
+
+For more information on how to add and play games, see the :doc:`../using_scummvm/adding_games` page.
+
+
+Controls
+=================
+
+Default control mapping
+*********************************
+
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
+
+See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 2
+
+ Game Controller Mapping,
+ Button,Action
+ Left stick,Mouse
+ R + Left stick,Slow Mouse
+ Cross,Left mouse button
+ Circle,Right mouse button
+ DPad,Keypad 'Cursor' Keys
+ R + DPad,Diagonal Keypad 'Cursor' Keys
+ L Trigger,Game menu (F5)
+ R Trigger,Shift
+ Square,Period
+ R + Square,Space '
+ Triangle,Escape
+ R + Triangle,Return
+ Start,Global main menu (GMM)
+ Select,Toggle virtual keyboard
+ R + Select,AGI predictive input dialog
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 2
+
+ "Front Touchscreen Controls, always enabled",
+ Touch,Action
+ Short single finger tap,Move pointer to finger position and left mouse button click
+ Short second finger tap while holding one finger,Move pointer to first finger position and right mouse button click
+ Single finger drag,Move pointer directly with finger
+ `Two finger drag`_ ,Move pointer while left mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
+ `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 2
+
+ "Back Touchpad Controls, enabled via settings",
+ Touch,Action
+ Short single finger tap,Left mouse button click
+ Short second finger tap while holding one finger,Right mouse button click
+ Single finger drag,"Move pointer indirectly with finger, pointer speed can be adjusted in control settings"
+ `Two finger drag`_,Move pointer while left mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
+ `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
+
+Keyboard and mouse support
+****************************
+
+Real bluetooth mice and keyboards work on the Vita and are supported by ScummVM. Go to **Settings > Devices** on the Vita home screen to pair your devices.
+
+.. note::
+
+ Not all bluetooth keyboards or mice pair successfully with the Vita.
+
+ We tested the Jelly Bean BT keyboard and mouse combo (ASIN:B06Y56BBYP) and with the standalone Jelly Comb Bluetooth Wireless Mouse (ASIN:B075HBDWCF).
+
+Touch support
+****************
+
+For multi-touch gestures, the fingers have to be far enough apart from each other that the Switch will not erroneously recognize them as a single finger, otherwise the pointer will jump around.
+
+The touch control scheme can be switched in the global settings. Go to **Options > Controls**:
+
+ - When **Touchpad mouse mode** is off:
+
+ - The touch controls are direct, which means the pointer always jumps to the finger position.
+ - The rear touchpad is disabled.
+
+ - When **Touchpad mouse mode** is on:
+
+ - The touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
+ - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
+ - The rear touchpad is enabled.
+
+
+The front touchscreen uses the direct mode by default, but this can be changed by editing the :doc:`configuration file <../advanced_options/configuration_file>` with the following keyword:
+
+.. _frontpanel:
+
+*frontpanel_touchpad_mode*
+
+When set to true, this forces the front touchscreen into an indirect mode similar to the rear touchpad.
+
+Two finger drag
+^^^^^^^^^^^^^^^^^^^
+
+The two finger drag works in the following way: holding down two fingers for a while initiates a drag and drop feature, where the left mouse button is being held down.
+
+- The first finger affects mouse motion during the drag, the second finger can be removed without affecting the drag.
+- When the last finger is removed, the left mouse button is released and the drag is over.
+- The second finger can be anywhere, it doesn't have to be close to the first finger, and it doesn't have to be put down simultaneously with the first finger.
+
+Typical usage of the two finger drag and drop in Full Throttle:
+ - Hold down one finger over an object.
+ - Hold down a second finger somewhere on the screen for a little bit to initiate a two finger drag. This brings up the action menu.
+ - Let go of the second finger. The two finger drag continues since one finger is still down.
+ - Select an action with the first finger, and let go of the first finger to end the drag.
+
+Three finger drag
+^^^^^^^^^^^^^^^^^^^^
+The three finger drag works in a similar way to the `Two finger drag`_, except that instead of holding down a single second finger, you hold down two extra fingers. Holding down the three fingers for a while initiates a drag and drop feature, where the right mouse button is being held down.
+
+Paths
+============================
+
+Saved games
+*******************
+``ux0:/data/scummvm/saves``
+
+Configuration file
+**************************
+``ux0:/data/scummvm/scummvm.ini``
+
+
+Settings
+===========================
+
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+Audio
+******
+
+Supported audio file formats:
+
+- ``.mp3``
+- ``.ogg``
+- ``.flac``
+- Uncompressed audio
+
+Controls
+*********
+
+See the `Touch support`_ section.
+
+Known Issues
+===============
+
+MT-32 emulation is not available on the PS Vita.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/psp.rst b/doc/docportal/other_platforms/psp.rst
new file mode 100644
index 0000000000..7568794a3d
--- /dev/null
+++ b/doc/docportal/other_platforms/psp.rst
@@ -0,0 +1,137 @@
+=====================
+Playstation Portable
+=====================
+
+Installing ScummVM
+===================
+
+Prerequisites
+****************
+
+- A homebrew-enabled PSP. How to enable homebrew is outside the scope of this documentation.
+- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
+
+Installing ScummVM
+*******************
+
+
+The PSP package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
+
+Download the ``.zip`` archive to a computer, and extract the files.
+
+Connect the PSP to the computer by USB cable. Go to **Settings > USB Connection** on the PSP. The computer should automatically open the root folder of the PSP. Alternatively, if you have a Memory Stick adapter, copy the files directly to the Memory Stick.
+
+Copy the extracted ``scummvm`` folder to your PSP, into the ``/PSP/GAME/`` folder.
+
+Go to **Game > Memory Stick** and choose **ScummVM** to launch ScummVM!
+
+Transferring game files
+==========================
+
+Transfer game files onto the PSP as described in the installation section above. They can be copied to any folder; location doesn't matter.
+
+For more information, see :doc:`../using_scummvm/adding_games`.
+
+Controls
+=================
+
+Default control mapping
+*********************************
+
+These controls can also be manually configured in the :doc:`Keymaps tab<../settings/keymaps>`.
+
+See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 2
+
+ Game Controller Mapping,
+ Button,Action
+ Right trigger,Modifier key
+ Left trigger,ESC
+ Analog,Mouse movement
+ Right trigger + Analog,Fine mouse movement
+ D-Pad,Arrow keys
+ D-Pad + Right Trigger,Diagonal arrow keys
+ Triangle,Enter
+ Cross,Left Mouse Button
+ Circle,Right Mouse Button
+ Square,Period
+ Right trigger + Square,Spacebar
+ Right trigger + Start,F5
+ Select,Show/Hide Virtual Keyboard. Hold down to move keyboard onscreen (with D-Pad).
+ Right trigger + Select,Show Image Viewer
+ Start,Global main menu
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Virtual Keyboard Mode,
+ Start,Enter. Also exits virtual keyboard mode
+ Select,Exit the virtual keyboard mode
+ Right trigger,Input: lowercase/uppercase letters (press to toggle)
+ Left trigger,Input: numbers/symbols (press to toggle)
+ D-Pad,"Select square of characters (up, down, left or right)"
+ Buttons/Triggers,Choose a specific character in the square. The four center characters are chosen by the button in the corresponding position. The 2 top characters are chosen by the triggers.
+ Analog,Moves in a direction (left/right/up/down)
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Image Viewer,
+ Left/Right,Previous/next image
+ Up/down,Zoom in/out
+ Analog,Move around the image
+ "Triggers, Start",Exit image viewer
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ 1st Person Game Mode ,
+ Right Trigger + Left Trigger + Square,Enable 1st Person Mode
+ Square,Modifier key (instead of Right Trigger)
+ Left/Right Trigger,Strafe left/right
+ D-Pad Left/Right,Turn left/right
+ Square + D-Pad,F1/F2/F3/F4
+ Square + Select,Image Viewer
+ Square + Start,Esc
+
+Settings
+===========================
+
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+Audio
+*******
+Supported audio file formats:
+
+- ``.mp3``
+- ``.ogg``
+- Uncompressed audio
+
+Games will generally run faster if audio files are in the ``.mp3`` file format.
+
+
+Paths
+========================
+
+Saved games
+************
+
+``ms0://scummvm_savegames/``
+
+Configuration file
+********************
+
+``ms0:/scummvm.ini``
+
+Known issues
+==============
+
+- Plugin files are not interchangeable between ScummVM versions. You must copy all the plugin files found in the ``PSP/GAME/scummvm/plugin/`` folder for every new version you install. If ScummVM crashes on startup, delete the existing plugin files in the plugin directory and copy the new ones again.
+
+- The PSP does not support audio files in the ``.flac`` file format. For games with voice (talkies), ensure the ``monster.sou`` file is not compressed to ``monster.sof``.
\ No newline at end of file
Commit: f0ce76521dfb089a1d213e2d1367ae708e533de3
https://github.com/scummvm/scummvm/commit/f0ce76521dfb089a1d213e2d1367ae708e533de3
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: adds Release notes section
Changed paths:
A doc/docportal/release_notes/release_notes_2.2.0.rst
diff --git a/doc/docportal/release_notes/release_notes_2.2.0.rst b/doc/docportal/release_notes/release_notes_2.2.0.rst
new file mode 100644
index 0000000000..6596dd64db
--- /dev/null
+++ b/doc/docportal/release_notes/release_notes_2.2.0.rst
@@ -0,0 +1,218 @@
+======================================
+Version 2.2.0 - "Interactive Fantasy"
+======================================
+
+
+New games
+=============
+ - Currently, more than 1600 games are detected and supported.
+ - Added support for Blazing Dragons.
+ - Added support for Griffon Legend.
+ - Added support for Interactive Fiction games based on the following engines:
+
+ - ADRIFT (except for version 5)
+ - AdvSys
+ - AGT
+ - Alan 2 & 3
+ - Archetype (newly reimplemented for Glk from the original Pascal sources)
+ - Hugo
+ - JACL
+ - Level 9
+ - Magnetic Scrolls
+ - Quest
+ - Scott Adams
+ - ZCode (all ZCode games except the Infocom graphical version 6 games).
+ - Added support for Operation Stealth.
+ - Added support for Police Quest: SWAT.
+ - Added support for English translation of Prince and the Coward.
+ - Added support for Ultima IV - Quest of the Avatar.
+ - Added support for Ultima VI - The False Prophet.
+ - Added support for Ultima VIII - Pagan.
+
+
+New ports
+==============
+ - MorphOS port got a major rewrite.
+
+Engines
+===========
+General
+****************
+
+ - Autosaves are now supported for all the engines.
+ - Errors are more likely to open the debugger, and be displayed, than just crash ScummVM.
+ - Games are sorted in GUI ignoring the articles.
+ - Now Hebrew is displayed correctly in GUI (requires FriBiDi library).
+ - Updated the Roland MT-32 emulation code to Munt 2.4.0.
+ - Added option to select the default voice for ports that support Text-to-Speech.
+ - Added support for Discord Rich Presence integration on supported platforms (Windows Vista+, macOS 10.9+ 64 Bit)
+ - Major improvements to the keymapper.
+
+BBVS
+****************
+
+ - Added support for the demo, available from our website.
+ - Added support for the Loogie minigame demo.
+
+Dreamweb
+****************
+
+ - Added support for Russian fan-translation.
+ - Fixed animation speed.
+
+Illusions
+************
+
+ - Fixed subtitle speed (set it to max for good speed).
+ - Added support for Russian Duckman.
+
+Kyra
+******
+
+ - Added support for the SegaCD version of Eye of the Beholder I (with CD-Audio, animated cutscenes and map function).
+ - Added support for the PC-98 version of Eye of the Beholder I.
+ - Added support for the Spanish versions of Eye of the Beholder I and II, Legend of Kyrandia 1 (CD-ROM fan translation) and Legend of Kyrandia 2 (floppy version and CD-ROM fan translation). Fix Spanish Lands of Lore support (floppy version and CD-ROM fan translation).
+
+Lab
+******
+
+ - Fixed sound looping in some rooms.
+
+Neverhood
+**********
+
+ - Added support for bigger demo, available from our website.
+
+Prince
+**********
+
+ - Fixed inventory item descriptions display.
+ - Added English translation.
+ - Fixed bug with infinite loop when looking at some objects.
+
+Queen
+********
+
+ - Fixed loading a save game from the launcher.
+ - Fixed random long delays when starting a game.
+
+SCI
+****
+
+ - Major improvements to Amiga and Mac sound drivers.
+ - Improved MIDI playback and fixed many audio issues.
+ - Fixed 30 original script bugs in ECO2, GK1, KQ4, KQ5, KQ6, KQ7, LB1, LONGBOW, PHANT2, QFG1, QFG3, QFG4, SQ5 and SQ6.
+ - Fixed a script bug responsible for rare and random lockups in most Sierra games between 1992-1996.
+ - Added support for Inside the Chest / Behind the Developer's Shield.
+ - Added support for German LSL6-Floppy.
+ - Added support for Hebrew Torin's Passage.
+ - Added support for Italian Lighthouse.
+ - Added support for Polish KQ5, LSL2, LSL3, LSL5 and LSL6-Floppy.
+ - Fixed Russian LSL1 error when hailing a taxi.
+ - Fixed Phantasmagoria 2 error when attempting easter eggs.
+ - Fixed QFG3 auto-saves.
+ - Fixed QFG4 and Shivers save game thumbnails being obscured by control panels.
+ - Fixed a random crash in the Windows version when exiting a game.
+ - Added support for Roland D-110 sound driver.
+ - The **Prefer digital sound effects** checkbox now works correctly for SCI01/SCI1 games.
+
+SCUMM
+**********
+
+ - Fixed palette issues leading to incorrect colors in MM NES intro and dark rooms.
+ - Fixed the rendering of the flashlight in MM NES to match the original version.
+ - Replaced the existing NES palette to a more accurate NTSC palette based on Mesen.
+ - Added a new GUI option to switch to an alternative NES palette based on the NES Classic.
+ - Improved colors in Apple //gs Maniac Mansion.
+ - Fixed crash when entering garage in Apple //gs Maniac Mansion.
+ - Added support from Classic Full Throttle from Remastered release.
+
+Supernova
+**********
+
+ - Improved English translation.
+
+Sky
+********
+
+ - Fixed syncing of music volume between native settings panel and ScummVM configuration.
+
+Sword1
+********
+
+ - Added support for localized menus in Novy Disk Russian Trilogy release.
+ - Added support for Spanish playable Demo available from our website.
+
+Sword2
+**********
+
+ - Added support for Spanish playable Demo available from our website.
+
+Titanic
+**********
+
+ - Fixed Barbot crash after asking what else he needs.
+
+Wintermute
+************
+
+ - Added subsystem for tracking achievements, implemented for 10+ games.
+
+Xeen
+************
+
+ - Added missing sprite drawer for enemies hit by Energy Blast.
+ - Fixed freeze due to bad mob data at the top of Witches Tower.
+ - Fixed crash loading some savegames directly from the launcher.
+ - Fixed curing the well in Nightshadow.
+ - Fixed loading of wall items from savegames.
+ - Fixed U/D keys not working on Quests dialog
+ - Fixed incorrect mirror destination for Dragon Tower
+ - Fixed crash reading book in Great Pyramid safe
+ - Prevent attributes from going negative
+ - Fixed border faces animation during Clairvoyance
+
+ZVision
+**********
+
+ - Fixed regression in the safe puzzle in Zork Nemesis: The Forbidden Lands.
+ - Fixed getting perfect score in Zork: Grand Inquisitor.
+
+Ports
+=======
+
+Android port
+************************
+
+ - Added support for immersive fullscreen mode.
+ - Improved keyboard and mouse input.
+
+iOS port
+************
+
+ - Fixed unsupported graphic mode for some games (such as SCI games with high quality video scaling enabled).
+ - Removed Quit button to follow the iOS design guidelines.
+ - Removed virtual keyboard input assistant bar. In particular this means that we no longer see a bar at the bottom of the screen when using an external keyboard.
+ - Added save of current game state if possible when switching to a different task and restore game state when returning to the ScummVM task.
+
+Linux port
+************
+
+ - Added option to use the system file browser instead of the ScummVM file browser.
+
+MacOS X port
+*************
+
+ - Fixed blurry on Retina screens. Unfortunately this required dropping support for the dark theme for window decorations.
+ - Fixed Taskbar icon display when running a game (this was broken since ScummVM 1.9.0).
+
+RISC OS port
+*****************
+
+ - Added a VFP optimized build for newer hardware.
+
+Windows port
+****************
+
+ - Added support for using additional OneCore voices for text to speech.
+ - Active support for Windows Vista and lower is now discontinued. While we still provide builds for those systems in the foreseeable future, some newer features might be missing.
Commit: 969bab50ccff284d1d380d7feb45587640c06655
https://github.com/scummvm/scummvm/commit/969bab50ccff284d1d380d7feb45587640c06655
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: adds first draft Settings pages
Changed paths:
A doc/docportal/settings/accessibility.rst
A doc/docportal/settings/audio.rst
A doc/docportal/settings/cloud.rst
A doc/docportal/settings/control.rst
A doc/docportal/settings/engine.rst
A doc/docportal/settings/game.rst
A doc/docportal/settings/graphics.rst
A doc/docportal/settings/how_to.rst
A doc/docportal/settings/keymaps.rst
A doc/docportal/settings/lan.rst
A doc/docportal/settings/misc.rst
A doc/docportal/settings/paths.rst
diff --git a/doc/docportal/settings/accessibility.rst b/doc/docportal/settings/accessibility.rst
new file mode 100644
index 0000000000..53edc2e7f6
--- /dev/null
+++ b/doc/docportal/settings/accessibility.rst
@@ -0,0 +1,28 @@
+=================
+Accessibility
+=================
+
+Overview
+===========
+
+The Accessibility tab
+----------------------
+
+From the Launcher, go to **Options**, click the red **>** button until the Accessibility tab is visible, then go to **Accessibility**.
+
+Use this tab to change accessibility settings.
+
+.. figure:: ../images/settings/accessibility.png
+
+ The Accessibility tab in the global settings.
+
+
+,,,,,,,,,,,,,,,,,,,,,,,,,,
+
+.. _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. Use the dropdown menu to choose from a variety of voices.
+
+ *tts_enabled*
+
diff --git a/doc/docportal/settings/audio.rst b/doc/docportal/settings/audio.rst
new file mode 100644
index 0000000000..1fe033a333
--- /dev/null
+++ b/doc/docportal/settings/audio.rst
@@ -0,0 +1,520 @@
+===============
+Audio
+===============
+
+Overview
+=============================
+
+Audio settings are found in four tabs:
+
+:ref:`Audio <audiotab>` | :ref:`Volume <volumetab>` | :ref:`MIDI <miditab>` | :ref:`MT-32 <mt32tab>`
+
+.. _audiotab:
+
+The Audio tab
+-----------------
+
+Use the audio tab to change the sound output for games.
+
+.. figure:: ../images/settings/audio.png
+
+ The Audio tab in the global settings
+
+.. figure:: ../images/settings/audio_game.png
+
+ The Audio tab in the game-specific settings.
+
+
+,,,,,,,,,,,,,,,,
+
+
+.. _device:
+
+**Preferred device (global settings)** or **Music device (game-specific settings)**
+ 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*
+
+.. _opl:
+
+:ref:`AdLib Emulator <AdLib>`
+ Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the preferred device.
+
+ *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*
+
+ *subtitles*
+
+.. _talkspeed:
+
+**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*
+
+,,,,,,,,,,,,,,,,,,,,,,,,,,,
+
+.. _volumetab:
+
+The Volume tab
+-----------------
+
+Use the volume tab to set the relative volumes for various sounds.
+
+
+.. figure:: ../images/settings/volume_game.png
+
+ The Audio tab in the game-specific settings.
+
+,,,,,,,,,,,,,
+
+
+.. _music:
+
+**Music volume**
+ Adjusts the volume of the music played back in the game.
+
+ *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.
+
+ *speech_volume*
+
+.. _mute:
+
+**Mute All**
+ Mutes all game audio.
+
+ *mute*
+
+,,,,,,,,,,,,,,,,,,
+
+.. _miditab:
+
+
+:ref:`The MIDI tab <MIDI>`
+------------------------------
+
+Use the MIDI tab to change the settings of General MIDI devices.
+
+
+.. figure:: ../images/settings/MIDI.png
+
+ The MIDI tab in the global settings.
+
+,,,,,,,,,,,,,
+
+.. _gm:
+
+**GM Device**
+ Specifies a preferred General MIDI (GM) device, which ScummVM uses if the **Preferred device** is set to **<default>** and General MIDI playback is required.
+
+ *gm_device*
+
+.. _soundfont:
+
+**Soundfont**
+ Specifies the path to a soundfont file, if this is required by the GM device.
+
+ *soundfont*
+
+.. _multi:
+
+`Mixed AdLib/MIDI mode`_
+ Combines MIDI music with AdLib sound effects.
+
+ *multi_midi*
+
+.. _gain:
+
+**MIDI gain**
+ Adjusts the relative volume of the MIDI music. This is only supported by some music devices.
+
+ *midi_gain*
+
+.. _fluid:
+
+
+:ref:`FluidSynth <FS>`
+************************************************************************
+
+Opens a new dialog, with three further tabs:
+`Reverb`_ | `Chorus`_ | `Misc`_
+
+
+.. figure:: ../images/settings/fluidsynth.png
+
+ The FluidSynth dialog, from the MIDI tab.
+
+
+_`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*
+
+.. _revroom:
+
+Room
+ Sets the room size, which determines how much reverb there is.
+
+ *fluidsynth_reverb_roomsize*
+
+.. _revdamp:
+
+Damp
+ Dampens higher-frequency reverb, which produces a warmer sound.
+
+ *fluidsynth_reverb_damping*
+
+.. _revwidth:
+
+Width
+ Sets the stereo spread of the reverb signal.
+
+ *fluidsynth_reverb_width*
+
+.. _revlevel:
+
+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.
+
+.. _chact:
+
+Active
+ If ticked, chorus effects are added to the software synthesizer output.
+
+ *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*
+
+.. _chlevel:
+
+Level
+ Specifies the output amplitude of the chorus signal.
+
+ *fluidsynth_chorus_level*
+
+.. _chspeed:
+
+Speed
+ Sets the modulation speed of the output, in Hz.
+
+ *fluidsynth_chorus_speed*
+
+.. _chdepth:
+
+Depth
+ Specifies the modulation depth of the chorus.
+
+ *fluidsynth_chorus_depth*
+
+.. _chwave:
+
+Type
+ Specifies the chorus modulation waveform type.
+
+ *fluidsynth_chorus_waveform*
+
+,,,,,,,,,,,,,
+
+
+_`Misc`
+^^^^^^^^^^^^^^
+.. _interp:
+
+Interpolation
+ Sets the interpolation method used by the software synthesizer.
+
+ *fluidsynth_misc_interpolation*
+
+,,,,,,,,,,,,,,,
+
+
+.. _mt32tab:
+
+:ref:`The MT-32 tab <MT-32>`
+----------------------------------------------------
+
+Use the MT-32 tab to change the settings of MT-32 devices.
+
+
+.. figure:: ../images/settings/MT32.png
+
+ The MT-32 tab in the global settings.
+
+,,,,,,,,,,,,,
+
+.. _mt32:
+
+MT-32 Device
+ Specifies a preferred MT-32 device, which ScummVM uses if the **Preferred device** is set to **<default>** and 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.
+
+
+Further reading
+==================================
+
+
+How do the audio settings work together?
+-----------------------------------------
+
+The **Preferred device** in the global settings Audio tab, or the **Music device** in the game-specific settings Audio tab, specifies the device that ScummVM uses to output audio. This device can be an emulated sound device or a software synthesizer, or an actual hardware device such as a soundcard or a hardware MIDI synthesizer. When set to **<default>**, ScummVM will automatically choose the most appropriate option for the played game.
+
+If **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses either an MT-32 or General MIDI device automatically, the settings on the MT-32 or MIDI tabs also apply, and the devices selected on these tabs are the ones that will be used. If **Preferred device** or **Music device** is set to either an MT-32 device or a GM device, ScummVM will use that device and ignore the devices chosen on the MT-32 and MIDI tabs.
+
+Many of the settings described in this section are highly dependent on the soundtrack(s) of the game you are playing; some offer only MIDI, while others have MP3 soundtracks, and so on.
+
+The evolution of audio
+-------------------------
+
+For a look at the evolution of PC audio, see `this video on YouTube <https://www.youtube.com/watch?v=a324ykKV-7Y>`_, or `this excellent post <http://www.oldskool.org/sound/pc>`_.
+
+Many of these old-school audio devices can be emulated by ScummVM:
+
+- PC Speaker: emulates the built-in PC speaker. This is mostly supported by older games, and was the only option before sound cards became widely used.
+
+ *pcspk*
+
+- IBM PCjr: emulates the sound of the 1984 IBM PCjr computer, which, enhanced with a Texas Instruments chip, provided three-voice sound and a white noise generator.
+
+ *pcjr*
+
+- Creative Music System `(C/MS) <https://en.wikipedia.org/wiki/Sound_Blaster#Creative_Music_System>`_: emulates the first sound card developed by Creative Technology (later Creative Labs), the precursor to the SoundBlaster line of sound cards. The C/MS provided 12 channels of square-wave stereo sound.
+
+ *cms*
+
+- C64 Audio: emulates the sound chip `(Sound Interface Device) <https://theconversation.com/the-sound-of-sid-35-years-of-chiptunes-influence-on-electronic-music-74935>`_ in the Commodore 64 computer. The SID was a three-voice synthesizer module, with a fourth voice for sampled drums or speech.
+
+ *C64*
+
+- Amiga Audio: emulates the Amiga audio chip, `Paula <https://en.wikipedia.org/wiki/Original_Chip_Set#Audio>`_, which had four 8-bit PCM sound channels.
+
+ *CAMD*
+
+- FM-Towns Audio: emulates the audio of the `FM Towns PC <https://en.wikipedia.org/wiki/FM_Towns#Sound>`_. Games on FM Towns computers often used audio CD standard tracks. The soundchips were capable of eight PCM voices and six FM channels.
+
+ *towns*
+
+- PC-98 Audio: emulates the audio of the NEC PC-9801-26 and PC-9801-86 sound cards.
+
+ *pc98*
+
+- SegaCD Audio: emulates the audio of the Sega CD add-on for the Sega Genesis/32x.
+
+ *segacd*
+
+To find out which emulation is compatible with the game you're playing, have a look at the manual that comes with the game.
+
+
+.. _MIDI:
+
+MIDI
+-------
+
+MIDI is a communications protocol for musical information; it can be likened to digital sheet music. By itself, MIDI is not sound. Hardware or software synthesizers create (synthesize) audio by interpreting the information given to them via the MIDI protocol.
+
+Some games only contain MIDI audio data. In the past this prevented audio for these games from working on platforms that did not support MIDI, or with soundcards that did not provide MIDI drivers.
+
+ScummVM can now convert MIDI data to sampled audio using MIDI device emulators.
+
+,,,,,,,,,,,,,,,,,,,,,,
+
+What is General MIDI?
+**********************
+
+General MIDI is a MIDI standard which is implemented by a large number of devices. While using MIDI as its protocol, it also specifies an instrument map and some other information that devices must implement.
+
+What is MT-32?
+*****************************
+
+The MT-32 is a `Roland sound module <https://en.wikipedia.org/wiki/Roland_MT-32>`_, although the term also commonly refers to a range of devices that are fully compatible with the MT-32. MT-32 devices also use MIDI as the communications protocol.
+
+
+.. _FS:
+
+General MIDI device emulation (FluidSynth)
+*****************************************************
+
+If the ScummVM you're using has libfluidsynth support it will be able to play MIDI music by using the FluidSynth emulator if set as the **Preferred device** or **Music device**, or if specified in the MIDI tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses General MIDI output automatically.
+
+You will have to specify a SoundFont in the MIDI tab for ScummVM to use FluidSynth. MIDI is like digital sheet music; it needs a library of sound samples known as a SoundFont to draw from in order to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
+
+Since the default output volume from FluidSynth can be fairly low, ScummVM will automatically set the gain to get a stronger signal. This can be further adjusted using the :ref:`MIDI gain <gain>` setting.
+
+The processor requirements for FluidSynth are quite high; a fast CPU is recommended.
+
+.. _MT-32:
+
+MT-32 device emulation
+**************************
+
+Some games which contain MIDI music data have tracks designed specifically for the Roland MT-32. ScummVM can emulate the MT-32 device, however you must provide the original MT-32 ROMs, taken from the MT-32 module, for the emulator to work. These files are:
+
+- MT32_PCM.ROM - IC21 (512KB)
+- MT32_CONTROL.ROM - IC26 (32KB) and IC27 (32KB)
+
+Place these ROMs in the game directory, in your extrapath, or in the directory where your ScummVM executable resides. ScummVM will also look for ``CM32L_PCM.ROM`` and ``CM32L_CONTROL.ROM`` - the ROMs from the CM-32L device - and will use these instead of the MT32 ROMs if they are available.
+
+ScummVM will use the MT-32 emulator if it is set as the **Preferred device** or **Music device**, or if it is specified in the MT-32 tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses MT-32 output automatically.
+
+You don't need to enable **True Roland MT-32** in the MT-32 tab, ScummVM does this automatically.
+
+.. tip::
+
+ Some games work better with some MT-32 devices than others. As an example, Lure of the Temptress makes use of extra sound effects included with the CM-32L and won't sound right with an MT-32. Likewise, The Colonel's Bequest exploits some bugs in the early MT-32 modules, which means that later devices will play incorrect sound effects!
+
+ `This Wikipedia article <https://en.wikipedia.org/wiki/List_of_MT-32-compatible_computer_games>`_ provides a comprehensive list of MT-32 compatible games, including which games work best with which device.
+
+The processor requirements for the MT-32 emulator are quite high; a fast CPU is strongly recommended.
+
+
+Native MIDI support
+**********************
+
+All MIDI ports will show up in the **Preferred device** or **Music device** dropdown selector. If you have selected a MIDI port, you will also need to specify what type of MIDI device this is with the options in the :ref:`MT-32 <mt32>` tab.
+
+- Enabling the **True Roland MT-32** option tells ScummVM that the MIDI device is an MT-32 (or fully compatible) device.
+- Enabling **Roland GS device** tells ScummVM to use an MT-32 soundtrack on a GS device. This is not supported by all games.
+- If no options are selected, this tells ScummVM that the device is General MIDI.
+
+Selecting an option that does not match the MIDI port selected may have unintended consequences; for example, if a game only has support for MT-32 and you have a General MIDI device selected as the **Preferred device** or **Music device**, ScummVM will convert the MT-32 MIDI data to GM-compatible MIDI data. While this may work fine for some games, it really depends on how the game has made use of the MT-32.
+
+.. note::
+
+ Soundcards or audio interfaces do not necessarily have anything to do with MIDI; while some older soundcards (and a few modern ones) have their own hardware-based synthesizers, it is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
+
+
+Mac OSX
+^^^^^^^^^
+
+Mac has a built-in MIDI synthesizer; Apple DLS software synthesizer. It uses the Mac's built-in sounds (which are based on Roland GS).
+
+The `Apple Support page <https://support.apple.com/en-nz/guide/audio-midi-setup/ams875bae1e0/mac>`_ has further information about setting up MIDI devices on a Mac.
+
+Windows
+^^^^^^^^
+
+Windows has a generic built-in MIDI synthesizer - GS WaveTable Synth - also based on Roland's GS sounds.
+
+For an in-depth look at audio and MIDI device setup on a Windows computer, see this `very helpful article <http://donyaquick.com/midi-on-windows/>`_.
+
+Linux
+^^^^^^^
+
+MIDI device setup may vary depending on your Linux distro.
+
+If you do not have a hardware MIDI device, there are two options: FluidSynth and TiMidity. FluidSynth is recommended as TiMidity may have some lag, depending on the system.
+
+Here are a couple of helpful articles from the Ubuntu community documentation to get you started. These instructions should work for any Debian-based distro.
+
+`How to: Software Synthesizers <https://help.ubuntu.com/community/Midi/SoftwareSynthesisHowTo>`_
+
+`How to: Hardware synthesizer soundcard setup <https://help.ubuntu.com/community/Midi/HardwareSynthesisSetup?action=show&redirect=MidiHardwareSynthesisSetup>`_
+
+
+.. _adlib:
+
+AdLib
+-----------
+
+AdLib devices do not use MIDI. They instead have a chip that produces sound via FM synthesis. While some games do store their audio data using a MIDI-derived format, this is converted by the game to work with the AdLib chip. ScummVM emulates a few different AdLib configurations, and selects the most appropriate for the game:
+
+- The original AdLib and SoundBlaster card had one OPL2 chip.
+- The SoundBlaster Pro 1 had two OPL2 chips
+- The SoundBlaster Pro 2 and 16 had an OPL3 chip.
+
+The AdLib emulator setting offers MAME, DOSBox and Nuked emulation, with MAME being the least accurate and using the least CPU power, and Nuked being the most accurate and also using the most CPU power - DOSBox is somewhere in between.
+
+There is also the option to select the OPL2LPT and OPL3LPT devices, which are external hardware devices with a real OPL chip, connected via the parallel port of a computer.
+
+AdLib does not require a SoundFont or ROMs, so for many games it may be the easiest to configure. However, if an MT-32 or GS emulator or device is available, ScummVM will prioritize this over AdLib.
+
+Mixed AdLib/MIDI mode
+------------------------
+Some games contain sound effects that are exclusive to the AdLib soundtrack, or the AdLib soundtrack may provide better sound effects. For these games, you can combine MIDI music with AdLib sound effects by using the :ref:`mixed AdLib/MIDI mode <multi>`.
+
+.. note::
+
+ Mixed AdLib/MIDI mode is not supported by all games.
+
+Digital Sound effects
+------------------------
+
+Some games have both sampled and synthesized sound effects. ScummVM will usually use the sampled sound effects, even if you select Adlib, MT-32 or GM as your audio device. Some games allow you to choose between sampled and synthesized sound effects by using the **Prefer digital sound effects** option in the Engine tab.
+
+.. _outputrate:
+
+Sample output rate
+--------------------
+
+The output sample rate tells ScummVM how many sound samples to play per channel per second.
+
+Most of the sounds were originally sampled at either 22050Hz or 11025Hz, so using a higher sample rate in these cases will not improve the quality of the audio.
+
+For games that use CD audio, the sounds were probably sampled at 44100Hz, so that is a better sample rate to choose for these games.
+
+ScummVM generates the samples when using AdLib, FM-Towns, PC Speaker or IBM PCjr emulated sound. 22050Hz will usually be fine for these options, although for Beneath a Steel Sky 44100Hz is recommended.
+
+ScummVM has to resample all sounds to the selected output frequency. It is recommended to choose an output frequency that is a multiple of the original frequency. Choosing an in-between number may not be supported by your sound card.
+
+.. _buffer:
+
+Audio buffer size
+---------------------
+
+There is no option to control audio buffer size through the GUI, but the default value can be overridden in the the :doc:`configuration file <../advanced_options/configuration_file>`. The default value is calculated based on output sampling frequency to keep audio latency below 45ms.
+
+Appropriate values are normally between 512 and 8192, but the value must be one of: 256, 512, 1024, 2048, 4096, 8192, 16384, or 32768.
+
+Smaller values yield faster response time, but can lead to stuttering if your CPU isn't able to catch up with audio sampling when using the sound emulators. Large buffer sizes may lead to minor audio delays (high latency).
+
+
diff --git a/doc/docportal/settings/cloud.rst b/doc/docportal/settings/cloud.rst
new file mode 100644
index 0000000000..1cb2c10421
--- /dev/null
+++ b/doc/docportal/settings/cloud.rst
@@ -0,0 +1,73 @@
+================
+Cloud
+================
+
+Overview
+=============================
+
+ScummVM currently supports Dropbox, OneDrive, Google Drive and Box. Connecting ScummVM to a cloud storage service provides an easy way of sharing game files and saved games between multiple devices.
+
+
+The Cloud tab
+----------------
+
+From the Launcher, go to **Options**, click the red **>** button until the Cloud tab is visible, then go to **Cloud**.
+
+Use the cloud tab to manage connected cloud storage services.
+
+.. figure:: ../images/settings/cloud.png
+
+ The Cloud tab in the global settings
+
+,,,,,,,,,,,,,,,,,,,,,
+
+Active storage
+ Choose from Dropbox, OneDrive, Google Drive, or Box.
+
+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, and 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.
+
+.. note::
+
+ Cloud functionality is not supported on all platforms.
+
+
+Further reading
+====================
+
+.. _howtocloud:
+
+How to connect ScummVM to cloud storage
+----------------------------------------
+
+From the Launcher, go to **Options > Cloud**.
+
+To connect your chosen cloud storage service to ScummVM, select it from the **Active storage** dropdown.
+
+.. figure:: ../images/cloud_and_lan/cloud_storage.png
+
+Click on the link shown at **1.**, and log in to your cloud storage account. Once you have logged in, a 6-digit code will be displayed.
+
+.. figure:: ../images/cloud_and_lan/cloud_code.png
+
+Copy the 6-digit code, click into the empty box next to the **Paste** button, and then click the **Paste** button.
+
+.. figure:: ../images/cloud_and_lan/cloud_connect.png
+
+Click **3. Connect**, then, once the next information loads, click on **Enable storage**.
+
+.. figure:: ../images/cloud_and_lan/cloud_enable.png
+
+Saved games automatically sync on launch, after saving, and on loading a saved game. You can also manually sync by using the **Sync now** button.
+
+To download the game files from your cloud ScummVM folder, click **Download game files**.
+
+To change to a different cloud account, or to disconnect your cloud account from ScummVM, click **Disconnect**.
\ No newline at end of file
diff --git a/doc/docportal/settings/control.rst b/doc/docportal/settings/control.rst
new file mode 100644
index 0000000000..a42ac76a0c
--- /dev/null
+++ b/doc/docportal/settings/control.rst
@@ -0,0 +1,32 @@
+=================
+Control
+=================
+
+Overview
+==========
+
+The Control tab
+----------------
+
+Use the control tab to change aspects of joystick controls. This tab is only available when a joystick or game controller is connected, or for certain touch screen enabled platforms.
+
+.. figure:: ../images/settings/control.png
+
+ The Control tab in the global settings
+
+
+,,,,,,,,,,,,,,
+
+.. _mousespeed:
+
+Pointer Speed
+ Sets the speed for the mouse pointer, when it is controlled by the keyboard or a joystick.
+
+ *kbdmouse_speed*
+
+.. _deadzone:
+
+Joy deadzone
+ Sets the deadzone for an analog joystick. A lower value will reduce the size of the deadzone.
+
+ *joystick_deadzone*
\ No newline at end of file
diff --git a/doc/docportal/settings/engine.rst b/doc/docportal/settings/engine.rst
new file mode 100644
index 0000000000..60e4da81d5
--- /dev/null
+++ b/doc/docportal/settings/engine.rst
@@ -0,0 +1,649 @@
+=====================
+Engine
+=====================
+
+Overview
+=========
+
+Engine settings are those settings that are unique to a particular game or game engine. 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_ |
+
+
+The Engine tab
+--------------
+
+Choose a game, then go to **Edit Game > Engine**. Note that this tab may not be available for all games.
+
+Use the engine tab to change settings that are unique to the game being played. Only available settings are shown.
+
+.. figure:: ../images/settings/engine.png
+
+ The Engine tab in the game-specific settings
+
+
+,,,,,,,,,,,,,,,,,,,,
+
+.. _ADL:
+
+ADL
+*****
+.. _ntsc:
+
+TV emulation
+ Emulate composite output to an NTSC TV.
+
+ *ntsc*
+
+.. _color:
+
+Color Graphics
+ Use color graphics instead of monochrome.
+
+ *color*
+
+.. _scan:
+
+Show scanlines
+ Darken every other scanline to mimic the look of CRT.
+
+ *scanlines*
+
+.. _mono:
+
+Always use sharp monochrome text
+ Do not emulate NTSC artifacts for text
+
+ *monotext*
+
+,,,,,,,,,
+
+.. _AGI:
+
+AGI
+******
+
+.. _osl:
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+ *originalsaveload*
+
+.. _altamiga:
+
+Use an alternative palette
+ Use an alternative palette, common for all Amiga games. This was the old behavior
+
+ *altamigapalette*
+
+.. _support:
+
+Mouse support
+ Enables mouse support. Allows to use mouse for movement and in game menus.
+
+ *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*
+
+.. _2gs:
+
+Add speed menu
+ Add game speed menu (similar to PC version)
+
+ *apple2gs_speedmenu*
+
+,,,,,,
+
+.. _BLADERUNNER:
+
+BLADERUNNER
+******************
+
+.. _sitcom:
+
+Sitcom mode
+ Game will add laughter after actor's line or narration
+
+ *sitcom*
+
+.. _shorty:
+
+Shorty mode
+ Game will shrink the actors and make their voices high pitched
+
+ *shorty*
+
+.. _nodelay:
+
+Frame limiter high performance mode
+ This mode may result in high CPU usage! It avoids use of delayMillis() function.
+
+ *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*
+
+.. _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*
+
+,,,,,,,,
+
+.. _CGE:
+
+CGE
+*******
+
+.. _blind:
+
+Color Blind Mode
+ Enable Color Blind Mode by default
+
+ *enable_color_blind*
+
+,,,,,,
+
+.. _CINE:
+
+CINE
+*********
+
+Use original save/load screen
+ Use the original save/load screens instead of the ScummVM one
+
+ *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*
+
+,,,,,,,,,
+
+.. _DRASCULA:
+
+DRASCULA
+*************
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+ *originalsaveload*
+
+,,,,,,,,,,
+
+.. _DREAMWEB:
+
+DREAMWEB
+**********
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+ *originalsaveload*
+
+.. _bright:
+
+Use bright palette mode
+ Display graphics using the game's bright palette
+
+ *bright_palette*
+
+,,,,,,,,,,
+
+.. _HDB:
+
+HDB
+**********
+
+.. _hyper:
+
+Enable cheat mode
+ Debug info and level selection becomes available
+
+ *hypercheat*
+
+,,,,,,,,,,
+
+.. _HOPKINS:
+
+HOPKINS
+*************
+
+.. _gore:
+
+Gore Mode
+ Enable Gore Mode when available
+
+ *enable_gore*
+
+,,,,,,,,,,
+
+.. _KYRA:
+
+KYRA
+********
+
+.. _studio:
+
+Enable studio audience
+ Studio audience adds an applause and cheering sounds whenever Malcolm makes a joke
+
+ *studio_audience*
+
+.. _skip:
+
+Skip support
+ This option allows the user to skip text and cutscenes.
+
+ *skip_support*
+
+.. _helium:
+
+Enable helium mode
+ Helium mode makes people sound like they've inhaled Helium.
+
+ *helium_mode*
+
+.. _smooth:
+
+Enable smooth scrolling when walking
+ When enabled, this option makes scrolling smoother when changing from one screen to another.
+
+ *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*
+
+Suggest save names
+ When enabled, this option will fill in an autogenerated savegame escription into the input prompt.
+
+ *auto_savenames*
+
+.. _hp:
+
+HP bar graphs
+ Enable hit point bar graphs
+
+ *hpbargraphs*
+
+.. _btswap:
+
+Fight Button L/R Swap
+ Left button to attack, right button to pick up items
+
+ *mousebtswap*
+
+,,,,,,,,,,
+
+.. _LURE:
+
+LURE
+******
+
+
+.. _ttsnarrator:
+
+TTS Narrator
+ Use text-to-speech to read the descriptions, if test-to-speech is available)
+
+ *tts_narrator*
+
+,,,,,,,,,,
+
+.. _MADS:
+
+MADS
+*******
+
+.. _easy:
+
+Easy mouse interface
+ Shows object names when hovering the mouse over them
+
+ *EasyMouse*
+
+.. _objanimated:
+
+Animated inventory items
+ Animated inventory items
+
+ *InvObjectsAnimated*
+
+.. _windowanimated:
+
+Animated game interface
+ Animated game interface
+
+ *TextWindowAnimated*
+
+.. _naughty:
+
+Naughty game mode
+ Naughty game mode
+
+ *NaughtyMode*
+
+.. _gdither:
+
+Graphics dithering
+ Graphics dithering
+
+ *GraphicsDithering*
+
+,,,,,,,,,,
+
+.. _NEVERHOOD:
+
+NEVERHOOD
+************
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+ *originalsaveload*
+
+.. _skiphall:
+
+Skip the Hall of Records storyboard scenes
+ Allows the player to skip past the Hall of Records storyboard scenes
+
+ *skiphallofrecordsscenes*
+
+.. _scale:
+
+Scale the making of videos to full screen
+ Scale the making of videos, so that they use the whole screen
+
+ *scalemakingofvideos*
+
+,,,,,,,,,,
+
+.. _QUEEN:
+
+QUEEN
+*****
+
+Alternate intro
+ Plays the alternate intro for Flight of the Amazon Queen.
+
+ *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*
+
+.. _hires:
+
+Enable high resolution graphics
+ Enable high resolution graphics/content
+
+ *enable_high_resolution_graphics*
+
+.. _blackline:
+
+Enable black-lined video
+ Draw black lines over videos to increase their apparent sharpness
+
+ *enable_black_lined_video*
+
+.. _hq:
+
+Use high-quality video scaling
+ Use linear interpolation when upscaling videos, where possible
+
+ *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 (sampled) 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*
+
+.. _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*
+
+.. _cd:
+
+Use CD audio
+ Use CD audio instead of in-game audio, if available
+
+ *use_cdaudio*
+
+.. _wincursors:
+
+Use Windows cursors
+ Use the Windows cursors (smaller and monochrome) instead of the DOS ones
+
+ *windows_cursors*
+
+.. _silver:
+
+Use silver cursors
+ Use the alternate set of silver cursors instead of the normal golden ones
+
+ *silver_cursors*
+
+.. _upscale:
+
+Upscale videos
+ Upscale videos to double their size
+
+ *enable_video_upscale*
+
+.. _censor:
+
+Enable content censoring
+ Enable the game's built-in optional content censoring"),
+
+ *enable_censoring*
+
+,,,,,,,,,,
+
+.. _SCUMM:
+
+SCUMM
+************
+
+.. _labels:
+
+Show Object Line
+ Show the names of objects at the bottom of the screen
+
+ *object_labels*
+
+.. _classic:
+
+Use NES Classic Palette
+ Use a more neutral color palette that closely emulates the NES Classic
+
+ *mm_nes_classic_palette*
+
+,,,,,,,,,,
+
+.. _SHERLOCK:
+
+SHERLOCK
+*********
+
+Use original load/save screens
+ Use the original save/load screens instead of the ScummVM ones"),
+
+ *originalsaveload*
+
+.. _fade:
+
+Pixellated scene transitions
+ When changing scenes, a randomized pixel transition is done
+
+ *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*
+
+.. _portraits:
+
+Show character portraits
+ Show portraits for the characters when conversing
+
+ *portraits_on*
+
+.. _style:
+
+Slide dialogs into view
+ Slide UI dialogs into view, rather than simply showing them immediately
+
+ *window_style*
+
+.. _transparentwindows:
+
+Transparent windows
+ Show windows with a partially transparent background
+
+ *transparent_windows*
+
+TTS Narrator
+ Use text-to-speech to read the descriptions, if text-to-speech is available.
+
+ *tts_narrator*
+
+,,,,,,,,,,
+
+.. _SKY:
+
+SKY
+******
+
+.. _altintro:
+
+Floppy intro
+ Use the floppy version's intro (CD version only)
+
+ *alt_intro*
+
+,,,,,,,,,,
+
+.. _SUPERNOVA:
+
+SUPERNOVA
+**********
+
+.. _improved:
+
+Improved mode
+ Removes some repetitive actions, adds possibility to change verbs by keyboard.
+
+ *improved*
+
+,,,,,,,,,,
+
+.. _TOLTECS:
+
+TOLTECS
+**************
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+ *originalsaveload*
+
+,,,,,,,,,,
+
+.. _WINTERMUTE:
+
+WINTERMUTE
+**************
+
+.. _fps:
+
+Show FPS-counter
+ Show the current number of frames per second in the upper left corner
+
+ *show_fps*
+
+.. _bilinear:
+
+Sprite bilinear filtering (SLOW)
+ Apply bilinear filtering to individual sprites
+
+ *bilinear_filtering*
+
+,,,,,,,,,,
+
+.. _XEEN:
+
+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*
+
+.. _durable:
+
+More durable armor
+ Armor won't break until character is at -80HP, rather than merely -10HP
+
+ *DurableArmor*
+
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
new file mode 100644
index 0000000000..0b700a2371
--- /dev/null
+++ b/doc/docportal/settings/game.rst
@@ -0,0 +1,48 @@
+=============
+Game
+=============
+
+Overview
+==========
+
+The Game tab
+---------------
+
+Choose a game, then go to **Edit Game**.
+
+Use the game tab to display and change information about how the game is
+identified by ScummVM.
+
+.. figure:: ../images/settings/game.png
+
+ The Game tab in the game-specific settings
+
+,,,,,,,
+
+.. _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*
+
+.. _description:
+
+**Name**
+ This field shows the full title of the game, as well as some basic information such as original platform and language.
+
+ *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*
+
+.. _platform:
+
+**Platform**
+ Specifies the original platform of the game.
+
+ *platform*
\ No newline at end of file
diff --git a/doc/docportal/settings/graphics.rst b/doc/docportal/settings/graphics.rst
new file mode 100644
index 0000000000..c4cbe61fc9
--- /dev/null
+++ b/doc/docportal/settings/graphics.rst
@@ -0,0 +1,218 @@
+===============
+Graphics
+===============
+
+Overview
+=========
+
+The Graphics tab
+-----------------
+
+To change settings globally, go to **Options > Graphics**. To change settings for a game, select the game, then go to **Edit Game > Graphics**.
+
+Use the graphics tab to change how games look when they are played.
+
+
+.. figure:: ../images/settings/graphics.png
+
+ The Graphics tab in the global settings
+
+,,,,,,,
+
+.. _gfxmode:
+
+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*
+
+
+.. _render:
+
+Render mode
+ Changes how the game is rendered, which affects how the game looks.
+
+ *render_mode*
+
+.. _stretchmode:
+
+Stretch mode
+ Changes the way the game is displayed in relation to the window size.
+
+ *stretch_mode*
+
+.. _ratio:
+
+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*
+
+.. _fullscreen:
+
+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*
+
+.. _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*
+
+Further reading
+=================
+
+
+How do the graphics settings work together?
+----------------------------------------------
+
+The graphics mode, aspect ratio, and stretch mode settings work together to change the resolution and display of each game. The first setting applied to the image is the graphics mode, then the aspect ratio correction, and then the stretch mode setting. The only exception to this is OpenGL mode, which applies all settings in one pass to arrive at a final image.
+
+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 modes
+---------------------------
+
+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.
+
+A 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.
+
+
+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.
+
+To switch between graphics modes on the go, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`1` to :kbd:`8`.
+
+OpenGL mode
+**************
+
+OpenGL graphics mode works a little differently to the other graphics modes. Instead of applying the aspect ratio and stretch mode settings one after the other (and after the graphics mode scaling has been applied), it does all the scaling and stretching in one step, going directly from the original game resolution to the final display resolution.
+
+Output is controlled by your window size (or screen resolution if in full screen) and the stretch mode selected, as well as the Filter graphics option.
+
+.. _aspect:
+
+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 - notice the moon is actually round now.
+
+To toggle aspect ratio on and off, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`a`.
+
+.. _stretch:
+
+Stretch modes
+----------------------
+
+
+There are five stretch modes:
+
+- Center - centers the image in the window.
+- Pixel-perfect scaling - scales the image to a multiple of the original game resolution as much as possible (for example, 2x, 3x, 4x and so on), and fills the remaining empty space with black borders.
+- Fit to window - fits the image to the window, but maintains the aspect ratio and 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 forced 4:3 aspect ratio.
+
+To switch between stretch modes on the go, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`s`.
+
+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
+
+Filter graphics
+----------------
+
+When enabled, ScummVM uses bilinear interpolation instead of nearest neighbor for the :ref:`aspect ratio <aspect>` and :ref:`stretch mode <stretch>`. It does not affect the graphics mode scaling unless OpenGL is selected, in which case it determines how the OpenGL scaling is done.
+
+To toggle between bilinear interpolation and nearest neighbor, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`f`.
\ No newline at end of file
diff --git a/doc/docportal/settings/how_to.rst b/doc/docportal/settings/how_to.rst
new file mode 100644
index 0000000000..c8fc8466f2
--- /dev/null
+++ b/doc/docportal/settings/how_to.rst
@@ -0,0 +1,20 @@
+=======================
+How to change settings
+=======================
+
+From the Launcher
+==================
+The settings are arranged by subject, on different tabs:
+
+:doc:`Game tab <game>` | :doc:`Engine tab <engine>` | :doc:`Graphics tab <graphics>` | :doc:`Control tab <control>` | :doc:`Keymaps tab <keymaps>` | :doc:`Audio tab <audio>` | :doc:`Volume tab <audio>` | :doc:`Midi tab <audio>` | :doc:`MT-32 tab <audio>` | :doc:`Paths tab <paths>` | :doc:`Misc tab <misc>` | :doc:`Cloud tab <cloud>` | :doc:`LAN tab <lan>` | :doc:`Accessibility tab <accessibility>`
+
+To change a setting globally, so that it affects all games, go to **Options** and select the tab containing the setting you would like to change.
+
+To change a setting for just one game, select the game, then go to **Edit Game** and select the tab containing the setting you would like to change. To make the game use the settings on that tab instead of the global settings, select **Override global settings**.
+
+Not all settings are available for all games; for example, where there is no MIDI soundtrack for a game, there will be no MIDI or MT-32 tabs.
+
+In the configuration file
+==========================
+
+See the :doc:`configuration file <../advanced_options/configuration_file>` page for more information on how to do this. Configuration keywords are listed in the Settings pages below the description of each setting, in italics.
\ No newline at end of file
diff --git a/doc/docportal/settings/keymaps.rst b/doc/docportal/settings/keymaps.rst
new file mode 100644
index 0000000000..3f2988b8b0
--- /dev/null
+++ b/doc/docportal/settings/keymaps.rst
@@ -0,0 +1,38 @@
+===============
+Keymaps
+===============
+
+Overview
+=========
+
+
+
+The Keymaps tab
+----------------
+
+To change settings globally, go to **Options > Keymaps**. To change settings for a game, select the game, then go to **Edit Game > Keymaps**.
+
+Use the keymaps tab to assign actions to keyboard keys or shortcuts, or mouse or joystick buttons.
+
+.. figure:: ../images/settings/keymaps.png
+
+ The Keymaps tab in the global settings
+
+.. figure:: ../images/settings/keymaps_dropdown.png
+
+ The Keymaps dropdown options.
+
+,,,,,,,,,,,,,,,,,
+
+Click on the red box next to the desired action to add an additional key or button. Click on the dropdown arrow for further options.
+
+If all the mapped keys are not visible, hover over the red box to see all the mapped keys.
+
+Reset
+ Resets all keymaps to default.
+
+Reset to defaults
+ Resets the keymaps for that action to default.
+
+Clear mapping
+ Clears all keymaps for that action.
\ No newline at end of file
diff --git a/doc/docportal/settings/lan.rst b/doc/docportal/settings/lan.rst
new file mode 100644
index 0000000000..f43d4da5ec
--- /dev/null
+++ b/doc/docportal/settings/lan.rst
@@ -0,0 +1,71 @@
+==============
+LAN
+==============
+
+Overview
+============
+
+ScummVM can run local network web server which allows browser-based file management, including uploading and downloading game files.
+
+The LAN tab
+------------
+
+From the Launcher, go to **Options**, click the red **>** button until the LAN tab is visible, then go to **LAN**.
+
+Use the LAN tab to control the web server.
+
+
+.. figure:: ../images/settings/LAN.png
+
+ The LAN tab in the global settings
+
+
+,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+
+Run server
+ Starts the web server. Once running, this displays the URL at which the web server can be accessed.
+
+Stop server
+ Stops the web server.
+
+.. _serverport:
+
+Server's port
+ The port on which the web server is available.
+
+ *local_server_port*
+
+.. _rootpath:
+
+/root/ Path
+ Allows you to specify the root path. Any sub-directories will be accessible.
+
+ *rootpath*
+
+,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+
+Further reading
+=================
+
+How to use the web server
+----------------------------
+
+To access the server, type the URL shown into the address bar of any web browser:
+
+.. figure:: ../images/settings/LAN_server.png
+
+ The server running in the browser.
+
+To download a file, click on the file you wish to download. A system download dialog box opens.
+
+To create a new directory, click **Create Directory**.
+
+.. figure:: ../images/settings/LAN_server_new.png
+
+ Creating a new directory.
+
+To upload files, click **Upload Files** and select files from the system file explorer.
+
+.. figure:: ../images/settings/LAN_server_upload.png
+
+ Uploading files.
diff --git a/doc/docportal/settings/misc.rst b/doc/docportal/settings/misc.rst
new file mode 100644
index 0000000000..2f8e49413a
--- /dev/null
+++ b/doc/docportal/settings/misc.rst
@@ -0,0 +1,56 @@
+======================
+Miscellaneous
+======================
+
+Overview
+==========
+
+The Miscellaneous tab
+--------------------------
+
+From the Launcher, go to **Options**, click the red **>** button, and then go to **Misc**.
+
+The Misc tab contains options that don’t belong on any of the other tabs.
+
+.. figure:: ../images/settings/misc.png
+
+ The Misc tab in the global settings.
+
+
+,,,,,,,,,,,,,,,
+
+.. _theme:
+
+Theme
+ Changes the visual appearance of the ScummVM Launcher
+
+ *gui_theme*
+
+GUI Renderer
+ Defines how the ScummVM GUI is rendered; normal or antialiased.
+
+ *gui_renderer*
+
+.. _autosave:
+
+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*
+
+GUI Language
+ Choose the language of the ScummVM Launcher
+
+ *gui_language*
+
+Switch the ScummVM GUI language to the game language
+ If ticked, the Launcher language will be the same as the game language.
+
+ *gui_use_game_language*
+
+.. _guibrowser:
+
+Use native system file browser
+ Uses the system file browser instead of the ScummVM browser.
+
+ *gui_browser_native*
diff --git a/doc/docportal/settings/paths.rst b/doc/docportal/settings/paths.rst
new file mode 100644
index 0000000000..6b9f200f59
--- /dev/null
+++ b/doc/docportal/settings/paths.rst
@@ -0,0 +1,43 @@
+==============
+Paths
+==============
+
+Overview
+============
+
+The Paths tab
+---------------
+
+Use the paths tab to tell ScummVM where to look for files.
+
+.. figure:: ../images/settings/paths.png
+
+ The Paths tab in the global settings
+
+,,,,,,,,,,,,,,,,,
+
+.. _savepath:
+
+Save Path
+ The folder in which ScummVM will store saved games. If this is not set, saved games will generally be stored in the current directory, although there are exceptions to this. For more information, see the :doc:`../using_scummvm/save_load_games` page.
+
+ *savepath*
+
+.. _themepath:
+
+Theme Path
+ The folder that additional themes for the ScummVM Launcher are stored in.
+
+ *themepath*
+
+.. _extra:
+
+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
+ * Soundfonts
+ * MT-32 ROMs
+
+ *extrapath*
+
Commit: f5746a773442f56bd2923aa04ff15d5592559543
https://github.com/scummvm/scummvm/commit/f5746a773442f56bd2923aa04ff15d5592559543
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: second draft - Using ScummVM pages
Changed paths:
A doc/docportal/using_scummvm/save_load_games.rst
R doc/docportal/using_scummvm/game_settings.rst
R doc/docportal/using_scummvm/global_settings.rst
doc/docportal/using_scummvm/adding_games.rst
doc/docportal/using_scummvm/keyboard_shortcuts.rst
doc/docportal/using_scummvm/the_launcher.rst
diff --git a/doc/docportal/using_scummvm/adding_games.rst b/doc/docportal/using_scummvm/adding_games.rst
index a2bcb3eddc..26e285d2ed 100644
--- a/doc/docportal/using_scummvm/adding_games.rst
+++ b/doc/docportal/using_scummvm/adding_games.rst
@@ -34,6 +34,60 @@ For games downloaded from digital distributors such as `GOG.com <gog.com>`__, `
- Run the installer or
- If the data files are supplied as a .zip file, extract the archive.
+.. tip::
+
+ A great way to share game files and automatically back up and sync your saved game states between devices running ScummVM is to connect a Cloud storage service such as Dropbox or Google Drive. Detailed instructions for setting this up can be found on the :ref:`Cloud settings page <howtocloud>`.
+
+ For devices on the same local network, ScummVM can run a web server to allow the transfer of files. Detailed instructions can be found on the :doc:`LAN settings page <../settings/lan>`. This is a good option if you do not wish to connect a Cloud service, although it doesn't offer as much functionality.
+
+
+Multi-disc games
+*****************
+
+ScummVM needs access to all the data files, so it will not be able to run directly from a CD in the case where the game has multiple discs. To add a multi-CD game, copy the required data files directly from the CD to a dedicated game folder on your hard drive.
+
+- Where there are duplicate, identical files (same name, same file size) on more than one disc, only one copy of the file is required.
+- Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the files to ``music1.clu`` and ``music2.clu``.
+
+.. tip::
+
+ The exact layout of files and folders within the game folder is not important, as long as all the files are there.
+
+.. _cd:
+
+CD audio
+**********
+
+Some games contain one or more separate audio tracks on CD. To use these with ScummVM, they need to be extracted from the CD in ``.wav`` or ``.aiff`` format, and then converted to either ``.mp3``, ``.flac`` or ``.ogg`` file formats.
+
+.. tip::
+
+ Software suggestion:
+
+ `fre:ac <https://www.freac.org/>`_ is a multi-platform, open-source software, with the ability to both rip CDs and convert audio between .mp3, .ogg, .flac and .wav formats.
+
+Place the converted audio files in the same folder that contains the other game datafiles.
+
+
+.. _macgames:
+
+Macintosh games
+******************
+
+All LucasArts SCUMM games also exist in versions for the Macintosh. Most of the newer games shipped with only a single data file; ScummVM can use this file like it does any other data files. Some discs shipped with hidden files. To view hidden files in Mac OSX, use the keyboard shortcut :kbd:`Cmd` + :kbd:`Shift` + :kbd:`Period (.)`.
+
+Mac uses a different file system to other systems (HFS+), so if you are accessing the CD or floppy from a Windows or Linux machine you will need additional software in order to view and copy the files.
+
+For Windows, HFSExplorer is a basic free option, which allows read-only access to HFS drives. `Download the installer <http://www.catacombae.org/hfsexplorer/>`_ rather than the ZIP file, to ensure it is installed correctly.
+
+For Linux, hfsplus allows read-only access to HFS drives. To use hfsplus, use the command line:
+
+ 1. Install hfsplus using the software manager. On Debian-based distributions, use ``sudo apt install hfsplus``.
+ 2. Find the game disc by running ``sudo fdisk -l`` and finding the one with type ``Apple HFS/HFS+``. In this example we will say this is ``/dev/fd0``.
+ 3. Create a mount point, for example: ``sudo mkdir /media/macgamedrive``
+ 4. Mount the device to that moint point: ``sudo mount -t hfsplus /dev/fd0 /media/macgamedrive``
+ 5. Access the device at ``/media/macgamedrive``.
+
.. _add and play games:
Adding the games to the Launcher
@@ -41,33 +95,29 @@ 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**.
+2. In the Launcher window, click **Add Game**. This opens a file browser; either the system file browser or the ScummVM file browser. To add multiple games at once, click on the dropdown arrow next to **Add Game**, and select **Mass Add...**.
-.. image:: ../images/Launcher/add_game.jpg
+.. image:: ../images/Launcher/add_game.png
: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.
+3. Use the file browser to locate the folder containing the game you wish to add. For the ScummVM file browser: 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 data files, click **Choose**.
-.. 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/Launcher/choose_game_directory.jpg
+.. image:: ../images/Launcher/choose_game_directory.png
:class: with-shadow
+.. note::
+ You may choose which file browser to use by setting the **Use Native file browser option in the :doc:`Misc <../settings/misc>` tab of the global settings.
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/Launcher/add_game_settings.jpg
+.. image:: ../images/Launcher/game_settings.png
:class: with-shadow
6. Added games are now ready to play! To play, select a game and click **Start** to play.
-.. image:: ../images/Launcher/start_game.jpg
+.. image:: ../images/Launcher/start_game.png
:class: with-shadow
Games can also be launched directly from the command line.
diff --git a/doc/docportal/using_scummvm/game_settings.rst b/doc/docportal/using_scummvm/game_settings.rst
deleted file mode 100644
index f4f31a3641..0000000000
--- a/doc/docportal/using_scummvm/game_settings.rst
+++ /dev/null
@@ -1,880 +0,0 @@
-=============
-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`_ | `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, including a complete list of configuration keywords, see the :doc:`../advanced_options/configuration_file` .
-
-_`Game tab`
-------------
-
-Use the game tab to display and change information about how the game is
-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*
-
-.. _description:
-
-**Name**
- This field shows the full title of the game, as well as some basic information such as original platform and language.
-
- *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*
-
-.. _platform:
-
-**Platform**
- Specifies the original platform of the game.
-
- *platform*
-
-,,,,,,,
-
-
-
-_`Graphics tab`
------------------
-
-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*
-
-
-
-**Render mode**
- Changes how the game is rendered, which affects how the game looks.
-
- *render_mode*
-
-
-**Stretch mode**
- Changes the way the game is displayed in relation to the window size.
-
- *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*
-
-**Fullscreen mode**
- Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt + Enter`.
-
- *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*
-,,,,,
-
-
-_`Audio tab`
---------------------
-
-Use the audio tab to change the sound output in the game.
-
-For more information including comprehensive explanation of the audio settings, see the :doc:`../advanced_options/audio` page.
-
-
-,,,,,,,
-
-**Override global 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 General MIDI device, or if ScummVM chooses one of these automatically, the settings on the MT-32 or MIDI tabs also apply.
-
- *music_driver*
-
-**AdLib Emulator**
- Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the preferred device.
-
- *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*
-
- *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*
-
-,,,,,,
-
-_`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.
-
- *music_volume*
-
-**SFX volume**
- Adjusts the volume of the sound effects within the game.
-
- *sfx_volume*
-
-
-**Speech volume**
- Adjusts the volume of the digitized speech in the game, if it has any.
-
- *speech_volume*
-
-**Mute All**
- Mutes all game audio.
-
- *mute*
-
-,,,,,,
-
-
-_`MIDI tab`
----------------
-
-Use the MIDI tab to change the settings of General MIDI devices. This tab will only be available for games that use MIDI.
-
-,,,,,,,
-
-**Override global MIDI settings**
- Check this box to make the game use custom settings instead of the global settings.
-
-**GM Device**
- Specifies the preferred General MIDI (GM) device for the game.
-
- *gm_device*
-
-**Soundfont**
- Specifies the path to a soundfont file, if this is required by the GM device.
-
- *soundfont*
-
-
-**Mixed AdLib/MIDI mode**
- Combines MIDI music with AdLib sound effects.
-
- *multi_midi*
-
-**MIDI gain**
- Adjusts the relative volume of the MIDI audio. This is only supported by some music devices.
-
- *midi_gain*
-
-
-
-_`MT-32 tab`
----------------
-
-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
- Specifies the preferred MT-32 device for the game.
-
-**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.
-
-
-**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.
-
-,,,,,
-
-
-_`Paths tab`
---------------
-
-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*
-
-**Extra Path**
- 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
- * MT-32 ROMs
-
- *extrapath*
-
-.. _gamepath:
-
-**Game Path**
- Chooses folder in which the game’s data files are stored.
-
- *gamepath*
-
-,,,,,,,
-
-_`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
-******
-.. _ntsc:
-
-TV emulation
- Emulate composite output to an NTSC TV.
-
- *ntsc*
-
-.. _color:
-
-Color Graphics
- Use color graphics instead of monochrome.
-
- *color*
-
-.. _scan:
-
-Show scanlines
- Darken every other scanline to mimic the look of CRT.
-
- *scanlines*
-
-.. _mono:
-
-Always use sharp monochrome text
- Do not emulate NTSC artifacts for text
-
- *monotext*
-
-,,,,,,,,,
-
-.. _AGI:
-
-**AGI**
-=================
-
-.. _osl:
-
-Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
-
- *originalsaveload*
-
-.. _altamiga:
-
-Use an alternative palette
- Use an alternative palette, common for all Amiga games. This was the old behavior
-
- *altamigapalette*
-
-.. _support:
-
-Mouse support
- Enables mouse support. Allows to use mouse for movement and in game menus.
-
- *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*
-
-.. _2gs:
-
-Add speed menu
- Add game speed menu (similar to PC version)
-
- *apple2gs_speedmenu*
-,,,,,,
-
-.. _BLADERUNNER:
-
-**BLADERUNNER**
-=================
-
-.. _sitcom:
-
-Sitcom mode
- Game will add laughter after actor's line or narration
-
- *sitcom*
-
-.. _shorty:
-
-Shorty mode
- Game will shrink the actors and make their voices high pitched
-
- *shorty*
-
-.. _nodelay:
-
-Frame limiter high performance mode
- This mode may result in high CPU usage! It avoids use of delayMillis() function.
-
- *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*
-
-.. _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*
-,,,,,,,,
-
-.. _CGE:
-
-**CGE**
-=================
-
-.. _blind:
-
-Color Blind Mode
- Enable Color Blind Mode by default
-
- *enable_color_blind*
-
-,,,,,,
-
-.. _CINE:
-
-**CINE**
-=================
-
-Use original save/load screen
- Use the original save/load screens instead of the ScummVM one
-
- *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*
-
-,,,,,,,,,
-
-.. _DRASCULA:
-
-**DRASCULA**
-=================
-
-Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
-
- *originalsaveload*
-,,,,,,,,,,
-
-.. _DREAMWEB:
-
-**DREAMWEB**
-=================
-
-Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
-
- *originalsaveload*
-
-.. _bright:
-
-Use bright palette mode
- Display graphics using the game's bright palette
-
- *bright_palette*
-,,,,,,,,,,
-
-.. _HDB:
-
-**HDB**
-=================
-
-.. _hyper:
-
-Enable cheat mode
- Debug info and level selection becomes available
-
- *hypercheat*
-
-,,,,,,,,,,
-
-.. _HOPKINS:
-
-**HOPKINS**
-=================
-
-.. _gore:
-
-Gore Mode
- Enable Gore Mode when available
-
- *enable_gore*
-
-,,,,,,,,,,
-
-.. _KYRA:
-
-**KYRA**
-=================
-
-.. _studio:
-
-Enable studio audience
- Studio audience adds an applause and cheering sounds whenever Malcolm makes a joke
-
- *studio_audience*
-
-.. _skip:
-
-Skip support
- This option allows the user to skip text and cutscenes.
-
- *skip_support*
-
-.. _helium:
-
-Enable helium mode
- Helium mode makes people sound like they've inhaled Helium.
-
- *helium_mode*
-
-.. _smooth:
-
-Enable smooth scrolling when walking
- When enabled, this option makes scrolling smoother when changing from one screen to another.
-
- *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*
-Suggest save names
- When enabled, this option will fill in an autogenerated savegame escription into the input prompt.
-
- *auto_savenames*
-.. _hp:
-
-HP bar graphs
- Enable hit point bar graphs
-
- *hpbargraphs*
-
-.. _btswap:
-
-Fight Button L/R Swap
- Left button to attack, right button to pick up items
-
- *mousebtswap*
-
-,,,,,,,,,,
-
-.. _LURE:
-
-**LURE**
-=================
-
-.. _ttsnarrator:
-
-TTS Narrator
- Use text-to-speech to read the descriptions, if test-to-speech is available)
-
- *tts_narrator*
-
-,,,,,,,,,,
-
-.. _MADS:
-
-**MADS**
-=================
-
-.. _easy:
-
-Easy mouse interface
- Shows object names when hovering the mouse over them
-
- *EasyMouse*
-
-.. _objanimated:
-
-Animated inventory items
- Animated inventory items
-
- *InvObjectsAnimated*
-
-.. _windowanimated:
-
-Animated game interface
- Animated game interface
-
- *TextWindowAnimated*
-
-.. _naughty:
-
-Naughty game mode
- Naughty game mode
-
- *NaughtyMode*
-
-.. _gdither:
-
-Graphics dithering
- Graphics dithering
-
- *GraphicsDithering*
-
-,,,,,,,,,,
-
-.. _NEVERHOOD:
-
-**NEVERHOOD**
-=================
-
-Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
-
- *originalsaveload*
-
-.. _skiphall:
-
-Skip the Hall of Records storyboard scenes
- Allows the player to skip past the Hall of Records storyboard scenes
-
- *skiphallofrecordsscenes*
-
-.. _scale:
-
-Scale the making of videos to full screen
- Scale the making of videos, so that they use the whole screen
-
- *scalemakingofvideos*
-
-,,,,,,,,,,
-
-.. _QUEEN:
-**QUEEN**
-==========
-
-Alternate intro
- Plays the alternate intro for Flight of the Amazon Queen.
-
- *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*
-
-.. _hires:
-
-Enable high resolution graphics
- Enable high resolution graphics/content
-
- *enable_high_resolution_graphics*
-
-.. _blackline:
-
-Enable black-lined video
- Draw black lines over videos to increase their apparent sharpness
-
- *enable_black_lined_video*
-
-.. _hq:
-
-Use high-quality video scaling
- Use linear interpolation when upscaling videos, where possible
-
- *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
-
- *prefer_digitalsfx*
-
-Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
-
- *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*
-
-.. _cd:
-
-Use CD audio
- Use CD audio instead of in-game audio, if available
-
- *use_cdaudio*
-
-.. _wincursors:
-
-Use Windows cursors
- Use the Windows cursors (smaller and monochrome) instead of the DOS ones
-
- *windows_cursors*
-
-.. _silver:
-
-Use silver cursors
- Use the alternate set of silver cursors instead of the normal golden ones
-
- *silver_cursors*
-
-.. _upscale:
-
-Upscale videos
- Upscale videos to double their size
-
- *enable_video_upscale*
-
-.. _censor:
-
-Enable content censoring
- Enable the game's built-in optional content censoring"),
-
- *enable_censoring*
-
-,,,,,,,,,,
-
-.. _SCUMM:
-
-**SCUMM**
-=================
-
-.. _labels:
-
-Show Object Line
- Show the names of objects at the bottom of the screen
-
- *object_labels*
-
-.. _classic:
-
-Use NES Classic Palette
- Use a more neutral color palette that closely emulates the NES Classic
-
- *mm_nes_classic_palette*
-
-,,,,,,,,,,
-
-.. _SHERLOCK:
-
-**SHERLOCK**
-=================
-Use original load/save screens
- Use the original save/load screens instead of the ScummVM ones"),
-
- *originalsaveload*
-
-.. _fade:
-
-Pixellated scene transitions
- When changing scenes, a randomized pixel transition is done
-
- *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*
-
-.. _portraits:
-
-Show character portraits
- Show portraits for the characters when conversing
-
- *portraits_on*
-
-.. _style:
-
-Slide dialogs into view
- Slide UI dialogs into view, rather than simply showing them immediately
-
- *window_style*
-
-.. _transparentwindows:
-
-Transparent windows
- Show windows with a partially transparent background
-
- *transparent_windows*
-
-TTS Narrator
- Use text-to-speech to read the descriptions, if text-to-speech is available.
-
- *tts_narrator*
-,,,,,,,,,,
-
-.. _SKY:
-
-**SKY**
-=================
-.. _altintro:
-
-Floppy intro
- Use the floppy version's intro (CD version only)
-
- *alt_intro*
-,,,,,,,,,,
-
-.. _SUPERNOVA:
-
-**SUPERNOVA**
-=================
-.. _improved:
-
-Improved mode
- Removes some repetitive actions, adds possibility to change verbs by keyboard.
-
- *improved*
-
-,,,,,,,,,,
-
-.. _TOLTECS:
-
-**TOLTECS**
-=================
-
-Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
-
- *originalsaveload*
-
-,,,,,,,,,,
-
-.. _WINTERMUTE:
-
-**WINTERMUTE**
-=================
-
-.. _fps:
-
-Show FPS-counter
- Show the current number of frames per second in the upper left corner
-
- *show_fps*
-
-.. _bilinear:
-
-Sprite bilinear filtering (SLOW)
- Apply bilinear filtering to individual sprites
-
- *bilinear_filtering*
-
-,,,,,,,,,,
-
-.. _XEEN:
-
-**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*
-
-.. _durable:
-
-More durable armor
- Armor won't break until character is at -80HP, rather than merely -10HP
-
- *DurableArmor*
-
diff --git a/doc/docportal/using_scummvm/global_settings.rst b/doc/docportal/using_scummvm/global_settings.rst
deleted file mode 100644
index b83f4f660c..0000000000
--- a/doc/docportal/using_scummvm/global_settings.rst
+++ /dev/null
@@ -1,462 +0,0 @@
-===============
-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`_ | `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. For more information including comprehensive explanation of the graphics settings, see the :doc:`../advanced_options/graphics` page.
-
-,,,,,,,
-
-.. _gfxmode:
-
-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*
-
-
-.. _render:
-
-Render mode
- Changes how the game is rendered, which affects how the game looks.
-
- *render_mode*
-
-.. _stretchmode:
-
-Stretch mode
- Changes the way the game is displayed in relation to the window size.
-
- *stretch_mode*
-
-.. _ratio:
-
-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*
-
-.. _fullscreen:
-
-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*
-
-.. _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*
-
-
-,,,,,,,,,,,,,,,,,,
-
-_`Audio tab`
--------------------
-
-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.
-
-,,,,,,,,,,,,,,,,
-
-.. _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*
-
-.. _opl:
-
-**AdLib Emulator**
- Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the preferred device.
-
- *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*
-
- *subtitles*
-
-.. _talkspeed:
-
-**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*
-
-,,,,,,,,,,,,,,,
-
-_`Volume tab`
----------------
-
-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*
-
-.. _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.
-
- *speech_volume*
-
-.. _mute:
-
-**Mute All**
- Mutes all game audio.
-
- *mute*
-
-,,,,,,,,,,,,,,,,,,
-
-
-_`MIDI tab`
-----------------
-
-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.
-
- *gm_device*
-
-.. _soundfont:
-
-**Soundfont**
- Specifies the path to a soundfont file, if this is required by the GM device.
-
- *soundfont*
-
-.. _multi:
-
-**Mixed AdLib/MIDI mode**
- Combines MIDI music with AdLib sound effects.
-
- *multi_midi*
-
-.. _gain:
-
-**MIDI gain**
- Adjusts the relative volume of the MIDI music. This is only supported by some music devices.
-
- *midi_gain*
-
-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.
-
-.. _revact:
-
-Active
- If ticked, reverb is added to the software synthesizer output.
-
- *fluidsynth_reverb_activate*
-
-.. _revroom:
-
-Room
- Sets the room size, which determines how much reverb there is.
-
- *fluidsynth_reverb_roomsize*
-
-.. _revdamp:
-
-Damp
- Dampens higher-frequency reverb, which produces a warmer sound.
-
- *fluidsynth_reverb_damping*
-
-.. _revwidth:
-
-Width
- Sets the stereo spread of the reverb signal.
-
- *fluidsynth_reverb_width*
-
-.. _revlevel:
-
-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.
-
-.. _chact:
-
-Active
- If ticked, chorus effects are added to the software synthesizer output.
-
- *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*
-
-.. _chlevel:
-
-Level
- Specifies the output amplitude of the chorus signal.
-
- *fluidsynth_chorus_level*
-
-.. _chspeed:
-
-Speed
- Sets the modulation speed of the output, in Hz.
-
- *fluidsynth_chorus_speed*
-
-.. _chdepth:
-
-Depth
- Specifies the modulation depth of the chorus.
-
- *fluidsynth_chorus_depth*
-
-.. _chwave:
-
-Type
- Specifies the chorus modulation waveform type.
-
- *fluidsynth_chorus_waveform*
-
-,,,,,,,,,,,,,
-
-_`Misc`
-*********
-.. _interp:
-
-Interpolation
- Sets the interpolation method used by the software synthesizer.
-
- *fluidsynth_misc_interpolation*
-
-,,,,,,,,,,,,,,,
-
-
-_`MT-32 tab`
----------------
-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.
-
-,,,,,
-
-_`Paths tab`
---------------------
-
-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:
-
- * 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``
-
- *savepath*
-
-.. _themepath:
-
-Theme Path
- The folder that additional themes for the ScummVM Launcher are stored in.
-
- *themepath*
-
-.. _extra:
-
-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
- * Soundfonts
- * MT-32 ROMs
-
- *extrapath*
-
-,,,,,,,,,,,,,,
-
-_`Misc tab`
-----------------------
-
-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
-
- *gui_theme*
-
-GUI Renderer
- Defines how the ScummVM GUI is rendered; normal or antialiased.
-
- *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*
-
-GUI Language
- Choose the language of the ScummVM Launcher
-
- *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*
-
-,,,,,,,,,,,,,
-
-_`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.
-
-.. _serverport:
-
-Server's port
- The port on which the web server is available.
-
- *local_server_port*
-
-.. _rootpath:
-
-/root/ Path
- Allows you to specify the root path. Any sub-directories will be accessible.
-
- *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*
-
-,,,,,,,,,,,,,,,,,,,,,
\ No newline at end of file
diff --git a/doc/docportal/using_scummvm/keyboard_shortcuts.rst b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
index 05167490ba..feaf9730dd 100755
--- a/doc/docportal/using_scummvm/keyboard_shortcuts.rst
+++ b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
@@ -1,8 +1,10 @@
===================
-Keyboard Shortcuts
+Keyboard shortcuts
===================
-ScummVM supports various in-game keyboard and mouse shortcuts.
+ScummVM supports various in-game keyboard and mouse shortcuts, and since version 2.2.0 these can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`, or in the :doc:`configuration file <../advanced_options/configuration_file>`.
+
+The shortcuts listed below are the defaults.
Common shortcuts (all games)
-------------------------------
@@ -17,16 +19,16 @@ Common shortcuts (all games)
: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:`Ctrl + u` ,Mutes all sounds
+ :kbd:`Ctrl + m` ,Toggles mouse capture
+ :kbd:`Ctrl + Alt + 1-8` ,Switches between graphics filters
+ :kbd:`Ctrl + Alt` and :kbd:`+` or :kbd:`-`,Increases/decreases the scale factor
+ :kbd:`Ctrl + Alt + a` ,Toggles aspect ratio correction on/off
+ :kbd:`Ctrl + Alt + f` ,Toggles between nearest neighbor and bilinear interpolation (graphics filtering on/off)
+ :kbd:`Ctrl + Alt + s` ,Cycles through stretch 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).
+ :kbd:`Alt + s` ,Takes a screenshot (SDL backend only)
+ :kbd:`Ctrl + F7`,"Opens virtual keyboard (if enabled).
This can also be opened with a long press of the middle mouse button or wheel."
SCUMM games
@@ -39,21 +41,21 @@ SCUMM games
Shortcut, Description
:kbd:`Alt + x` ,Quit
- :kbd:`Ctrl + 0-9` ,Save game state
- :kbd:`Alt + 0-9`,Load saved game state
+ :kbd:`Ctrl + 0-9` ,Saves game state
+ :kbd:`Alt + 0-9`,Loads saved game state
:kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Ctrl + f` ,Toggle fast mode
+ :kbd:`Ctrl + f` ,Toggles 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:`Ctrl + t` ,"Switches between 'Speech only', 'Speech and Subtitles' and 'Subtitles only'"
+ :kbd:`~` ,Shows/hides 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
+ :kbd:`Enter` ,Simulates left mouse button press
+ :kbd:`Tab`,Simulates right mouse button press
Beneath a Steel Sky
---------------------
@@ -64,7 +66,7 @@ Beneath a Steel Sky
Shortcut, Description
:kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Ctrl + f` ,Toggle fast mode
+ :kbd:`Ctrl + f` ,Toggles fast mode
:kbd:`Ctrl + g` ,Runs in REALLY fast mode
:kbd:`F5` ,Displays a save/load box
:kbd:`Esc` ,Skips the game intro
@@ -128,8 +130,8 @@ Dragon History
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:`Esc` ,"Skips the intro, exit map/inventory"
+ any click ,Skips the currently dubbed sentence
:kbd:`q` ,
@@ -188,6 +190,19 @@ Indiana Jones and the Last Crusade
Shortcut, Description
:kbd:`i` ,Displays IQ points
+Myst
+------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ Left Click, Move/action
+ :kbd:`Space`, Pause the game
+ :kbd:`Esc`, Skip cutscene
+ :kbd:`F5`, Menu
+
Nippon Safes
---------------
@@ -200,6 +215,25 @@ Nippon Safes
:kbd:`l`,Load game
:kbd:`s`,Save game
+Riven
+------
+
+.. csv-table::
+ :widths: 40 60
+ :header-rows: 1
+
+ Shortcut, Description
+ Left Click, Move/action
+ Arrow Keys, Movement
+ :kbd:`PgUp`, Look up
+ :kbd:`PgDn`, Look down
+ :kbd:`Space`, Pause the game
+ :kbd:`Esc`, Skip cutscene
+ :kbd:`F5`, Menu
+ :kbd:`Ctrl + o`, Load game
+ :kbd:`Ctrl + s`, Save game
+
+
Simon the Sorcerer 1 and 2
---------------------------
@@ -209,8 +243,8 @@ Simon the Sorcerer 1 and 2
:header-rows: 1
Shortcut, Description
- :kbd:`Ctrl + 0-9` ,Save game state
- :kbd:`Alt + 0-9`, Load saved game state
+ :kbd:`Ctrl + 0-9` ,Saves game state
+ :kbd:`Alt + 0-9`, Loads saved game state
:kbd:`Ctrl + d` ,Starts the debugger
:kbd:`Ctrl + f` ,Toggles fast mode
:kbd:`F1` and :kbd:`F3` ,"Text speed, faster - slower"
@@ -299,8 +333,8 @@ The Legend of Kyrandia
:header-rows: 1
Shortcut, Description
- :kbd:`Ctrl + 0-9` ,Save game state
- :kbd:`Alt + 0-9`, Load saved game state
+ :kbd:`Ctrl + 0-9` ,Saves game state
+ :kbd:`Alt + 0-9`, Loads saved game state
:kbd:`Ctrl + d` ,Starts the debugger
TeenAgent
diff --git a/doc/docportal/using_scummvm/save_load_games.rst b/doc/docportal/using_scummvm/save_load_games.rst
new file mode 100644
index 0000000000..2b2b096b56
--- /dev/null
+++ b/doc/docportal/using_scummvm/save_load_games.rst
@@ -0,0 +1,159 @@
+
+===============================
+Saving and loading games
+===============================
+
+Saving a game
+==============
+
+
+Games can be saved from the Global Main Menu (GMM), which can be accessed during game play by using the default :kbd:`Ctrl` + :kbd:`F5` keyboard shortcut, or by using the shortcut set in the :doc:`../settings/keymaps` setting.
+
+.. figure:: ../images/Launcher/gmm_save.png
+
+ The Global Main Menu, or GMM.
+
+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.
+
+.. figure:: ../images/Launcher/save_game_tile.png
+
+ Saving a game, tile view.
+
+.. figure:: ../images/Launcher/save_game_tile_desc.png
+
+ Save game decription, tile view.
+
+.. figure:: ../images/Launcher/save_game_list.png
+
+ Saving a game, list view.
+
+.. caution::
+
+ Saving via the Global Main Menu does not work for all games. Some games have support for saving and loading games using the in-game menu.
+
+
+Autosave
+------------
+
+ScummVM will automatically save the game every 5 minutes. The :ref:`autosave period <autosave>` can be changed in the :doc:`Misc tab <../settings/misc>` or in the :doc:`configuration file <../advanced_options/configuration_file>`.
+
+
+
+Loading a game
+===============
+
+Saved games can be loaded directly from the Launcher without starting the game first, by selecting the **Load** button.
+
+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.
+
+.. figure:: ../images/Launcher/load_game_list.png
+
+ Loading a game, list view.
+
+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.
+
+
+.. figure:: ../images/Launcher/load_game_tile.png
+
+ Loading a game, tile view.
+
+Saved games can also be loaded from the Global Main Menu, which can be accessed during game play by using the default :kbd:`Ctrl` + :kbd:`F5` keyboard shortcut, or by using the shortcut set in the :doc:`../settings/keymaps` setting.
+
+
+.. caution::
+
+ Not all games support saving and loading games via the Global Main Menu.
+
+ 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 this may crash ScummVM in some games.
+
+
+
+
+Location of saved game files
+-------------------------------
+
+Saved game files can be found in the current ScummVM directory for some platforms, and in default directories for others. The defaults for Windows, Mac and Linux/Unix are shown below.
+
+The save directory can be changed via the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_options/configuration_file>`.
+
+.. tabs::
+
+ .. tab:: Mac OSX
+
+ ``~/Documents/ScummVM Savegames/``, where ``~`` is your Home directory. To see the Libraries folder you will need to view hidden files.
+
+ .. tab:: Windows
+
+ **Windows NT4**: ``<windir>\Profiles\username\Application Data\ScummVM\Saved games\`` where ``<windir>`` refers to the Windows directory. Most commonly, this is ``C:\WINDOWS``.
+
+ **Windows 2000/XP**: ``\Documents and Settings\username\Application Data\ScummVM\Saved games\``
+
+ **Window 7/Vista**: ``\Users\username\AppData\Roaming\ScummVM\Saved games\``
+
+ The Application Data/AppData directory is hidden. To view it, use the Run utility or the command prompt, and enter ``%APPDATA%\ScummVM\Saved Games``, or enable hidden files in Windows Explorer.
+
+ .. tab:: Linux/Unix
+
+ We follow the XDG Base Directory Specification. This means our configuration can be found in ``$XDG_DATA_HOME/scummvm/saves/``
+
+ If XDG_DATA_HOME is not defined or empty, ``~/.local/share/`` will be used, where ``~`` is your Home directory.
+
+ Note that ``.local`` 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`.
+
+ If ScummVM was installed using Snap, the saves can be found at ``~/snap/scummvm/current/.local/share/scummvm/saves/``
+
+.. _originalsaves:
+
+Using saved games from original versions
+-------------------------------------------
+
+This is only supported by a small selection of games.
+
+For the file names shown below, ``xxx`` is the saved game slot ScummVM uses, for example ``001`` for slot 1.
+
+- Blade Runner
+
+ - Use the debugger console and command "save" to save the game to the original format, and command "load" to load a game from the original format.
+ - Saved games between different languages are interchangeable
+ - It is not recommended to convert saved games from the version with restored content. They may cause game breaking bugs.
+
+- Elvira 1 and 2
+
+ - Edit the saved game file. Add an 8-letter saved game name to the start of the saved game file.
+ - Elvira 1: rename the saved game to ``elvira1.xxx``.
+ - Elvira 2: rename the saved game to ``elvira2-pc.xxx`` for the DOS version, and ``elvira2.xxx`` for other versions.
+
+- Myst
+
+ - Rename the saved game to ``myst-xxx.mys``.
+
+- Riven
+
+ - Rename the saved game to ``riven-xxx.rvn``.
+ - Saved games from the CD and DVD edition are not interchangeable.
+
+- Simon the Sorcerer 1 and 2
+
+ - For Simon 1: rename the saved game to ``simon1.xxx``
+ - For SImon 2: rename the saved game to ``simon2.xxx``
+
+- Starship Titanic
+
+ - Rename the saved game to ``titanic-win.xxx`` for the English version, and ``titanic-wind-de.xxx`` for the German version.
+ - Saved games from different languages are not interchangeable.
+
+- The Feeble Files
+
+ - Rename the saved game to ``feeble.xxx``
+
+- Waxworks
+
+ - Edit the saved game file. Add an 8-letter saved game name to the start of the saved game file.
+ - Rename the saved game to ``waxworks-pc.xxx`` for the DOS version, and ``waxworks.xxx`` for other versions.
diff --git a/doc/docportal/using_scummvm/the_launcher.rst b/doc/docportal/using_scummvm/the_launcher.rst
index 2cbd9b9b4d..cdbb0ece99 100755
--- a/doc/docportal/using_scummvm/the_launcher.rst
+++ b/doc/docportal/using_scummvm/the_launcher.rst
@@ -4,13 +4,16 @@ The Launcher
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.
+.. figure:: ../images/Launcher/the_launcher.png
+
+ The Launcher.
+
+
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.
-.. image:: ../images/Launcher/the_launcher.jpg
- :class: with-shadow
Quick search
=============
@@ -20,8 +23,9 @@ The quick search input is located at the top of the page next to the magnifying
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
+.. figure:: ../images/Launcher/quicksearch.png
+
+ Using the quick search function.
The buttons
============
@@ -31,48 +35,19 @@ Start
-----
Launches the highlighted game.
-.. image:: ../images/Launcher/start_game.jpg
-
Load
----
Opens the Load window, from which you can run a previously saved state without having to start the game first.
-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 the save game feature, or whose saved states lack information such as playtime or screenshots.
-
-.. image:: ../images/Launcher/save_game_list.jpg
- :class: with-shadow
-
-.. image:: ../images/Launcher/save_game_tile.jpg
- :class: with-shadow
-
-
+See the :doc:`save_load_games` page.
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**.
+Opens a file browser to select a folder containing game files.
-.. 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.
+See the :doc:`save_load_games` page.
Edit Game
----------
@@ -80,10 +55,8 @@ Edit Game
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.
+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:`../settings/how_to` page.
-.. image:: ../images/Launcher/edit_game.jpg
- :class: with-shadow
Remove Game
-----------
@@ -94,10 +67,7 @@ Removes the highlighted game from the list.
Options
-------
-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..
+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 information, see the :doc:`../settings/how_to` page
About
-----
@@ -110,27 +80,18 @@ Closes the Launcher and quits the ScummVM application.
The Global Main Menu
=====================
-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:
+.. figure:: ../images/Launcher/gmm.png
-.. image:: ../images/Launcher/gmm.jpg
- :class: with-shadow
+ The Global Main Menu, or GMM.
+
+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:
- **Resume:** Closes the GMM and resume the game.
- **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:** Provides gameplay options, such as sound volume and subtitle settings.
-
-.. image:: ../images/Launcher/gmm_options.jpg
- :class: with-shadow
-
+- **Options:** Provides gameplay options, such as sound volume, subtitle and keymap settings.
- **About:** Displays the ScummVM About box. This is also available from the The Launcher.
- **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 this way, however it is not intended for this purpose and may crash ScummVM in some games.
-
Commit: 8d9da4a6772da517196e496533fd8578e2f19807
https://github.com/scummvm/scummvm/commit/8d9da4a6772da517196e496533fd8578e2f19807
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: keeps index page up to date with all changes
Changed paths:
doc/docportal/index.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index b7b0e1ec00..c64e744c72 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -1,39 +1,80 @@
.. toctree::
:glob:
- :caption: Getting Started
+ :caption: Quickstart Guide
:maxdepth: 2
:hidden:
- getting_started/mac
- getting_started/linux
- getting_started/windows
- getting_started/ios
- getting_started/android
-
-
-
+ getting_started/mac_linux_windows
+
.. toctree::
- :caption: Installing ScummVM
:glob:
+ :caption: Other Platforms
:maxdepth: 2
:hidden:
- installing_scummvm/*
+ other_platforms/*
.. toctree::
:caption: Using ScummVM
:glob:
:hidden:
- using_scummvm/game_settings
- using_scummvm/*
+ using_scummvm/the_launcher
+ using_scummvm/adding_games
+ using_scummvm/save_load_games
+ using_scummvm/keyboard_shortcuts
+
+
+.. toctree::
+ :caption: Settings
+ :glob:
+ :hidden:
+
+ settings/how_to
+ settings/game
+ settings/engine
+ settings/graphics
+ settings/control
+ settings/keymaps
+ settings/audio
+ settings/paths
+ settings/misc
+ settings/cloud
+ settings/lan
+ settings/accessibility
+
+.. toctree::
+ :caption: Games
+ :glob:
+ :hidden:
+
+ games/copy_protection
+
.. toctree::
:caption: Advanced Options
:glob:
:hidden:
- advanced_options/*
+ advanced_options/command_line
+ advanced_options/configuration_file
+
+
+.. toctree::
+ :caption: Help
+ :glob:
+ :hidden:
+
+ help/reporting_bugs
+ help/contact
+ help/faq
+
+.. toctree::
+ :caption: Release Notes
+ :glob:
+ :hidden:
+
+ release_notes/*
====================
Welcome to ScummVM!
@@ -45,47 +86,60 @@ SCUMM (Script Creation Utility for Maniac Mansion) is a utility that was used to
While ScummVM was originally designed to run LucasArts' SCUMM games, over time support has been added for many other games.
+.. _firststeps:
+
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:**
+We have guides available to show you how to get ScummVM up and running:
+
+- **Quickstart**: :doc:`getting_started/mac_linux_windows`
+- **Phones and Tablets**: :doc:`other_platforms/ios` | :doc:`other_platforms/android`
+- **Consoles**: :doc:`other_platforms/ps_vita` | :doc:`other_platforms/psp` | :doc:`other_platforms/nintendo_switch`
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:
+So you have ScummVM installed, but now you need to know how to add and play some games! We have lots of useful information to help you out:
- **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`
+- **Playing games**: :doc:`using_scummvm/adding_games` | :doc:`using_scummvm/save_load_games` | :doc:`using_scummvm/keyboard_shortcuts`
+- **Settings**: :doc:`settings/how_to`
-Advanced features
+
+The games!
+============
+
+One of the most commonly asked questions we get is, "Where do I get the games??". If you still have your old floppy discs and CDs lying around (and have a way to read them!), then you can use the game files from these original discs. For a list of which files you need for each game, check out the `Datafiles page <https://wiki.scummvm.org/index.php?title=Datafiles>`__ on our wiki.
+
+If you haven't had a floppy disc or even a CD in your possession for a while, we have a `wiki page <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ dedicated to helping you find some games to play. As a quick summary, there are a few freeware games available for download on our website's `Downloads page <scummvm.org/downloads>`_, or there are digital distributors such as `GOG.com <gog.com>`_ and `Steam <https://store.steampowered.com/>`_.
+
+Make sure you check out the `compatibility list <https://www.scummvm.org/compatibility/>`_ on our website and the `Supported Games page <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ on our wiki before you buy a game, to ensure it can run with ScummVM.
+
+
+Advanced options
============================
-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.
+For our more experienced users, ScummVM has a command line interface, as well as the ability to edit settings directly in a configuration file.
-- **Advanced settings**: :doc:`advanced_options/graphics` | :doc:`advanced_options/audio`
-- **The command line interface**: :doc:`advanced_options/command_line`
+:doc:`advanced_options/configuration_file` | :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.
+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!
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 <#>`__
+:doc:`help/faq` | :doc:`How to report a bug <help/reporting_bugs>` | :doc:`help/contact`
+
+What's changed since I was last here?
+======================================
+
+For a quick recap on what's been happening with the latest release, check out our Release Notes section.
The ScummVM Project
Commit: 767d6a921ecf49c5dba969a03a389f6cb8d7fbda
https://github.com/scummvm/scummvm/commit/767d6a921ecf49c5dba969a03a389f6cb8d7fbda
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: adds Guides section
- removes extra info from settings pages into standalone guides
Changed paths:
A doc/docportal/guides/connect_cloud.rst
A doc/docportal/guides/local_webserver.rst
A doc/docportal/guides/understand_audio.rst
A doc/docportal/guides/understand_graphics.rst
R doc/docportal/settings/how_to.rst
doc/docportal/settings/audio.rst
doc/docportal/settings/cloud.rst
doc/docportal/settings/control.rst
doc/docportal/settings/engine.rst
doc/docportal/settings/game.rst
doc/docportal/settings/graphics.rst
doc/docportal/settings/keymaps.rst
doc/docportal/settings/lan.rst
diff --git a/doc/docportal/guides/connect_cloud.rst b/doc/docportal/guides/connect_cloud.rst
new file mode 100644
index 0000000000..79296457c1
--- /dev/null
+++ b/doc/docportal/guides/connect_cloud.rst
@@ -0,0 +1,27 @@
+===============================
+Connect a Cloud service
+===============================
+
+From the Launcher, go to **Options > Cloud**.
+
+To connect your chosen cloud storage service to ScummVM, select it from the **Active storage** dropdown.
+
+.. figure:: ../images/cloud_and_lan/cloud_storage.png
+
+Click on the link shown at **1.**, and log in to your cloud storage account. Once you have logged in, a 6-digit code will be displayed.
+
+.. figure:: ../images/cloud_and_lan/cloud_code.png
+
+Copy the 6-digit code, click into the empty box next to the **Paste** button, and then click the **Paste** button.
+
+.. figure:: ../images/cloud_and_lan/cloud_connect.png
+
+Click **3. Connect**, then, once the next information loads, click on **Enable storage**.
+
+.. figure:: ../images/cloud_and_lan/cloud_enable.png
+
+Saved games automatically sync on launch, after saving, and on loading a saved game. You can also manually sync by using the **Sync now** button.
+
+To download the game files from your cloud ScummVM folder, click **Download game files**.
+
+To change to a different cloud account, or to disconnect your cloud account from ScummVM, click **Disconnect**.
\ No newline at end of file
diff --git a/doc/docportal/guides/local_webserver.rst b/doc/docportal/guides/local_webserver.rst
new file mode 100644
index 0000000000..74c783012b
--- /dev/null
+++ b/doc/docportal/guides/local_webserver.rst
@@ -0,0 +1,36 @@
+==============================
+Set up a local webserver
+==============================
+
+ScummVM has the ability to run a local webserver, to make the transfer of game files easier.
+
+How to use the web server
+----------------------------
+
+Go to **Options > LAN**. You may need to use the red **>** button to bring the LAN tab into view.
+
+Click **Run server**.
+
+.. figure:: ../images/settings/LAN.png
+
+ The LAN tab.
+
+To access the server, type the URL shown into the address bar of any web browser:
+
+.. figure:: ../images/settings/LAN_server.png
+
+ The server running in the browser.
+
+To download a file, click on the file you wish to download. A system download dialog box opens.
+
+To create a new directory, click **Create Directory**.
+
+.. figure:: ../images/settings/LAN_server_new.png
+
+ Creating a new directory.
+
+To upload files, click **Upload Files** and select files from the system file explorer.
+
+.. figure:: ../images/settings/LAN_server_upload.png
+
+ Uploading files.
diff --git a/doc/docportal/guides/understand_audio.rst b/doc/docportal/guides/understand_audio.rst
new file mode 100644
index 0000000000..15def31647
--- /dev/null
+++ b/doc/docportal/guides/understand_audio.rst
@@ -0,0 +1,220 @@
+======================================================
+Understand the audio settings
+======================================================
+
+This guide is designed to expand on the information contained on the :doc:`audio settings <../settings/audio>` page.
+
+
+How do the settings work together?
+=====================================
+
+The **Preferred device** in the global settings Audio tab, or the **Music device** in the game-specific settings Audio tab, specifies the device that ScummVM uses to output audio. This device can be an emulated sound device or a software synthesizer, or an actual hardware device such as a soundcard or a hardware MIDI synthesizer. When set to **<default>**, ScummVM will automatically choose the most appropriate option for the played game.
+
+If **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses either an MT-32 or General MIDI device automatically, the settings on the MT-32 or MIDI tabs also apply, and the devices selected on these tabs are the ones that will be used. If **Preferred device** or **Music device** is set to either an MT-32 device or a GM device, ScummVM will use that device and ignore the devices chosen on the MT-32 and MIDI tabs.
+
+Many of the settings are highly dependent on the soundtrack(s) of the game you are playing; some offer only MIDI, while others have MP3 soundtracks, and so on.
+
+
+The evolution of PC audio
+=============================
+
+For a look at the evolution of PC audio, see `this video on YouTube <https://www.youtube.com/watch?v=a324ykKV-7Y>`_, or `this excellent post <http://www.oldskool.org/sound/pc>`_.
+
+Many of these old-school audio devices can be emulated by ScummVM:
+
+- PC Speaker: emulates the built-in PC speaker. This is mostly supported by older games, and was the only option before sound cards became widely used.
+
+ *pcspk*
+
+- IBM PCjr: emulates the sound of the 1984 IBM PCjr computer, which, enhanced with a Texas Instruments chip, provided three-voice sound and a white noise generator.
+
+ *pcjr*
+
+- Creative Music System `(C/MS) <https://en.wikipedia.org/wiki/Sound_Blaster#Creative_Music_System>`_: emulates the first sound card developed by Creative Technology (later Creative Labs), the precursor to the SoundBlaster line of sound cards. The C/MS provided 12 channels of square-wave stereo sound.
+
+ *cms*
+
+- C64 Audio: emulates the sound chip `(Sound Interface Device) <https://theconversation.com/the-sound-of-sid-35-years-of-chiptunes-influence-on-electronic-music-74935>`_ in the Commodore 64 computer. The SID was a three-voice synthesizer module, with a fourth voice for sampled drums or speech.
+
+ *C64*
+
+- Amiga Audio: emulates the Amiga audio chip, `Paula <https://en.wikipedia.org/wiki/Original_Chip_Set#Audio>`_, which had four 8-bit PCM sound channels.
+
+ *CAMD*
+
+- FM-Towns Audio: emulates the audio of the `FM Towns PC <https://en.wikipedia.org/wiki/FM_Towns#Sound>`_. Games on FM Towns computers often used audio CD standard tracks. The soundchips were capable of eight PCM voices and six FM channels.
+
+ *towns*
+
+- PC-98 Audio: emulates the audio of the NEC PC-9801-26 and PC-9801-86 sound cards.
+
+ *pc98*
+
+- SegaCD Audio: emulates the audio of the Sega CD add-on for the Sega Genesis/32x.
+
+ *segacd*
+
+To find out which emulation is compatible with the game you're playing, have a look at the manual that comes with the game.
+
+What is MIDI?
+======================
+
+MIDI is a communications protocol for musical information; it can be likened to digital sheet music. By itself, MIDI is not sound. Hardware or software synthesizers create (synthesize) audio by interpreting the information given to them via the MIDI protocol.
+
+Some games only contain MIDI audio data. In the past this prevented audio for these games from working on platforms that did not support MIDI, or with soundcards that did not provide MIDI drivers.
+
+ScummVM can now convert MIDI data to sampled audio using MIDI device emulators.
+
+
+
+What is General MIDI?
+------------------------------
+
+General MIDI is a MIDI standard which is implemented by a large number of devices. While using MIDI as its protocol, it also specifies an instrument map and some other information that devices must implement.
+
+.. _FS:
+
+General MIDI device emulation (FluidSynth)
+*************************************************
+
+If the ScummVM you're using has libfluidsynth support it will be able to play MIDI music by using the FluidSynth emulator if set as the **Preferred device** or **Music device**, or if specified in the MIDI tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses General MIDI output automatically.
+
+You will have to specify a SoundFont in the MIDI tab for ScummVM to use FluidSynth. MIDI is like digital sheet music; it needs a library of sound samples known as a SoundFont to draw from in order to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
+
+Since the default output volume from FluidSynth can be fairly low, ScummVM will automatically set the gain to get a stronger signal. This can be further adjusted using the :ref:`MIDI gain <gain>` setting.
+
+The processor requirements for FluidSynth are quite high; a fast CPU is recommended.
+
+What is MT-32?
+---------------------
+
+The MT-32 is a `Roland sound module <https://en.wikipedia.org/wiki/Roland_MT-32>`_, although the term also commonly refers to a range of devices that are fully compatible with the MT-32. MT-32 devices also use MIDI as the communications protocol.
+
+
+.. _MT-32:
+
+MT-32 device emulation
+********************************
+
+Some games which contain MIDI music data have tracks designed specifically for the Roland MT-32. ScummVM can emulate the MT-32 device, however you must provide the original MT-32 ROMs, taken from the MT-32 module, for the emulator to work. These files are:
+
+- MT32_PCM.ROM - IC21 (512KB)
+- MT32_CONTROL.ROM - IC26 (32KB) and IC27 (32KB)
+
+Place these ROMs in the game directory, in your extrapath, or in the directory where your ScummVM executable resides. ScummVM will also look for ``CM32L_PCM.ROM`` and ``CM32L_CONTROL.ROM`` - the ROMs from the CM-32L device - and will use these instead of the MT32 ROMs if they are available.
+
+ScummVM will use the MT-32 emulator if it is set as the **Preferred device** or **Music device**, or if it is specified in the MT-32 tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses MT-32 output automatically.
+
+You don't need to enable **True Roland MT-32** in the MT-32 tab, ScummVM does this automatically.
+
+.. tip::
+
+ Some games work better with some MT-32 devices than others. As an example, Lure of the Temptress makes use of extra sound effects included with the CM-32L and won't sound right with an MT-32. Likewise, The Colonel's Bequest exploits some bugs in the early MT-32 modules, which means that later devices will play incorrect sound effects!
+
+ `This Wikipedia article <https://en.wikipedia.org/wiki/List_of_MT-32-compatible_computer_games>`_ provides a comprehensive list of MT-32 compatible games, including which games work best with which device.
+
+The processor requirements for the MT-32 emulator are quite high; a fast CPU is strongly recommended.
+
+
+Native MIDI support
+--------------------------
+
+All MIDI ports will show up in the **Preferred device** or **Music device** dropdown selector. If you have selected a MIDI port, you will also need to specify what type of MIDI device this is with the options in the :ref:`MT-32 <mt32>` tab.
+
+- Enabling the **True Roland MT-32** option tells ScummVM that the MIDI device is an MT-32 (or fully compatible) device.
+- Enabling **Roland GS device** tells ScummVM to use an MT-32 soundtrack on a GS device. This is not supported by all games.
+- If no options are selected, this tells ScummVM that the device is General MIDI.
+
+Selecting an option that does not match the MIDI port selected may have unintended consequences; for example, if a game only has support for MT-32 and you have a General MIDI device selected as the **Preferred device** or **Music device**, ScummVM will convert the MT-32 MIDI data to GM-compatible MIDI data. While this may work fine for some games, it really depends on how the game has made use of the MT-32.
+
+.. note::
+
+ Soundcards or audio interfaces do not necessarily have anything to do with MIDI; while some older soundcards (and a few modern ones) have their own hardware-based synthesizers, it is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
+
+
+Mac OSX
+**********
+
+Mac has a built-in MIDI synthesizer; Apple DLS software synthesizer. It uses the Mac's built-in sounds (which are based on Roland GS).
+
+The `Apple Support page <https://support.apple.com/en-nz/guide/audio-midi-setup/ams875bae1e0/mac>`_ has further information about setting up MIDI devices on a Mac.
+
+Windows
+**********
+
+Windows has a generic built-in MIDI synthesizer - GS WaveTable Synth - also based on Roland's GS sounds.
+
+For an in-depth look at audio and MIDI device setup on a Windows computer, see this `very helpful article <http://donyaquick.com/midi-on-windows/>`_.
+
+Linux
+******
+
+MIDI device setup may vary depending on your Linux distro.
+
+If you do not have a hardware MIDI device, there are two options: FluidSynth and TiMidity. FluidSynth is recommended as TiMidity may have some lag, depending on the system.
+
+Here are a couple of helpful articles from the Ubuntu community documentation to get you started. These instructions should work for any Debian-based distro.
+
+`How to: Software Synthesizers <https://help.ubuntu.com/community/Midi/SoftwareSynthesisHowTo>`_
+
+`How to: Hardware synthesizer soundcard setup <https://help.ubuntu.com/community/Midi/HardwareSynthesisSetup?action=show&redirect=MidiHardwareSynthesisSetup>`_
+
+,,,,,,,,,,,,,,,,,,,,
+
+.. _adlib:
+
+What is AdLib?
+================
+
+AdLib devices do not use MIDI. They instead have a chip that produces sound via FM synthesis. While some games do store their audio data using a MIDI-derived format, this is converted by the game to work with the AdLib chip. ScummVM emulates a few different AdLib configurations, and selects the most appropriate for the game:
+
+- The original AdLib and SoundBlaster card had one OPL2 chip.
+- The SoundBlaster Pro 1 had two OPL2 chips
+- The SoundBlaster Pro 2 and 16 had an OPL3 chip.
+
+The AdLib emulator setting offers MAME, DOSBox and Nuked emulation, with MAME being the least accurate and using the least CPU power, and Nuked being the most accurate and also using the most CPU power - DOSBox is somewhere in between.
+
+There is also the option to select the OPL2LPT and OPL3LPT devices, which are external hardware devices with a real OPL chip, connected via the parallel port of a computer.
+
+AdLib does not require a SoundFont or ROMs, so for many games it may be the easiest to configure. However, if an MT-32 or GS emulator or device is available, ScummVM will prioritize this over AdLib.
+
+Mixed AdLib/MIDI mode
+------------------------
+Some games contain sound effects that are exclusive to the AdLib soundtrack, or the AdLib soundtrack may provide better sound effects. For these games, you can combine MIDI music with AdLib sound effects by using the :ref:`mixed AdLib/MIDI mode <multi>`.
+
+.. note::
+
+ Mixed AdLib/MIDI mode is not supported by all games.
+
+Digital Sound effects
+=======================
+
+Some games have both sampled and synthesized sound effects. ScummVM will usually use the sampled sound effects, even if you select Adlib, MT-32 or GM as your audio device. Some games allow you to choose between sampled and synthesized sound effects by using the **Prefer digital sound effects** option in the Engine tab.
+
+.. _outputrate:
+
+Sample output rate
+========================
+
+The output sample rate tells ScummVM how many sound samples to play per channel per second.
+
+Most of the sounds were originally sampled at either 22050Hz or 11025Hz, so using a higher sample rate in these cases will not improve the quality of the audio.
+
+For games that use CD audio, the sounds were probably sampled at 44100Hz, so that is a better sample rate to choose for these games.
+
+ScummVM generates the samples when using AdLib, FM-Towns, PC Speaker or IBM PCjr emulated sound. 22050Hz will usually be fine for these options, although for Beneath a Steel Sky 44100Hz is recommended.
+
+ScummVM has to resample all sounds to the selected output frequency. It is recommended to choose an output frequency that is a multiple of the original frequency. Choosing an in-between number may not be supported by your sound card.
+
+.. _buffer:
+
+Audio buffer size
+==========================
+
+There is no option to control audio buffer size through the GUI, but the default value can be overridden in the the :doc:`configuration file <../advanced_options/configuration_file>`. The default value is calculated based on output sampling frequency to keep audio latency below 45ms.
+
+Appropriate values are normally between 512 and 8192, but the value must be one of: 256, 512, 1024, 2048, 4096, 8192, 16384, or 32768.
+
+Smaller values yield faster response time, but can lead to stuttering if your CPU isn't able to catch up with audio sampling when using the sound emulators. Large buffer sizes may lead to minor audio delays (high latency).
+
+
diff --git a/doc/docportal/guides/understand_graphics.rst b/doc/docportal/guides/understand_graphics.rst
new file mode 100644
index 0000000000..b7fbede4ec
--- /dev/null
+++ b/doc/docportal/guides/understand_graphics.rst
@@ -0,0 +1,156 @@
+=====================================
+Understand the graphics settings
+=====================================
+
+This guide is designed to expand on the information contained on the :doc:`graphics settings <../settings/graphics>` page.
+
+How do the graphics settings work together?
+----------------------------------------------
+
+The graphics mode, aspect ratio, and stretch mode settings work together to change the resolution and display of each game. The first setting applied to the image is the graphics mode, then the aspect ratio correction, and then the stretch mode setting. The only exception to this is OpenGL mode, which applies all settings in one pass to arrive at a final image.
+
+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 modes
+---------------------------
+
+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.
+
+A 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.
+
+
+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.
+
+To switch between graphics modes on the go, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`1` to :kbd:`8`.
+
+OpenGL mode
+**************
+
+OpenGL graphics mode works a little differently to the other graphics modes. Instead of applying the aspect ratio and stretch mode settings one after the other (and after the graphics mode scaling has been applied), it does all the scaling and stretching in one step, going directly from the original game resolution to the final display resolution.
+
+Output is controlled by your window size (or screen resolution if in full screen) and the stretch mode selected, as well as the Filter graphics option.
+
+.. _aspect:
+
+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 - notice the moon is actually round now.
+
+To toggle aspect ratio on and off, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`a`.
+
+.. _stretch:
+
+Stretch modes
+----------------------
+
+
+There are five stretch modes:
+
+- Center - centers the image in the window.
+- Pixel-perfect scaling - scales the image to a multiple of the original game resolution as much as possible (for example, 2x, 3x, 4x and so on), and fills the remaining empty space with black borders.
+- Fit to window - fits the image to the window, but maintains the aspect ratio and 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 forced 4:3 aspect ratio.
+
+To switch between stretch modes on the go, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`s`.
+
+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
+
+Filter graphics
+----------------
+
+When enabled, ScummVM uses bilinear interpolation instead of nearest neighbor for the :ref:`aspect ratio <aspect>` and :ref:`stretch mode <stretch>`. It does not affect the graphics mode scaling unless OpenGL is selected, in which case it determines how the OpenGL scaling is done.
+
+To toggle between bilinear interpolation and nearest neighbor, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`f`.
\ No newline at end of file
diff --git a/doc/docportal/settings/audio.rst b/doc/docportal/settings/audio.rst
index 1fe033a333..e9af9ca6a8 100644
--- a/doc/docportal/settings/audio.rst
+++ b/doc/docportal/settings/audio.rst
@@ -2,13 +2,13 @@
Audio
===============
-Overview
-=============================
Audio settings are found in four tabs:
:ref:`Audio <audiotab>` | :ref:`Volume <volumetab>` | :ref:`MIDI <miditab>` | :ref:`MT-32 <mt32tab>`
+For a comprehensive look at how to use ScummVM's extensive audio settings, check out our :doc:`../guides/understand_audio` guide.
+
.. _audiotab:
The Audio tab
@@ -37,7 +37,7 @@ Use the audio tab to change the sound output for games.
.. _opl:
-:ref:`AdLib Emulator <AdLib>`
+AdLib Emulator
Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the preferred device.
*opl_driver*
@@ -108,7 +108,7 @@ Use the volume tab to set the relative volumes for various sounds.
.. _miditab:
-:ref:`The MIDI tab <MIDI>`
+The MIDI tab
------------------------------
Use the MIDI tab to change the settings of General MIDI devices.
@@ -136,7 +136,7 @@ Use the MIDI tab to change the settings of General MIDI devices.
.. _multi:
-`Mixed AdLib/MIDI mode`_
+Mixed AdLib/MIDI mode
Combines MIDI music with AdLib sound effects.
*multi_midi*
@@ -151,7 +151,7 @@ Use the MIDI tab to change the settings of General MIDI devices.
.. _fluid:
-:ref:`FluidSynth <FS>`
+FluidSynth
************************************************************************
Opens a new dialog, with three further tabs:
@@ -268,7 +268,7 @@ Interpolation
.. _mt32tab:
-:ref:`The MT-32 tab <MT-32>`
+The MT-32 tab
----------------------------------------------------
Use the MT-32 tab to change the settings of MT-32 devices.
@@ -300,221 +300,4 @@ MT-32 Device
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.
-Further reading
-==================================
-
-
-How do the audio settings work together?
------------------------------------------
-
-The **Preferred device** in the global settings Audio tab, or the **Music device** in the game-specific settings Audio tab, specifies the device that ScummVM uses to output audio. This device can be an emulated sound device or a software synthesizer, or an actual hardware device such as a soundcard or a hardware MIDI synthesizer. When set to **<default>**, ScummVM will automatically choose the most appropriate option for the played game.
-
-If **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses either an MT-32 or General MIDI device automatically, the settings on the MT-32 or MIDI tabs also apply, and the devices selected on these tabs are the ones that will be used. If **Preferred device** or **Music device** is set to either an MT-32 device or a GM device, ScummVM will use that device and ignore the devices chosen on the MT-32 and MIDI tabs.
-
-Many of the settings described in this section are highly dependent on the soundtrack(s) of the game you are playing; some offer only MIDI, while others have MP3 soundtracks, and so on.
-
-The evolution of audio
--------------------------
-
-For a look at the evolution of PC audio, see `this video on YouTube <https://www.youtube.com/watch?v=a324ykKV-7Y>`_, or `this excellent post <http://www.oldskool.org/sound/pc>`_.
-
-Many of these old-school audio devices can be emulated by ScummVM:
-
-- PC Speaker: emulates the built-in PC speaker. This is mostly supported by older games, and was the only option before sound cards became widely used.
-
- *pcspk*
-
-- IBM PCjr: emulates the sound of the 1984 IBM PCjr computer, which, enhanced with a Texas Instruments chip, provided three-voice sound and a white noise generator.
-
- *pcjr*
-
-- Creative Music System `(C/MS) <https://en.wikipedia.org/wiki/Sound_Blaster#Creative_Music_System>`_: emulates the first sound card developed by Creative Technology (later Creative Labs), the precursor to the SoundBlaster line of sound cards. The C/MS provided 12 channels of square-wave stereo sound.
-
- *cms*
-
-- C64 Audio: emulates the sound chip `(Sound Interface Device) <https://theconversation.com/the-sound-of-sid-35-years-of-chiptunes-influence-on-electronic-music-74935>`_ in the Commodore 64 computer. The SID was a three-voice synthesizer module, with a fourth voice for sampled drums or speech.
-
- *C64*
-
-- Amiga Audio: emulates the Amiga audio chip, `Paula <https://en.wikipedia.org/wiki/Original_Chip_Set#Audio>`_, which had four 8-bit PCM sound channels.
-
- *CAMD*
-
-- FM-Towns Audio: emulates the audio of the `FM Towns PC <https://en.wikipedia.org/wiki/FM_Towns#Sound>`_. Games on FM Towns computers often used audio CD standard tracks. The soundchips were capable of eight PCM voices and six FM channels.
-
- *towns*
-
-- PC-98 Audio: emulates the audio of the NEC PC-9801-26 and PC-9801-86 sound cards.
-
- *pc98*
-
-- SegaCD Audio: emulates the audio of the Sega CD add-on for the Sega Genesis/32x.
-
- *segacd*
-
-To find out which emulation is compatible with the game you're playing, have a look at the manual that comes with the game.
-
-
-.. _MIDI:
-
-MIDI
--------
-
-MIDI is a communications protocol for musical information; it can be likened to digital sheet music. By itself, MIDI is not sound. Hardware or software synthesizers create (synthesize) audio by interpreting the information given to them via the MIDI protocol.
-
-Some games only contain MIDI audio data. In the past this prevented audio for these games from working on platforms that did not support MIDI, or with soundcards that did not provide MIDI drivers.
-
-ScummVM can now convert MIDI data to sampled audio using MIDI device emulators.
-
-,,,,,,,,,,,,,,,,,,,,,,
-
-What is General MIDI?
-**********************
-
-General MIDI is a MIDI standard which is implemented by a large number of devices. While using MIDI as its protocol, it also specifies an instrument map and some other information that devices must implement.
-
-What is MT-32?
-*****************************
-
-The MT-32 is a `Roland sound module <https://en.wikipedia.org/wiki/Roland_MT-32>`_, although the term also commonly refers to a range of devices that are fully compatible with the MT-32. MT-32 devices also use MIDI as the communications protocol.
-
-
-.. _FS:
-
-General MIDI device emulation (FluidSynth)
-*****************************************************
-
-If the ScummVM you're using has libfluidsynth support it will be able to play MIDI music by using the FluidSynth emulator if set as the **Preferred device** or **Music device**, or if specified in the MIDI tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses General MIDI output automatically.
-
-You will have to specify a SoundFont in the MIDI tab for ScummVM to use FluidSynth. MIDI is like digital sheet music; it needs a library of sound samples known as a SoundFont to draw from in order to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
-
-Since the default output volume from FluidSynth can be fairly low, ScummVM will automatically set the gain to get a stronger signal. This can be further adjusted using the :ref:`MIDI gain <gain>` setting.
-
-The processor requirements for FluidSynth are quite high; a fast CPU is recommended.
-
-.. _MT-32:
-
-MT-32 device emulation
-**************************
-
-Some games which contain MIDI music data have tracks designed specifically for the Roland MT-32. ScummVM can emulate the MT-32 device, however you must provide the original MT-32 ROMs, taken from the MT-32 module, for the emulator to work. These files are:
-
-- MT32_PCM.ROM - IC21 (512KB)
-- MT32_CONTROL.ROM - IC26 (32KB) and IC27 (32KB)
-
-Place these ROMs in the game directory, in your extrapath, or in the directory where your ScummVM executable resides. ScummVM will also look for ``CM32L_PCM.ROM`` and ``CM32L_CONTROL.ROM`` - the ROMs from the CM-32L device - and will use these instead of the MT32 ROMs if they are available.
-
-ScummVM will use the MT-32 emulator if it is set as the **Preferred device** or **Music device**, or if it is specified in the MT-32 tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses MT-32 output automatically.
-
-You don't need to enable **True Roland MT-32** in the MT-32 tab, ScummVM does this automatically.
-
-.. tip::
-
- Some games work better with some MT-32 devices than others. As an example, Lure of the Temptress makes use of extra sound effects included with the CM-32L and won't sound right with an MT-32. Likewise, The Colonel's Bequest exploits some bugs in the early MT-32 modules, which means that later devices will play incorrect sound effects!
-
- `This Wikipedia article <https://en.wikipedia.org/wiki/List_of_MT-32-compatible_computer_games>`_ provides a comprehensive list of MT-32 compatible games, including which games work best with which device.
-
-The processor requirements for the MT-32 emulator are quite high; a fast CPU is strongly recommended.
-
-
-Native MIDI support
-**********************
-
-All MIDI ports will show up in the **Preferred device** or **Music device** dropdown selector. If you have selected a MIDI port, you will also need to specify what type of MIDI device this is with the options in the :ref:`MT-32 <mt32>` tab.
-
-- Enabling the **True Roland MT-32** option tells ScummVM that the MIDI device is an MT-32 (or fully compatible) device.
-- Enabling **Roland GS device** tells ScummVM to use an MT-32 soundtrack on a GS device. This is not supported by all games.
-- If no options are selected, this tells ScummVM that the device is General MIDI.
-
-Selecting an option that does not match the MIDI port selected may have unintended consequences; for example, if a game only has support for MT-32 and you have a General MIDI device selected as the **Preferred device** or **Music device**, ScummVM will convert the MT-32 MIDI data to GM-compatible MIDI data. While this may work fine for some games, it really depends on how the game has made use of the MT-32.
-
-.. note::
-
- Soundcards or audio interfaces do not necessarily have anything to do with MIDI; while some older soundcards (and a few modern ones) have their own hardware-based synthesizers, it is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
-
-
-Mac OSX
-^^^^^^^^^
-
-Mac has a built-in MIDI synthesizer; Apple DLS software synthesizer. It uses the Mac's built-in sounds (which are based on Roland GS).
-
-The `Apple Support page <https://support.apple.com/en-nz/guide/audio-midi-setup/ams875bae1e0/mac>`_ has further information about setting up MIDI devices on a Mac.
-
-Windows
-^^^^^^^^
-
-Windows has a generic built-in MIDI synthesizer - GS WaveTable Synth - also based on Roland's GS sounds.
-
-For an in-depth look at audio and MIDI device setup on a Windows computer, see this `very helpful article <http://donyaquick.com/midi-on-windows/>`_.
-
-Linux
-^^^^^^^
-
-MIDI device setup may vary depending on your Linux distro.
-
-If you do not have a hardware MIDI device, there are two options: FluidSynth and TiMidity. FluidSynth is recommended as TiMidity may have some lag, depending on the system.
-
-Here are a couple of helpful articles from the Ubuntu community documentation to get you started. These instructions should work for any Debian-based distro.
-
-`How to: Software Synthesizers <https://help.ubuntu.com/community/Midi/SoftwareSynthesisHowTo>`_
-
-`How to: Hardware synthesizer soundcard setup <https://help.ubuntu.com/community/Midi/HardwareSynthesisSetup?action=show&redirect=MidiHardwareSynthesisSetup>`_
-
-
-.. _adlib:
-
-AdLib
------------
-
-AdLib devices do not use MIDI. They instead have a chip that produces sound via FM synthesis. While some games do store their audio data using a MIDI-derived format, this is converted by the game to work with the AdLib chip. ScummVM emulates a few different AdLib configurations, and selects the most appropriate for the game:
-
-- The original AdLib and SoundBlaster card had one OPL2 chip.
-- The SoundBlaster Pro 1 had two OPL2 chips
-- The SoundBlaster Pro 2 and 16 had an OPL3 chip.
-
-The AdLib emulator setting offers MAME, DOSBox and Nuked emulation, with MAME being the least accurate and using the least CPU power, and Nuked being the most accurate and also using the most CPU power - DOSBox is somewhere in between.
-
-There is also the option to select the OPL2LPT and OPL3LPT devices, which are external hardware devices with a real OPL chip, connected via the parallel port of a computer.
-
-AdLib does not require a SoundFont or ROMs, so for many games it may be the easiest to configure. However, if an MT-32 or GS emulator or device is available, ScummVM will prioritize this over AdLib.
-
-Mixed AdLib/MIDI mode
-------------------------
-Some games contain sound effects that are exclusive to the AdLib soundtrack, or the AdLib soundtrack may provide better sound effects. For these games, you can combine MIDI music with AdLib sound effects by using the :ref:`mixed AdLib/MIDI mode <multi>`.
-
-.. note::
-
- Mixed AdLib/MIDI mode is not supported by all games.
-
-Digital Sound effects
-------------------------
-
-Some games have both sampled and synthesized sound effects. ScummVM will usually use the sampled sound effects, even if you select Adlib, MT-32 or GM as your audio device. Some games allow you to choose between sampled and synthesized sound effects by using the **Prefer digital sound effects** option in the Engine tab.
-
-.. _outputrate:
-
-Sample output rate
---------------------
-
-The output sample rate tells ScummVM how many sound samples to play per channel per second.
-
-Most of the sounds were originally sampled at either 22050Hz or 11025Hz, so using a higher sample rate in these cases will not improve the quality of the audio.
-
-For games that use CD audio, the sounds were probably sampled at 44100Hz, so that is a better sample rate to choose for these games.
-
-ScummVM generates the samples when using AdLib, FM-Towns, PC Speaker or IBM PCjr emulated sound. 22050Hz will usually be fine for these options, although for Beneath a Steel Sky 44100Hz is recommended.
-
-ScummVM has to resample all sounds to the selected output frequency. It is recommended to choose an output frequency that is a multiple of the original frequency. Choosing an in-between number may not be supported by your sound card.
-
-.. _buffer:
-
-Audio buffer size
----------------------
-
-There is no option to control audio buffer size through the GUI, but the default value can be overridden in the the :doc:`configuration file <../advanced_options/configuration_file>`. The default value is calculated based on output sampling frequency to keep audio latency below 45ms.
-
-Appropriate values are normally between 512 and 8192, but the value must be one of: 256, 512, 1024, 2048, 4096, 8192, 16384, or 32768.
-
-Smaller values yield faster response time, but can lead to stuttering if your CPU isn't able to catch up with audio sampling when using the sound emulators. Large buffer sizes may lead to minor audio delays (high latency).
-
diff --git a/doc/docportal/settings/cloud.rst b/doc/docportal/settings/cloud.rst
index 1cb2c10421..773d86ec83 100644
--- a/doc/docportal/settings/cloud.rst
+++ b/doc/docportal/settings/cloud.rst
@@ -2,9 +2,6 @@
Cloud
================
-Overview
-=============================
-
ScummVM currently supports Dropbox, OneDrive, Google Drive and Box. Connecting ScummVM to a cloud storage service provides an easy way of sharing game files and saved games between multiple devices.
@@ -39,35 +36,3 @@ Disconnect
Cloud functionality is not supported on all platforms.
-
-Further reading
-====================
-
-.. _howtocloud:
-
-How to connect ScummVM to cloud storage
-----------------------------------------
-
-From the Launcher, go to **Options > Cloud**.
-
-To connect your chosen cloud storage service to ScummVM, select it from the **Active storage** dropdown.
-
-.. figure:: ../images/cloud_and_lan/cloud_storage.png
-
-Click on the link shown at **1.**, and log in to your cloud storage account. Once you have logged in, a 6-digit code will be displayed.
-
-.. figure:: ../images/cloud_and_lan/cloud_code.png
-
-Copy the 6-digit code, click into the empty box next to the **Paste** button, and then click the **Paste** button.
-
-.. figure:: ../images/cloud_and_lan/cloud_connect.png
-
-Click **3. Connect**, then, once the next information loads, click on **Enable storage**.
-
-.. figure:: ../images/cloud_and_lan/cloud_enable.png
-
-Saved games automatically sync on launch, after saving, and on loading a saved game. You can also manually sync by using the **Sync now** button.
-
-To download the game files from your cloud ScummVM folder, click **Download game files**.
-
-To change to a different cloud account, or to disconnect your cloud account from ScummVM, click **Disconnect**.
\ No newline at end of file
diff --git a/doc/docportal/settings/control.rst b/doc/docportal/settings/control.rst
index a42ac76a0c..ba5791aa50 100644
--- a/doc/docportal/settings/control.rst
+++ b/doc/docportal/settings/control.rst
@@ -2,9 +2,6 @@
Control
=================
-Overview
-==========
-
The Control tab
----------------
diff --git a/doc/docportal/settings/engine.rst b/doc/docportal/settings/engine.rst
index 60e4da81d5..75137988fb 100644
--- a/doc/docportal/settings/engine.rst
+++ b/doc/docportal/settings/engine.rst
@@ -2,9 +2,6 @@
Engine
=====================
-Overview
-=========
-
Engine settings are those settings that are unique to a particular game or game engine. 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>`_.
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index 0b700a2371..4897fc1e68 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -2,9 +2,6 @@
Game
=============
-Overview
-==========
-
The Game tab
---------------
diff --git a/doc/docportal/settings/graphics.rst b/doc/docportal/settings/graphics.rst
index c4cbe61fc9..c1ca7ff82b 100644
--- a/doc/docportal/settings/graphics.rst
+++ b/doc/docportal/settings/graphics.rst
@@ -2,9 +2,6 @@
Graphics
===============
-Overview
-=========
-
The Graphics tab
-----------------
@@ -12,6 +9,7 @@ To change settings globally, go to **Options > Graphics**. To change settings fo
Use the graphics tab to change how games look when they are played.
+For a comprehensive look at how to use these settings, check out our :doc:`../guides/understand_graphics` guide.
.. figure:: ../images/settings/graphics.png
@@ -62,157 +60,4 @@ Filter graphics
*filtering*
-Further reading
-=================
-
-
-How do the graphics settings work together?
-----------------------------------------------
-
-The graphics mode, aspect ratio, and stretch mode settings work together to change the resolution and display of each game. The first setting applied to the image is the graphics mode, then the aspect ratio correction, and then the stretch mode setting. The only exception to this is OpenGL mode, which applies all settings in one pass to arrive at a final image.
-
-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 modes
----------------------------
-
-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.
-
-A 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.
-
-
-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.
-
-To switch between graphics modes on the go, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`1` to :kbd:`8`.
-
-OpenGL mode
-**************
-
-OpenGL graphics mode works a little differently to the other graphics modes. Instead of applying the aspect ratio and stretch mode settings one after the other (and after the graphics mode scaling has been applied), it does all the scaling and stretching in one step, going directly from the original game resolution to the final display resolution.
-
-Output is controlled by your window size (or screen resolution if in full screen) and the stretch mode selected, as well as the Filter graphics option.
-
-.. _aspect:
-
-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 - notice the moon is actually round now.
-
-To toggle aspect ratio on and off, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`a`.
-
-.. _stretch:
-
-Stretch modes
-----------------------
-
-
-There are five stretch modes:
-
-- Center - centers the image in the window.
-- Pixel-perfect scaling - scales the image to a multiple of the original game resolution as much as possible (for example, 2x, 3x, 4x and so on), and fills the remaining empty space with black borders.
-- Fit to window - fits the image to the window, but maintains the aspect ratio and 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 forced 4:3 aspect ratio.
-
-To switch between stretch modes on the go, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`s`.
-
-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
-
-Filter graphics
-----------------
-
-When enabled, ScummVM uses bilinear interpolation instead of nearest neighbor for the :ref:`aspect ratio <aspect>` and :ref:`stretch mode <stretch>`. It does not affect the graphics mode scaling unless OpenGL is selected, in which case it determines how the OpenGL scaling is done.
-To toggle between bilinear interpolation and nearest neighbor, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`f`.
\ No newline at end of file
diff --git a/doc/docportal/settings/how_to.rst b/doc/docportal/settings/how_to.rst
deleted file mode 100644
index c8fc8466f2..0000000000
--- a/doc/docportal/settings/how_to.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-=======================
-How to change settings
-=======================
-
-From the Launcher
-==================
-The settings are arranged by subject, on different tabs:
-
-:doc:`Game tab <game>` | :doc:`Engine tab <engine>` | :doc:`Graphics tab <graphics>` | :doc:`Control tab <control>` | :doc:`Keymaps tab <keymaps>` | :doc:`Audio tab <audio>` | :doc:`Volume tab <audio>` | :doc:`Midi tab <audio>` | :doc:`MT-32 tab <audio>` | :doc:`Paths tab <paths>` | :doc:`Misc tab <misc>` | :doc:`Cloud tab <cloud>` | :doc:`LAN tab <lan>` | :doc:`Accessibility tab <accessibility>`
-
-To change a setting globally, so that it affects all games, go to **Options** and select the tab containing the setting you would like to change.
-
-To change a setting for just one game, select the game, then go to **Edit Game** and select the tab containing the setting you would like to change. To make the game use the settings on that tab instead of the global settings, select **Override global settings**.
-
-Not all settings are available for all games; for example, where there is no MIDI soundtrack for a game, there will be no MIDI or MT-32 tabs.
-
-In the configuration file
-==========================
-
-See the :doc:`configuration file <../advanced_options/configuration_file>` page for more information on how to do this. Configuration keywords are listed in the Settings pages below the description of each setting, in italics.
\ No newline at end of file
diff --git a/doc/docportal/settings/keymaps.rst b/doc/docportal/settings/keymaps.rst
index 3f2988b8b0..348720bc14 100644
--- a/doc/docportal/settings/keymaps.rst
+++ b/doc/docportal/settings/keymaps.rst
@@ -2,11 +2,6 @@
Keymaps
===============
-Overview
-=========
-
-
-
The Keymaps tab
----------------
diff --git a/doc/docportal/settings/lan.rst b/doc/docportal/settings/lan.rst
index f43d4da5ec..a074d4c502 100644
--- a/doc/docportal/settings/lan.rst
+++ b/doc/docportal/settings/lan.rst
@@ -42,30 +42,3 @@ Server's port
*rootpath*
-,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
-
-Further reading
-=================
-
-How to use the web server
-----------------------------
-
-To access the server, type the URL shown into the address bar of any web browser:
-
-.. figure:: ../images/settings/LAN_server.png
-
- The server running in the browser.
-
-To download a file, click on the file you wish to download. A system download dialog box opens.
-
-To create a new directory, click **Create Directory**.
-
-.. figure:: ../images/settings/LAN_server_new.png
-
- Creating a new directory.
-
-To upload files, click **Upload Files** and select files from the system file explorer.
-
-.. figure:: ../images/settings/LAN_server_upload.png
-
- Uploading files.
Commit: 2aebeb795b6877364e57c2b27cdc0cbf6453b293
https://github.com/scummvm/scummvm/commit/2aebeb795b6877364e57c2b27cdc0cbf6453b293
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-02T05:17:49-05:00
Commit Message:
DOCS: renames files for consistency
- renames files and titles to conform with style guide
- fixes resulting broken links
Changed paths:
A doc/docportal/help/report_bugs.rst
A doc/docportal/using_scummvm/add_play_games.rst
A doc/docportal/using_scummvm/how_to_settings.rst
R doc/docportal/help/reporting_bugs.rst
R doc/docportal/using_scummvm/adding_games.rst
doc/docportal/getting_started/mac_linux_windows.rst
doc/docportal/help/faq.rst
doc/docportal/index.rst
doc/docportal/other_platforms/nintendo_switch.rst
doc/docportal/other_platforms/ps_vita.rst
doc/docportal/other_platforms/psp.rst
doc/docportal/using_scummvm/save_load_games.rst
doc/docportal/using_scummvm/the_launcher.rst
diff --git a/doc/docportal/getting_started/mac_linux_windows.rst b/doc/docportal/getting_started/mac_linux_windows.rst
index 8ef2f6fee9..6817cabc1b 100644
--- a/doc/docportal/getting_started/mac_linux_windows.rst
+++ b/doc/docportal/getting_started/mac_linux_windows.rst
@@ -95,4 +95,4 @@ Alternatively, you can download the Windows zipped file appropriate to your oper
Next steps...
-----------------------
-ScummVM is now installed and ready for you to :doc:`add your games <../using_scummvm/adding_games>`!
+ScummVM is now installed and ready for you to :doc:`add your games <../using_scummvm/add_play_games>`!
diff --git a/doc/docportal/help/faq.rst b/doc/docportal/help/faq.rst
index df3a79477a..bc99d9540d 100644
--- a/doc/docportal/help/faq.rst
+++ b/doc/docportal/help/faq.rst
@@ -44,7 +44,7 @@ Q: Where do I get the games?
Q: How do I install games from my floppy discs/CDs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** Generally speaking, you do not need to install the games. You only need to point ScummVM to the game files contained on these discs. See :doc:`../using_scummvm/adding_games`.
+**A:** Generally speaking, you do not need to install the games. You only need to point ScummVM to the game files contained on these discs. See :doc:`../using_scummvm/add_play_games`.
Q: Do I need the original game discs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -56,11 +56,11 @@ The best place to check is the `Compatibility page <https://www.scummvm.org/comp
Q: I have saved games from when I played the original game - can I use these with ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** This is only supported for a select number of games. See :ref:`originalsaves`.
+**A:** This is only supported for a select number of games. See the `wiki <wiki.scummvm.org>`_.
Q: How do I launch a game from the game folder?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** Games must be added to and started from :doc:`../using_scummvm/the_launcher`, they cannot be started directly from the game files. See :doc:`../using_scummvm/adding_games`.
+**A:** Games must be added to and started from :doc:`../using_scummvm/the_launcher`, they cannot be started directly from the game files. See :doc:`../using_scummvm/add_play_games`.
Troubleshooting
@@ -78,7 +78,7 @@ You can also find error messages in the ScummVM log file. See :ref:`logfile`.
Q: I think I found a bug. What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** See :doc:`reporting_bugs`.
+**A:** See :doc:`report_bugs`.
Games
********
@@ -88,11 +88,11 @@ Q: Help! My game won't run!
A: First, make sure your game is supported. See the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
-Check that you have all the required datafiles. See :doc:`../using_scummvm/adding_games`.
+Check that you have all the required datafiles. See :doc:`../using_scummvm/add_play_games`.
Ask on the forums or on Discord whether your game is supported on the platform you're trying to play it on. See :doc:`contact`.
-If you think the game should run, and it doesn't, report it as a bug. See :doc:`reporting_bugs`.
+If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
Q: I installed my game but ScummVM can't find it... What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/doc/docportal/help/reporting_bugs.rst b/doc/docportal/help/report_bugs.rst
similarity index 99%
rename from doc/docportal/help/reporting_bugs.rst
rename to doc/docportal/help/report_bugs.rst
index 17264c13d6..ade495b787 100644
--- a/doc/docportal/help/reporting_bugs.rst
+++ b/doc/docportal/help/report_bugs.rst
@@ -1,6 +1,6 @@
=======================
-Reporting a bug
+Report a bug
=======================
To report a bug, go to the ScummVM `Issue Tracker <https://bugs.scummvm.org/>`_ and log in with your GitHub account.
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index c64e744c72..f308bc4f0a 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -20,17 +20,16 @@
:hidden:
using_scummvm/the_launcher
- using_scummvm/adding_games
+ using_scummvm/add_play_games
using_scummvm/save_load_games
using_scummvm/keyboard_shortcuts
-
+ using_scummvm/how_to_settings
.. toctree::
:caption: Settings
:glob:
:hidden:
- settings/how_to
settings/game
settings/engine
settings/graphics
@@ -43,6 +42,13 @@
settings/lan
settings/accessibility
+.. toctree::
+ :caption: Guides
+ :glob:
+ :hidden:
+
+ guides/*
+
.. toctree::
:caption: Games
:glob:
@@ -65,7 +71,7 @@
:glob:
:hidden:
- help/reporting_bugs
+ help/report_bugs
help/contact
help/faq
@@ -104,10 +110,15 @@ How do I...?
So you have ScummVM installed, but now you need to know how to add and play some games! We have lots of useful information to help you out:
- **Understanding the interface**: :doc:`using_scummvm/the_launcher`
-- **Playing games**: :doc:`using_scummvm/adding_games` | :doc:`using_scummvm/save_load_games` | :doc:`using_scummvm/keyboard_shortcuts`
-- **Settings**: :doc:`settings/how_to`
+- **Playing games**: :doc:`using_scummvm/add_play_games` | :doc:`using_scummvm/save_load_games` | :doc:`using_scummvm/keyboard_shortcuts`
+- **Settings**: :doc:`using_scummvm/how_to_settings`
+
+Definitive guides
+=====================
+We do some deep dives into ScummVM features - from audio settings to our brand new Cloud functionality. Check out our Guides section!
+:doc:`guides/understand_audio` | :doc:`guides/understand_graphics`
The games!
============
@@ -134,7 +145,7 @@ ScummVM is still under development. While we do our best to make sure that as ma
If you are having problems with any aspect of ScummVM, take a look at our help section.
-:doc:`help/faq` | :doc:`How to report a bug <help/reporting_bugs>` | :doc:`help/contact`
+:doc:`help/faq` | :doc:`How to report a bug <help/report_bugs>` | :doc:`help/contact`
What's changed since I was last here?
======================================
diff --git a/doc/docportal/other_platforms/nintendo_switch.rst b/doc/docportal/other_platforms/nintendo_switch.rst
index 8e05ccbfaa..aa5fabc3e4 100644
--- a/doc/docportal/other_platforms/nintendo_switch.rst
+++ b/doc/docportal/other_platforms/nintendo_switch.rst
@@ -26,9 +26,9 @@ Transferring game files
Copy the folders containing game files into the ``/switch/scummvm/`` folder on the microSD card.
-ScummVM on the Nintendo switch supports :ref:`Cloud functionality <howtocloud>`.
+ScummVM on the Nintendo switch supports :doc:`Cloud functionality <../guides/connect_cloud>`.
-For more information on how to add and play games, see the :doc:`../using_scummvm/adding_games` page.
+For more information on how to add and play games, see the :doc:`../using_scummvm/add_play_games` page.
Controls
=================
diff --git a/doc/docportal/other_platforms/ps_vita.rst b/doc/docportal/other_platforms/ps_vita.rst
index 44c3aaf529..f5f1dc122c 100644
--- a/doc/docportal/other_platforms/ps_vita.rst
+++ b/doc/docportal/other_platforms/ps_vita.rst
@@ -35,9 +35,9 @@ If you're using SD2Vita:
Folders containing game files can be copied into any folder.
-ScummVM on the PS Vita supports :ref:`Cloud functionality <howtocloud>`.
+ScummVM on the PS Vita supports :doc:`Cloud functionality <../guides/connect_cloud>`.
-For more information on how to add and play games, see the :doc:`../using_scummvm/adding_games` page.
+For more information on how to add and play games, see the :doc:`../using_scummvm/add_play_games` page.
Controls
diff --git a/doc/docportal/other_platforms/psp.rst b/doc/docportal/other_platforms/psp.rst
index 7568794a3d..0542eabd03 100644
--- a/doc/docportal/other_platforms/psp.rst
+++ b/doc/docportal/other_platforms/psp.rst
@@ -30,7 +30,7 @@ Transferring game files
Transfer game files onto the PSP as described in the installation section above. They can be copied to any folder; location doesn't matter.
-For more information, see :doc:`../using_scummvm/adding_games`.
+For more information, see :doc:`../using_scummvm/add_play_games`.
Controls
=================
@@ -38,7 +38,7 @@ Controls
Default control mapping
*********************************
-These controls can also be manually configured in the :doc:`Keymaps tab<../settings/keymaps>`.
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
diff --git a/doc/docportal/using_scummvm/adding_games.rst b/doc/docportal/using_scummvm/add_play_games.rst
similarity index 95%
rename from doc/docportal/using_scummvm/adding_games.rst
rename to doc/docportal/using_scummvm/add_play_games.rst
index 26e285d2ed..7748801a95 100644
--- a/doc/docportal/using_scummvm/adding_games.rst
+++ b/doc/docportal/using_scummvm/add_play_games.rst
@@ -1,6 +1,6 @@
=================================
-Adding and playing games
+Add and play games
=================================
Accessing the game files
@@ -36,9 +36,9 @@ For games downloaded from digital distributors such as `GOG.com <gog.com>`__, `
.. tip::
- A great way to share game files and automatically back up and sync your saved game states between devices running ScummVM is to connect a Cloud storage service such as Dropbox or Google Drive. Detailed instructions for setting this up can be found on the :ref:`Cloud settings page <howtocloud>`.
+ A great way to share game files and automatically back up and sync your saved game states between devices running ScummVM is to connect a Cloud storage service such as Dropbox or Google Drive. Detailed instructions for setting this up can be found on the :doc:`../guides/connect_cloud` guide.
- For devices on the same local network, ScummVM can run a web server to allow the transfer of files. Detailed instructions can be found on the :doc:`LAN settings page <../settings/lan>`. This is a good option if you do not wish to connect a Cloud service, although it doesn't offer as much functionality.
+ For devices on the same local network, ScummVM can run a web server to allow the transfer of files. Detailed instructions can be found on the :doc:`../guides/local_webserver`. This is a good option if you do not wish to connect a Cloud service, although it doesn't offer as much functionality.
Multi-disc games
@@ -108,7 +108,7 @@ Adding the games to the Launcher
.. note::
- You may choose which file browser to use by setting the **Use Native file browser option in the :doc:`Misc <../settings/misc>` tab of the global settings.
+ You may choose which file browser to use by setting the **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings.
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**.
diff --git a/doc/docportal/using_scummvm/how_to_settings.rst b/doc/docportal/using_scummvm/how_to_settings.rst
new file mode 100644
index 0000000000..ae34ecde48
--- /dev/null
+++ b/doc/docportal/using_scummvm/how_to_settings.rst
@@ -0,0 +1,20 @@
+=======================
+How to change settings
+=======================
+
+From the Launcher
+==================
+The settings are arranged by subject, on different tabs:
+
+:doc:`Game tab <../settings/game>` | :doc:`Engine tab <../settings/engine>` | :doc:`Graphics tab <../settings/graphics>` | :doc:`Control tab <../settings/control>` | :doc:`Keymaps tab <../settings/keymaps>` | :doc:`Audio tab <../settings/audio>` | :doc:`Volume tab <../settings/audio>` | :doc:`Midi tab <../settings/audio>` | :doc:`MT-32 tab <../settings/audio>` | :doc:`Paths tab <../settings/paths>` | :doc:`Misc tab <../settings/misc>` | :doc:`Cloud tab <../settings/cloud>` | :doc:`LAN tab <../settings/lan>` | :doc:`Accessibility tab <../settings/accessibility>`
+
+To change a setting globally, so that it affects all games, go to **Options** and select the tab containing the setting you would like to change.
+
+To change a setting for just one game, select the game, then go to **Edit Game** and select the tab containing the setting you would like to change. To make the game use the settings on that tab instead of the global settings, select **Override global settings**.
+
+Not all settings are available for all games; for example, where there is no MIDI soundtrack for a game, there will be no MIDI or MT-32 tabs.
+
+In the configuration file
+==========================
+
+See the :doc:`configuration file <../advanced_options/configuration_file>` page for more information on how to do this. Configuration keywords are listed in the Settings pages below the description of each setting, in italics.
\ No newline at end of file
diff --git a/doc/docportal/using_scummvm/save_load_games.rst b/doc/docportal/using_scummvm/save_load_games.rst
index 2b2b096b56..62f566e371 100644
--- a/doc/docportal/using_scummvm/save_load_games.rst
+++ b/doc/docportal/using_scummvm/save_load_games.rst
@@ -1,9 +1,9 @@
===============================
-Saving and loading games
+Save and load games
===============================
-Saving a game
+Save a game
==============
@@ -39,7 +39,7 @@ ScummVM will automatically save the game every 5 minutes. The :ref:`autosave per
-Loading a game
+Load a game
===============
Saved games can be loaded directly from the Launcher without starting the game first, by selecting the **Load** button.
@@ -111,49 +111,3 @@ The save directory can be changed via the savepath setting in the :doc:`Paths ta
.. _originalsaves:
-Using saved games from original versions
--------------------------------------------
-
-This is only supported by a small selection of games.
-
-For the file names shown below, ``xxx`` is the saved game slot ScummVM uses, for example ``001`` for slot 1.
-
-- Blade Runner
-
- - Use the debugger console and command "save" to save the game to the original format, and command "load" to load a game from the original format.
- - Saved games between different languages are interchangeable
- - It is not recommended to convert saved games from the version with restored content. They may cause game breaking bugs.
-
-- Elvira 1 and 2
-
- - Edit the saved game file. Add an 8-letter saved game name to the start of the saved game file.
- - Elvira 1: rename the saved game to ``elvira1.xxx``.
- - Elvira 2: rename the saved game to ``elvira2-pc.xxx`` for the DOS version, and ``elvira2.xxx`` for other versions.
-
-- Myst
-
- - Rename the saved game to ``myst-xxx.mys``.
-
-- Riven
-
- - Rename the saved game to ``riven-xxx.rvn``.
- - Saved games from the CD and DVD edition are not interchangeable.
-
-- Simon the Sorcerer 1 and 2
-
- - For Simon 1: rename the saved game to ``simon1.xxx``
- - For SImon 2: rename the saved game to ``simon2.xxx``
-
-- Starship Titanic
-
- - Rename the saved game to ``titanic-win.xxx`` for the English version, and ``titanic-wind-de.xxx`` for the German version.
- - Saved games from different languages are not interchangeable.
-
-- The Feeble Files
-
- - Rename the saved game to ``feeble.xxx``
-
-- Waxworks
-
- - Edit the saved game file. Add an 8-letter saved game name to the start of the saved game file.
- - Rename the saved game to ``waxworks-pc.xxx`` for the DOS version, and ``waxworks.xxx`` for other versions.
diff --git a/doc/docportal/using_scummvm/the_launcher.rst b/doc/docportal/using_scummvm/the_launcher.rst
index cdbb0ece99..7c6ed14bb5 100755
--- a/doc/docportal/using_scummvm/the_launcher.rst
+++ b/doc/docportal/using_scummvm/the_launcher.rst
@@ -55,7 +55,7 @@ Edit Game
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:`../settings/how_to` page.
+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:`../using_scummvm/how_to_settings` page.
Remove Game
@@ -67,7 +67,7 @@ Removes the highlighted game from the list.
Options
-------
-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 information, see the :doc:`../settings/how_to` page
+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 information, see the :doc:`../using_scummvm/how_to_settings` page
About
-----
More information about the Scummvm-git-logs
mailing list