[Scummvm-git-logs] scummvm master -> 5dd6aae2db9369e5d94642ae7404fb4301c94d20
ccawley2011
ccawley2011 at gmail.com
Sun Mar 14 14:12:08 UTC 2021
This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
5dd6aae2db DOCS: Remove trailing whitespace
Commit: 5dd6aae2db9369e5d94642ae7404fb4301c94d20
https://github.com/scummvm/scummvm/commit/5dd6aae2db9369e5d94642ae7404fb4301c94d20
Author: Cameron Cawley (ccawley2011 at gmail.com)
Date: 2021-03-14T14:11:51Z
Commit Message:
DOCS: Remove trailing whitespace
Changed paths:
doc/docportal/_static/custom.css
doc/docportal/advanced_topics/command_line.rst
doc/docportal/advanced_topics/configuration_file.rst
doc/docportal/advanced_topics/understand_audio.rst
doc/docportal/advanced_topics/understand_graphics.rst
doc/docportal/contribute/platform_template.rst
doc/docportal/contribute/settings_template.rst
doc/docportal/help/contact.rst
doc/docportal/help/faq.rst
doc/docportal/help/report_bugs.rst
doc/docportal/index.rst
doc/docportal/other_platforms/amigaos_4.rst
doc/docportal/other_platforms/android.rst
doc/docportal/other_platforms/atari.rst
doc/docportal/other_platforms/ios.rst
doc/docportal/other_platforms/nintendo_3ds.rst
doc/docportal/other_platforms/nintendo_switch.rst
doc/docportal/other_platforms/playstation_3.rst
doc/docportal/other_platforms/playstation_portable.rst
doc/docportal/other_platforms/playstation_vita.rst
doc/docportal/other_platforms/risc_os.rst
doc/docportal/other_platforms/sega_dreamcast.rst
doc/docportal/release_notes/release_notes_2.2.0.rst
doc/docportal/settings/accessibility.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
doc/docportal/settings/misc.rst
doc/docportal/settings/paths.rst
doc/docportal/use_scummvm/LAN.rst
doc/docportal/use_scummvm/add_play_games.rst
doc/docportal/use_scummvm/connect_cloud.rst
doc/docportal/use_scummvm/game_files.rst
doc/docportal/use_scummvm/how_to_settings.rst
doc/docportal/use_scummvm/install_computer.rst
doc/docportal/use_scummvm/keyboard_shortcuts.rst
doc/docportal/use_scummvm/save_load_games.rst
doc/docportal/use_scummvm/the_launcher.rst
diff --git a/doc/docportal/_static/custom.css b/doc/docportal/_static/custom.css
index 3752c7d755..3f44d72375 100644
--- a/doc/docportal/_static/custom.css
+++ b/doc/docportal/_static/custom.css
@@ -3,12 +3,12 @@
@media (min-width: 385px){
.wy-table-responsive table td {
white-space: normal !important;
-
+
}
-
+
.wy-table-responsive {
overflow: visible !important;
-
+
}
.wy-table-responsive table {
diff --git a/doc/docportal/advanced_topics/command_line.rst b/doc/docportal/advanced_topics/command_line.rst
index 5f1481d2f5..696ad59e16 100755
--- a/doc/docportal/advanced_topics/command_line.rst
+++ b/doc/docportal/advanced_topics/command_line.rst
@@ -3,9 +3,9 @@
Command line interface
=======================
-Launching ScummVM from the command line lets you pass a number of options, some of which override the applicable global or game-specific settings. It also lets you launch straight into a game without going to the Launcher first.
+Launching ScummVM from the command line lets you pass a number of options, some of which override the applicable global or game-specific settings. It also lets you launch straight into a game without going to the Launcher first.
-Some options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without starting the Launcher or starting a game.
+Some options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without starting the Launcher or starting a game.
Usage
=========
@@ -14,42 +14,42 @@ Usage
scummvm [option] [game]
-To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any of the options documented below, and/or the path to the game you wish to start. If a game has already been added to the games list in the Launcher, you can pass the game id instead of the path to the game.
+To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any of the options documented below, and/or the path to the game you wish to start. If a game has already been added to the games list in the Launcher, you can pass the game id instead of the path to the game.
.. tabbed:: Windows
-
+
.. panels::
:column: col-lg-12
- The following examples assume that the path to ScummVM is ``C:\Program Files\ScummVM\scummvm.exe``.
+ The following examples assume that the path to ScummVM is ``C:\Program Files\ScummVM\scummvm.exe``.
^^^^
To run Monkey Island, fullscreen (``-f``):
- .. code-block::
+ .. code-block::
C:\Program Files\ScummVM\scummvm.exe -f monkey
-
-
- To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
+
+
+ To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
.. code-block::
C:\Program Files\ScummVM\scummvm.exe -f -n -pD:``resource``ft
.. tabbed:: macOS
-
+
.. panels::
:column: col-lg-12
- The following examples assume the path to the ScummVM app is ``Applications/ScummVM.app``.
-
- If you are unsure of the path to the app, drag the ScummVM app icon into the Terminal window. This prints the path to the ScummVM app.
-
- To run ScummVM from the command line, add ``/Contents/MacOS/scummvm`` to that path.
+ The following examples assume the path to the ScummVM app is ``Applications/ScummVM.app``.
+
+ If you are unsure of the path to the app, drag the ScummVM app icon into the Terminal window. This prints the path to the ScummVM app.
+
+ To run ScummVM from the command line, add ``/Contents/MacOS/scummvm`` to that path.
^^^^
@@ -57,29 +57,29 @@ To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any o
.. code::
- /Applications/ScummVM.app/Contents/MacOS/scummvm -f monkey
+ /Applications/ScummVM.app/Contents/MacOS/scummvm -f monkey
- To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
+ To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
.. code::
/Applications/ScummVM.app/Contents/MacOS/scummvm -f -n -p/cdrom/resource/ft
.. tabbed:: Linux
-
+
.. panels::
:column: col-lg-12
The following examples assume the path to ScummVM is ``/usr/games/scummvm``.
-
+
^^^^^^
To run Monkey Island, fullscreen (``-f``):
-
+
.. code::
- /usr/games/scummvm -f monkey
+ /usr/games/scummvm -f monkey
To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
@@ -88,27 +88,27 @@ To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any o
/usr/games/scummvm -f -n -p/cdrom/resource/ft
- .. tip::
+ .. tip::
If ScummVM is on PATH, there is no need to enter the full path to ScummVM. Similarly, if a game is already added to the Launcher, there is no need to specify the path to the game.
-
+
Options
========
-The meaning of most options can be inverted by prefixing them with ``no-``. For example, ``--no-aspect-ratio`` will turn aspect ratio correction off. This does not apply to short options.
+The meaning of most options can be inverted by prefixing them with ``no-``. For example, ``--no-aspect-ratio`` will turn aspect ratio correction off. This does not apply to short options.
Option parameters are shown below in capitals, and need to be replaced with real values.
-Short options are listed where they are available.
+Short options are listed where they are available.
-.. csv-table::
+.. csv-table::
:widths: 35 10 55
:header-rows: 1
-
+
Option,Short,Description
- ``--add``,``-a``,"Adds all games from current or specified directory.
-
+ ``--add``,``-a``,"Adds all games from current or specified directory.
+
If ``--game=NAME`` is passed, only the game with id NAME is added. See also ``--detect``. Use ``--path=PATH`` before ``-a`` or ``--add`` to specify a directory."
``--alt-intro``, ,":ref:`Uses alternative intro for CD versions <altintro>`"
``--aspect-ratio``,,":ref:`Enables aspect ratio correction <ratio>`"
@@ -116,7 +116,7 @@ Short options are listed where they are available.
``--boot-param=NUM``,``-b``,"Pass number to the boot script (`boot param <https://wiki.scummvm.org/index.php/Boot_Params>`_)."
``--cdrom=DRIVE``,,"Sets the CD drive to play CD audio from. This can be a drive, path, or numeric index (default: 0)"
``--config=FILE``,``-c``,"Uses alternate configuration file"
- ``--console``,,"Enables the console window (default: enabled). Win32 and Symbian32 only."
+ ``--console``,,"Enables the console window (default: enabled). Win32 and Symbian32 only."
``--copy-protection``,,"Enables copy protection"
``--debug-channels-only``,,"Shows only the specified debug channels"
``--debugflags=FLAGS``,,"Enables engine specific debug flags"
@@ -124,7 +124,7 @@ Short options are listed where they are available.
``--demo-mode``,,"Starts demo mode of Maniac Mansion or The 7th Guest"
``--detect``,,"Displays a list of games with their game id from the current or specified directory. This does not add the game to the games list. Use ``--path=PATH`` before ``--detect`` to specify a directory."
``--dimuse-tempo=NUM``,,"Sets internal Digital iMuse tempo (10 - 100) per second (default: 10)"
- ``--engine-speed=NUM``,,"Sets frames per second limit (0 - 100) for Grim Fandango or Escape from Monkey Island (default: 60)."
+ ``--engine-speed=NUM``,,"Sets frames per second limit (0 - 100) for Grim Fandango or Escape from Monkey Island (default: 60)."
``--dump-scripts``,``-u``,"Enables script dumping if a directory called 'dumps' exists in the current directory"
``--enable-gs``,,":ref:`Enables Roland GS mode for MIDI playback <gs>`"
``--extrapath=PATH``,,":ref:`Extra path to additional game data <extra>`"
@@ -140,7 +140,7 @@ Short options are listed where they are available.
``--list-saves --game=TARGET``,,"Displays a list of saved games for the game (TARGET) specified"
``--list-targets``,``-t``,"Displays list of configured targets and exits"
``--list-themes``,,"Displays list of all usable GUI themes"
- ``--logfile=PATH``,-l,"Uses alternate path for log file (SDL backend only)."
+ ``--logfile=PATH``,-l,"Uses alternate path for log file (SDL backend only)."
``--midi-gain=NUM``,,":ref:`Sets the gain for MIDI playback <gain>`. 0-1000 (default: 100). Only supported by some MIDI drivers"
``--multi-midi``,,":ref:`Enables combination AdLib and native MIDI <multi>`"
``--music-driver=MODE``,``-e``,":ref:`Selects preferred music device <device>`"
@@ -148,8 +148,8 @@ Short options are listed where they are available.
``--native-mt32``,,":ref:`True Roland MT-32 (disables GM emulation) <mt32>`"
``--no-filtering``,,"Forces unfiltered graphics mode"
``--no-fullscreen``,``-F``,"Forces windowed mode"
- ``--opl-driver=DRIVER``,,":ref:`Selects AdLib (OPL) emulator <opl>`"
- ``--output-rate=RATE``,,"Selects output sample rate in Hz"
+ ``--opl-driver=DRIVER``,,":ref:`Selects AdLib (OPL) emulator <opl>`"
+ ``--output-rate=RATE``,,"Selects output sample rate in Hz"
``--path=PATH``,``-p``,"Sets path to where the game is installed"
``--platform=STRING``,,":ref:`Specifes platform of game <platform>`. Allowed values: 2gs, 3do, acorn, amiga, atari, c64, fmtowns, nes, mac, pc pc98, pce, segacd, wii, windows."
``--recursive``,,"In combination with ``--add or ``--detect`` recurses down all subdirectories"
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index 28b0c7e756..b7a8466da8 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -3,31 +3,31 @@
Configuration file
=======================
-The configuration file provides a way to edit both global and game-specific settings. It is a text file containing configuration keys and parameters.
+The configuration file provides a way to edit both global and game-specific settings. It is a text file containing configuration keys and parameters.
-Settings are also accessible directly from the Launcher. See :doc:`../use_scummvm/how_to_settings`.
+Settings are also accessible directly from the Launcher. See :doc:`../use_scummvm/how_to_settings`.
Location
==========
-The configuration file saves to different default locations, depending on the platform.
+The configuration file saves to different default locations, depending on the platform.
+
-
.. tabbed:: Windows
.. panels::
:column: col-lg-12 mb-2
95/98/ME
- ^^^^^^^^^^
-
+ ^^^^^^^^^^
+
``C:\WINDOWS\scummvm.ini``
-
-
+
+
---
:column: col-lg-12 mb-2
- Windows NT4
+ Windows NT4
^^^^^^^^^^^^
``C:\WINDOWS\Profiles\username\Application Data\ScummVM\scummvm.ini``
@@ -56,11 +56,11 @@ The configuration file saves to different default locations, depending on the pl
.. note::
If an earlier version of ScummVM was installed on your system, the configuration file remains in the previous default location of ``~/.scummvmrc``.
-
+
.. tip::
-
+
To see the Library folder, press :kbd:`Option` when clicking **Go** in the Finder menu.
-
+
.. tabbed:: Linux
@@ -68,20 +68,20 @@ The configuration file saves to different default locations, depending on the pl
:column: col-lg-12 mb-2
ScummVM follows the XDG Base Directory Specification, so by default the configuration file is found at ``~/.config/scummvm/scummvm.ini``, but its location might vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
-
+
If ScummVM was installed using Snap, the configuration file is found at ``~/snap/scummvm/current/.config/scummvm/scummvm.ini``
.. note::
-
+
``.config`` is a hidden directory. To view it use ``ls -a`` on the command line.
-
+
Using the configuration file
==================================
-Global settings are listed under the ``[scummvm]`` heading. Global :doc:`keymaps settings <../settings/keymaps>` 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 keys to change settings.
+Global settings are listed under the ``[scummvm]`` heading. Global :doc:`keymaps settings <../settings/keymaps>` 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 keys to change settings.
Example of a configuration file
@@ -128,11 +128,11 @@ Example of a configuration file
Configuration keys
=====================
-There are many recognized configuration keys. In the table below, each key is either linked to an explanatory description in the Settings pages, or has further information in the **Decription/Options** column.
+There are many recognized configuration keys. In the table below, each key is either linked to an explanatory description in the Settings pages, or has further information in the **Decription/Options** column.
-.. csv-table::
+.. csv-table::
:widths: 37 13 25 25
- :header-rows: 1
+ :header-rows: 1
Key,Type,Default,Description/Options
alsa_port,integer,,Specifies which ALSA port ScummVM uses when using the ALSA music driver (Linux).
@@ -142,15 +142,15 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`aspect_ratio <ratio>`",boolean,false,
":ref:`audio_buffer_size <buffer>`",integer,"Calculated based on output sampling frequency to keep audio latency below 45ms.","Overrides the size of the audio buffer. Allowed values:
- - 256
- - 512
- - 1024
- - 2048
- - 4096
- - 8192
- - 16384
+ - 256
+ - 512
+ - 1024
+ - 2048
+ - 4096
+ - 8192
+ - 16384
- 32768"
- ":ref:`autosave_period <autosave>`", integer, 300,
+ ":ref:`autosave_period <autosave>`", integer, 300,
auto_savenames,boolean,false, Automatically generates names for saved games
":ref:`bilinear_filtering <bilinear>`",boolean,false,
`boot_param <https://wiki.scummvm.org/index.php/Boot_Params>`_,integer,none,
@@ -159,13 +159,13 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`color <color>`",boolean,,
":ref:`commandpromptwindow <cmd>`",boolean,false,
confirm_exit,boolean,false, ScummVM requests confirmation before quitting (SDL backend only)
- console,boolean,true, Enables the console window for Win32/Symbian32.
- controller_map_db,string,"``gamecontrollerdb.txt`` is loaded from the specified extrapath", "Specifies the custom controller mapping file to load to complete the default database (SDL backend only)."
+ console,boolean,true, Enables the console window for Win32/Symbian32.
+ controller_map_db,string,"``gamecontrollerdb.txt`` is loaded from the specified extrapath", "Specifies the custom controller mapping file to load to complete the default database (SDL backend only)."
copy_protection,boolean,false, Enables copy protection
demo_mode,boolean,false, Starts demo mode of Maniac Mansion or the 7th Guest
":ref:`description <description>`",string,,
desired_screen_aspect_ratio,string,auto,
- dimuse_tempo,integer,10,"Sets internal Digital iMuse tempo per second; 0 - 100"
+ dimuse_tempo,integer,10,"Sets internal Digital iMuse tempo per second; 0 - 100"
":ref:`disable_dithering <dither>`",boolean,false,
":ref:`disable_stamina_drain <stamina>`",boolean,false,
":ref:`DurableArmor <durable>`",boolean,false,
@@ -178,10 +178,10 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`enable_high_resolution_graphics <hires>`",boolean,true,
":ref:`enable_hq_video <hq>`",boolean,true,
":ref:`enable_larryscale <larry>`",boolean,true,
- ":ref:`enable_reporter <reporter>`",boolean,false,RISC OS only.
+ ":ref:`enable_reporter <reporter>`",boolean,false,RISC OS only.
":ref:`enable_video_upscale <upscale>`",boolean,true,
":ref:`enable_tts <ttsenabled>`",boolean,false,
- enable_unsupported_game_warning,boolean,true, Shows a warning when adding a game that is unsupported.
+ enable_unsupported_game_warning,boolean,true, Shows a warning when adding a game that is unsupported.
extra,string, ,"Shows additional information about a game, such as version"
":ref:`extrapath <extra>`",string,None,
":ref:`fade_style <fade>`",boolean,true,
@@ -192,7 +192,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`fluidsynth_chorus_level <chlevel>`",integer,100,"- 0 - 100"
":ref:`fluidsynth_chorus_nr <chnr>`",integer,3,"- 0 - 99"
":ref:`fluidsynth_chorus_speed <chspeed>`",integer,30,"- 10 - 500"
- ":ref:`fluidsynth_chorus_waveform <chwave>`",string,Sine,"
+ ":ref:`fluidsynth_chorus_waveform <chwave>`",string,Sine,"
- sine
- triangle"
":ref:`fluidsynth_misc_interpolation <interp>`",string,4th,"
@@ -227,14 +227,14 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`gm_device <gm>`",string,null,"
- auto
- alsa
- - seq
+ - seq
- sndio
- - fluidsynth
+ - fluidsynth
- timidity"
":ref:`GraphicsDithering <gdither>`",boolean,true,
":ref:`gui_browser_native <guibrowser>`", boolean, true
gui_browser_show_hidden,boolean,false, Shows hidden files/folders in the ScummVM file browser.
- gui_list_max_scan_entries,integer,-1, "Specifies the threshold for scanning directories in the Launcher. If the number of game entires exceeds the specified number, then scanning is skipped."
+ gui_list_max_scan_entries,integer,-1, "Specifies the threshold for scanning directories in the Launcher. If the number of game entires exceeds the specified number, then scanning is skipped."
gui_saveload_chooser,string,grid,"- list
- grid"
gui_saveload_last_pos,string,0,
@@ -244,11 +244,11 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`herculesfont <herc>`",boolean,false,
":ref:`hpbargraphs <hp>`",boolean,true,
":ref:`hypercheat <hyper>`",boolean,false,
- iconpath,string,, "Specifies the path to icons to use as overlay for the ScummVM icon in the Windows taskbar or the macOS Dock when running a game. The icon files should be named after the :ref:`gameid <gameid>`, and be an ICO file on Windows, or a PNG file on macOS."
+ iconpath,string,, "Specifies the path to icons to use as overlay for the ScummVM icon in the Windows taskbar or the macOS Dock when running a game. The icon files should be named after the :ref:`gameid <gameid>`, and be an ICO file on Windows, or a PNG file on macOS."
":ref:`improved <improved>`",boolean,true,
":ref:`InvObjectsAnimated <objanimated>`",boolean,true,
":ref:`joystick_deadzone <deadzone>`",integer, 3
- joystick_num,integer,0,Enables joystick input and selects which joystick to use. The default is the first joystick.
+ joystick_num,integer,0,Enables joystick input and selects which joystick to use. The default is the first joystick.
":ref:`kbdmouse_speed <mousespeed>`", integer, 10
":ref:`keymap_engine-default_DOWN <down>`",string,JOY_DOWN
":ref:`keymap_engine-default_LCLK <LCLK>`",string,MOUSE_LEFT JOY_A
@@ -262,38 +262,38 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`keymap_engine-default_RIGHT <right>`",string,JOY_RIGHT
":ref:`keymap_engine-default_SKIP <skip>`",string,ESCAPE JOY
":ref:`keymap_engine-default_SKLI <SKLI>`",string,PERIOD JOY_X
- ":ref:`keymap_engine-default_UP <up>`",string,JOY_UP
- ":ref:`keymap_global_DEBUGGER <debug>`",string,C+A+d
+ ":ref:`keymap_engine-default_UP <up>`",string,JOY_UP
+ ":ref:`keymap_global_DEBUGGER <debug>`",string,C+A+d
":ref:`keymap_global_MENU <gmm>`",string,C+F5 JOY_START,
- ":ref:`keymap_global_MUTE <mute>`",string,C+u,
- ":ref:`keymap_global_QUIT <globalquit>`",string,C+q,
- ":ref:`keymap_global_VMOUSEDOWN <vmousedown>`",string,JOY_LEFT_STICK_Y+,
- ":ref:`keymap_global_VMOUSELEFT <vmouseleft>`",string,JOY_LEFT_STICK_X-,
- ":ref:`keymap_global_VMOUSERIGHT <vmouseright>`",string,JOY_LEFT_STICK_X+,
- ":ref:`keymap_global_VMOUSESLOW <vmouseslow>`",string,JOY_RIGHT_SHOULDER,
- ":ref:`keymap_global_VMOUSEUP <vmouseup>`",string,JOY_LEFT_STICK_Y-,
- ":ref:`keymap_gui_CLOS <close>`",string,ESCAPE JOY_Y,
- ":ref:`keymap_gui_DOWN <guidown>`",string,JOY_DOWN,
- ":ref:`keymap_gui_INTRCT <interact>`",string,JOY_A,
- ":ref:`keymap_gui_LEFT <guileft>`",string,
- ":ref:`keymap_gui_RIGHT <guiright>`",string,JOY_RIGHT,
- ":ref:`keymap_gui_UP <guiup>`",string,JOY_UP,
- ":ref:`keymap_sdl-graphics_ASPT <ASPT>`",string,C+A+a,
+ ":ref:`keymap_global_MUTE <mute>`",string,C+u,
+ ":ref:`keymap_global_QUIT <globalquit>`",string,C+q,
+ ":ref:`keymap_global_VMOUSEDOWN <vmousedown>`",string,JOY_LEFT_STICK_Y+,
+ ":ref:`keymap_global_VMOUSELEFT <vmouseleft>`",string,JOY_LEFT_STICK_X-,
+ ":ref:`keymap_global_VMOUSERIGHT <vmouseright>`",string,JOY_LEFT_STICK_X+,
+ ":ref:`keymap_global_VMOUSESLOW <vmouseslow>`",string,JOY_RIGHT_SHOULDER,
+ ":ref:`keymap_global_VMOUSEUP <vmouseup>`",string,JOY_LEFT_STICK_Y-,
+ ":ref:`keymap_gui_CLOS <close>`",string,ESCAPE JOY_Y,
+ ":ref:`keymap_gui_DOWN <guidown>`",string,JOY_DOWN,
+ ":ref:`keymap_gui_INTRCT <interact>`",string,JOY_A,
+ ":ref:`keymap_gui_LEFT <guileft>`",string,
+ ":ref:`keymap_gui_RIGHT <guiright>`",string,JOY_RIGHT,
+ ":ref:`keymap_gui_UP <guiup>`",string,JOY_UP,
+ ":ref:`keymap_sdl-graphics_ASPT <ASPT>`",string,C+A+a,
":ref:`keymap_sdl-graphics_CAPT <CAPT>`",string,C+m,
":ref:`keymap_sdl-graphics_FILT <FILT>`",string,C+A+f
- ":ref:`keymap_sdl-graphics_FLT1 <FLT1>`",string,C+A+1
+ ":ref:`keymap_sdl-graphics_FLT1 <FLT1>`",string,C+A+1
":ref:`keymap_sdl-graphics_FLT2 <FLT2>`",string,C+A+2
- ":ref:`keymap_sdl-graphics_FLT3 <FLT3>`",string,C+A+3
- ":ref:`keymap_sdl-graphics_FLT4 <FLT4>`",string,C+A+4
- ":ref:`keymap_sdl-graphics_FLT5 <FLT5>`",string,C+A+5
+ ":ref:`keymap_sdl-graphics_FLT3 <FLT3>`",string,C+A+3
+ ":ref:`keymap_sdl-graphics_FLT4 <FLT4>`",string,C+A+4
+ ":ref:`keymap_sdl-graphics_FLT5 <FLT5>`",string,C+A+5
":ref:`keymap_sdl-graphics_FLT6 <FLT6>`",string, C+A+6
":ref:`keymap_sdl-graphics_FLT7 <FLT7>`",string,C+A+7
":ref:`keymap_sdl-graphics_FLT8 <FLT8>`",string,C+A+8
":ref:`keymap_sdl-graphics_FULS <FULS>`",string,A+RETURN
- ":ref:`keymap_sdl-graphics_SCL- <SCL>`",string,C+A+MINUS
- ":ref:`keymap_sdl-graphics_SCL+ <SCL>`",string,C+A+PLUS
- ":ref:`keymap_sdl-graphics_SCRS <SCRS>`",string,A+s
- ":ref:`keymap_sdl-graphics_STCH <STCH>`",string,C+A+s
+ ":ref:`keymap_sdl-graphics_SCL- <SCL>`",string,C+A+MINUS
+ ":ref:`keymap_sdl-graphics_SCL+ <SCL>`",string,C+A+PLUS
+ ":ref:`keymap_sdl-graphics_SCRS <SCRS>`",string,A+s
+ ":ref:`keymap_sdl-graphics_STCH <STCH>`",string,C+A+s
":ref:`language <lang>`",string,,
":ref:`local_server_port <serverport>`",integer,12345,
":ref:`midi_gain <gain>`",integer,,"- 0 - 1000"
@@ -304,12 +304,12 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`mt32_device <mt32>`",string,auto,"
- auto
- alsa
- - seq
+ - seq
- fluidsynth
- mt32
- timidity "
":ref:`multi_midi <multi>`",boolean,,
- ":ref:`music_driver [scummvm] <device>`",string,auto,"
+ ":ref:`music_driver [scummvm] <device>`",string,auto,"
- null
- auto
@@ -322,10 +322,10 @@ There are many recognized configuration keys. In the table below, each key is ei
- windows (Windows)
- - fluidsynth
+ - fluidsynth
- mt32
- adlib
- - pcspk
+ - pcspk
- pcjr
- cms
- timidity
@@ -338,7 +338,7 @@ There are many recognized configuration keys. In the table below, each key is ei
- pc98
- segacd
"
- music_mute,boolean,false, Mutes the game music.
+ music_mute,boolean,false, Mutes the game music.
":ref:`music_volume <music>`",integer,192,"- 0-256 "
":ref:`mute <mute>`",boolean,false,
":ref:`native_fb01 <fb01>`",boolean,false,
@@ -360,24 +360,24 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`output_rate <outputrate>`",integer,,"
Sensible values are:
- - 11025
+ - 11025
- 22050
- 44100"
":ref:`platform <platform>`",string,,
":ref:`portaits_on <portraits>`",boolean,true,
":ref:`prefer_digitalsfx <dsfx>`",boolean,true,
- ":ref:`render_mode <render>`",string,default,"
- - hercGreen
+ ":ref:`render_mode <render>`",string,default,"
+ - hercGreen
- hercAmber
- cga
- ega
- vga
- - amiga
- - fmtowns
+ - amiga
+ - fmtowns
- pc9821
- - pc9801
- - 2gs
- - atari
+ - pc9801
+ - 2gs
+ - atari
- macintosh "
":ref:`rootpath <rootpath>`",string,,
":ref:`savepath <savepath>`",string,,
@@ -385,7 +385,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`scalemakingofvideos <scale>`",boolean,false,
":ref:`scanlines <scan>`",boolean,false,
screenshotpath,string,,Specifies where screenshots are saved
- sfx_mute,boolean,false, Mutes the game sound effects.
+ sfx_mute,boolean,false, Mutes the game sound effects.
":ref:`sfx_volume <sfx>`",integer,192,
":ref:`shorty <shorty>`",boolean,false,
":ref:`show_fps <fps>`",boolean,false,
@@ -398,16 +398,16 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`speech_mute <speechmute>`",boolean,false,
":ref:`speech_volume <speechvol>`",integer,192,
":ref:`stretch_mode <stretchmode>`",string,,"
- - center
- - pixel-perfect
- - fit
- - stretch
+ - center
+ - pixel-perfect
+ - fit
+ - stretch
- fit_force_aspect "
":ref:`studio_audience <studio>`",boolean,true,
":ref:`subtitles <speechmute>`",boolean,false,
":ref:`talkspeed <talkspeed>`",integer,60,"- 0 - 255 "
tempo,integer,100,"Sets the music tempo, in percent, for SCUMM games.
-
+
- 50-200"
":ref:`TextWindowAnimated <windowanimated>`",boolean,true,
":ref:`themepath <themepath>`",string,none,
@@ -416,24 +416,24 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`tts_enabled <ttsenabled>`",boolean,false,
":ref:`tts_narrator <ttsnarrator>`",boolean,false,
use_cdaudio,boolean,true, "If true, ScummVM uses audio from the game CD."
- versioninfo,string,,Shows the ScummVM version that created the configuration file.
+ versioninfo,string,,Shows the ScummVM version that created the configuration file.
":ref:`window_style <style>`",boolean,true,
":ref:`windows_cursors <wincursors>`",boolean,false,
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/docportal/advanced_topics/understand_audio.rst b/doc/docportal/advanced_topics/understand_audio.rst
index c890622f04..ed8dfd375c 100644
--- a/doc/docportal/advanced_topics/understand_audio.rst
+++ b/doc/docportal/advanced_topics/understand_audio.rst
@@ -2,68 +2,68 @@
Understanding the audio settings
======================================================
-This guide expands on the information contained on the :doc:`audio settings <../settings/audio>` page.
+This guide expands on the information contained on the :doc:`audio settings <../settings/audio>` page.
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.
+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.
+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.
-Not all settings are applicable to all games. For example, changing the General MIDI settings will not have any effect on a game that only has CD audio.
+Not all settings are applicable to all games. For example, changing the General MIDI settings will not have any effect on a game that only has CD audio.
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>`_.
+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.
+- 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.
+- 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.
+- 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 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.
+- 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.
+- 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.
+- 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 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?
+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 by the MIDI protocol.
+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 by the MIDI protocol.
-While some older soundcards (and a few modern ones) have their own hardware-based synthesizers, this is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
+While some older soundcards (and a few modern ones) have their own hardware-based synthesizers, this is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
-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.
+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?
@@ -77,11 +77,11 @@ General MIDI is a MIDI standard which is implemented by a large number of device
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.
+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 to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
+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 to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
-The default output volume from FluidSynth can be fairly low, so ScummVM automatically sets the gain to get a stronger signal. Use the :ref:`MIDI gain <gain>` setting to further adjust this.
+The default output volume from FluidSynth can be fairly low, so ScummVM automatically sets the gain to get a stronger signal. Use the :ref:`MIDI gain <gain>` setting to further adjust this.
The processor requirements for FluidSynth are quite high; a fast CPU is recommended.
@@ -101,21 +101,21 @@ Some games which contain MIDI music data have tracks designed specifically for t
- 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 also looks for ``CM32L_PCM.ROM`` and ``CM32L_CONTROL.ROM``—the ROMs from the CM-32L device—and uses these instead of the MT32 ROMs if they are available.
+Place these ROMs in the game directory, in your extrapath, or in the directory where your ScummVM executable resides. ScummVM also looks for ``CM32L_PCM.ROM`` and ``CM32L_CONTROL.ROM``—the ROMs from the CM-32L device—and uses these instead of the MT32 ROMs if they are available.
.. note::
- The MT-32 ROMs are copyrighted, and are not provided by ScummVM. These must be taken from your own MT-32 module.
+ The MT-32 ROMs are copyrighted, and are not provided by ScummVM. These must be taken from your own MT-32 module.
-ScummVM uses 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.
+ScummVM uses 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.
+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 uses 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.
+ 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 uses 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.
@@ -123,38 +123,38 @@ The processor requirements for the MT-32 emulator are quite high; a fast CPU is
Built-in MIDI support
--------------------------
-All MIDI ports show up in the **Preferred device** or **Music device** dropdown selector. If you have selected a MIDI port, you need to specify what type of MIDI device this is with the options in the :ref:`MT-32 <mt32>` tab.
+All MIDI ports show up in the **Preferred device** or **Music device** dropdown selector. If you have selected a MIDI port, you need to specify what type of MIDI device this is with the options in the :ref:`MT-32 <mt32>` tab.
-- Enable **True Roland MT-32** to tell ScummVM that the MIDI device is an MT-32 (or fully compatible) device.
+- Enable **True Roland MT-32** to tell ScummVM that the MIDI device is an MT-32 (or fully compatible) device.
- Enable **Roland GS device** to tell ScummVM to use an MT-32 soundtrack on a GS device. This is not supported by all games.
-- If no options are selected, ScummVM treats the device on the port as a General MIDI device.
+- If no options are selected, ScummVM treats the device on the port as a General MIDI device.
-If you select an option that does not match the actual device, this might 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 might work fine for some games, it really depends on how the game has made use of the MT-32.
+If you select an option that does not match the actual device, this might 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 might work fine for some games, it really depends on how the game has made use of the MT-32.
-macOS/Mac OSX
+macOS/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.
+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.
+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 might vary depending on your Linux distro.
+MIDI device setup might 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 might have some lag, depending on the system.
+If you do not have a hardware MIDI device, there are two options: FluidSynth and TiMidity. FluidSynth is recommended as TiMidity might have some lag, depending on the system.
-Here are a couple of helpful articles from the Ubuntu community documentation to get you started.
+Here are a couple of helpful articles from the Ubuntu community documentation to get you started.
`How to: Software Synthesizers <https://help.ubuntu.com/community/Midi/SoftwareSynthesisHowTo>`_
@@ -164,20 +164,20 @@ Here are a couple of helpful articles from the Ubuntu community documentation to
.. _adlib:
-What is AdLib?
+What is AdLib?
================
AdLib devices do not use MIDI. They instead have a chip that produces sound through 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 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 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.
+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 through the parallel port of a computer.
+There is also the option to select the OPL2LPT and OPL3LPT devices, which are external hardware devices with a real OPL chip, connected through the parallel port of a computer.
-AdLib does not require a SoundFont or ROMs, so for many games it might be the easiest to configure. However, if an MT-32 or GS emulator or device is available, ScummVM will prioritize this over AdLib.
+AdLib does not require a SoundFont or ROMs, so for many games it might 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
------------------------
@@ -185,19 +185,19 @@ Some games contain sound effects that are exclusive to the AdLib soundtrack, or
.. note::
- Mixed AdLib/MIDI mode is not supported by all games.
+ 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.
+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.
+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.
@@ -212,9 +212,9 @@ ScummVM has to resample all sounds to the selected output frequency. It is recom
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_topics/configuration_file>` with the *audio_buffer_size* configuration keyword. The default value is calculated based on output sampling frequency to keep audio latency below 45ms.
+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_topics/configuration_file>` with the *audio_buffer_size* configuration keyword. 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.
+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 might lead to minor audio delays (high latency).
diff --git a/doc/docportal/advanced_topics/understand_graphics.rst b/doc/docportal/advanced_topics/understand_graphics.rst
index 2f09b9fc79..26a6235948 100644
--- a/doc/docportal/advanced_topics/understand_graphics.rst
+++ b/doc/docportal/advanced_topics/understand_graphics.rst
@@ -2,14 +2,14 @@
Understanding the graphics settings
=====================================
-This guide expands on the information contained on the :doc:`graphics settings <../settings/graphics>` page.
+This guide expands 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.
+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.
+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
@@ -27,13 +27,13 @@ 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, scales the image by a factor of 2. Default for non 640x480 games.
.. figure:: ../images/graphics/graphics_mode/3x.png
-
+
**3x**: No filtering, scales the image by a factor of 3.
.. figure:: ../images/graphics/graphics_mode/2xsai.png
@@ -74,17 +74,17 @@ A comparison of graphics modes
.. note::
-
- Not all platforms support all the graphics modes.
-To switch between graphics modes, press :kbd:`Ctrl + Alt` and :kbd:`1` to :kbd:`8`.
+ Not all platforms support all the graphics modes.
+
+To switch between graphics modes, press :kbd:`Ctrl + Alt` and :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. OpenGL mode uses hardware rendering, instead of software rendering.
+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. OpenGL mode uses hardware rendering, instead of software rendering.
-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.
+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.
@@ -93,9 +93,9 @@ Output is controlled by your window size (or screen resolution if in full screen
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.
+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.
-For a game with an original resolution of 320x200, aspect ratio correction results in a resolution of 320x240.
+For a game with an original resolution of 320x200, aspect ratio correction results in a resolution of 320x240.
.. figure:: ../images/graphics/aspect_ratio/no_aspect_ratio.png
@@ -103,7 +103,7 @@ For a game with an original resolution of 320x200, aspect ratio correction resul
.. figure:: ../images/graphics/aspect_ratio/aspect_ratio.png
- Aspect ratio correction applied. The moon is actually round, as it should be!
+ Aspect ratio correction applied. The moon is actually round, as it should be!
To toggle aspect ratio on and off, press :kbd:`Ctrl+Alt+a`.
@@ -115,8 +115,8 @@ Stretch modes
There are five stretch modes:
-- Center: centers the image in the window.
-- Pixel-perfect scaling: scales the image to the highest multiple of the game resolution that fits the window, or that fits the screen if in fullscreen mode. Any empty space is filled with black bars.
+- Center: centers the image in the window.
+- Pixel-perfect scaling: scales the image to the highest multiple of the game resolution that fits the window, or that fits the screen if in fullscreen mode. Any empty space is filled with black bars.
- For example, a game with an original resolution of 320x200 with aspect ratio correction applied (320x240) and a 3x graphics mode, will be stretched to a multiple of 900x720 pixels: 1800x1440, 2700x2160 and so on.
@@ -129,12 +129,12 @@ To switch between stretch modes, press :kbd:`Ctrl+Alt+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 lets you decide which system you want ScummVM to reproduce.
+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 lets you decide which system you want ScummVM to reproduce.
-Below are some of the common render modes, to illustrate how the render mode setting works.
+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
@@ -160,8 +160,8 @@ Below are some of the common render modes, to illustrate how the render mode set
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.
+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.
-Nearest neighbor is a simple way to scale an image; each pixel becomes multiple pixels of the same color. While this preserves the sharper details in a pixel art image, it also creates "jagged" edges as the image is scaled up. Bilinear interpolation finds the average color between pixel color values and fills in missing pixel, which results in a "smoothed" image.
+Nearest neighbor is a simple way to scale an image; each pixel becomes multiple pixels of the same color. While this preserves the sharper details in a pixel art image, it also creates "jagged" edges as the image is scaled up. Bilinear interpolation finds the average color between pixel color values and fills in missing pixel, which results in a "smoothed" image.
To toggle between bilinear interpolation and nearest neighbor, press :kbd:`Ctrl+Alt+f`.
\ No newline at end of file
diff --git a/doc/docportal/contribute/platform_template.rst b/doc/docportal/contribute/platform_template.rst
index b28c5a7116..88379825de 100644
--- a/doc/docportal/contribute/platform_template.rst
+++ b/doc/docportal/contribute/platform_template.rst
@@ -5,17 +5,17 @@ Title
What you'll need
===================
-- Bullet points listing all prerequisites.
+- Bullet points listing all prerequisites.
Install ScummVM
===============================
-Detailed download and install instructions.
+Detailed download and install instructions.
Transferring game files
=========================
-Detailed instructions for getting game files onto the device.
+Detailed instructions for getting game files onto the device.
"See :doc:`../use_scummvm/game_files` for more information about game file requirements."
@@ -24,14 +24,14 @@ Controls
"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."
+"See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts."
Default control mapping
*************************
-Use a CSV-list table. Set widths to equal 100%. Choose how many header rows you have.
+Use a CSV-list table. Set widths to equal 100%. Choose how many header rows you have.
-It's easiest to use Google Sheets or Excel to export a spreadsheet as a CSV file.
+It's easiest to use Google Sheets or Excel to export a spreadsheet as a CSV file.
.. csv-table::
:widths: 30 30 40
@@ -45,15 +45,15 @@ It's easiest to use Google Sheets or Excel to export a spreadsheet as a CSV file
[Other control information] - Optional
*****************************************
-Paths
+Paths
=======
-Saved games
+Saved games
*******************
``path/to/savedgames``
-Configuration file
+Configuration file
**************************
``path/to/configurationfile``
@@ -61,7 +61,7 @@ Configuration file
Settings
==========
-"For more information, see the Settings section of the documentation. Only platform-specific differences are listed here."
+"For more information, see the Settings section of the documentation. Only platform-specific differences are listed here."
[Applicable tab] e.g. Audio
*******************************
@@ -72,4 +72,4 @@ Settings
Known issues
==============
-Anything specific to this port that is a known issue.
\ No newline at end of file
+Anything specific to this port that is a known issue.
\ No newline at end of file
diff --git a/doc/docportal/contribute/settings_template.rst b/doc/docportal/contribute/settings_template.rst
index 6debc48a39..2cf8332791 100644
--- a/doc/docportal/contribute/settings_template.rst
+++ b/doc/docportal/contribute/settings_template.rst
@@ -4,32 +4,32 @@ Name of settings tab
Short description of what is on the tab, and why you would use settings on this tab.
-"**To change settings globally:**
+"**To change settings globally:**
- From the Launcher, select **Options**. The **xxxx** tab is the first tab shown.
+ From the Launcher, select **Options**. The **xxxx** tab is the first tab shown.
-**To change settings for a specific game:**
+**To change settings for a specific game:**
- Highlight the game in the games list, select **Edit Game** then select the **xxxx** tab."
+ Highlight the game in the games list, select **Edit Game** then select the **xxxx** tab."
.. figure:: ../images/settings/screenshotoftab.png
The xxxx tab in the global settings
-"All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description."
+"All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description."
,,,,,,,,,,,,,,
.. _refforconfigurationfile:
-Option label
- Description of option.
+Option label
+ Description of option.
*config_file_key*
.. _refforconfigurationfile:
-Option label
- Description of option.
+Option label
+ Description of option.
*config_file_key*
\ No newline at end of file
diff --git a/doc/docportal/help/contact.rst b/doc/docportal/help/contact.rst
index 1296bbd6bd..bf2ec1607d 100644
--- a/doc/docportal/help/contact.rst
+++ b/doc/docportal/help/contact.rst
@@ -5,16 +5,16 @@ Contact us
There are a few ways to become a part of the ScummVM community:
-- Chat with us on `Discord <https://discord.com/invite/5D8yTtF>`_ or the `IRC Channel <irc://irc.freenode.net/scummvm?key=scummvm>`_ . It's a great place to hang out with developers and other ScummVM users.
+- Chat with us on `Discord <https://discord.com/invite/5D8yTtF>`_ or the `IRC Channel <irc://irc.freenode.net/scummvm?key=scummvm>`_ . It's a great place to hang out with developers and other ScummVM users.
-- Post on the `ScummVM Forum <https://forums.scummvm.org/>`_ . We have several forums; the `Help and Support forum <https://forums.scummvm.org/viewforum.php?f=2>`_ if you need help while using ScummVM, the `General discussion forum <https://forums.scummvm.org/viewforum.php?f=1>`_ for all general questions, and `The Junkyard <https://forums.scummvm.org/viewforum.php?f=8>`_ for almost everything else! We also have some platform-specific forums, in case you have a specific question. Make sure to read the `Forum Rules <https://forums.scummvm.org/viewtopic.php?t=17>`_ before posting.
+- Post on the `ScummVM Forum <https://forums.scummvm.org/>`_ . We have several forums; the `Help and Support forum <https://forums.scummvm.org/viewforum.php?f=2>`_ if you need help while using ScummVM, the `General discussion forum <https://forums.scummvm.org/viewforum.php?f=1>`_ for all general questions, and `The Junkyard <https://forums.scummvm.org/viewforum.php?f=8>`_ for almost everything else! We also have some platform-specific forums, in case you have a specific question. Make sure to read the `Forum Rules <https://forums.scummvm.org/viewtopic.php?t=17>`_ before posting.
- There are three ScummVM mailing lists, which you can join `here <https://lists.scummvm.org/>`_.
-- If you find a bug, :doc:`report_bugs`.
+- If you find a bug, :doc:`report_bugs`.
- Feature requests can be made to our `Feature request tracker <https://bugs.scummvm.org/report/11>`_.
-- If you have made modifications to the ScummVM source code and would like to see them merged into the main code, open a Pull Request on our `GitHub page <https://github.com/scummvm/scummvm/pulls>`_.
+- If you have made modifications to the ScummVM source code and would like to see them merged into the main code, open a Pull Request on our `GitHub page <https://github.com/scummvm/scummvm/pulls>`_.
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
index 5168ab17df..7a3ab492cb 100644
--- a/doc/docportal/help/faq.rst
+++ b/doc/docportal/help/faq.rst
@@ -14,13 +14,13 @@ About
Is ScummVM an emulator?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-No! ScummVM actually replaces the original executable file that shipped with the game. This means that your games can run on platforms they were never designed for! For an in-depth look at how ScummVM works, see the `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
+No! ScummVM actually replaces the original executable file that shipped with the game. This means that your games can run on platforms they were never designed for! For an in-depth look at how ScummVM works, see the `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
-Is ScummVM free?
+Is ScummVM free?
^^^^^^^^^^^^^^^^^^^^
-ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is available for you to do whatever you want with it, but if you make modifications and redistribute your work, you must make your source code available.
+ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is available for you to do whatever you want with it, but if you make modifications and redistribute your work, you must make your source code available.
-The ScummVM team would be delighted if you send them your modifications, so that the changes you've made can be merged into the main source code. See the `Developer Central <https://wiki.scummvm.org/index.php/Developer_Central>`_ wiki page for contributing guidelines.
+The ScummVM team would be delighted if you send them your modifications, so that the changes you've made can be merged into the main source code. See the `Developer Central <https://wiki.scummvm.org/index.php/Developer_Central>`_ wiki page for contributing guidelines.
How do I install ScummVM onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -29,24 +29,24 @@ See :ref:`firststeps`.
How do I get game files onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-For general guidance, see the :doc:`../use_scummvm/game_files` page. For platform-specific information, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
+For general guidance, see the :doc:`../use_scummvm/game_files` page. For platform-specific information, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
ScummVM has cloud and LAN functionality to simplify the file transfer process. For more information, see :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
On what platform(s) will ScummVM run?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See our `Platforms <https://wiki.scummvm.org/index.php/Platforms>`_ wiki page for a full list. We have guides available for many of the supported platforms, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
+See our `Platforms <https://wiki.scummvm.org/index.php/Platforms>`_ wiki page for a full list. We have guides available for many of the supported platforms, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
Games
********
Can I only play LucasArts SCUMM games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-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 full list of supported games `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_. There is a caveat; not all supported games are playable on all platforms. Often this is because the game is simply too CPU intensive for the device, or because of some other hardware or software limitation. If a game is not available on a platform, you will not be able to add it to ScummVM.
+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 full list of supported games `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_. There is a caveat; not all supported games are playable on all platforms. Often this is because the game is simply too CPU intensive for the device, or because of some other hardware or software limitation. If a game is not available on a platform, you will not be able to add it to ScummVM.
.. _getgames:
-Where do I get the games?
+Where do I get the games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Where_to_get_the_games>`_ wiki page.
@@ -55,11 +55,11 @@ See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Wher
How do I install games from my floppy discs/CDs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Generally speaking, you do not need to install the games. You only need to point ScummVM to the game files contained on these discs. For a complete guide, see :doc:`../use_scummvm/game_files`.
+Generally speaking, you do not need to install the games. You only need to point ScummVM to the game files contained on these discs. For a complete guide, see :doc:`../use_scummvm/game_files`.
Do I need the original game discs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Ideally yes, however we know that a lot of people don't! If you do not have any hard copy games, there are some digital options available, including some games that have been released as freeware. See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Where_to_get_the_games>`_ wiki page.
+Ideally yes, however we know that a lot of people don't! If you do not have any hard copy games, there are some digital options available, including some games that have been released as freeware. See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Where_to_get_the_games>`_ wiki page.
How do I know if I can play my game using ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -67,15 +67,15 @@ The best place to check is the `Compatibility page <https://www.scummvm.org/comp
I have saved games from when I played the original game - can I use these with ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-This is only supported for a select number of games. See the `wiki <https://wiki.scummvm.org/index.php/Category:Supported_Games>`_ page for the game you are playing.
+This is only supported for a select number of games. See the `wiki <https://wiki.scummvm.org/index.php/Category:Supported_Games>`_ page for the game you are playing.
How do I launch a game straight from the game folder?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Games must be added to and started from :doc:`the ScummVM Launcher <../use_scummvm/the_launcher>`; they cannot be started directly from the game files. See :doc:`../use_scummvm/add_play_games`.
+Games must be added to and started from :doc:`the ScummVM Launcher <../use_scummvm/the_launcher>`; they cannot be started directly from the game files. See :doc:`../use_scummvm/add_play_games`.
What are the in-game keyboard shortcuts?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A list of default shortcuts can be found on the :doc:`../use_scummvm/keyboard_shortcuts` page. Since version 2.2.0 you can also create custom shortcuts on the :doc:`../settings/keymaps` tab.
+A list of default shortcuts can be found on the :doc:`../use_scummvm/keyboard_shortcuts` page. Since version 2.2.0 you can also create custom shortcuts on the :doc:`../settings/keymaps` tab.
Troubleshooting
===================
@@ -83,38 +83,38 @@ Troubleshooting
ScummVM
***********
-ScummVM crashes, but the console window disappears too quickly to see the error message.
+ScummVM crashes, but the console window disappears too quickly to see the error message.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If you are using a computer, you can run ScummVM from the :doc:`command line <../advanced_topics/command_line>`. By doing this, error messages remain visible even after ScummVM exits.
+If you are using a computer, you can run ScummVM from the :doc:`command line <../advanced_topics/command_line>`. By doing this, error messages remain visible even after ScummVM exits.
-You can also find error messages in the ScummVM log file. See :ref:`logfile`.
+You can also find error messages in the ScummVM log file. See :ref:`logfile`.
I think I found a bug. What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See :doc:`report_bugs`.
+See :doc:`report_bugs`.
Games
********
-Help! My game won't run!
+Help! My game won't run!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-1. Make sure your game is supported. Check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website, and the `Platform Overview <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ page on the wiki.
+1. Make sure your game is supported. Check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website, and the `Platform Overview <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ page on the wiki.
-2. Check that you have all the required datafiles. See the :doc:`../use_scummvm/game_files` page.
+2. Check that you have all the required datafiles. See the :doc:`../use_scummvm/game_files` page.
-3. Ask for advice on the ScummVM forums or on Discord. See the :doc:`contact` page.
+3. Ask for advice on the ScummVM forums or on Discord. See the :doc:`contact` page.
-4. If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
+4. If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
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. In most cases you will need to copy the files from the disc into a folder ScummVM can access. See :doc:`../use_scummvm/game_files`.
+Installing the game does not necessarily provide ScummVM with the files it needs. In most cases you will need to copy the files from the disc into a folder ScummVM can access. See :doc:`../use_scummvm/game_files`.
Why are the subtitles in my non-English game messed up?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-You need to specify the correct :ref:`language <lang>` in the game-specific settings.
+You need to specify the correct :ref:`language <lang>` in the game-specific settings.
Audio
*******
@@ -123,11 +123,11 @@ Audio
Help! There's no sound!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Sometimes it's worth checking the obvious.
+Sometimes it's worth checking the obvious.
-1. Are your speakers on? Are your headphones properly connected?
-2. Try playing an audio clip from another source to see if you have sound in general.
-3. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM falls back on an audio setting that works, but if for some reason it doesn't, you might need to change the settings yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
+1. Are your speakers on? Are your headphones properly connected?
+2. Try playing an audio clip from another source to see if you have sound in general.
+3. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM falls back on an audio setting that works, but if for some reason it doesn't, you might need to change the settings yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
Help! There's no sound on my iPhone/iPad!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -135,16 +135,16 @@ ScummVM will not play any sound if your device is in Silent Mode. If this is not
I have a "talkie" version of a LucasArts game but I can't hear the voices. What's the problem?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The original games shipped with an uncompressed voice file (``MONSTER.SOU``). If you have compressed this file to an mp3 file (``MONSTER.SO3``), an Ogg Vorbis file (``MONSTER.SOG``), or a FLAC file (``MONSTER.SOF``), make sure that the ScummVM you're using has support for those formats.
+The original games shipped with an uncompressed voice file (``MONSTER.SOU``). If you have compressed this file to an mp3 file (``MONSTER.SO3``), an Ogg Vorbis file (``MONSTER.SOG``), or a FLAC file (``MONSTER.SOF``), make sure that the ScummVM you're using has support for those formats.
The audio is really glitchy. What can I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There are a few things you can try:
-- Try to increase the :ref:`audio buffer size <buffer>` in the configuration file.
-- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU might not have the processing power to keep up. In this case, you might 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>`_, provided your platform supports it.
+- Try to increase the :ref:`audio buffer size <buffer>` in the configuration file.
+- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU might not have the processing power to keep up. In this case, you might 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>`_, provided your platform supports it.
- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU might not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
-- If you are using the :ref:`AdLib <adlib>` emulator, try selecting the least CPU-intensive option; MAME.
+- If you are using the :ref:`AdLib <adlib>` emulator, try selecting the least CPU-intensive option; MAME.
I have a CD version of a game, how do I get the sound to work without running the game from the CD?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -155,13 +155,13 @@ Graphics
There are so many options... How do I know what to pick?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Start by checking out our :doc:`../advanced_topics/understand_graphics` page. It has comprehensive information on how all this stuff works.
+Start by checking out our :doc:`../advanced_topics/understand_graphics` page. It has comprehensive information on how all this stuff works.
Can I just make the image larger (for example, 1 pixel becomes 4 pixels) without any smoothing or antialiasing?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-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. Also check that **Filter graphics** is not enabled.
-
+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. Also check that **Filter graphics** is not enabled.
+
The game colors are messed up, how do I fix them?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Ensure the correct game platform 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
+Ensure the correct game platform 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/report_bugs.rst b/doc/docportal/help/report_bugs.rst
index ab57eff2d2..b56468c569 100644
--- a/doc/docportal/help/report_bugs.rst
+++ b/doc/docportal/help/report_bugs.rst
@@ -3,29 +3,29 @@
Report a bug
=======================
-To report a bug, go to the ScummVM `Issue Tracker <https://bugs.scummvm.org/>`_ and log in with your GitHub account.
+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 completeable on the `Supported Games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ wiki page, or on the compatibility list. We already know those games have bugs!
Please include the following information in the bug report:
- ScummVM version (test the latest git/Daily build)
-- Bug details, including instructions for how to reproduce the bug. If possible, include log files, screenshots, and any other relevant information.
+- Bug details, including instructions for how to reproduce the bug. If possible, include log files, screenshots, and any other relevant information.
- Game language
- Game version (for example, talkie or floppy)
- Platform and Compiler (for example, Win32, Linux or FreeBSD)
-- An attached saved game, if possible.
+- An attached saved game, if possible.
- If this bug only occurred recently, include the last version without the bug, and the first version with 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 is difficult to track the status of each individual bug when they aren't on their own tickets.
+Finally, please report each issue separately; do not file multiple issues on the same ticket. It is difficult to track the status of each individual bug when they aren't on their own tickets.
-.. _logfile:
+.. _logfile:
The ScummVM log file
=====================
-To help you report a bug, you can find error messages in the ScummVM log file. The location of this file varies depending on your operating system.
+To help you report a bug, you can find error messages in the ScummVM log file. The location of this file varies depending on your operating system.
.. tabbed:: macOS
@@ -40,7 +40,7 @@ To help you report a bug, you can find error messages in the ScummVM log file. T
.. panels::
:column: col-lg-12 mb-2
- We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location might vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
+ We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location might vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
.. tabbed:: Windows
@@ -49,7 +49,7 @@ To help you report a bug, you can find error messages in the ScummVM log file. T
Window Vista/7/8/10
^^^^^^^^^^^^^^^^^^^^^^
-
+
``%APPDATA%\ScummVM\scummvm.log``
-
+
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 90dada2dfc..d791772c5f 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -13,7 +13,7 @@
use_scummvm/how_to_settings
use_scummvm/connect_cloud
use_scummvm/LAN
-
+
.. toctree::
:caption: Platform guides
:glob:
@@ -66,7 +66,7 @@
:glob:
:hidden:
- release_notes/*
+ release_notes/*
@@ -78,9 +78,9 @@ Welcome to ScummVM!
ScummVM allows you to play classic graphic point-and-click adventure games, text adventure games, and RPGs, as long as you already have the game data files. ScummVM replaces the executable files shipped with the games, which means you can now play your favorite games on all your favorite devices.
-So how did ScummVM get its name? Many of the famous LucasArts adventure games, such as Maniac Mansion and the Monkey Island series, were created using a utility called SCUMM (Script Creation Utility for Maniac Mansion). The 'VM' in ScummVM stands for Virtual Machine.
+So how did ScummVM get its name? Many of the famous LucasArts adventure games, such as Maniac Mansion and the Monkey Island series, were created using a utility called SCUMM (Script Creation Utility for Maniac Mansion). The 'VM' in ScummVM stands for Virtual Machine.
-While ScummVM was originally designed to run LucasArts' SCUMM games, over time support has been added for many other games: see the full list `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_. Noteworthy titles include Broken Sword, Myst and Blade Runner, although there are countless other hidden gems to explore.
+While ScummVM was originally designed to run LucasArts' SCUMM games, over time support has been added for many other games: see the full list `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_. Noteworthy titles include Broken Sword, Myst and Blade Runner, although there are countless other hidden gems to explore.
@@ -101,7 +101,7 @@ We have a user manual section covering **THE BASICS**:
:doc:`use_scummvm/the_launcher`
---
-
+
Playing games
^^^^^^^^^^^^^^^
:doc:`use_scummvm/game_files`
@@ -111,7 +111,7 @@ We have a user manual section covering **THE BASICS**:
:doc:`use_scummvm/save_load_games`
---
-
+
Controls and settings
^^^^^^^^^^^^^^^^^^^^^^^
@@ -120,7 +120,7 @@ We have a user manual section covering **THE BASICS**:
:doc:`use_scummvm/how_to_settings`
---
-
+
Useful features
^^^^^^^^^^^^^^^^
@@ -147,7 +147,7 @@ We also have guides on how to get ScummVM running on a wide range of other platf
:doc:`other_platforms/playstation_vita`
---
-
+
Other consoles
^^^^^^^^^^^^^^^^
@@ -173,8 +173,8 @@ We also have guides on how to get ScummVM running on a wide range of other platf
:doc:`other_platforms/risc_os`
-
-
+
+
@@ -182,9 +182,9 @@ We also have guides on how to get ScummVM running on a wide range of other platf
Advanced topics
============================
-For our more experienced users, ScummVM features a command line interface, as well as the ability to edit settings directly in a configuration file.
+For our more experienced users, ScummVM features a command line interface, as well as the ability to edit settings directly in a configuration file.
-In this section, we also take a deep dive into understanding the graphics and audio settings.
+In this section, we also take a deep dive into understanding the graphics and audio settings.
.. panels::
@@ -192,12 +192,12 @@ In this section, we also take a deep dive into understanding the graphics and au
Advanced features
^^^^^^^^^^^^^^^^^^^^
- :doc:`advanced_topics/configuration_file`
-
+ :doc:`advanced_topics/configuration_file`
+
:doc:`advanced_topics/command_line`
---
-
+
Understanding the settings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -218,22 +218,22 @@ If you are having problems with any aspect of ScummVM, take a look at our help s
:container: text-center mb-4
:column: col-lg-12
- :doc:`help/faq`
-
- :doc:`How to report a bug <help/report_bugs>`
-
+ :doc:`help/faq`
+
+ :doc:`How to report a bug <help/report_bugs>`
+
:doc:`help/contact`
What's changed since I was last here?
======================================
-We have a **RELEASE NOTES** section on the sidebar; here you can see what's changed in both current and past releases.
+We have a **RELEASE NOTES** section on the sidebar; here you can see what's changed in both current and past releases.
The ScummVM Project
===================
-ScummVM is an open-source project created, maintained and constantly improved by a team of passionate volunteers from all around the world. If you enjoy using ScummVM and would like to support the team, you can use the PayPal Donate button below.
+ScummVM is an open-source project created, maintained and constantly improved by a team of passionate volunteers from all around the world. If you enjoy using ScummVM and would like to support the team, you can use the PayPal Donate button below.
.. raw:: html
@@ -246,7 +246,7 @@ ScummVM is an open-source project created, maintained and constantly improved by
Another way to support us is to buy your games from GOG.com using the ScummVM Affiliate link.
-.. raw:: html
+.. raw:: html
<a href="https://www.gog.com/?pp=22d200f8670dbdb3e253a90eee5098477c95c23d">
<img src="GOG_button_small.png" width="126" height="46" alt="GOG.com games">
@@ -254,7 +254,7 @@ Another way to support us is to buy your games from GOG.com using the ScummVM Af
-If you have software development or technical writing skills, we would love for you to join the ScummVM team! Check out `Developer Central <https://wiki.scummvm.org/index.php?title=Developer_Central>`_ on the ScummVM wiki for more information on contributing to ScummVM.
+If you have software development or technical writing skills, we would love for you to join the ScummVM team! Check out `Developer Central <https://wiki.scummvm.org/index.php?title=Developer_Central>`_ on the ScummVM wiki for more information on contributing to ScummVM.
diff --git a/doc/docportal/other_platforms/amigaos_4.rst b/doc/docportal/other_platforms/amigaos_4.rst
index ef40fa2ef7..3f7745f0a9 100644
--- a/doc/docportal/other_platforms/amigaos_4.rst
+++ b/doc/docportal/other_platforms/amigaos_4.rst
@@ -2,7 +2,7 @@
AmigaOS 4
=============================
-This page contains all the information you need to get ScummVM up and running on AmigaOS 4.
+This page contains all the information you need to get ScummVM up and running on AmigaOS 4.
What you'll need
===================
@@ -12,42 +12,42 @@ What you'll need
Installing ScummVM
=====================================
-ScummVM is available for download from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_ or the `OS4 Depot <http://www.os4depot.net>`_.
+ScummVM is available for download from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_ or the `OS4 Depot <http://www.os4depot.net>`_.
-Download and extract the ``.lha`` file.
+Download and extract the ``.lha`` file.
-Run the extracted ``ScummVM_Install`` script. This installer guides you through the installation process.
+Run the extracted ``ScummVM_Install`` script. This installer guides you through the installation process.
.. figure:: ../images/amigaos_4/installer.png
- The ScummVM installer.
+ The ScummVM installer.
-To automatically keep ScummVM up to date through AmiUpdate, run the ``Autoinstall`` script.
+To automatically keep ScummVM up to date through AmiUpdate, run the ``Autoinstall`` script.
Transferring game files
=========================
-For games on PC or Mac formatted discs, use the original platform to access the data files, and then transfer these to Amiga. Alternatively, if you have external hardware such as a Catweazel floppy disc controller, you might be able to use this to access the files.
+For games on PC or Mac formatted discs, use the original platform to access the data files, and then transfer these to Amiga. Alternatively, if you have external hardware such as a Catweazel floppy disc controller, you might be able to use this to access the files.
-ScummVM for Amiga OS has Cloud and LAN functionality, to help manage the transfer of files. See :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
+ScummVM for Amiga OS has Cloud and LAN functionality, to help manage the transfer of files. See :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
-Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common default keyboard shortcuts.
+Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common default keyboard shortcuts.
-Paths
+Paths
=======
-Saved games
+Saved games
*******************
``Games:ScummVM/saves``
-Configuration file
+Configuration file
**************************
``Games:ScummVM/scummvm.ini``
@@ -55,7 +55,7 @@ Configuration file
Settings
==========
-For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
+For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
Audio
******
@@ -66,6 +66,6 @@ The CAMD driver allows the use of MIDI hardware. Select CAMD as the :ref:`Prefer
Known issues
==============
-Due to the big-endian nature of Amiga OS, there can sometimes be graphics and sounds issues with games. Check out the Platform Overview `wiki page <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ for a list of compatible engines.
+Due to the big-endian nature of Amiga OS, there can sometimes be graphics and sounds issues with games. Check out the Platform Overview `wiki page <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ for a list of compatible engines.
If a game crashes and it's listed as compatible, report it as a :doc:`bug <../help/report_bugs>`.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/android.rst b/doc/docportal/other_platforms/android.rst
index 59539eb8c6..34b3386eac 100644
--- a/doc/docportal/other_platforms/android.rst
+++ b/doc/docportal/other_platforms/android.rst
@@ -3,7 +3,7 @@
Android
===============
-This page contains all the information you need to get ScummVM up and running on an Android device.
+This page contains all the information you need to get ScummVM up and running on an Android device.
What you'll need
================
@@ -12,48 +12,48 @@ What you'll need
.. note::
- ScummVM has been tested to work up to Android 10. Currently there are some file browsing limitations with Android 11. The ScummVM team are working to resolve these.
+ ScummVM has been tested to work up to Android 10. Currently there are some file browsing limitations with Android 11. The ScummVM team are working to resolve these.
Installing ScummVM
====================================
-There are two ways to install ScummVM on an Android device; install it from the Google Play Store, or manually download and install the APK package from the ScummVM downloads page.
+There are two ways to install ScummVM on an Android device; install it from the Google Play Store, or manually download and install the APK package from the ScummVM downloads page.
Installing from the Google Play Store
***************************************
-The latest supported version of ScummVM is on the Google Play Store; search for ScummVM on the Google Play Store and select **Install**.
+The latest supported version of ScummVM is on the Google Play Store; search for ScummVM on the Google Play Store and select **Install**.
-Manually installing the APK package
+Manually installing the APK package
*************************************
-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 suggests the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
+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 suggests the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
-.. tip::
+.. tip::
To find the correct package for your device, find out whether the device has a 32 or 64-bit operating system, and which chipset the device has. Do an internet search using the device model number to find these details.
-Click on the correct package to start the download. After it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and after permission is granted, returns to the install.
+Click on the correct package to start the download. After it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and after permission is granted, returns to the install.
-.. note::
+.. note::
The downloaded APK package is treated as an app from an unknown source, because it doesn't originate in the Google Play store. To allow unknown apps:
- For Android 7 or lower, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
- - For Android 8 or higher, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
-
-Transferring game files
+ - For Android 8 or higher, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
+
+Transferring game files
========================================
-Transfer all the required game data files to your device, into a folder accessible by the ScummVM app.
+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 lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
+ScummVM has built-in Cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
There are a few other options to transfer the game files:
- Copy the files directly onto the microSD card, if the device has one.
- - USB transfer from a computer. To complete file transfer by 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 opens.
+ - USB transfer from a computer. To complete file transfer by 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 opens.
- Download games such as freeware games or those from digital distributors directly to your device.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
@@ -66,15 +66,15 @@ Controls
Default control mapping
****************************
-Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
-.. csv-table::
+.. csv-table::
:header-rows: 1
Touch screen control, Action
One finger tap, Left mouse click
Two finger tap, Right mouse click
- One finger touch & hold, Middle mouse click
+ One finger touch & hold, Middle mouse click
Long press system Back button, Opens Global Main Menu
Short press system Back button, "Skip, or Cancel/Quit in the Launcher"
Small keyboard icon (top right), Opens/closes Virtual keyboard
@@ -84,26 +84,26 @@ Touch controls
The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
- When touchpad mouse mode is off (default), the touch controls are direct. The pointer jumps to where the finger touches the screen.
- - 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.
+ - 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 tap
^^^^^^^^^^^^^^^^^
-To do a two finger tap, hold one finger down and then tap with a second finger.
+To do a two finger tap, hold one finger down and then tap with a second finger.
Immersive Sticky fullscreen mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-ScummVM for Android uses the Immersive Sticky fullscreen mode, which means that the Android system bar is hidden until the user swipes from an edge with a system bar. Swipe from the edge to reveal the system bars. They remain semi-transparent and disappear after a few seconds unless you interact with them. Your swipe also registers in the game, so if you need to swipe from an edge with system bars, your game play is not interrupted.
+ScummVM for Android uses the Immersive Sticky fullscreen mode, which means that the Android system bar is hidden until the user swipes from an edge with a system bar. Swipe from the edge to reveal the system bars. They remain semi-transparent and disappear after a few seconds unless you interact with them. Your swipe also registers in the game, so if you need to swipe from an edge with system bars, your game play is not interrupted.
Virtual keyboard
^^^^^^^^^^^^^^^^^^^^^
-To open the virtual keyboard, tap on the small keyboard icon at the top right of the screen, or tap on any editable text field. To hide the virtual keyboard, tap the small keyboard icon again, or tap outside the text field.
+To open the virtual keyboard, tap on the small keyboard icon at the top right of the screen, or tap on any editable text field. To hide the virtual keyboard, tap the small keyboard icon again, or tap outside the text field.
-To display or hide the small keyboard icon, from the Launcher select **Options** and then the **Control** tab. Tick the **Show on-screen control** box to enable the keyboard icon.
+To display or hide the small keyboard icon, from the Launcher select **Options** and then the **Control** tab. Tick the **Show on-screen control** box to enable the keyboard icon.
Paths
@@ -112,26 +112,26 @@ Paths
Saved games
**************
-By default, the saved games are saved in the internal app folder. To change the path, go to the :doc:`../settings/paths` tab in either the global or game-specific settings.
+By default, the saved games are saved in the internal app folder. To change the path, go to the :doc:`../settings/paths` tab in either the global or game-specific settings.
Configuration file
************************
-The configuration file is in the internal app folder, and this path cannot be changed.
+The configuration file is in the internal app folder, and this path cannot be changed.
Accessing the internal app folder
************************************
To access the internal app folder, use ScummVM's built-in LAN functionality:
-1. From the Launcher, select **Options** and then the **LAN** tab.
+1. From the Launcher, select **Options** and then the **LAN** tab.
2. Select **/root/Path**.
-3. Use the file browser to **Go up** to the root of the ScummVM internal app folder.
-4. Select the **ScummVM data (int)** shortcut, and tap **Choose**.
-5. Run the server to access the ``scummvm.ini``` configuration file.
+3. Use the file browser to **Go up** to the root of the ScummVM internal app folder.
+4. Select the **ScummVM data (int)** shortcut, and tap **Choose**.
+5. Run the server to access the ``scummvm.ini``` configuration file.
-For more information, see the :doc:`../use_scummvm/LAN` page.
+For more information, see the :doc:`../use_scummvm/LAN` page.
Known issues
@@ -139,7 +139,7 @@ Known issues
- On some newer devices, there is an issue if the saved path is outside the app's internal (or external) storage. The ScummVM team is currently working on a fix.
-- If ScummVM is uninstalled or downgraded, its internal and external app spaces are fully deleted. If you want to keep saved games use ScummVM's :doc:`cloud <../use_scummvm/connect_cloud>` or LAN functionality to keep those files. Alternatively, change the saved game path to a shared location such as an SD card.
+- If ScummVM is uninstalled or downgraded, its internal and external app spaces are fully deleted. If you want to keep saved games use ScummVM's :doc:`cloud <../use_scummvm/connect_cloud>` or LAN functionality to keep those files. Alternatively, change the saved game path to a shared location such as an SD card.
diff --git a/doc/docportal/other_platforms/atari.rst b/doc/docportal/other_platforms/atari.rst
index db89bd1281..f1fe6e9250 100644
--- a/doc/docportal/other_platforms/atari.rst
+++ b/doc/docportal/other_platforms/atari.rst
@@ -2,12 +2,12 @@
Atari/FreeMiNT
=============================
-This page contains all the information you need to get ScummVM up and running on an Atari system.
+This page contains all the information you need to get ScummVM up and running on an Atari system.
What you'll need
=================
-- A powerful Atari system or clone; recommended minimum CPU 68060.
+- A powerful Atari system or clone; recommended minimum CPU 68060.
- FreeMiNT, TOS or MagiC operating system.
Installing ScummVM
@@ -15,35 +15,35 @@ Installing ScummVM
Binary packages are provided for the m68000 CPU, the m68020 to m68060 range of CPUs, and the Coldfire (FireBee) CPU. All are available for download from the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_. To install ScummVM, extract the selected ScummVM archive into a folder on the hard disk.
-Run ``scummvm.gtp`` to start Scummvm. The ``scummvm.gtp`` command will take :doc:`command line options <../advanced_topics/command_line>` to set parameters for the ScummVM session.
+Run ``scummvm.gtp`` to start Scummvm. The ``scummvm.gtp`` command will take :doc:`command line options <../advanced_topics/command_line>` to set parameters for the ScummVM session.
+
+To run ScummVM from a FreeMiNT Command Line Interface, make the program executable with the following command:
-To run ScummVM from a FreeMiNT Command Line Interface, make the program executable with the following command:
-
.. code-block:: bash
chmod +x scummvm.gtp
-For the best performance, run ScummVM under FreeMiNT, from the command line, and without the AES started.
+For the best performance, run ScummVM under FreeMiNT, from the command line, and without the AES started.
Transferring game files
=========================
-Transfer files to the Atari as you normally would, such as through a network connection or by optical disc.
+Transfer files to the Atari as you normally would, such as through a network connection or by optical disc.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
-Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
-Paths
+Paths
=======
FreeMiNT
***************
-Saved games and the configuration file are found in the user’s defined home directory.
+Saved games and the configuration file are found in the user’s defined home directory.
MagiC/TOS
***************
@@ -54,12 +54,12 @@ Saved games and the configuration file are found in the ScummVM installation dir
Settings
==========
-For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
Graphics
************
-For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. This is not a ScummVM setting, but rather a system-wide setting.
+For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. This is not a ScummVM setting, but rather a system-wide setting.
.. tip::
@@ -71,7 +71,7 @@ Audio
Supported audio file formats:
- MP3
-- OGG
+- OGG
- FLAC
- Uncompressed audio
@@ -80,8 +80,8 @@ Known issues
- There is no cloud/LAN functionality.
-- The Atari built-in MIDI driver (STMIDI) does not work.
+- The Atari built-in MIDI driver (STMIDI) does not work.
- FLAC, OGG and MP3 decoding libraries are extremely CPU intensive and greatly slow down the user experience. ScummVM is best run with uncompressed audio, when available.
-- While all supported engines are included in the Atari ScummVM release, not all games will run well due to the lack of resources. For example, the Curse of Monkey Island will run on a CT60-equipped Atari Falcon, but very poorly.
\ No newline at end of file
+- While all supported engines are included in the Atari ScummVM release, not all games will run well due to the lack of resources. For example, the Curse of Monkey Island will run on a CT60-equipped Atari Falcon, but very poorly.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/ios.rst b/doc/docportal/other_platforms/ios.rst
index 3882891bbc..0e5016b3a0 100644
--- a/doc/docportal/other_platforms/ios.rst
+++ b/doc/docportal/other_platforms/ios.rst
@@ -8,18 +8,18 @@ This page contains all the information you need to get ScummVM up and running on
Installing ScummVM
=====================
-There are two ways to install ScummVM on an iOS device, and the method you use depends on whether or not the device has custom firmware installed.
+There are two ways to install ScummVM on an iOS device, and the method you use depends on whether or not the device has custom firmware installed.
Devices without custom firmware
************************************
-To installing ScummVM on an iOS device without custom firmware you need to build the app from the source code, and then install it on your device. While a basic knowledge of the command line would be useful, the following instructions, if followed carefully, can be completed by anyone.
+To installing ScummVM on an iOS device without custom firmware you need to build the app from the source code, and then install it on your device. While a basic knowledge of the command line would be useful, the following instructions, if followed carefully, can be completed by anyone.
What you'll need
^^^^^^^^^^^^^^^^^^^^
- 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.
+- 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://downloads.scummvm.org/frs/build/scummvm-ios7-libs-v2.zip>`_ downloaded, and the zip file extracted.
.. note::
@@ -39,7 +39,7 @@ The first step is to download the repository containing the code required to bui
To view the Home directory in the Finder, select **Go > Home** in the menu bar, or press :kbd:`command+shift+H`.
-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 also installs the command line tools required.
+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 also installs the command line tools required.
Create a new directory called ``build`` at the same level as the repository you just cloned, using either the Finder, or the command line as follows:
@@ -47,13 +47,13 @@ Create a new directory called ``build`` at the same level as the repository you
mkdir build
-Copy the contents of the ``scummvm-ios7-libs-v2`` folder you extracted earlier into the ``build`` directory, using either the Finder, or the command line as follows:
+Copy the contents of the ``scummvm-ios7-libs-v2`` folder you extracted earlier into the ``build`` directory, using either the Finder, or the command line as follows:
.. code-block::
cp -r ~/Downloads/scummvm-ios7-libs-v2/* ~/build/
-If your downloaded iOS library folder is not in the Downloads folder as it is in the preceding example, change the path to where the folder actually is.
+If your downloaded iOS library folder is not in the Downloads folder as it is in the preceding example, change the path to where the folder actually is.
Now let's change the present working directory and then set up the tools required to create the Xcode project:
@@ -85,7 +85,7 @@ The resulting directory structure looks like this:
Home
|--scummvm
'--build
- |-- include
+ |-- include
|-- lib
|-- engines
'-- scummvm.xcodeproj
@@ -100,25 +100,25 @@ Open the ``scummvm.xcodeproj`` file from the Finder, or from the command line:
Step 3: Building the ScummVM app
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-When Xcode is open, connect a device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then select the device you just connected. You will need to "Trust" the device for it to show up on the list of connected devices.
+When Xcode is open, connect a device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then select the device you just connected. You will need to "Trust" the device for it to show up on the list of connected devices.
.. figure:: ../images/ios/choose_device.gif
-
-The last step before building ScummVM 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** there is a field labeled **Bundle Identifier**. Enter a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
+
+The last step before building ScummVM 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** there is a field labeled **Bundle Identifier**. Enter 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.
+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. Click **Add an Account** in the dropdown menu.
-In the upper left-hand corner, press the play button to build ScummVM. When the build is finished, it launches on your connected device.
+In the upper left-hand corner, press the play button to build ScummVM. When the build is finished, it launches on your connected device.
If ScummVM does not launch and you get an error message advising that the app failed to launch due to an invalid code signature, inadequate entitlements or because its profile has not been explicitly trusted by the user, you need to trust the apps that you have built. On your iOS device, go to **Settings > General > Device Management > Developer App > Trust "Apple Development:yourAppleIDhere" > Trust**.
@@ -140,31 +140,31 @@ Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and down
Ensure the package is saved somewhere in the ``/var/mobile/`` directory. It defaults to ``/var/mobile/Documents/``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
-Restart your device for the install to complete.
+Restart your device for the install to complete.
-Transferring game files
+Transferring game files
========================
-There are multiple ways to transfer game files to your iOS device.
+There are multiple ways to transfer game files to your iOS device.
-ScummVM has built-in cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
+ScummVM has built-in cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
.. note::
ScummVM's cloud functionality does not currently support iCloud, however you can 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 the folder containing the game files into the **ScummVM** folder. For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
+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 the folder containing the game files into the **ScummVM** folder. For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
.. image:: ../images/ios/ios_transfer_files.gif
-
-See :doc:`../use_scummvm/game_files` for more information about game file requirements.
+
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
============
-.. csv-table::
- :widths: 40 60
+.. csv-table::
+ :widths: 40 60
:header-rows: 2
Game Controller Mapping,
@@ -173,20 +173,20 @@ Controls
:ref:`twofinger`, Right mouse click
:ref:`twofingerdouble`,ESC
Two finger swipe (bottom to top), Toggles `Click and drag mode`_
- Two finger swipe (left to right),Toggles between touch direct mode and touchpad mode.
- Two finger swipe (top to bottom),Global Main Menu
- Three finger swipe, Arrow keys
-
+ Two finger swipe (left to right),Toggles between touch direct mode and touchpad mode.
+ Two finger swipe (top to bottom),Global Main Menu
+ Three finger swipe, Arrow keys
+
Pinch gesture, Enables/disables keyboard
Keyboard spacebar, Pause
-
+
Touch controls
*******************
The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
- When touchpad mouse mode is off, the touch controls are direct. The pointer jumps to where the finger touches the screen.
- - 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.
+ - 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.
.. _twofinger:
@@ -194,7 +194,7 @@ The touch control scheme can be switched in the global settings. From the Launch
Two finger tap
^^^^^^^^^^^^^^^^^^^^^
-For a two finger tap, hold one finger down and then tap with a second finger.
+For a two finger tap, hold one finger down and then tap with a second finger.
.. _twofingerdouble:
@@ -209,7 +209,7 @@ Click and drag mode
Simulates a left mouse click when you touch the screen. The mouse pointer drags to wherever you slide your finger, and releases where you lift your finger.
-If you press down a second finger in this mode, it releases the simulated left mouse button, and presses down the simulated right mouse button. The right mouse button is released when you lift your finger again.
+If you press down a second finger in this mode, it releases the simulated left mouse button, and presses down the simulated right mouse button. The right mouse button is released when you lift your finger again.
Keyboard
^^^^^^^^^^^^^^^^^^^^
@@ -221,9 +221,9 @@ Paths
Saved games
**************
-``/var/mobile/Library/ScummVM/Savegames/`` if the device is jailbroken, or ``Savegames/`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
+``/var/mobile/Library/ScummVM/Savegames/`` if the device is jailbroken, or ``Savegames/`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
Configuration file
*********************
-``/var/mobile/Library/ScummVM/Preferences`` if the device is jailbroken, or ``Preferences`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
\ No newline at end of file
+``/var/mobile/Library/ScummVM/Preferences`` if the device is jailbroken, or ``Preferences`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/nintendo_3ds.rst b/doc/docportal/other_platforms/nintendo_3ds.rst
index 46bd8685ec..af9db0db5b 100644
--- a/doc/docportal/other_platforms/nintendo_3ds.rst
+++ b/doc/docportal/other_platforms/nintendo_3ds.rst
@@ -7,34 +7,34 @@ This page contains all the information you need to get ScummVM up and running on
What you'll need
===================
-- A Nintendo 3DS with a Homebrew Launcher or custom firmware. How to enable homebrew is outside the scope of this documentation.
+- A Nintendo 3DS with a Homebrew Launcher or custom firmware. How to enable homebrew is outside the scope of this documentation.
Installing ScummVM
======================================
-Download the Nintendo 3DS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Extract the archive.
+Download the Nintendo 3DS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Extract the archive.
-There are two ways to install ScummVM: using the 3DSX format, or the CIA format.
+There are two ways to install ScummVM: using the 3DSX format, or the CIA format.
Using the 3DSX format
***********************
-Copy the extracted files to your SD card into the ``/3ds/scummvm`` directory.
+Copy the extracted files to your SD card into the ``/3ds/scummvm`` directory.
-Launch ScummVM using the Homebrew Launcher.
+Launch ScummVM using the Homebrew Launcher.
Using the CIA format
***********************
Use any CIA installation software to install the ``scummvm.cia`` file.
-The CIA format requires a DSP binary dump saved on your SD card as ``/3ds/dspfirm.cdc``. This is not an optional step, because without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
+The CIA format requires a DSP binary dump saved on your SD card as ``/3ds/dspfirm.cdc``. This is not an optional step, because without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
Transferring game files
========================
-Transfer game folders onto the SD card. The exact location is not important.
+Transfer game folders onto the SD card. The exact location is not important.
-ScummVM for the Nintendo 3DS also has cloud functionality. See :doc:`../use_scummvm/connect_cloud`.
+ScummVM for the Nintendo 3DS also has cloud functionality. See :doc:`../use_scummvm/connect_cloud`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
@@ -45,7 +45,7 @@ Controls
Default control mapping
****************************
-Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. csv-table::
:widths: 50 50
@@ -58,7 +58,7 @@ Controls can also be manually configured in the :doc:`Keymaps tab <../settings/k
â’¶,Left mouse button
â’·,Right mouse button
â“,Opens the virtual keyboard
- â“Ž,ESC
+ â“Ž,ESC
Control Pad,Keypad cursor keys
L Button,Toggles magnify mode on/off
R Button,Toggles between hover/drag modes
@@ -70,7 +70,7 @@ Controls can also be manually configured in the :doc:`Keymaps tab <../settings/k
Hover mode
************
-When using the touchscreen, hover mode simulates the movement of the mouse. You can click with taps, however you can't drag or hold down a mouse button unless you use the buttons mapped to the right/left mouse buttons.
+When using the touchscreen, hover mode simulates the movement of the mouse. You can click with taps, however you can't drag or hold down a mouse button unless you use the buttons mapped to the right/left mouse buttons.
Drag mode
**************
@@ -93,15 +93,15 @@ Magnify mode can only be used when the following conditions are met:
Magnify mode cannot be used in the Launcher menu.
-Paths
+Paths
=======
-Saved games
+Saved games
*******************
``sdmc:/3ds/scummvm/saves/``
-Configuration file
+Configuration file
**************************
``sdmc:/3ds/scummvm/scummvm.ini``
@@ -110,14 +110,14 @@ Configuration file
Settings
==========
-For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
+For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
The 3DS config menu
*********************
.. figure:: ../images/3ds/config.png
- The 3DS config menu.
+ The 3DS config menu.
Show mouse cursor
Toggles a visible mouse cursor on/off.
@@ -126,25 +126,25 @@ Stretch to fit
Stretches the image to fit the screen
Snap to edges
- The 3DS touch screen has difficulty reaching the very end of the screen. With this option enabled, if you're within a few pixels of the edge the cursor snaps to the edge.
-
+ The 3DS touch screen has difficulty reaching the very end of the screen. With this option enabled, if you're within a few pixels of the edge the cursor snaps to the edge.
+
Use Screen:
Sets whether ScummVM uses the **Top**, **Bottom** or **Both** screens.
-
+
C-Pad Sensitivity
- Sets the sensitivity of the Circle Pad.
+ Sets the sensitivity of the Circle Pad.
Audio
******
Supported audio file formats:
-- MP3
-- OGG
+- MP3
+- OGG
- OGG
- Uncompressed audio
Known issues
==============
-Some games are not playable due to the slow CPU speed on the 3DS. If there are any games that run really slowly, this is considered a hardware limitation, not a bug.
+Some games are not playable due to the slow CPU speed on the 3DS. If there are any games that run really slowly, this is considered a hardware limitation, not a bug.
diff --git a/doc/docportal/other_platforms/nintendo_switch.rst b/doc/docportal/other_platforms/nintendo_switch.rst
index 0316da5ae4..91ff2290c6 100644
--- a/doc/docportal/other_platforms/nintendo_switch.rst
+++ b/doc/docportal/other_platforms/nintendo_switch.rst
@@ -14,17 +14,17 @@ Installing ScummVM
The Nintendo Switch package is available for download on the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_.
-Download the zip file to a computer, and extract the files.
+Download the zip file to a computer, and extract the files.
-Copy the extracted ``scummvm`` folder to your Nintendo Switch microSD card, into the ``/switch/`` folder.
+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.
+Copy the folders containing game files into the ``/switch/scummvm/`` folder on the microSD card.
-ScummVM on the Nintendo switch supports :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
+ScummVM on the Nintendo switch supports :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
@@ -34,7 +34,7 @@ Controls
Default control map
*********************************
-These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |plus| raw:: html
@@ -44,7 +44,7 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M2 8a.75.75 0 01.75-.75h10.5a.75.75 0 010 1.5H2.75A.75.75 0 012 8z"></path></svg>
-.. csv-table::
+.. csv-table::
:header-rows: 1
Button,Action
@@ -55,15 +55,15 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
Directional buttons,"Keypad 'Cursor' Keys"
Directional buttons + R button ,"Diagonal Keypad 'Cursor' Keys"
L button,Game menu (F5)
- R button,Shift
+ R button,Shift
â“Ž,Period
- â“Ž + R button,Space
- â“,Escape
+ â“Ž + R button,Space
+ â“,Escape
â“ + R button,Return
|plus|,Global main menu (GMM)
|minus|,Toggle virtual keyboard
|minus| + R button,AGI predictive input dialog
-
+
.. csv-table::
:header-rows: 2
@@ -74,7 +74,7 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
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::
:header-rows: 2
@@ -98,32 +98,32 @@ For multi-touch gestures, the fingers have to be far enough apart from each othe
The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
- When touchpad mouse mode is off (default), the touch controls are direct. The pointer always jumps to where the finger touches the screen.
- - 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.
+ - 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
^^^^^^^^^^^^^^^^^^^
-Hold down two fingers to initiate a drag-and-drop feature. The two finger drag simulates the left mouse button being held down.
+Hold down two fingers to initiate a drag-and-drop feature. The two finger drag simulates the left mouse button 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 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.
Three finger drag
^^^^^^^^^^^^^^^^^^^^
-Hold down the three fingers to initiate a drag-and-drop feature. The three finger drag simulates the right mouse button being held down.
+Hold down the three fingers to initiate a drag-and-drop feature. The three finger drag simulates the right mouse button being held down.
-Paths
+Paths
=======
-Saved games
+Saved games
*******************
-``/switch/scummvm/saves``
+``/switch/scummvm/saves``
-Configuration file
+Configuration file
**************************
``/switch/scummvm/scummvm.ini``
@@ -131,7 +131,7 @@ Configuration file
Settings
==========
-For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
Audio
******
@@ -145,12 +145,12 @@ Supported devices:
Supported audio file formats:
- MP3
-- OGG
+- OGG
- FLAC
- Uncompressed audio
Controls
*********
-See the `Touch support`_ section.
+See the `Touch support`_ section.
diff --git a/doc/docportal/other_platforms/playstation_3.rst b/doc/docportal/other_platforms/playstation_3.rst
index 8cd9d81659..ae1dd2cd8a 100644
--- a/doc/docportal/other_platforms/playstation_3.rst
+++ b/doc/docportal/other_platforms/playstation_3.rst
@@ -14,26 +14,26 @@ What you'll need
Installing ScummVM
=====================================
-Download the Playstation 3 package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Copy the ``.pkg`` file to a USB drive.
+Download the Playstation 3 package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Copy the ``.pkg`` file to a USB drive.
Plug the USB drive into the PS3. Go to the XMB, then go to **Games > Install Package** to install the ScummVM package.
-To launch ScummVM, go to the XMB, then go to **Games > PlayStation 3 > ScummVM**.
+To launch ScummVM, go to the XMB, then go to **Games > PlayStation 3 > ScummVM**.
Transferring game files
=======================
-Games can be launched from either a USB drive, or from the internal hard drive. The hard drive has better performance.
+Games can be launched from either a USB drive, or from the internal hard drive. The hard drive has better performance.
-To copy game files to the hard drive, use the USB drive, or use ScummVM's :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
+To copy game files to the hard drive, use the USB drive, or use ScummVM's :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
-Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
Default control map
@@ -65,22 +65,22 @@ Default control map
Left stick,Moves pointer
|x|,Left mouse button
|circle|,Right mouse button
- |triangle|,Game menu
+ |triangle|,Game menu
|square|,Esc
- START,Global Main Menu
+ START,Global Main Menu
SELECT,Toggle virtual keyboard
L1 button,AGI predictive input dialog
-Paths
+Paths
=======
-Saved games
+Saved games
*******************
```/hdd0/game/SCUM12000/USRDIR/saves/``
-Configuration file
+Configuration file
**************************
``/hdd0/game/SCUM12000/USRDIR/scummvm.ini``
@@ -88,7 +88,7 @@ Configuration file
Settings
==========
-For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
Audio
*********
diff --git a/doc/docportal/other_platforms/playstation_portable.rst b/doc/docportal/other_platforms/playstation_portable.rst
index 47e571ad72..27d5bff7d9 100644
--- a/doc/docportal/other_platforms/playstation_portable.rst
+++ b/doc/docportal/other_platforms/playstation_portable.rst
@@ -8,25 +8,25 @@ What you'll need
===================
- A homebrew-enabled PSP. How to enable homebrew is outside the scope of this documentation.
-- A computer to download an extract the install files.
+- A computer to download an extract the install files.
Installing ScummVM
=======================================
The PSP package is available for download ScummVM's `Downloads page <https://www.scummvm.org/downloads>`_.
-Download the zip file to a computer, and extract the files.
+Download the zip file to a computer, and extract the files.
-Connect the PSP to the computer by USB cable. Go to **Settings > USB Connection** on the PSP. Ensure the **USB Device** option is set to **Memory Stick**. The computer automatically opens the root folder of the PSP. Alternatively, if you have a Memory Stick adapter, copy the files directly to the Memory Stick.
+Connect the PSP to the computer by USB cable. Go to **Settings > USB Connection** on the PSP. Ensure the **USB Device** option is set to **Memory Stick**. The computer automatically opens 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.
+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.
+Transfer game files onto the PSP as described in the installation section above. They can be copied to any folder; location doesn't matter.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
@@ -36,7 +36,7 @@ Controls
Default control map
*********************************
-These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |square| raw:: html
@@ -56,28 +56,28 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24"><path d="M11.574 3.712c.195-.323.662-.323.857 0l9.37 15.545c.2.333-.039.757-.429.757l-18.668-.006c-.385 0-.629-.422-.428-.758l9.298-15.538zm.429-2.483c-.76 0-1.521.37-1.966 1.111l-9.707 16.18c-.915 1.523.182 3.472 1.965 3.472h19.416c1.783 0 2.879-1.949 1.965-3.472l-9.707-16.18c-.446-.741-1.205-1.111-1.966-1.111z"/></svg>
-.. csv-table::
+.. csv-table::
:header-rows: 2
Game Controller Mapping,
Button,Action
- R button,Modifier key
- L button,ESC
+ R button,Modifier key
+ L button,ESC
Analog stick,Mouse movement
Analog stick + R button,Fine mouse movement
- Directional buttons,Arrow keys
- Directional buttons + R button,Diagonal arrow keys
- |triangle|,Enter
- |x|,Left Mouse Button
- |circle|,Right Mouse Button
+ Directional buttons,Arrow keys
+ Directional buttons + R button,Diagonal arrow keys
+ |triangle|,Enter
+ |x|,Left Mouse Button
+ |circle|,Right Mouse Button
|square|,Period
|square| + R button,Spacebar
- SELECT,Shows/Hides the virtual Keyboard. Hold down with Directional buttons to move the keyboard.
- SELECT + R button ,Shows Image Viewer
+ SELECT,Shows/Hides the virtual Keyboard. Hold down with Directional buttons to move the keyboard.
+ SELECT + R button ,Shows Image Viewer
START,Global Main Menu
- START + R button,F5
+ START + R button,F5
-.. csv-table::
+.. csv-table::
:header-rows: 1
Virtual Keyboard Mode,
@@ -87,9 +87,9 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
L button,Input: numbers/symbols (press to toggle)
Directional buttons,"Selects square of characters (up, down, left or right)"
|triangle| |x| |circle| |square| and L/R buttons,Chooses 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 L/R buttons.
- Analog stick,Moves in a direction (left/right/up/down)
+ Analog stick,Moves in a direction (left/right/up/down)
-.. csv-table::
+.. csv-table::
:header-rows: 1
Image Viewer,
@@ -98,7 +98,7 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
Analog stick,Moves around the image
"L/R buttons + START",Exits image viewer
-.. csv-table::
+.. csv-table::
:header-rows: 1
1st Person Game Mode ,
@@ -108,12 +108,12 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
Directional buttons left/right,Turns left/right
|square| + Directional buttons,F1/F2/F3/F4
|square| + SELECT,Image Viewer
- |square| + START,Esc
+ |square| + START,Esc
Settings
===========================
-For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
Audio
*******
@@ -146,4 +146,4 @@ 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.
-- If the virtual keyboard does not show up on the screen, ensure the ``kbd.zip`` file is in the ``scummvm`` folder.
\ No newline at end of file
+- If the virtual keyboard does not show up on the screen, ensure the ``kbd.zip`` file is in the ``scummvm`` folder.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/playstation_vita.rst b/doc/docportal/other_platforms/playstation_vita.rst
index 6dc7bde8a7..5465aa1f6d 100644
--- a/doc/docportal/other_platforms/playstation_vita.rst
+++ b/doc/docportal/other_platforms/playstation_vita.rst
@@ -14,19 +14,19 @@ Installing ScummVM
The PS Vita package is available for download on the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_.
-Copy the ``.vpk`` to the PS Vita and install it using VitaShell.
+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.
+There are a few ways to transfer game files to the PS Vita.
-Use VitaShell to transfer the files by USB or FTP, or use SD2Vita to transfer the files directly to the microSD card.
+Use VitaShell to transfer the files by USB or FTP, or use SD2Vita to transfer the files directly to the microSD card.
-Folders containing game files can be copied anywhere on the SD card.
+Folders containing game files can be copied anywhere on the SD card.
-ScummVM on the PS Vita supports :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
+ScummVM on the PS Vita supports :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
@@ -37,7 +37,7 @@ Controls
Default control map
*********************************
-These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |square| raw:: html
@@ -56,7 +56,7 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24"><path d="M11.574 3.712c.195-.323.662-.323.857 0l9.37 15.545c.2.333-.039.757-.429.757l-18.668-.006c-.385 0-.629-.422-.428-.758l9.298-15.538zm.429-2.483c-.76 0-1.521.37-1.966 1.111l-9.707 16.18c-.915 1.523.182 3.472 1.965 3.472h19.416c1.783 0 2.879-1.949 1.965-3.472l-9.707-16.18c-.446-.741-1.205-1.111-1.966-1.111z"/></svg>
-.. csv-table::
+.. csv-table::
:widths: 50 50
:header-rows: 2
@@ -66,19 +66,19 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
Left stick + R button,Slow Mouse
|x|,Left mouse click
|circle|,Right mouse click
- Directional buttons,Keypad 'Cursor' Keys
+ Directional buttons,Keypad 'Cursor' Keys
Directional buttons + R button,Diagonal Keypad 'Cursor' Keys
L button,Game menu (F5)
- R button,Shift
+ R button,Shift
|square|,Period (.)
- R button + |square|,Spacebar
- |triangle|,Escape
+ R button + |square|,Spacebar
+ |triangle|,Escape
R button + |triangle|,Return
START,Global main menu (GMM)
SELECT,Toggle virtual keyboard
SELECT + R button,AGI predictive input dialog
-.. csv-table::
+.. csv-table::
:header-rows: 2
"Front Touchscreen Controls, always enabled",
@@ -86,10 +86,10 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
One finger tap,Moves pointer to finger position and left mouse click
Two finger tap,Moves pointer to first finger position and right mouse click
Single finger drag,Moves pointer directly with finger
- `Two finger drag`_ ,Moves pointer while left mouse button is held down (drag-and-drop).
- `Three finger drag`_ ,Moves pointer while right mouse button is held down (drag-and-drop).
+ `Two finger drag`_ ,Moves pointer while left mouse button is held down (drag-and-drop).
+ `Three finger drag`_ ,Moves pointer while right mouse button is held down (drag-and-drop).
-.. csv-table::
+.. csv-table::
:widths: 50 50
:header-rows: 2
@@ -98,8 +98,8 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
One finger tap,Left mouse button click
Two finger tap,Right mouse button click
Single finger drag,"Moves pointer indirectly with finger, pointer speed can be adjusted in control settings"
- `Two finger drag`_,Moves pointer while left mouse button is held down (drag-and-drop).
- `Three finger drag`_ ,Moves pointer while right mouse button is held down (drag-and-drop).
+ `Two finger drag`_,Moves pointer while left mouse button is held down (drag-and-drop).
+ `Three finger drag`_ ,Moves pointer while right mouse button is held down (drag-and-drop).
Keyboard and mouse support
****************************
@@ -121,15 +121,15 @@ Touchpad mouse mode
The touch control scheme can be switched in the global settings. Go to **Options > Control**:
- When **Touchpad mouse mode** is off:
-
- - The touch controls are direct, which means the pointer always jumps to the finger position.
- - The rear touch pad is disabled.
+
+ - The touch controls are direct, which means the pointer always jumps to the finger position.
+ - The rear touch pad 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 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:`Control tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
- - The rear touch pad is enabled.
+ - The rear touch pad is enabled.
The front touchscreen uses the direct mode by default, but this can be changed by editing the :doc:`configuration file <../advanced_topics/configuration_file>` with the following keyword:
@@ -138,36 +138,36 @@ The front touchscreen uses the direct mode by default, but this can be changed b
*frontpanel_touchpad_mode*
-When set to true, the touch controls on the front touchscreen are indirect.
+When set to true, the touch controls on the front touchscreen are indirect.
Two finger tap
^^^^^^^^^^^^^^^^^^^^
-For a two finger tap, hold one finger down and then tap with a second finger.
+For a two finger tap, hold one finger down and then tap with a second finger.
Two finger drag
^^^^^^^^^^^^^^^^^^^
-Hold down two fingers to initiate a drag-and-drop feature. The two finger drag simulates the left mouse button being held down.
+Hold down two fingers to initiate a drag-and-drop feature. The two finger drag simulates the left mouse button 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 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.
Three finger drag
^^^^^^^^^^^^^^^^^^^^
-Hold down the three fingers to initiate a drag-and-drop feature. The three finger drag simulates the right mouse button being held down.
+Hold down the three fingers to initiate a drag-and-drop feature. The three finger drag simulates the right mouse button being held down.
-Paths
+Paths
============================
-Saved games
+Saved games
*******************
-``ux0:/data/scummvm/saves``
+``ux0:/data/scummvm/saves``
-Configuration file
+Configuration file
**************************
``ux0:/data/scummvm/scummvm.ini``
@@ -175,7 +175,7 @@ Configuration file
Settings
===========================
-For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
Audio
******
@@ -183,14 +183,14 @@ Audio
Supported audio file formats:
- MP3
-- OGG
+- OGG
- FLAC
- Uncompressed audio
Controls
*********
-See the `Touch support`_ section.
+See the `Touch support`_ section.
Known Issues
===============
diff --git a/doc/docportal/other_platforms/risc_os.rst b/doc/docportal/other_platforms/risc_os.rst
index 0d2246d4fb..d0e32c3eb3 100644
--- a/doc/docportal/other_platforms/risc_os.rst
+++ b/doc/docportal/other_platforms/risc_os.rst
@@ -2,7 +2,7 @@
RISC OS
=============================
-This page contains all the information you need to get ScummVM up and running on the RISC operating system.
+This page contains all the information you need to get ScummVM up and running on the RISC operating system.
What you'll need
===================
@@ -13,56 +13,55 @@ What you'll need
Installing ScummVM
======================================
-Download the RISC OS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_.
+Download the RISC OS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_.
-Use a tool such as SparkFS to extract the archive. It is important that the archive is not extracted on any other system, because this results in a loss of file type information. ScummVM requires the file type information to run properly.
+Use a tool such as SparkFS to extract the archive. It is important that the archive is not extracted on any other system, because this results in a loss of file type information. ScummVM requires the file type information to run properly.
Transferring game files
=======================
-Copy data files directly from the original discs on machines that have CD and/or floppy drives, or use a USB drive to transfer the files from another system.
+Copy data files directly from the original discs on machines that have CD and/or floppy drives, or use a USB drive to transfer the files from another system.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
-Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common default keyboard shortcuts.
+Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common default keyboard shortcuts.
-Paths
+Paths
=======
-Saved games
+Saved games
*******************
-``<Choices$Write>.ScummVM.Saves``
+``<Choices$Write>.ScummVM.Saves``
-Configuration file
+Configuration file
**************************
-``<Choices$Write>.ScummVM.scummvmrc``
+``<Choices$Write>.ScummVM.scummvmrc``
-The ``<Choices$Write>`` environment variable is usually ``$.!Boot.Choices``.
+The ``<Choices$Write>`` environment variable is usually ``$.!Boot.Choices``.
Settings
==========
-For more information about settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
+For more information about settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
.. _reporter:
-There is one additional configuration option, *enable_reporter*. When set to true in :doc:`../advanced_topics/configuration_file`, log messages are sent to the `!Reporter <http://www.avisoft.force9.co.uk/Reporter.html>`_ application. This is useful mostly for developers.
+There is one additional configuration option, *enable_reporter*. When set to true in :doc:`../advanced_topics/configuration_file`, log messages are sent to the `!Reporter <http://www.avisoft.force9.co.uk/Reporter.html>`_ application. This is useful mostly for developers.
Known issues
==============
-- ScummVM for RISC OS does not have cloud or LAN functionality.
-- FluidSynth is not supported.
-- ScummVM is not compatible with RISC OS 3, 4 or 6.
+- ScummVM for RISC OS does not have cloud or LAN functionality.
+- FluidSynth is not supported.
+- ScummVM is not compatible with RISC OS 3, 4 or 6.
-
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/sega_dreamcast.rst b/doc/docportal/other_platforms/sega_dreamcast.rst
index 9aee4a2636..16b4d91cf0 100644
--- a/doc/docportal/other_platforms/sega_dreamcast.rst
+++ b/doc/docportal/other_platforms/sega_dreamcast.rst
@@ -9,22 +9,22 @@ What you'll need
- A CD-R disc (80min/700mb).
- A CD-RW drive.
-- A computer running Windows.
-- Software to create a bootable disc image, such as `BootDreams <https://dcemulation.org/index.php?title=BootDreams>`_
-- CD burning software such as Nero Burning ROM, ImgBurn or Alcohol120%.
+- A computer running Windows.
+- Software to create a bootable disc image, such as `BootDreams <https://dcemulation.org/index.php?title=BootDreams>`_
+- CD burning software such as Nero Burning ROM, ImgBurn or Alcohol120%.
Running ScummVM
==================================
There are two ways to get ScummVM running on the Dreamcast:
-1. Download the ready-to-go Nero Image and Demos package and burn the extracted ``.nrg`` image to a CD-R using Nero Burning ROM.
+1. Download the ready-to-go Nero Image and Demos package and burn the extracted ``.nrg`` image to a CD-R using Nero Burning ROM.
2. Download the Dreamcast plain files package and use the extracted files to create a custom disc image to burn to a CD-R.
Both packages are available from the ScummVM `Downloads page <https://www.scummvm.org/downloads/>`_
Creating a disc from the Dreamcast Nero Image and Demos package
********************************************************************
-Use Nero Burning ROM to burn the ``.nrg`` file contained in the package to a CD-R disc.
+Use Nero Burning ROM to burn the ``.nrg`` file contained in the package to a CD-R disc.
Creating a disc from the Dreamcast plain files package
********************************************************
@@ -32,13 +32,13 @@ Create a directory on your computer. In this example, the directory is called ``
Copy the downloaded ``SCUMMVM.BIN`` and ``IP.BIN`` files into the ``ScummVMDC`` directory. These are the main boot and engine files required for ScummVM to run.
-The ``.PLG`` files in the plain files package are the plugins that are required to run the games. For the best performance, only include the plugins for games you want to play. For example, if you want to play LucasArts games, include ``SCUMM.PLG``.
+The ``.PLG`` files in the plain files package are the plugins that are required to run the games. For the best performance, only include the plugins for games you want to play. For example, if you want to play LucasArts games, include ``SCUMM.PLG``.
In the plain files package there are also ``.DAT`` files. These files might be listed as required Datafiles on the `Datafiles wiki page <https://wiki.scummvm.org/index.php/Datafiles>`_.
-Copy the required ``.PLG`` and ``.DAT`` files into the root of the ``ScummVMDC`` directory.
+Copy the required ``.PLG`` and ``.DAT`` files into the root of the ``ScummVMDC`` directory.
-Next, make a new directory for each game. In this example, all the required Day of the Tentacle data files have been copied into a subdirectory named ``DOTT``.
+Next, make a new directory for each game. In this example, all the required Day of the Tentacle data files have been copied into a subdirectory named ``DOTT``.
Our file structure now looks like this:
@@ -53,20 +53,20 @@ Our file structure now looks like this:
|-- SCUMM.PLG
`-- SCUMMVM.BIN
-The next step is to create a bootable disc image from the ``ScummVMDC`` folder.
+The next step is to create a bootable disc image from the ``ScummVMDC`` folder.
-Use Bootdreams to create either a Discjuggler, Nero or Alcohol120% disc image.
+Use Bootdreams to create either a Discjuggler, Nero or Alcohol120% disc image.
.. figure:: ../images/dreamcast/bootdreams.png
-1. Choose the preferred disc image type by clicking on the corresponding icon at the top of the window.
+1. Choose the preferred disc image type by clicking on the corresponding icon at the top of the window.
2. Choose the ``ScummVMDC`` folder as the **Selfboot folder**
-3. Enter a title for the disc image in the **CD label** field.
+3. Enter a title for the disc image in the **CD label** field.
4. Leave the **Disc format** as **Audio/Data**
-5. Click **Process** to create the disc image.
+5. Click **Process** to create the disc image.
-To burn the resulting image to disc, use any software capable of using those image formats, such as Nero Burning ROM for NRG, Alcohol120% for MDS, and Padus DiscJuggler or ImgBurn for CDI disc images.
+To burn the resulting image to disc, use any software capable of using those image formats, such as Nero Burning ROM for NRG, Alcohol120% for MDS, and Padus DiscJuggler or ImgBurn for CDI disc images.
.. tip::
@@ -75,16 +75,16 @@ To burn the resulting image to disc, use any software capable of using those ima
.. caution::
- Use the lowest possible burning speed for best results; the Dreamcast is an older system and as such can have problems reading discs burned at high speeds. If available, the 4x speed is ideal. Ensure that you use good quality discs from a reputable manufacturer. If possible, use archival grade discs.
+ Use the lowest possible burning speed for best results; the Dreamcast is an older system and as such can have problems reading discs burned at high speeds. If available, the 4x speed is ideal. Ensure that you use good quality discs from a reputable manufacturer. If possible, use archival grade discs.
Transferring game files
========================
Game files can be included on the same CD as the ScummVM binary file, or on a separate disc.
-The Dreamcast port does not use the normal ScummVM Launcher. It uses its own custom graphical user interface, which automatically scans the disc for games, and adds the games to a games list through ScummVM's built-in autodetection.
+The Dreamcast port does not use the normal ScummVM Launcher. It uses its own custom graphical user interface, which automatically scans the disc for games, and adds the games to a games list through ScummVM's built-in autodetection.
-ScummVM for the Dreamcast supports disc swapping from the GUI. It rescans after a new disc is inserted and repopulates the games list.
+ScummVM for the Dreamcast supports disc swapping from the GUI. It rescans after a new disc is inserted and repopulates the games list.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
@@ -109,26 +109,26 @@ Default control map
â“,5,For boxing in Indiana Jones and the Last Crusade
â“ + Directional pad,"1, 2, 3, 4, 6, 7, 8, 9",For boxing in Indiana Jones and the Last Crusade
-The mouse cursor is controlled with the standard Dreamcast controller. The Dreamcast mouse and keyboard peripherals are also supported.
+The mouse cursor is controlled with the standard Dreamcast controller. The Dreamcast mouse and keyboard peripherals are also supported.
-Paths
+Paths
=======
-Saved games
+Saved games
*****************
-The Visual Memory Unit (VMU) is used to save and load games.
+The Visual Memory Unit (VMU) is used to save and load games.
Autosave is enabled on the Dreamcast, so each game will use some memory blocks (between 2 and 13) for the autosave in save slot 0.
When a game is saved, the VMU beeps, and a prompt is displayed on the screen to let you know that the game has been saved.
-Games are saved and loaded through the built-in game menus.
+Games are saved and loaded through the built-in game menus.
-Configuration file
+Configuration file
*********************
-ScummVM for the Dreamcast does not use a configuration file.
+ScummVM for the Dreamcast does not use a configuration file.
Settings
==========
@@ -138,10 +138,10 @@ There is no way to change ScummVM settings on the Dreamcast.
Known issues
==============
-- The Dreamcast has no external storage medium, and only has 16MB of RAM. As such, the Dreamcast port of ScummVM does not support The Curse of Monkey Island or the Dig. The resources required for these games are too great for the Dreamcast to handle. Full Throttle is not completable.
+- The Dreamcast has no external storage medium, and only has 16MB of RAM. As such, the Dreamcast port of ScummVM does not support The Curse of Monkey Island or the Dig. The resources required for these games are too great for the Dreamcast to handle. Full Throttle is not completable.
-- There is currently no way to manually add games to the games list. The autodetect feature usually works well, but sometimes games will show up on the list twice, incorrect games will show up with the correct game, and, quite rarely, the game will not show up on the list at all.
+- There is currently no way to manually add games to the games list. The autodetect feature usually works well, but sometimes games will show up on the list twice, incorrect games will show up with the correct game, and, quite rarely, the game will not show up on the list at all.
- Some games, for example SPY Fox 1: Dry Cereal, use filenames which are incompatible with the ISO 9660 filesystem standard. The Dreamcast port does not support filename extensions like RockRidge or Joliet, so the CD mastering software needs to be instructed not to change the filenames to comply to ISO 9660, or the engine will not be able to open the files.
diff --git a/doc/docportal/release_notes/release_notes_2.2.0.rst b/doc/docportal/release_notes/release_notes_2.2.0.rst
index eb748ee8bc..ee3752724c 100644
--- a/doc/docportal/release_notes/release_notes_2.2.0.rst
+++ b/doc/docportal/release_notes/release_notes_2.2.0.rst
@@ -1,8 +1,8 @@
======================================
Version 2.2.0 - "Interactive Fantasy"
======================================
-
-
+
+
New games
=============
@@ -11,7 +11,7 @@ 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
@@ -34,7 +34,7 @@ Currently, more than 1600 games are detected and supported.
New ports
==============
- - MorphOS port got a major rewrite.
+ - MorphOS port got a major rewrite.
Engines
===========
@@ -48,55 +48,55 @@ General
- 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.
+ - Major improvements to the keymapper.
BBVS
****************
- Added support for the demo, available from our website.
- - Added support for the Loogie minigame demo.
+ - Added support for the Loogie minigame demo.
Dreamweb
****************
- Added support for Russian fan-translation.
- - Fixed animation speed.
+ - Fixed animation speed.
Illusions
************
- Fixed subtitle speed (set it to max for good speed).
- - Added support for Russian Duckman.
+ - 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).
+ - 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.
+ - Fixed sound looping in some rooms.
Neverhood
**********
- - Added support for bigger demo, available from our website.
+ - 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.
+ - 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.
+ - Fixed random long delays when starting a game.
SCI
****
@@ -116,7 +116,7 @@ SCI
- 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.
+ - The **Prefer digital sound effects** checkbox now works correctly for SCI01/SCI1 games.
SCUMM
**********
@@ -127,38 +127,38 @@ SCUMM
- Added a new GUI option to switch to an alternative NES palette based on the NES Classic.
- Improved colors in Apple IIGS Maniac Mansion.
- Fixed crash when entering garage in Apple IIGS Maniac Mansion.
- - Added support from Classic Full Throttle from Remastered release.
+ - Added support from Classic Full Throttle from Remastered release.
Supernova
**********
- - Improved English translation.
+ - Improved English translation.
Sky
********
- - Fixed syncing of music volume between built-in settings panel and ScummVM configuration.
+ - Fixed syncing of music volume between built-in 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.
+ - Added support for Spanish playable Demo available from our website.
Sword2
**********
- - Added support for Spanish playable Demo available from our website.
+ - Added support for Spanish playable Demo available from our website.
Titanic
**********
- - Fixed Barbot crash after asking what else he needs.
+ - Fixed Barbot crash after asking what else he needs.
Wintermute
************
- - Added subsystem for tracking achievements, implemented for 10+ games.
+ - Added subsystem for tracking achievements, implemented for 10+ games.
Xeen
************
@@ -172,13 +172,13 @@ Xeen
- 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
+ - 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.
+ - Fixed getting perfect score in Zork: Grand Inquisitor.
Ports
=======
@@ -187,7 +187,7 @@ Android port
************************
- Added support for immersive fullscreen mode.
- - Improved keyboard and mouse input.
+ - Improved keyboard and mouse input.
iOS port
************
@@ -195,23 +195,23 @@ 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.
+ - 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.
+ - 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).
+ - 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.
+ - Added a VFP optimized build for newer hardware.
Windows port
****************
diff --git a/doc/docportal/settings/accessibility.rst b/doc/docportal/settings/accessibility.rst
index 287ea4f04a..e4072b97ce 100644
--- a/doc/docportal/settings/accessibility.rst
+++ b/doc/docportal/settings/accessibility.rst
@@ -2,7 +2,7 @@
Accessibility
=================
-Use the Accessibility tab to change accessibility settings.
+Use the Accessibility tab to change accessibility settings.
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
@@ -10,16 +10,16 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the LA
.. figure:: ../images/settings/accessibility.png
- The Accessibility tab in the global settings.
+ The Accessibility tab in the global settings.
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,,,,,,,,,,,,
.. _ttsenabled:
Use Text to Speech
- Enables text to speech. As the pointer is held over any text field in the Launcher it is converted to speech. Use the dropdown list to choose from a variety of voices.
+ Enables text to speech. As the pointer is held over any text field in the Launcher it is converted to speech. Use the dropdown list to choose from a variety of voices.
- *tts_enabled*
+ *tts_enabled*
diff --git a/doc/docportal/settings/audio.rst b/doc/docportal/settings/audio.rst
index c1c5eaf15e..6de95e7faa 100644
--- a/doc/docportal/settings/audio.rst
+++ b/doc/docportal/settings/audio.rst
@@ -4,23 +4,23 @@ Audio
Audio settings are found on four tabs:
-:ref:`Audio <audiotab>` | :ref:`Volume <volumetab>` | :ref:`MIDI <miditab>` | :ref:`MT-32 <mt32tab>`
+:ref:`Audio <audiotab>` | :ref:`Volume <volumetab>` | :ref:`MIDI <miditab>` | :ref:`MT-32 <mt32tab>`
**To change settings globally:**
-
- From the Launcher, select **Options**, then select the applicable tab.
-
+
+ From the Launcher, select **Options**, then select the applicable tab.
+
**To change settings for a specific game:**
-
- From the Launcher, highlight the game in the games list, select **Edit Game**, and then select the applicable tab.
-For a comprehensive look at how to use ScummVM's extensive audio settings, check out our :doc:`../advanced_topics/understand_audio` guide.
+ From the Launcher, highlight the game in the games list, select **Edit Game**, and then select the applicable tab.
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+For a comprehensive look at how to use ScummVM's extensive audio settings, check out our :doc:`../advanced_topics/understand_audio` guide.
+
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
.. _audiotab:
-The Audio tab
+The Audio tab
-----------------
Use the Audio tab to change the sound output for games.
@@ -42,30 +42,30 @@ Use the Audio tab to change the sound output for games.
Preferred device (global settings) or Music device (game-specific settings)
Specifies the device ScummVM uses to output audio. When set to **<default>**, ScummVM automatically chooses 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*
+ *music_driver*
.. _opl:
-AdLib Emulator
+AdLib Emulator
Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the **Preferred device**.
- *opl_driver*
+ *opl_driver*
.. _speechmute:
Text and Speech
- For games with digitized speech, this setting lets the user decide whether to play the game with speech only, subtitles only, or both.
+ For games with digitized speech, this setting lets the user decide whether to play the game with speech only, subtitles only, or both.
- *speech_mute*
+ *speech_mute*
- *subtitles*
+ *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*
+ *talkspeed*
,,,,,,,,,,,,,,,,,,,,,,,,,,,
@@ -87,40 +87,40 @@ Use the Volume tab to set the relative volumes for various in-game sounds.
.. _music:
Music volume
- Adjusts the volume of the music in the game.
+ Adjusts the volume of the music in the game.
- *music_volume*
+ *music_volume*
.. _sfx:
SFX volume
Adjusts the volume of the sound effects in the game.
- *sfx_volume*
+ *sfx_volume*
.. _speechvol:
Speech volume
Adjusts the volume of the digitized speech in the game, if it has any.
- *speech_volume*
+ *speech_volume*
.. _mute:
Mute All
- Mutes all game audio.
+ Mutes all game audio.
- *mute*
+ *mute*
,,,,,,,,,,,,,,,,,,
.. _miditab:
-The MIDI tab
+The MIDI tab
------------------------------
-Use the MIDI tab to change the settings of General MIDI (GM) devices.
+Use the MIDI tab to change the settings of General MIDI (GM) devices.
.. figure:: ../images/settings/MIDI.png
@@ -132,35 +132,35 @@ Use the MIDI tab to change the settings of General MIDI (GM) devices.
.. _gm:
GM Device
- Specifies a preferred General MIDI device, which ScummVM uses if the **Preferred device** is set to **<default>** and General MIDI playback is required.
+ Specifies a preferred General MIDI device, which ScummVM uses if the **Preferred device** is set to **<default>** and General MIDI playback is required.
- *gm_device*
+ *gm_device*
.. _soundfont:
Soundfont
- Specifies the path to a soundfont file, if this is required by the GM device.
+ Specifies the path to a soundfont file, if this is required by the GM device.
- *soundfont*
+ *soundfont*
.. _multi:
Mixed AdLib/MIDI mode
- Combines MIDI music with AdLib sound effects.
+ Combines MIDI music with AdLib sound effects.
- *multi_midi*
+ *multi_midi*
.. _gain:
MIDI gain
Adjusts the relative volume of the MIDI music. This is only supported by some music devices.
-
- *midi_gain*
+
+ *midi_gain*
.. _fluid:
-FluidSynth
+FluidSynth
****************
Opens a new dialog, with three further tabs:
@@ -176,40 +176,40 @@ Opens a new dialog, with three further tabs:
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.
+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.
+ If ticked, reverb is added to the software synthesizer output.
- *fluidsynth_reverb_activate*
+ *fluidsynth_reverb_activate*
.. _revroom:
Room
- Sets the room size, which determines how much reverb there is.
+ Sets the room size, which determines how much reverb there is.
- *fluidsynth_reverb_roomsize*
+ *fluidsynth_reverb_roomsize*
.. _revdamp:
Damp
- Dampens higher-frequency reverb, which produces a warmer sound.
+ Dampens higher-frequency reverb, which produces a warmer sound.
- *fluidsynth_reverb_damping*
+ *fluidsynth_reverb_damping*
.. _revwidth:
Width
- Sets the stereo spread of the reverb signal.
+ Sets the stereo spread of the reverb signal.
- *fluidsynth_reverb_width*
+ *fluidsynth_reverb_width*
.. _revlevel:
-Level
- Sets the reverb output amplitude.
+Level
+ Sets the reverb output amplitude.
*fluidsynth_reverb_level*
@@ -217,49 +217,49 @@ 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.
+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.
+Active
+ If ticked, chorus effects are added to the software synthesizer output.
- *fluidsynth_chorus_activate*
+ *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*
+ *fluidsynth_chorus_nr*
.. _chlevel:
Level
Specifies the output amplitude of the chorus signal.
- *fluidsynth_chorus_level*
+ *fluidsynth_chorus_level*
.. _chspeed:
Speed
Sets the modulation speed of the output, in Hz.
- *fluidsynth_chorus_speed*
+ *fluidsynth_chorus_speed*
.. _chdepth:
Depth
Specifies the modulation depth of the chorus.
- *fluidsynth_chorus_depth*
+ *fluidsynth_chorus_depth*
.. _chwave:
Type
- Specifies the chorus modulation waveform type.
+ Specifies the chorus modulation waveform type.
- *fluidsynth_chorus_waveform*
+ *fluidsynth_chorus_waveform*
,,,,,,,,,,,,,
@@ -269,16 +269,16 @@ _`Misc`
.. _interp:
Interpolation
- Sets the interpolation method used by the software synthesizer.
+ Sets the interpolation method used by the software synthesizer.
- *fluidsynth_misc_interpolation*
+ *fluidsynth_misc_interpolation*
,,,,,,,,,,,,,,,
.. _mt32tab:
-The MT-32 tab
+The MT-32 tab
-----------------
Use the MT-32 tab to change the settings of Roland MT-32 devices.
@@ -293,23 +293,23 @@ Use the MT-32 tab to change the settings of Roland MT-32 devices.
.. _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.
+ 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)**
- Tells ScummVM that the MIDI device is an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500 or other MT-32 device. Note that this cannot be used in conjuntion with the Roland GS device option.
+ Tells ScummVM that the MIDI device is an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500 or other MT-32 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)**
- Tells ScummVM that the MIDI device is 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.
+ Tells ScummVM that the MIDI device is 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.
*enable_gs*
-
+
diff --git a/doc/docportal/settings/cloud.rst b/doc/docportal/settings/cloud.rst
index e99b9b12d5..9b62d672eb 100644
--- a/doc/docportal/settings/cloud.rst
+++ b/doc/docportal/settings/cloud.rst
@@ -4,7 +4,7 @@ Cloud
Use the Cloud tab to manage connected cloud storage services.
-For a comprehensive look at how to use ScummVM's built-in cloud functionality, check out our :doc:`../use_scummvm/connect_cloud` guide.
+For a comprehensive look at how to use ScummVM's built-in cloud functionality, check out our :doc:`../use_scummvm/connect_cloud` guide.
From the Launcher, select **Options**, click the **>** scroll arrow until the Cloud tab is visible, and then select the **Cloud** tab.
@@ -17,20 +17,20 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the Cl
,,,,,,,,,,,,,,,,,,,,,
Active storage
- Choose from Dropbox, OneDrive, Google Drive, or Box.
+ Choose from Dropbox, OneDrive, Google Drive, or Box.
After a Cloud service has been selected, further options are available:
Sync Now
- Manually syncs saved games with the cloud service. Saved games automatically sync on launch, after saving, and on game load.
+ Manually syncs saved games with the cloud service. Saved games automatically sync on launch, after saving, and on game load.
Download game files
Downloads game files from your Cloud ScummVM folder.
Disconnect
- Disconnects the cloud storage account. To change accounts, disconnect and connect a new account.
+ Disconnects the cloud storage account. To change accounts, disconnect and connect a new account.
.. note::
- Cloud functionality is not supported on all platforms.
+ Cloud functionality is not supported on all platforms.
diff --git a/doc/docportal/settings/control.rst b/doc/docportal/settings/control.rst
index 2dc2899fe1..3236d13208 100644
--- a/doc/docportal/settings/control.rst
+++ b/doc/docportal/settings/control.rst
@@ -2,7 +2,7 @@
Control
=================
-Use the Control tab to change settings for joysticks, game controllers, and touch screens. This tab is not always available.
+Use the Control tab to change settings for joysticks, game controllers, and touch screens. This tab is not always available.
From the Launcher, select **Options**, and then select the **Control** tab.
@@ -10,14 +10,14 @@ From the Launcher, select **Options**, and then select the **Control** tab.
The Control tab in the global settings
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,
.. _mousespeed:
-Pointer Speed
- Sets the speed for the mouse pointer, when it is controlled by the keyboard or a joystick.
+Pointer Speed
+ Sets the speed for the mouse pointer, when it is controlled by the keyboard or a joystick.
*kbdmouse_speed*
@@ -32,4 +32,4 @@ Show on-screen control
Toggles the small on-screen keyboard icon on and off.
Touchpad mouse mode
- Toggles between direct mode and touchpad mode.
\ No newline at end of file
+ Toggles between direct mode and touchpad mode.
\ No newline at end of file
diff --git a/doc/docportal/settings/engine.rst b/doc/docportal/settings/engine.rst
index 52c99b62f0..14f6809c16 100644
--- a/doc/docportal/settings/engine.rst
+++ b/doc/docportal/settings/engine.rst
@@ -2,12 +2,12 @@
Engine
=====================
-Use the Engine tab to change settings that are unique to the game being played.
+Use the Engine tab to change settings that are unique to the game being played.
-From the Launcher, highlight a game on the games list, select **Edit Game**, and then select the **Engine** tab. This tab is not available for all games.
+From the Launcher, highlight a game on the games list, select **Edit Game**, and then select the **Engine** tab. This tab is not available for all games.
To find out which engine powers your game, have a look at the ScummVM Supported Games `wiki page
-<https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_.
+<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_ |
@@ -15,7 +15,7 @@ Engines: ADL_ | AGI_ | BLADERUNNER_ | CGE_ | CINE_ | DRASCULA_ | DREAMWEB_ | HDB
The Engine tab in the game-specific settings
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,,,,,,
@@ -29,28 +29,28 @@ ADL
TV emulation
Emulates the composite output to an NTSC TV.
- *ntsc*
+ *ntsc*
.. _color:
Color Graphics
Uses color graphics instead of monochrome graphics.
- *color*
+ *color*
.. _scan:
Show scanlines
Darkens every other scanline to mimic the look of a CRT display.
- *scanlines*
+ *scanlines*
.. _mono:
Always use sharp monochrome text
Does not emulate NTSC artifacts for text.
- *monotext*
+ *monotext*
,,,,,,,,,
@@ -62,23 +62,23 @@ AGI
.. _osl:
Use original save/load screens
- Uses the original save/load screens instead of the ScummVM screens.
+ Uses the original save/load screens instead of the ScummVM screens.
- *originalsaveload*
+ *originalsaveload*
.. _altamiga:
Use an alternative palette
Uses an alternative palette, common to all Amiga games.
- *altamigapalette*
+ *altamigapalette*
.. _support:
Mouse support
Enables mouse support for movement and in game menus.
- *mousesupport*
+ *mousesupport*
.. _herc:
@@ -92,16 +92,16 @@ Use Hercules hires font
Pause when entering commands
Shows a command prompt window and pauses the game, instead of a real-time prompt.
- *commandpromptwindow*
+ *commandpromptwindow*
.. _2gs:
Add speed menu
Adds a game speed menu, similar to the PC version.
- *apple2gs_speedmenu*
+ *apple2gs_speedmenu*
-,,,,,,
+,,,,,,
.. _BLADERUNNER:
@@ -113,35 +113,35 @@ BLADERUNNER
Sitcom mode
Adds laughter after the actor's line or narration.
- *sitcom*
+ *sitcom*
.. _shorty:
Shorty mode
Shrinks the actors and makes their voices high pitched.
- *shorty*
+ *shorty*
.. _nodelay:
Frame limiter high performance mode
Avoids use of ``delayMillis()`` function. This mode might result in high CPU usage.
- *nodelaymillisfl*
+ *nodelaymillisfl*
.. _fpsfl:
Max frames per second limit
Targets a maximum of 120 frames per second (fps). When disabled, the game targets 60 fps.
- *frames_per_secondfl*
+ *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*
+ *disable_stamina_drain*
,,,,,,,,
@@ -155,7 +155,7 @@ CGE
Color Blind Mode
Enables Color Blind Mode by default.
- *enable_color_blind*
+ *enable_color_blind*
,,,,,,
@@ -165,16 +165,16 @@ CINE
*********
Use original save/load screen
- Uses the original save/load screens instead of the ScummVM screens.
+ Uses the original save/load screens instead of the ScummVM screens.
- *originalsaveload*
+ *originalsaveload*
.. _transparentdialog:
Use transparent dialog boxes in 16 color scenes
Uses transparent dialog boxes in 16 color scenes even if the original game version did not support them.
- *transparentdialogboxes*
+ *transparentdialogboxes*
,,,,,,,,,
@@ -184,9 +184,9 @@ DRASCULA
*************
Use original save/load screens
- Uses the original save/load screens instead of the ScummVM screens.
+ Uses the original save/load screens instead of the ScummVM screens.
- *originalsaveload*
+ *originalsaveload*
,,,,,,,,,,
@@ -196,16 +196,16 @@ DREAMWEB
**********
Use original save/load screens
- Uses the original save/load screens instead of the ScummVM screens.
+ Uses the original save/load screens instead of the ScummVM screens.
- *originalsaveload*
+ *originalsaveload*
.. _bright:
Use bright palette mode
Displays graphics using the game's bright palette.
- *bright_palette*
+ *bright_palette*
,,,,,,,,,,
@@ -219,7 +219,7 @@ HDB
Enable cheat mode
Enables debug info and level selection.
- *hypercheat*
+ *hypercheat*
,,,,,,,,,,
@@ -233,7 +233,7 @@ HOPKINS
Gore Mode
Enables Gore Mode when available.
- *enable_gore*
+ *enable_gore*
,,,,,,,,,,
@@ -247,54 +247,54 @@ KYRA
Enable studio audience
Studio audience adds an applause and cheering sounds whenever Malcolm makes a joke.
- *studio_audience*
+ *studio_audience*
.. _skipsupport:
Skip support
Lets the user skip text and cutscenes.
- *skip_support*
+ *skip_support*
.. _helium:
Enable helium mode
Makes characters sound like they inhaled Helium.
- *helium_mode*
+ *helium_mode*
.. _smooth:
Enable smooth scrolling when walking
Makes scrolling smoother when changing from one screen to another.
- *smooth_scrolling*
+ *smooth_scrolling*
.. _floating:
Enable floating cursors
Changes the cursor when it floats to the edge of the screen to a directional arrow. Click to walk in that direction.
- *floating_cursors*
+ *floating_cursors*
Suggest save names
Fills in an autogenerated save game description into the input prompt.
- *auto_savenames*
-
+ *auto_savenames*
+
.. _hp:
HP bar graphs
Enables hit point bar graphs.
- *hpbargraphs*
+ *hpbargraphs*
.. _btswap:
Fight Button L/R Swap
Swaps the buttons so that the left button attacks, and the right button picks up items.
- *mousebtswap*
+ *mousebtswap*
,,,,,,,,,,
@@ -309,7 +309,7 @@ LURE
TTS Narrator
Uses text-to-speech to read the descriptions, if text-to-speech is available.
- *tts_narrator*
+ *tts_narrator*
,,,,,,,,,,
@@ -321,37 +321,37 @@ MADS
.. _easy:
Easy mouse interface
- Shows object names when the mouse pointer is held over the object.
+ Shows object names when the mouse pointer is held over the object.
- *EasyMouse*
+ *EasyMouse*
.. _objanimated:
Animated inventory items
Animates the inventory items.
- *InvObjectsAnimated*
+ *InvObjectsAnimated*
.. _windowanimated:
Animated game interface
Animates the game interface.
- *TextWindowAnimated*
+ *TextWindowAnimated*
.. _naughty:
Naughty game mode
Enables naughty game mode.
- *NaughtyMode*
+ *NaughtyMode*
.. _gdither:
Graphics dithering
Enables graphics dithering.
- *GraphicsDithering*
+ *GraphicsDithering*
,,,,,,,,,,
@@ -361,23 +361,23 @@ NEVERHOOD
************
Use original save/load screens
- Uses the original save/load screens instead of the ScummVM screens.
+ Uses the original save/load screens instead of the ScummVM screens.
- *originalsaveload*
+ *originalsaveload*
.. _skiphall:
Skip the Hall of Records storyboard scenes
Lets the player skip past the Hall of Records storyboard scenes.
- *skiphallofrecordsscenes*
+ *skiphallofrecordsscenes*
.. _scale:
Scale the making of videos to full screen
Scales the making-of videos, so that they use the whole screen.
- *scalemakingofvideos*
+ *scalemakingofvideos*
,,,,,,,,,,
@@ -388,8 +388,8 @@ QUEEN
Alternate intro
Plays the alternate intro for Flight of the Amazon Queen.
-
- *alt_intro*
+
+ *alt_intro*
,,,,,,,,,,,,,,,
@@ -403,28 +403,28 @@ SCI
Skip EGA dithering pass (full color backgrounds)
Skips dithering pass in EGA games. Graphics are shown with full colors.
- *disable_dithering*
+ *disable_dithering*
.. _hires:
Enable high resolution graphics
- Enables high resolution graphics and content.
+ Enables high resolution graphics and content.
- *enable_high_resolution_graphics*
+ *enable_high_resolution_graphics*
.. _blackline:
Enable black-lined video
Draws black lines over videos to increase their apparent sharpness.
- *enable_black_lined_video*
+ *enable_black_lined_video*
.. _hq:
Use high-quality video scaling
Uses linear interpolation when upscaling videos, where possible.
- *enable_hq_video*
+ *enable_hq_video*
.. _larry:
@@ -441,51 +441,51 @@ Prefer digital sound effects
*prefer_digitalsfx*
Use original save/load screens
- Uses the original save/load screens instead of the ScummVM screens.
+ Uses the original save/load screens instead of the ScummVM screens.
- *originalsaveload*
+ *originalsaveload*
.. _fb01:
Use IMF/Yamaha FB-01 for MIDI output
Uses an IBM Music Feature card or a Yamaha FB-01 FM synth module for MIDI output.
- *native_fb01*
+ *native_fb01*
.. _cd:
Use CD audio
Uses CD audio instead of in-game audio, if available.
- *use_cdaudio*
+ *use_cdaudio*
.. _wincursors:
Use Windows cursors
- Uses the Windows cursor (smaller and monochrome) instead of the DOS cursor.
+ Uses the Windows cursor (smaller and monochrome) instead of the DOS cursor.
- *windows_cursors*
+ *windows_cursors*
.. _silver:
Use silver cursors
- Uses the alternate set of silver cursors instead of the normal golden cursors.
+ Uses the alternate set of silver cursors instead of the normal golden cursors.
- *silver_cursors*
+ *silver_cursors*
.. _upscale:
Upscale videos
Upscales videos to double their size
- *enable_video_upscale*
+ *enable_video_upscale*
.. _censor:
-Enable content censoring
+Enable content censoring
Enables the game's built-in optional content censoring.
- *enable_censoring*
+ *enable_censoring*
,,,,,,,,,,
@@ -499,14 +499,14 @@ SCUMM
Show Object Line
Show the names of objects at the bottom of the screen.
- *object_labels*
+ *object_labels*
.. _classic:
Use NES Classic Palette
Uses a more neutral color palette that closely emulates the NES Classic.
- *mm_nes_classic_palette*
+ *mm_nes_classic_palette*
,,,,,,,,,,
@@ -517,49 +517,49 @@ SHERLOCK
Use original load/save screens
Uses the original save/load screens instead of the ScummVM screens.
-
- *originalsaveload*
+
+ *originalsaveload*
.. _fade:
Pixellated scene transitions
- Enables randomized pixel transitions between scenes.
+ Enables randomized pixel transitions between scenes.
- *fade_style*
+ *fade_style*
.. _help:
Don't show hotspots when moving mouse
Only shows hotspot names after you click on a hotspot or action button.
- *help_style*
+ *help_style*
.. _portraits:
Show character portraits
Shows portraits of the characters when the characters converse.
- *portraits_on*
+ *portraits_on*
.. _style:
Slide dialogs into view
Slides UI dialogs into view.
- *window_style*
+ *window_style*
.. _transparentwindows:
Transparent windows
Shows windows with a partially transparent background.
- *transparent_windows*
+ *transparent_windows*
TTS Narrator
Uses text-to-speech to read the descriptions, if text-to-speech is available.
*tts_narrator*
-
+
,,,,,,,,,,
.. _SKY:
@@ -586,7 +586,7 @@ SUPERNOVA
Improved mode
Removes some repetitive actions, and adds the possibility to change verbs by keyboard.
- *improved*
+ *improved*
,,,,,,,,,,
@@ -596,10 +596,10 @@ TOLTECS
**************
Use original save/load screens
- Uses the original save/load screens instead of the ScummVM screens.
+ Uses the original save/load screens instead of the ScummVM screens.
+
+ *originalsaveload*
- *originalsaveload*
-
,,,,,,,,,,
.. _WINTERMUTE:
@@ -612,14 +612,14 @@ WINTERMUTE
Show FPS-counter
Shows the current number of frames per second in the upper left corner.
- *show_fps*
+ *show_fps*
.. _bilinear:
Sprite bilinear filtering (SLOW)
Applies bilinear filtering to individual sprites.
- *bilinear_filtering*
+ *bilinear_filtering*
,,,,,,,,,,
@@ -633,12 +633,12 @@ XEEN
Show item costs in standard inventory mode
Shows item costs in standard inventory mode, which lets the value of items be compared.
- *ShowItemCosts*
+ *ShowItemCosts*
.. _durable:
More durable armor
Armor won't break until character is at -80HP, instead of the default -10HP.
- *DurableArmor*
+ *DurableArmor*
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index 29cdcb8887..4632433bcd 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -5,14 +5,14 @@ Game
Use the Game tab to display and change information about how the game is
identified by ScummVM.
-From the Launcher, highlight a game on the games list, then select **Edit Game**. The **Game** tab is the first tab shown.
+From the Launcher, highlight a game on the games list, then select **Edit Game**. The **Game** tab is the first tab shown.
.. figure:: ../images/settings/game.png
The Game tab in the game-specific settings
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,
@@ -21,25 +21,25 @@ All settings can also be changed in the :doc:`../advanced_topics/configuration_f
**ID**
Shows the short name of the game. This ID can be used for launching the game from the command line.
- *gameid*
+ *gameid*
.. _description:
**Name**
Shows the full title of the game, as well as some basic information such as original platform and language.
-
- *description*
+
+ *description*
.. _lang:
**Language**
- For games that were released with support for multiple languages, this options changes the language of the game. For games that have a single language hardcoded, this option does not change the language of the game, it only affects the subtitles. Select the correct language to ensure that subtitles display correctly, especially for non-English games.
+ For games that were released with support for multiple languages, this options changes the language of the game. For games that have a single language hardcoded, this option does not change the language of the game, it only affects the subtitles. Select the correct language to ensure that subtitles display correctly, especially for non-English games.
- *language*
+ *language*
.. _platform:
**Platform**
Specifies the original platform of the game.
- *platform*
\ No newline at end of file
+ *platform*
\ No newline at end of file
diff --git a/doc/docportal/settings/graphics.rst b/doc/docportal/settings/graphics.rst
index 88e70c8f8c..1cd494ad08 100644
--- a/doc/docportal/settings/graphics.rst
+++ b/doc/docportal/settings/graphics.rst
@@ -2,67 +2,67 @@
Graphics
===============
-Use the Graphics tab to change how games look when they are played.
+Use the Graphics tab to change how games look when they are played.
-**To change settings globally:**
+**To change settings globally:**
- From the Launcher, select **Options**. The **Graphics** tab is the first tab shown.
+ From the Launcher, select **Options**. The **Graphics** tab is the first tab shown.
-**To change settings for a specific game:**
+**To change settings for a specific game:**
- Highlight the game in the games list, select **Edit Game** then select the **Graphics** tab.
+ Highlight the game in the games list, select **Edit Game** then select the **Graphics** tab.
-For a comprehensive look at how to use these settings, check out our :doc:`../advanced_topics/understand_graphics` guide.
+For a comprehensive look at how to use these settings, check out our :doc:`../advanced_topics/understand_graphics` guide.
.. figure:: ../images/settings/graphics.png
The Graphics tab in the global settings
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,
.. _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.
+ 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*
- *gfx_mode*
-
.. _render:
Render mode
Changes how the game is rendered.
- *render_mode*
-
+ *render_mode*
+
.. _stretchmode:
Stretch mode
Changes the way the game is displayed in relation to the window or screen size.
- *stretch_mode*
+ *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.
+ If ticked, corrects the aspect ratio so that games appear the same as they would on original 320x200 resolution displays.
- *aspect_ratio*
+ *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*
+ *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.
+ 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*
+ *filtering*
diff --git a/doc/docportal/settings/keymaps.rst b/doc/docportal/settings/keymaps.rst
index 63cb28be2b..a535eebe36 100644
--- a/doc/docportal/settings/keymaps.rst
+++ b/doc/docportal/settings/keymaps.rst
@@ -2,15 +2,15 @@
Keymaps
===============
-Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or to mouse or joystick buttons.
+Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or to mouse or joystick buttons.
-**To change settings globally:**
+**To change settings globally:**
- From the Launcher, select **Options**, then select the **Keymaps** tab.
+ From the Launcher, select **Options**, then select the **Keymaps** tab.
-**To change settings for a specific game:**
+**To change settings for a specific game:**
- Highlight the game in the games list, select **Edit Game** then select the **Keymaps** tab.
+ Highlight the game in the games list, select **Edit Game** then select the **Keymaps** tab.
.. figure:: ../images/settings/keymaps.png
@@ -21,19 +21,19 @@ Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or to mouse
The Keymaps dropdown options.
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,,,
-Click on the button next to the desired action to add an additional key or button. Click on the **â–¼** dropdown expander for more options.
+Click on the button next to the desired action to add an additional key or button. Click on the **â–¼** dropdown expander for more options.
-If all the mapped keys are not visible, hold the pointer over the button to see all the mapped keys.
+If all the mapped keys are not visible, hold the pointer over the button to see all the mapped keys.
Reset
Resets all keymaps to default.
Reset to defaults
- Resets the keymaps for that action to default.
+ Resets the keymaps for that action to default.
Clear mapping
Clears all keymaps for that action.
@@ -43,9 +43,9 @@ Clear mapping
Global settings
-------------------
-The following are the available global keymap options. Listed in italics are the configuration keywords. For more information, see the :doc:`../advanced_topics/configuration_file` page.
+The following are the available global keymap options. Listed in italics are the configuration keywords. For more information, see the :doc:`../advanced_topics/configuration_file` page.
-Global
+Global
*********
.. _gmm:
@@ -70,7 +70,7 @@ Open Debugger
.. _vmouseup:
Virtual mouse up
- *keymap_global_VMOUSEUP*
+ *keymap_global_VMOUSEUP*
.. _vmousedown:
@@ -89,7 +89,7 @@ Virtual mouse right
.. _vmouseslow:
-Slow down virtual mouse
+Slow down virtual mouse
*keymap_global_VMOUSESLOW*
Graphics
@@ -131,11 +131,11 @@ Increase the scale factor
*keymap_sdl-graphics_SCL+*
Decrease the scale factor
- *keymap_sdl-graphics_SCL-*
+ *keymap_sdl-graphics_SCL-*
.. _FLT1:
-Switch to nearest neighbour scaling
+Switch to nearest neighbour scaling
*keymap_sdl-graphics_FLT1*
.. _FLT2:
@@ -151,7 +151,7 @@ Switch to HQ 2x/3x scaling
.. _FLT4:
Switch to 2XSai scaling
- *keymap_sdl-graphics_FLT4*
+ *keymap_sdl-graphics_FLT4*
.. _FLT5:
@@ -171,9 +171,9 @@ Switch to TV 2x scaling
.. _FLT8:
Switch to DotMatrix scaling
- *keymap_sdl-graphics_FLT8*
+ *keymap_sdl-graphics_FLT8*
-GUI
+GUI
*****
.. _interact:
@@ -187,7 +187,7 @@ Close
.. _guiup:
-Up
+Up
*keymap_gui_UP*
.. _guidown:
@@ -197,7 +197,7 @@ Down
.. _guileft:
-Left
+Left
*keymap_gui_LEFT*
.. _guiright:
@@ -208,19 +208,19 @@ Right
Game settings
-------------------
-The following are the available keymap game-specific keymaps options. Listed in italics are the configuration keywords. For more information, see the :doc:`../advanced_topics/configuration_file` page.
+The following are the available keymap game-specific keymaps options. Listed in italics are the configuration keywords. For more information, see the :doc:`../advanced_topics/configuration_file` page.
Default game keymap
********************
.. _LCLK:
-Left mouse button
- *keymap_engine-default_LCLK*
+Left mouse button
+ *keymap_engine-default_LCLK*
.. _MCLK:
-Middle click
+Middle click
*keymap_engine-default_MCLK*
.. _RCLK:
@@ -235,7 +235,7 @@ Pause
.. _menu:
-Game menu
+Game menu
keymap_engine-default_MENU
.. _skip:
@@ -245,35 +245,35 @@ Skip
.. _SKLI:
-Skip line
+Skip line
*keymap_engine-default_SKLI*
.. _PIND:
-Predictive input dialog
+Predictive input dialog
*keymap_engine-default_PIND*
.. _RETURN:
-Confirm
+Confirm
*keymap_engine-default_RETURN*
.. _up:
-Up
+Up
*keymap_engine-default_UP*
.. _down:
-Down
+Down
*keymap_engine-default_DOWN*
.. _left:
-Left
+Left
*keymap_engine-default_LEFT*
.. _right:
-Right
+Right
*keymap_engine-default_RIGHT*
\ No newline at end of file
diff --git a/doc/docportal/settings/lan.rst b/doc/docportal/settings/lan.rst
index bb98c74483..74d4b0075f 100644
--- a/doc/docportal/settings/lan.rst
+++ b/doc/docportal/settings/lan.rst
@@ -2,9 +2,9 @@
LAN
==============
-Use the LAN tab to control the Local Area Network (local web server).
+Use the LAN tab to control the Local Area Network (local web server).
-For a comprehensive look at how to use ScummVM's built-in LAN functionality, check out our :doc:`../use_scummvm/LAN` guide.
+For a comprehensive look at how to use ScummVM's built-in LAN functionality, check out our :doc:`../use_scummvm/LAN` guide.
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
@@ -13,27 +13,27 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the LA
The LAN tab in the global settings
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
Run server
- Starts the web server. When running, this displays the URL at which the web server can be accessed.
+ Starts the web server. When running, this displays the URL at which the web server can be accessed.
Stop server
- Stops the web server.
+ Stops the web server.
.. _serverport:
Server's port
- The port on which the web server is available.
-
- *local_server_port*
+ The port on which the web server is available.
+
+ *local_server_port*
.. _rootpath:
-/root/ Path
- Specifies the root path of the server. Any sub-directories will be accessible.
+/root/ Path
+ Specifies the root path of the server. Any sub-directories will be accessible.
- *rootpath*
+ *rootpath*
diff --git a/doc/docportal/settings/misc.rst b/doc/docportal/settings/misc.rst
index b836f25d45..f2ce48fcdc 100644
--- a/doc/docportal/settings/misc.rst
+++ b/doc/docportal/settings/misc.rst
@@ -10,7 +10,7 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the Mi
The Misc tab in the global settings.
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,
@@ -19,36 +19,36 @@ All settings can also be changed in the :doc:`../advanced_topics/configuration_f
Theme
Changes the visual appearance of the ScummVM Launcher
- *gui_theme*
+ *gui_theme*
GUI Renderer
Defines how the ScummVM GUI is rendered; normal or antialiased.
- *gui_renderer*
+ *gui_renderer*
.. _autosave:
Autosave
- Adjusts the time period between autosaves. The default setting is 5 minutes.
+ Adjusts the time period between autosaves. The default setting is 5 minutes.
- *autosave_period*
+ *autosave_period*
GUI Language
Chooses the language of the ScummVM Launcher.
- *gui_language*
+ *gui_language*
.. _guilanguage:
Switch the ScummVM GUI language to the game language
- If ticked, the Launcher language is the same as the game language.
+ If ticked, the Launcher language is the same as the game language.
- *gui_use_game_language*
+ *gui_use_game_language*
.. _guibrowser:
Use native system file browser
- Uses the system file browser instead of the ScummVM 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
index aebc5d7e65..e17cab6092 100644
--- a/doc/docportal/settings/paths.rst
+++ b/doc/docportal/settings/paths.rst
@@ -4,40 +4,40 @@ Paths
Use the Paths tab to tell ScummVM where to look for files.
-**To change settings globally:**
+**To change settings globally:**
- From the Launcher, select **Options**, then select the **Paths** tab.
+ From the Launcher, select **Options**, then select the **Paths** tab.
-**To change settings for a specific game:**
+**To change settings for a specific game:**
- Highlight the game in the games list, select **Edit Game** then select the **Paths** tab.
+ Highlight the game in the games list, select **Edit Game** then select the **Paths** tab.
.. figure:: ../images/settings/paths.png
The Paths tab in the global settings
-All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,,,
.. _savepath:
Save Path
- Sets the path to the folder in which ScummVM stores saved games. For more information on the default location of saved games, see the :ref:`Save and Load games <savelocation>` page, or the guide for the platform you're using.
-
- *savepath*
+ Sets the path to the folder in which ScummVM stores saved games. For more information on the default location of saved games, see the :ref:`Save and Load games <savelocation>` page, or the guide for the platform you're using.
+
+ *savepath*
.. _themepath:
Theme Path
- Sets the path to the folder in which ScummVM stores additional themes.
+ Sets the path to the folder in which ScummVM stores additional themes.
- *themepath*
+ *themepath*
.. _extra:
Extra Path
- Sets the path to the folder in which ScummVM will look for various extra files. These could include additional datafiles required for certain games, Soundfonts or MT-32 ROMs.
+ Sets the path to the folder in which ScummVM will look for various extra files. These could include additional datafiles required for certain games, Soundfonts or MT-32 ROMs.
- *extrapath*
+ *extrapath*
diff --git a/doc/docportal/use_scummvm/LAN.rst b/doc/docportal/use_scummvm/LAN.rst
index bde2bce442..7f451ca6da 100644
--- a/doc/docportal/use_scummvm/LAN.rst
+++ b/doc/docportal/use_scummvm/LAN.rst
@@ -2,46 +2,46 @@
Using the local web server
==================================
-ScummVM can run a local web server (LAN), to simplify the transfer of game files, saved games and configuration files between devices on the same network. This is a good option if you do not want to use the Cloud, or if ScummVM for your platform does not have cloud functionality.
+ScummVM can run a local web server (LAN), to simplify the transfer of game files, saved games and configuration files between devices on the same network. This is a good option if you do not want to use the Cloud, or if ScummVM for your platform does not have cloud functionality.
-.. note::
+.. note::
- LAN functionality is not supported on all platforms.
+ LAN functionality is not supported on all platforms.
-This guide explains how to set up and run a local web server.
+This guide explains how to set up and run a local web server.
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
-Click **Run server** to start the server.
+Click **Run server** to start the server.
.. figure:: ../images/cloud_and_lan/lan_server_running.png
- The LAN tab, with the server running.
-
+ The LAN tab, with the server running.
+
To access the server, type the URL shown into the address bar of any web browser:
.. figure:: ../images/cloud_and_lan/LAN_server.png
- The server's browser interface.
+ The server's browser interface.
-To download a file, click on the file to open the system download dialog.
+To download a file, click on the file to open the system download dialog.
-To create a new directory, click **Create Directory**.
+To create a new directory, click **Create Directory**.
.. figure:: ../images/cloud_and_lan/LAN_server_new.png
Create a new directory.
-To upload files, click **Upload Files** and select files from the system file browser.
+To upload files, click **Upload Files** and select files from the system file browser.
.. figure:: ../images/cloud_and_lan/LAN_server_upload.png
- Upload files.
+ Upload files.
-To change which files are accessible on the web server, set the **/root/ Path** to the directory containing the files you wish to access. You can access anything inside that directory, but you cannot access its parent directory. On some platforms ScummVM automatically sets the **/root/ Path**, but on some other platforms you need to configure this manually before running the web server for the first time.
+To change which files are accessible on the web server, set the **/root/ Path** to the directory containing the files you wish to access. You can access anything inside that directory, but you cannot access its parent directory. On some platforms ScummVM automatically sets the **/root/ Path**, but on some other platforms you need to configure this manually before running the web server for the first time.
-To stop the web server, click **Stop server** to stop the server, or click **Ok** to close the settings dialog.
+To stop the web server, click **Stop server** to stop the server, or click **Ok** to close the settings dialog.
diff --git a/doc/docportal/use_scummvm/add_play_games.rst b/doc/docportal/use_scummvm/add_play_games.rst
index 1d0848acd8..e09612a22f 100644
--- a/doc/docportal/use_scummvm/add_play_games.rst
+++ b/doc/docportal/use_scummvm/add_play_games.rst
@@ -6,42 +6,42 @@ Adding and playing a game
Where to get the games
=============================
-One of the most frequently asked questions is, "Where do I get the games?!?". If you still have your old floppy discs or CDs lying around, and have a way to read them, then you can use the game files from those original discs.
+One of the most frequently asked questions is, "Where do I get the games?!?". If you still have your old floppy discs or CDs lying around, and have a way to read them, then you can use the game files from those original discs.
-If you haven't had a floppy disc or even a CD in your possession for a while, there is a ScummVM `wiki page <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ dedicated to helping you find some games to play.
+If you haven't had a floppy disc or even a CD in your possession for a while, there is a ScummVM `wiki page <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ dedicated to helping you find some games to play.
.. tip::
ScummVM has an affiliate referrer programme with GOG.com, so if you are going to buy a game, please use this `GOG.com <https://www.gog.com/?pp=22d200f8670dbdb3e253a90eee5098477c95c23d">`_ link to help the project!
-Make sure to check out the `compatibility list <https://www.scummvm.org/compatibility/>`_ on the ScummVM website, and the `Supported Games page <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ and `Platform Overview page <https://wiki.scummvm.org/index.php/Platforms/Overview>`_ on the ScummVM wiki before you buy a game, to ensure it can run with ScummVM.
+Make sure to check out the `compatibility list <https://www.scummvm.org/compatibility/>`_ on the ScummVM website, and the `Supported Games page <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ and `Platform Overview page <https://wiki.scummvm.org/index.php/Platforms/Overview>`_ on the ScummVM wiki before you buy a game, to ensure it can run with ScummVM.
.. _add and play games:
Adding games to the Launcher
==============================
-The following steps explain how to add a game to ScummVM, and assume you have access to the data files for each game. If you're not sure how to access the game data files, see the :doc:`game_files` page.
+The following steps explain how to add a game to ScummVM, and assume you have access to the data files for each game. If you're not sure how to access the game data files, see the :doc:`game_files` page.
1. Run ScummVM to open :doc:`the Launcher <../use_scummvm/the_launcher>`.
-2. In the Launcher window, click **Add Game**. This opens a file browser; either the system file browser or the ScummVM file browser.
+2. In the Launcher window, click **Add Game**. This opens a file browser; either the system file browser or the ScummVM file browser.
.. image:: ../images/Launcher/add_game.png
-To add multiple games at once, click the expander arrow next to **Add Game**, and select **Mass Add**.
+To add multiple games at once, click the expander arrow next to **Add Game**, and select **Mass Add**.
.. image:: ../images/Launcher/mass_add.png
-3. Use the file browser to locate the folder containing the game data files. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Highlight the folder by clicking on it, and then click **Choose**
+3. Use the file browser to locate the folder containing the game data files. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Highlight the folder by clicking on it, and then click **Choose**
.. image:: ../images/Launcher/choose_game_directory.png
:class: with-shadow
.. note::
- The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the system file browser, or its own file browser.
+ The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the system file browser, or its own file browser.
If you are using **Mass Add**, select **Yes** to run the mass game detector. A dialog opens to advise which games were added to the games list.
@@ -50,24 +50,24 @@ If you are using **Mass Add**, select **Yes** to run the mass game detector. A d
.. image:: ../images/Launcher/mass_add_success.png
-Sometimes, ScummVM detects multiple versions of a single game. In this case, highlight the correct version and click **Choose** to continue.
+Sometimes, ScummVM detects multiple versions of a single game. In this case, highlight the correct version and click **Choose** to continue.
.. figure:: ../images/Launcher/choose_version.png
.. caution::
-
- If you are using **Mass Add**, ScummVM adds all versions of a game.
-If you are adding an unknown version of a game, ScummVM is not able to add the game to the games list. An error message appears to warn you that the game has not been added.
+ If you are using **Mass Add**, ScummVM adds all versions of a game.
-4. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should be OK at the default settings. Any settings changed here override the global settings. Click **Ok**.
+If you are adding an unknown version of a game, ScummVM is not able to add the game to the games list. An error message appears to warn you that the game has not been added.
+
+4. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should be OK at the default settings. Any settings changed here override the global settings. Click **Ok**.
.. image:: ../images/Launcher/game_settings.png
:class: with-shadow
.. note::
-
- The **Edit Game** dialog does not open when **Mass Add** is used.
+
+ The **Edit Game** dialog does not open when **Mass Add** is used.
6. Games are now ready to play! To play, highlight a game in the games list and click **Start**, or double-click the game in the games list.
@@ -76,10 +76,10 @@ If you are adding an unknown version of a game, ScummVM is not able to add the g
Games can also be launched directly from the command line. For more information, see the `Command line options <../advanced_topics/command_line>`_ page.
-A note about copyright
+A note about copyright
==============================
-ScummVM has a strict anti-piracy stance and the team wil not tolerate discussions around pirated games in any part of the project, including on the Forum or on Discord.
+ScummVM has a strict anti-piracy stance and the team wil not tolerate discussions around pirated games in any part of the project, including on the Forum or on Discord.
Copy protection screen
************************
diff --git a/doc/docportal/use_scummvm/connect_cloud.rst b/doc/docportal/use_scummvm/connect_cloud.rst
index 760ea43fa1..691ec4d263 100644
--- a/doc/docportal/use_scummvm/connect_cloud.rst
+++ b/doc/docportal/use_scummvm/connect_cloud.rst
@@ -3,17 +3,17 @@ Connecting a cloud service
===============================
-Connecting ScummVM to a cloud storage service provides an easy way of sharing game files and saved games between multiple devices. ScummVM currently supports Dropbox, OneDrive, Google Drive and Box, although only one service can be connected at any one time.
+Connecting ScummVM to a cloud storage service provides an easy way of sharing game files and saved games between multiple devices. ScummVM currently supports Dropbox, OneDrive, Google Drive and Box, although only one service can be connected at any one time.
-.. note::
+.. note::
- Cloud functionality is not supported on all platforms.
+ Cloud functionality is not supported on all platforms.
-This guide explains how to connect a cloud service to ScummVM.
+This guide explains how to connect a cloud service to ScummVM.
From the Launcher, select **Options**, click the **>** scroll arrow until the Cloud tab is visible, and then select the **Cloud** tab.
-
-Select your preferred cloud storage service from the **Active storage** dropdown.
+
+Select your preferred cloud storage service from the **Active storage** dropdown.
.. figure:: ../images/cloud_and_lan/cloud_storage.png
@@ -23,13 +23,13 @@ Click on the link shown at **1.**, and sign in to your cloud storage account. A
.. warning::
- Do not share this 6-digit code with anyone before you connect your cloud storage account.
+ Do not share this 6-digit code with anyone before you connect your cloud storage account.
For devices without a web browser, navigate to the following ScummVM links on a computer or any other device with a web browser:
`Dropbox <https://cloud.scummvm.org/dropbox>`_ | `OneDrive <https://cloud.scummvm.org/onedrive>`_ | `Google Drive <https://cloud.scummvm.org/gdrive>`_ | `Box <https://cloud.scummvm.org/box>`_
-Copy the 6-digit code, click into the empty field next to **Paste**, and then click **Paste**. Alternatively, for devices without a web browser, manually enter the 6-digit code.
+Copy the 6-digit code, click into the empty field next to **Paste**, and then click **Paste**. Alternatively, for devices without a web browser, manually enter the 6-digit code.
.. figure:: ../images/cloud_and_lan/cloud_connect.png
@@ -37,8 +37,8 @@ Click **3. Connect**. After the next page loads, click **Enable storage**.
.. figure:: ../images/cloud_and_lan/cloud_enable.png
-Saved games sync automatically on launch, when a game is saved, and when a saved game is loaded. Select **Sync now** to manually sync.
+Saved games sync automatically on launch, when a game is saved, and when a saved game is loaded. Select **Sync now** to manually sync.
-To download game files from your cloud ScummVM folder, click **Download game files**.
+To download 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
+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/use_scummvm/game_files.rst b/doc/docportal/use_scummvm/game_files.rst
index e6039f74ba..49488bcfbe 100644
--- a/doc/docportal/use_scummvm/game_files.rst
+++ b/doc/docportal/use_scummvm/game_files.rst
@@ -3,7 +3,7 @@
Handling game files
===========================
-ScummVM needs access to the data files for each game. A comprehensive list of required data files for each game is found on the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page. ScummVM can run the game data files from any directory it has access to, including external media.
+ScummVM needs access to the data files for each game. A comprehensive list of required data files for each game is found on the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page. ScummVM can run the game data files from any directory it has access to, including external media.
.. note::
@@ -20,7 +20,7 @@ ScummVM needs access to the data files for each game. A comprehensive list of re
-For games on floppies or CDs, if the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above. If the data files are not accessible, run the installer on the platform the game was designed for, to extract the game files.
+For games on floppies or CDs, if the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above. If the data files are not accessible, run the installer on the platform the game was designed for, to extract the game files.
For games downloaded from digital distributors or from various `freeware sources <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games#Freeware_Games>`__ run the installer to extract the data files, or if the data files are supplied as a zip file, extract the files.
@@ -37,22 +37,22 @@ Multi-disc games
ScummVM needs access to all the data files, so it will not be able to run directly from a CD if the game has multiple discs. To add a multi-CD game, copy the required data files from the CD to a folder on your hard drive. For a comprehensive list of required files, see the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page.
-As a general guideline, 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 file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.
+As a general guideline, 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 file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.
.. _cdaudio:
CD audio
============
-In most cases, ScummVM can use CD audio directly from the game CD. If you don't always want to insert the game CD to use the CD audio, you can extract the audio tracks from the CD and save them locally:
+In most cases, ScummVM can use CD audio directly from the game CD. If you don't always want to insert the game CD to use the CD audio, you can extract the audio tracks from the CD and save them locally:
-1. Extract the CD audio tracks in WAV or AIFF format.
-2. Convert the tracks to either MP3, FLAC or OGG file formats.
-3. Place the converted audio files in the same folder that contains the other game datafiles.
+1. Extract the CD audio tracks in WAV or AIFF format.
+2. Convert the tracks to either MP3, FLAC or OGG file formats.
+3. Place the converted audio files in the same folder that contains the other game datafiles.
.. tip::
- `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 file formats.
+ `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 file formats.
.. _macgames:
@@ -60,13 +60,13 @@ In most cases, ScummVM can use CD audio directly from the game CD. If you don't
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 file. Some discs shipped with hidden files. To view hidden files in macOS, press :kbd:`Cmd+Shift+.` in a Finder window.
+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 file. Some discs shipped with hidden files. To view hidden files in macOS, press :kbd:`Cmd+Shift+.` in a Finder window.
-Mac uses a different file system to other systems (HFS+), so to access the CD or floppy disc on a Windows or Linux system you need additional software to view and copy the files.
+Mac uses a different file system to other systems (HFS+), so to access the CD or floppy disc on a Windows or Linux system you need additional software to view and copy the files.
-For Windows, `HFS Explorer <http://www.catacombae.org/hfsexplorer/>`_ is a basic and free option, which gives you read-only access to HFS drives. Use the installer rather than the zip file, to ensure it is installed correctly.
+For Windows, `HFS Explorer <http://www.catacombae.org/hfsexplorer/>`_ is a basic and free option, which gives you read-only access to HFS drives. Use the installer rather than the zip file, to ensure it is installed correctly.
-For Linux, hfsplus gives you read-only access to HFS drives. To use hfsplus, use the command line:
+For Linux, hfsplus gives you 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, this is ``/dev/fd0``.
diff --git a/doc/docportal/use_scummvm/how_to_settings.rst b/doc/docportal/use_scummvm/how_to_settings.rst
index 13cd1d35f1..7ada0d9fe1 100644
--- a/doc/docportal/use_scummvm/how_to_settings.rst
+++ b/doc/docportal/use_scummvm/how_to_settings.rst
@@ -6,13 +6,13 @@ 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>`
+: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, select **Options** and then select the tab containing the setting you would like to change.
-To change a setting for just one game, highlight the game in the games list, then select **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 tab, tick **Override global settings**.
+To change a setting for just one game, highlight the game in the games list, then select **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 tab, tick **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.
+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
==========================
diff --git a/doc/docportal/use_scummvm/install_computer.rst b/doc/docportal/use_scummvm/install_computer.rst
index 49d0a544a7..f2c678c4c8 100644
--- a/doc/docportal/use_scummvm/install_computer.rst
+++ b/doc/docportal/use_scummvm/install_computer.rst
@@ -1,26 +1,26 @@
=====================================
-Installing ScummVM
+Installing ScummVM
=====================================
This page explains how to install ScummVM on a computer. For all other platforms, see the relevant :ref:`platform guide <platformspecific>`.
.. tabbed:: Windows
- There are two ways to install ScummVM on Windows: use the installer, or install manually.
+ There are two ways to install ScummVM on Windows: use the installer, or install manually.
.. dropdown:: Installing ScummVM using the installer
:open:
- Download the Windows installer for your operating system from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, and double click the downloaded file. The installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
+ Download the Windows installer for your operating system from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, and double click the downloaded file. The installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
To run ScummVM, either navigate to desktop and double click the ScummVM shortcut, or go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Apps > ScummVM**.
.. dropdown:: Installing ScummVM manually
-
- Download the Windows zip file for your operating system (32bit or 64bit). To extract the files, right-click the folder and select **Extract All**.
- To run ScummVM from the extracted folder, find the ``scummvm.exe`` file and double click it.
+ Download the Windows zip file for your operating system (32bit or 64bit). To extract the files, right-click the folder and select **Extract All**.
+
+ To run ScummVM from the extracted folder, find the ``scummvm.exe`` file and double click it.
.. tabbed:: macOS
@@ -33,19 +33,19 @@ This page explains how to install ScummVM on a computer. For all other platforms
.. note::
- macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. ScummVM is not available from the App Store, so follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
-
+ macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. ScummVM is not available from the App Store, so follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
+
.. tabbed:: Linux
- There are multiple ways to install ScummVM on Linux: use the Snap Store, Flathub or the software repository, or manually install the release binary.
+ There are multiple ways to install ScummVM on Linux: use the Snap Store, Flathub or the software repository, or manually install the release binary.
.. dropdown:: Installing ScummVM using the Snap Store
:open:
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.
+ The ScummVM Snap comes with a selection of freeware games and demos pre-loaded.
Enter the following on the command line to install the ScummVM Snap:
@@ -65,7 +65,7 @@ This page explains how to install ScummVM on a computer. For all other platforms
flatpak install flathub org.scummvm.ScummVM
- Some distributions have the option to install Flatpaks through the graphical desktop interface. Navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ , click the **INSTALL** button and then follow the install process.
+ Some distributions have the option to install Flatpaks through the graphical desktop interface. Navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ , click the **INSTALL** button and then follow the install process.
To run ScummVM, enter the following on the command line:
@@ -75,31 +75,31 @@ This page explains how to install ScummVM on a computer. For all other platforms
To pass :doc:`Command line arguments <../advanced_topics/command_line>`, add them after the Flatpak ``run`` command.
- .. note::
+ .. note::
+
+ The Flatpak version of ScummVM is sandboxed, meaning that any games need to be copied into the Documents folder to be accessible by ScummVM.
- The Flatpak version of ScummVM is sandboxed, meaning that any games need to be copied into the Documents folder to be accessible by ScummVM.
-
.. dropdown:: Installing ScummVM using the software repository
- ScummVM is found in the software repositories of many Linux distributions.
+ ScummVM is found in the software repositories of many Linux distributions.
.. caution::
- The repositories might not contain the most up-to-date version of ScummVM.
+ The repositories might not contain the most up-to-date version of ScummVM.
To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
.. dropdown:: Installing ScummVM using the release binaries
-
+
Binary packages are only released for Debian and Ubuntu. On the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, find and download the ScummVM package that corresponds to your operating system and architecture. To install a DEB package, either double click on the downloaded DEB file to use the graphical installer, or, if that's not available, use the command line.
.. code:: bash
sudo apt install /path/to/downloaded/file.deb
- Replace ``/path/to/downloaded/file.deb`` with the actual path to the downloaded DEB package. The APT software manager handles the installation.
+ Replace ``/path/to/downloaded/file.deb`` with the actual path to the downloaded DEB package. The APT software manager handles the installation.
To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
diff --git a/doc/docportal/use_scummvm/keyboard_shortcuts.rst b/doc/docportal/use_scummvm/keyboard_shortcuts.rst
index e5d5ba7603..078c1f0af8 100755
--- a/doc/docportal/use_scummvm/keyboard_shortcuts.rst
+++ b/doc/docportal/use_scummvm/keyboard_shortcuts.rst
@@ -4,15 +4,15 @@ Keyboard 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_topics/configuration_file>`.
-For game-specific controls, see the `wiki entry <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ for the game you are playing.
+For game-specific controls, see the `wiki entry <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ for the game you are playing.
-Default shortcuts are shown in the table.
+Default shortcuts are shown in the table.
-.. csv-table::
+.. csv-table::
:widths: 30 70
:header-rows: 1
-
+
Shortcut, Description
:kbd:`Ctrl+F5` ,Displays the Global Main Menu
:kbd:`Cmd+q` ,Quit (macOS)
diff --git a/doc/docportal/use_scummvm/save_load_games.rst b/doc/docportal/use_scummvm/save_load_games.rst
index 5a71fd521b..5247c81e55 100644
--- a/doc/docportal/use_scummvm/save_load_games.rst
+++ b/doc/docportal/use_scummvm/save_load_games.rst
@@ -3,7 +3,7 @@
Saving and loading a game
===============================
-This page explains how to save and load a game from the Global Main Menu, or load a game directly from the Launcher.
+This page explains how to save and load a game from the Global Main Menu, or load a game directly from the Launcher.
.. note::
@@ -12,15 +12,15 @@ This page explains how to save and load a game from the Global Main Menu, or loa
Saving a game
==============
-When you're playing a game and you're ready to save, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac) to access the Global Main Menu. Select **Save**.
+When you're playing a game and you're ready to save, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac) to access the Global Main Menu. Select **Save**.
.. figure:: ../images/Launcher/gmm_save.png
- The Global Main Menu (GMM).
+ The Global Main Menu (GMM).
-There are two views: list view and tile view. Click the list and tile icons at the bottom left of the window to toggle between the two.
+There are two views: list view and tile view. Click the list and tile icons at the bottom left of the window to toggle between the two.
-In tile view, click on the **New Save** tile. Enter a description for the game, then click **OK**.
+In tile view, click on the **New Save** tile. Enter a description for the game, then click **OK**.
.. figure:: ../images/Launcher/save_game_tile.png
@@ -28,13 +28,13 @@ In tile view, click on the **New Save** tile. Enter a description for the game,
.. figure:: ../images/Launcher/save_game_tile_desc.png
- Save game decription, tile view.
+ Save game decription, tile view.
In list view, click on a slot to save the game to that slot. Enter a description for the game, then click **Save**.
.. figure:: ../images/Launcher/save_game_list.png
- Saving a game, list view.
+ Saving a game, list view.
Autosave
@@ -47,18 +47,18 @@ Location of saved game files
The save directory can be changed with the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_topics/configuration_file>`.
-Default saved game paths are shown below.
+Default saved game paths are shown below.
.. tabbed:: Windows
.. panels::
:column: col-lg-12 mb-2
- Windows NT4
+ Windows NT4
^^^^^^^^^^^^
- ``C:\WINDOWS\Profiles\username\Application Data\ScummVM\Saved games\``
-
+ ``C:\WINDOWS\Profiles\username\Application Data\ScummVM\Saved games\``
+
---
:column: col-lg-12 mb-2
@@ -80,21 +80,21 @@ Default saved game paths are shown below.
:column: col-lg-12 mb-2
``~/Documents/ScummVM Savegames/``
-
+
.. tabbed:: Linux/Unix
.. panels::
:column: col-lg-12 mb-2
-
+
ScummVM follows the XDG Base Directory Specification, so by default the saved games can be found at ``~/.local/share/scummvm/saves/``, but this location might vary depending on the value of the ``XDG_DATA_HOME`` environment variable.
-
+
``.local`` is a hidden directory. To view it use ``ls -a`` on the command line.
If ScummVM was installed using Snap, the saves can be found at ``~/snap/scummvm/current/.local/share/scummvm/saves/``
-
+
Loading a game
@@ -102,9 +102,9 @@ Loading a game
If you want to load your saved game without having to start the game first, select the **Load** button directly from the Launcher. To load a saved game while you're playing a game, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac) to access the Global Main Menu, then select **Load**.
-There are two views: list view and tile view. Click the list and tile icons at the bottom left of the window to toggle between the two.
+There are two views: list view and tile view. Click the list and tile icons at the bottom left of the window to toggle between the two.
-In list view, the pane on the left shows a list of your saved games. Click on a saved game to highlight it. In the pane on the right you can see timestamps, screenshots and playtime for that saved game.
+In list view, the pane on the left shows a list of your saved games. Click on a saved game to highlight it. In the pane on the right you can see timestamps, screenshots and playtime for that saved game.
Once you have highlighted the game you want to play, click **Load**.
@@ -112,13 +112,13 @@ To delete a saved game, highlight the saved game and click **Delete**.
.. figure:: ../images/Launcher/load_game_list.png
- Loading a game, list view.
+ Loading a game, list view.
In tile view, each tile shows a screenshot of the saved state, as well as a description and a save slot number. Click on the tile to load that saved game.
.. figure:: ../images/Launcher/load_game_tile.png
-
- Loading a game, tile view.
+
+ Loading a game, tile view.
.. _savelocation:
diff --git a/doc/docportal/use_scummvm/the_launcher.rst b/doc/docportal/use_scummvm/the_launcher.rst
index 612fe5f795..01dc0c7bdd 100755
--- a/doc/docportal/use_scummvm/the_launcher.rst
+++ b/doc/docportal/use_scummvm/the_launcher.rst
@@ -5,11 +5,11 @@ Understanding the interface
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.
+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/launcher.png
-
- The Launcher, with labels for each GUI element.
+
+ The Launcher, with labels for each GUI element.
The games list
@@ -23,7 +23,7 @@ The search box
The search box lets you filter the games list. It is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, click **X**.
-There are many ways to filter games. For example, you can type "Monkey Island" to locate all "Monkey Island" games on the list, or you can type "German" to find German games.
+There are many ways to filter games. For example, you can type "Monkey Island" to locate all "Monkey Island" games on the list, or you can type "German" to find German games.
The buttons
************************
@@ -34,32 +34,32 @@ Start
^^^^^^^^
Launches the highlighted game.
-Load
+Load
^^^^^^^
-Opens the load game window, from which you can go to a saved game without having to start the game first.
+Opens the load game window, from which you can go to a saved game without having to start the game first.
See the :doc:`save_load_games` page.
-Add Game
+Add Game
^^^^^^^^^^
-Opens a file browser. To add a game, select a folder containing game files.
+Opens a file browser. To add a game, select a folder containing game files.
See the :doc:`add_play_games` page.
-Edit Game
+Edit Game
^^^^^^^^^^^^
Opens the game settings window. This window also opens whenever a game is added to the games list in the Launcher.
-Use this window to configure settings specific to a game. These settings override the global settings. For more information, see the :doc:`../use_scummvm/how_to_settings` page.
+Use this window to configure settings specific to a game. These settings override the global settings. For more information, see the :doc:`../use_scummvm/how_to_settings` page.
Remove Game
^^^^^^^^^^^^^
-Removes the highlighted game from the list. This does not remove any saved games, so if you add a game to the games list again, you are able to resume where you left off.
+Removes the highlighted game from the list. This does not remove any saved games, so if you add a game to the games list again, you are able to resume where you left off.
Options
@@ -78,7 +78,7 @@ Closes the Launcher and quits the ScummVM application.
The Global Main Menu
=====================
-You can access the ScummVM Global Main Menu, also known as the GMM, while you are playing a game. To open the GMM, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac).
+You can access the ScummVM Global Main Menu, also known as the GMM, while you are playing a game. To open the GMM, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac).
.. figure:: ../images/Launcher/gmm.png
@@ -90,7 +90,7 @@ The buttons
In the Global Main Menu there are a number of buttons. Their functions are as follows:
-Resume
+Resume
^^^^^^^^^^
Closes the GMM and resumes the game.
@@ -103,12 +103,12 @@ Opens the load game window. From here, you can load a saved game.
Save
^^^^^^
-Opens the save game window. From here, you can save a game.
+Opens the save game window. From here, you can save a game.
Options
^^^^^^^^
-Opens a dialog which provides some gameplay options, such as sound volume, subtitle and keymap settings.
+Opens a dialog which provides some gameplay options, such as sound volume, subtitle and keymap settings.
About
@@ -119,18 +119,18 @@ Displays the ScummVM **About** dialog. This is also available from the Launcher.
Help
^^^^^^
-Displays a list of keyboard shortcuts for the game.
+Displays a list of keyboard shortcuts for the game.
Return to Launcher
^^^^^^^^^^^^^^^^^^^^^
-Quits the game and returns to the Launcher.
+Quits the game and returns to the Launcher.
.. note::
-
+
This is not available for all games.
Quit
^^^^^^^
-Quits the game and ScummVM, and returns to the operating system. Any unsaved game progress is lost.
+Quits the game and ScummVM, and returns to the operating system. Any unsaved game progress is lost.
More information about the Scummvm-git-logs
mailing list