thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

DOCS: final drafts

Browse source 
- final drafts Quickstart, Use, Settings, and Advanced topics sections
- renames some files/folders and updates links
This commit is contained in:
cadihowley 2020-11-19 10:31:46 +13:00 • committed by Eugene Sandulenko
parent 13bc6b7774
commit e2ab48e4fd
35 changed files with 320 additions and 224 deletions
Download patch file Download diff file Expand all files Collapse all files

112
doc/docportal/advanced_topics/command_line.rst
View file

@ -48,7 +48,7 @@ To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any o
.. panels::
:column: col-lg-12
The following examples assume that the path to ScummVM is ``C:\Games\LucasArts\scummvm.exe``.
The following examples assume that the path to ScummVM is ``C:``Games``LucasArts``scummvm.exe``.
^^^^
@ -56,7 +56,7 @@ To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any o
.. code-block::
C:\Games\LucasArts\scummvm.exe -f monkey
C:``Games``LucasArts``scummvm.exe -f monkey
@ -64,7 +64,7 @@ To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any o
.. code-block::
C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ft
C:``Games``LucasArts``scummvm.exe -f -n -pD:``resource``ft
.. tabbed:: Linux/Unix
@ -107,60 +107,60 @@ Short options are listed where they are available.
: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>`"
\--auto-detect,,"Displays a list of games from current or specified directory and starts the first one. Use \--path=PATH before \--auto-detect to specify a directory."
\--boot-param=NUM,-b,"Pass number to the boot script (boot param)"
\--cdrom=DRIVE,,"CD drive to play CD audio from; can either be a drive, path, or numeric index (default: 0 = best choice drive)"
\--config=FILE,-c,"Uses alternate configuration file"
\--copy-protection,,"Enables copy protection"
\--debug-channels-only,,"Shows only the specified debug channels"
\--debugflags=FLAGS,,"Enables engine specific debug flags"
\--debuglevel=NUM,-d,"Sets debug verbosity level"
\--demo-mode,,"Starts demo mode of Maniac Mansion or The 7th Guest"
\--detect,,"Displays a list of games with their ID from current or specified directory without adding it to the config. Use \--path=PATH before \--detect to specify a directory."
\--dimuse-tempo=NUM,,"Sets internal Digital iMuse tempo (10 - 100) per second (default: 10)"
\--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>`"
\--filtering,,":ref:`Forces filtered graphics mode <filtering>`"
\--fullscreen,-f,":ref:`Forces full-screen mode <fullscreen>`"
\--game=NAME,,"In combination with \--add or \--detect only adds or attempts to detect the :ref:`game with id NAME <gameid>`."
\--gfx-mode,-g,":ref:`Selects graphics mode <gfxmode>`"
\--gui-theme=THEME,,":ref:`Selects GUI theme <theme>`"
\--help,-h,"Displays a brief help text and exit"
\--joystick=NUM,,"Enables joystick input (default: 0 = first joystick)"
\--language,-q,":ref:`Selects language <lang>` (en, de, fr, it, pt, es, jp, zh, kr, se, gb, hb, ru, cz)"
\--list-audio-devices,,"Lists all available audio devices"
\--list-saves --game=TARGET,,"Displays a list of saved games for the game (TARGET) specified"
\--list-targets,-t,"Displays list of configured targets and exit"
\--list-themes,,"Displays list of all usable GUI themes"
--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>`"
\--music-volume=NUM,-m,":ref:`Sets the music volume <music>`, 0-255 (default: 192)"
\--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"
\--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"
\--render-mode=MODE,,":ref:`Enables additional render modes <render>`"
\--save-slot=NUM,-x,"Specifies the saved game slot to load (default: autosave)"
\--savepath=PATH,,":ref:`Specifies path to where saved games are stored <savepath>`"
\--sfx-volume=NUM,-s,":ref:`Sets the sfx volume <sfx>`, 0-255 (default: 192)"
\--soundfont=FILE,,":ref:`Selects the SoundFont for MIDI playback. <soundfont>`. Only supported by some MIDI drivers."
\--speech-volume=NUM,-r,":ref:`Sets the speech volume <speechvol>`, 0-255 (default: 192)"
\--subtitles,-n,":ref:`Enables subtitles <speechmute>`"
\--talkspeed=NUM,,":ref:`Sets talk speed for games <talkspeed>` (default: 60)"
\--tempo=NUM,,"Sets music tempo (in percent, 50-200) for SCUMM games (default: 100)"
\--themepath=PATH,,":ref:`Specifies path to where GUI themes are stored <themepath>`"
\--version,-v,"Displays ScummVM version information and exits"
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>`"
``--auto-detect``,,"Displays a list of games from the current or specified directory and starts the first game. Use ``--path=PATH`` before ``--auto-detect`` to specify a directory."
``--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"
``--copy-protection``,,"Enables copy protection"
``--debug-channels-only``,,"Shows only the specified debug channels"
``--debugflags=FLAGS``,,"Enables engine specific debug flags"
``--debuglevel=NUM``,``-d``,"Sets debug verbosity level"
``--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)"
``--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>`"
``--filtering``,,":ref:`Forces filtered graphics mode <filtering>`"
``--fullscreen``,``-f``,":ref:`Forces full-screen mode <fullscreen>`"
``--game=NAME``,,"In combination with ``--add`` or ``--detect`` only adds or attempts to detect the :ref:`game with id NAME <gameid>`."
``--gfx-mode``,``-g``,":ref:`Selects graphics mode <gfxmode>`"
``--gui-theme=THEME``,,":ref:`Selects GUI theme <theme>`"
``--help``,``-h``,"Displays a brief help text and exit"
``--joystick=NUM``,,"Enables joystick input (default: 0 = first joystick)"
``--language``,``-q``,":ref:`Selects language <lang>` (en, de, fr, it, pt, es, jp, zh, kr, se, gb, hb, ru, cz)"
``--list-audio-devices``,,"Lists all available audio devices"
``--list-saves --game=TARGET``,,"Displays a list of saved games for the game (TARGET) specified"
``--list-targets``,``-t``,"Displays list of configured targets and exit"
``--list-themes``,,"Displays list of all usable GUI themes"
``--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>`"
``--music-volume=NUM``,``-m``,":ref:`Sets the music volume <music>`, 0-255 (default: 192)"
``--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"
``--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"
``--render-mode=MODE``,,":ref:`Enables additional render modes <render>`"
``--save-slot=NUM``,``-x``,"Specifies the saved game slot to load (default: autosave)"
``--savepath=PATH``,,":ref:`Specifies path to where saved games are stored <savepath>`"
``--sfx-volume=NUM``,``-s``,":ref:`Sets the sfx volume <sfx>`, 0-255 (default: 192)"
``--soundfont=FILE``,,":ref:`Selects the SoundFont for MIDI playback. <soundfont>`. Only supported by some MIDI drivers."
``--speech-volume=NUM``,``-r``,":ref:`Sets the speech volume <speechvol>`, 0-255 (default: 192)"
``--subtitles``,``-n``,":ref:`Enables subtitles <speechmute>`"
``--talkspeed=NUM``,,":ref:`Sets talk speed for games <talkspeed>` (default: 60)"
``--tempo=NUM``,,"Sets music tempo (in percent, 50-200) for SCUMM games (default: 100)"
``--themepath=PATH``,,":ref:`Specifies path to where GUI themes are stored <themepath>`"
``--version``,``-v``,"Displays ScummVM version information and exits"

18
doc/docportal/advanced_topics/configuration_file.rst
View file

@ -5,7 +5,7 @@ Configuration file
The configuration file provides a way to edit both global and game-specific settings. It is a text file containing configuration keywords and parameters.
Settings are also accessible directly from :doc:`the Launcher <../using_scummvm/the_launcher>`. See :doc:`../using_scummvm/how_to_settings`.
Settings are also accessible directly from the Launcher. See :doc:`../use_scummvm/how_to_settings`.
Location
==========
@ -77,13 +77,13 @@ The configuration file saves to different default locations, depending on the pl
.. panels::
:column: col-lg-12 mb-2
We follow the XDG Base Directory Specification, so by default the configuration file can be found at ``/~.config/scummvm/scummvm.ini``, but its location may vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
We follow the XDG Base Directory Specification, so by default the configuration file is found at ``/~.config/scummvm/scummvm.ini``, but its location may vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
If ScummVM was installed using Snap, the configuration file can be 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. Ff you are using a GUI file manager, use the keyboard shortcut :kbd:`Ctrl + H`.
``.config`` is a hidden directory. To view it use ``ls -a`` on the command line, or, if you are using a GUI file manager, press :kbd:`Ctrl + H`.
@ -151,7 +151,7 @@ There are many recognized configuration keywords. In the table below, each keywo
:widths: 35 15 25 25
:header-rows: 1
Keyword,Type,Default,Description or Available options
Keyword,Type,Default,Description/Options
alsa_port,number,,
":ref:`alt_intro <altintro>`",boolean,false,
":ref:`altamigapalette <altamiga>`",boolean,false,
@ -169,7 +169,7 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`autosave_period <autosave>`", integer, 300s
auto_savenames,boolean,false
":ref:`bilinear_filtering <bilinear>`",boolean,false,
boot_param,number,none,
`boot_param <https://wiki.scummvm.org/index.php/Boot_Params>`_,number,none,
":ref:`bright_palette <bright>`",boolean,true,
cdrom,number,,
":ref:`color <color>`",boolean,,
@ -192,8 +192,8 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`enable_high_resolution_graphics <hires>`",boolean,true,
":ref:`enable_hq_video <hq>`",boolean,true,
":ref:`enable_larryscale <larry>`",boolean,true,
":ref:`enable_video_upscale <upscale>`",boolean,true,
":ref:`enable_reporter <reporter>`",boolean,false,RISC OS only.
":ref:`enable_video_upscale <upscale>`",boolean,true,
":ref:`enable_tts <ttsenabled>`",boolean,false,
":ref:`extrapath <extra>`",string,None," path"
":ref:`fade_style <fade>`",boolean,true,
@ -368,7 +368,7 @@ There are many recognized configuration keywords. In the table below, each keywo
- 22050
- 44100"
":ref:`platform <platform>`",string,,
":ref:`portaits_on, <portraits>`",boolean,true,
":ref:`portaits_on <portraits>`",boolean,true,
":ref:`prefer_digitalsfx <dsfx>`",boolean,true,
":ref:`render_mode <render>`",string,,"
- hercGreen
@ -394,7 +394,7 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`ShowItemCosts <cost>`",boolean,false,
":ref:`silver_cursors <silver>`",boolean,false,
":ref:`sitcom <sitcom>`",boolean,false,
":ref:`skip_support <skip>`",boolean,true,
":ref:`skip_support <skipsupport>`",boolean,true,
":ref:`skiphallofrecordsscenes <skiphall>`",boolean,false,
":ref:`smooth_scrolling <smooth>`",boolean,true,
":ref:`speech_mute <speechmute>`",boolean,false,
@ -414,7 +414,7 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`transparentdialogboxes <transparentdialog>`",boolean,false,
":ref:`tts_enabled <ttsenabled>`",boolean,false,
":ref:`tts_narrator <ttsnarrator>`",boolean,false,
":ref:`use_cdaudio <cdaudio>`",boolean,true,
use_cdaudio,boolean,true,
versioninfo,string,,
":ref:`window_style <style>`",boolean,true,
":ref:`windows_cursors <wincursors>`",boolean,false,

27
doc/docportal/advanced_topics/understand_audio.rst
View file

@ -61,10 +61,9 @@ What is MIDI?
MIDI is a communications protocol for musical information; it can be likened to digital sheet music. By itself, MIDI is not sound. Hardware or software synthesizers create (synthesize) audio by interpreting the information given to them via the MIDI protocol.
Some games only contain MIDI audio data. In the past this prevented audio for these games from working on platforms that did not support MIDI, or with soundcards that did not provide MIDI drivers.
ScummVM can now convert MIDI data to sampled audio using MIDI device emulators.
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.
What is General MIDI?
@ -72,6 +71,7 @@ What is General MIDI?
General MIDI is a MIDI standard which is implemented by a large number of devices. While using MIDI as its protocol, it also specifies an instrument map and some other information that devices must implement.
.. _FS:
General MIDI device emulation (FluidSynth)
@ -101,9 +101,9 @@ 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 will also look for ``CM32L_PCM.ROM`` and ``CM32L_CONTROL.ROM`` - the ROMs from the CM-32L device - and will use these instead of the MT32 ROMs if they are available.
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.
ScummVM will use the MT-32 emulator if it is set as the **Preferred device** or **Music device**, or if it is specified in the MT-32 tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses MT-32 output automatically.
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.
@ -119,17 +119,14 @@ The processor requirements for the MT-32 emulator are quite high; a fast CPU is
Native MIDI support
--------------------------
All MIDI ports will show up in the **Preferred device** or **Music device** dropdown selector. If you have selected a MIDI port, you will also need to specify what type of MIDI device this is with the options in the :ref:`MT-32 <mt32>` tab.
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.
- Enabling the **True Roland MT-32** option tells ScummVM that the MIDI device is an MT-32 (or fully compatible) device.
- Enabling **Roland GS device** tells ScummVM to use an MT-32 soundtrack on a GS device. This is not supported by all games.
- If no options are selected, this tells ScummVM that the device is General MIDI.
- 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.
Selecting an option that does not match the MIDI port selected may have unintended consequences; for example, if a game only has support for MT-32 and you have a General MIDI device selected as the **Preferred device** or **Music device**, ScummVM will convert the MT-32 MIDI data to GM-compatible MIDI data. While this may work fine for some games, it really depends on how the game has made use of the MT-32.
If you select an option that does not match the actual device, this may have unintended consequences. For example, if a game only has support for MT-32 and you have a General MIDI device selected as the **Preferred device** or **Music device**, ScummVM will convert the MT-32 MIDI data to GM-compatible MIDI data. While this may work fine for some games, it really depends on how the game has made use of the MT-32.
.. note::
Soundcards or audio interfaces do not necessarily have anything to do with MIDI; while some older soundcards (and a few modern ones) have their own hardware-based synthesizers, it is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
macOS/Mac OSX
@ -142,7 +139,7 @@ The `Apple Support page <https://support.apple.com/en-nz/guide/audio-midi-setup/
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/>`_.
@ -211,7 +208,7 @@ 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>`. 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.

24
doc/docportal/advanced_topics/understand_graphics.rst
View file

@ -17,7 +17,7 @@ Graphics modes
The original game graphics are upscaled using different graphical filters, which are specialized algorithms used to ensure that low resolution pixel-art still looks good when it is displayed at a higher resolution.
If the game originally ran at a resolution of 320x200 - which is typical for most SCUMM games - then using a graphics mode with a scale factor of 2x will yield 640x400 graphics. A 3x scale factor will yield 960x600.
If the game originally ran at a resolution of 320x200—which is typical for most SCUMM games—then using a graphics mode with a scale factor of 2x yields 640x400 graphics. A 3x scale factor yields 960x600.
A comparison of graphics modes
*************************************
@ -75,14 +75,14 @@ Not all engines support all, or even any, of the graphics modes.
There is always a speed penalty when using any form of anti-aliasing/linear filtering.
To switch between graphics modes on the go, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`1` to :kbd:`8`.
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.
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.
.. _aspect:
@ -97,9 +97,9 @@ Older games were designed to be run at 320x200 pixels, but on systems where each
.. figure:: ../images/graphics/aspect_ratio/aspect_ratio.png
Aspect ratio correction applied - notice the moon is actually round now.
Aspect ratio correction applied. Notice the moon is actually round now.
To toggle aspect ratio on and off, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`a`.
To toggle aspect ratio on and off, press :kbd:`Ctrl+Alt+a`.
.. _stretch:
@ -109,13 +109,13 @@ Stretch modes
There are five stretch modes:
- Center - centers the image in the window.
- Pixel-perfect scaling - scales the image to a multiple of the original game resolution as much as possible (for example, 2x, 3x, 4x and so on), and fills the remaining empty space with black borders.
- Fit to window - fits the image to the window, but maintains the aspect ratio and does not stretch it to fill the window.
- Stretch - stretches the image to fill the window
- Fit to window (4:3) - fits the image to the window, at a forced 4:3 aspect ratio.
- Center: centers the image in the window.
- Pixel-perfect scaling: scales the image to a multiple of the original game resolution as much as possible (for example, 2x, 3x, 4x and so on), and fills the remaining empty space with black borders.
- Fit to window: fits the image to the window, but maintains the aspect ratio and does not stretch it to fill the window.
- Stretch: stretches the image to fill the window
- Fit to window (4:3): fits the image to the window, at a forced 4:3 aspect ratio.
To switch between stretch modes on the go, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`s`.
To switch between stretch modes, press :kbd:`Ctrl+Alt+s`.
Render mode
-------------
@ -153,4 +153,4 @@ Filter graphics
When enabled, ScummVM uses bilinear interpolation instead of nearest neighbor for the :ref:`aspect ratio <aspect>` and :ref:`stretch mode <stretch>`. It does not affect the graphics mode scaling unless OpenGL is selected, in which case it determines how the OpenGL scaling is done.
To toggle between bilinear interpolation and nearest neighbor, use :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`f`.
To toggle between bilinear interpolation and nearest neighbor, press :kbd:`Ctrl+Alt+f`.

6
doc/docportal/consoles/nintendo_3ds.rst
View file

@ -35,9 +35,9 @@ Transfer game files
Transfer game folders onto the SD card. The exact location is not important.
ScummVM for the Nintendo 3DS also has Cloud functionality. See :doc:`../using_scummvm/connect_cloud`.
ScummVM for the Nintendo 3DS also has Cloud functionality. See :doc:`../use_scummvm/connect_cloud`.
See :doc:`../using_scummvm/add_play_games` for more information about how to add games to ScummVM.
See :doc:`../use_scummvm/add_play_games` for more information about how to add games to ScummVM.
Controls
@ -48,7 +48,7 @@ Default control mapping
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:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. csv-table::
:widths: 50 50

6
doc/docportal/consoles/nintendo_switch.rst
View file

@ -26,9 +26,9 @@ Transfer game files
Copy the folders containing game files into the ``/switch/scummvm/`` folder on the microSD card.
ScummVM on the Nintendo switch supports :doc:`Cloud functionality <../using_scummvm/connect_cloud>`.
ScummVM on the Nintendo switch supports :doc:`Cloud functionality <../use_scummvm/connect_cloud>`.
For more information on how to add and play games, see the :doc:`../using_scummvm/add_play_games` page.
For more information on how to add and play games, see the :doc:`../use_scummvm/add_play_games` page.
Controls
=================
@ -38,7 +38,7 @@ Default control mapping
These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |plus| raw:: html

6
doc/docportal/consoles/playstation_3.rst
View file

@ -27,16 +27,16 @@ Transfer game files
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 <../using_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:`../using_scummvm/add_play_games` for more information.
See :doc:`../use_scummvm/add_play_games` for more information.
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:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
Default control mapping

4
doc/docportal/consoles/playstation_portable.rst
View file

@ -30,7 +30,7 @@ Transfer game files
Transfer game files onto the PSP as described in the installation section above. They can be copied to any folder; location doesn't matter.
For more information, see :doc:`../using_scummvm/add_play_games`.
For more information, see :doc:`../use_scummvm/add_play_games`.
Controls
=================
@ -40,7 +40,7 @@ Default control mapping
These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |square| raw:: html

6
doc/docportal/consoles/ps_vita.rst
View file

@ -35,9 +35,9 @@ If you're using SD2Vita:
Folders containing game files can be copied into any folder.
ScummVM on the PS Vita supports :doc:`Cloud functionality <../using_scummvm/connect_cloud>`.
ScummVM on the PS Vita supports :doc:`Cloud functionality <../use_scummvm/connect_cloud>`.
For more information on how to add and play games, see the :doc:`../using_scummvm/add_play_games` page.
For more information on how to add and play games, see the :doc:`../use_scummvm/add_play_games` page.
Controls
@ -48,7 +48,7 @@ Default control mapping
These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |square| raw:: html

2
doc/docportal/contribute/tech_writers.md
View file

@ -25,7 +25,7 @@ This may include documenting a new feature, documenting a new or existing port,
* Linux: Use `sudo apt install python3-pip`.
* Windows: Pip3 is installed when you install Python3.
* macOS: Pip3 is installed if you install Python3 with Homebrew.
* Use pip3 to install [sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html), [sphinx-panels](https://sphinx-panels.readthedocs.io/en/latest/#installation) and [recommonmark](https://www.sphinx-doc.org/en/master/usage/markdown.html).
* Use pip3 to install [sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html), the [Read the Docs theme](https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html) [sphinx-panels](https://sphinx-panels.readthedocs.io/en/latest/#installation) and [recommonmark](https://www.sphinx-doc.org/en/master/usage/markdown.html).
* [Install Git](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/set-up-git), if you don’t have it already.
* [Fork and clone](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo) the [scummvm repository](https://github.com/scummvm/scummvm).
* [Create and checkout](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository) a new branch.

102
doc/docportal/get_started/android.rst
View file

@ -46,19 +46,107 @@ Transfer game files
Transfer all the required game data files to your device, into a folder accessible by the ScummVM app.
ScummVM has built-in Cloud functionality, which allows you to connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../using_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../using_scummvm/local_webserver` page.
ScummVM has built-in Cloud functionality, which allows you to connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../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 via USB cable, tap the **Charging this device via USB notification** when the device is connected. Select **Use USB for** and then **File Transfer**. An Android File Transfer window opens.
- Download games such as freeware games or those from digital distributors such `GOG.com <gog.com>`_ or `Steam <steam.steampowered.com>`_ directly to your device.
For more information on which files ScummVM requires, and how to add and play games, see :doc:`../using_scummvm/add_play_games`.
- Download games such as freeware games or those from digital distributors directly to your device.
For more information on which files ScummVM requires, and how to add and play games, see :doc:`../use_scummvm/add_play_games`.
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.
.. csv-table::
:header-rows: 1
Touch screen control, Action
One finger tap, Left mouse click
Two finger tap, Right mouse click
Long hold one finger tap, 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
Two finger tap
****************
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.
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 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.
Touchscreen modes
*******************
The touchscreen operates in two modes: Direct mode or Touchpad mode. To toggle between the two, from the Launcher select **Options** and then the **Control** tab. Tick **Touchpad mouse mode** to enable Touchpad mode.
Direct mode
^^^^^^^^^^^^^
The mouse cursor is placed directly under where your finger touches the screen.
Touchpad mode
^^^^^^^^^^^^^^^^
The mouse cursor doesn't stay underneath your finger. The cursor is moved around from its current position by the direction of your finger movement, just like a touchpad on a laptop.
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.
Configuration file
************************
The configuration file is in the internal app folder, and this path cannot be changed.
Access 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.
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.
For more information, see the :doc:`../use_scummvm/LAN` page.
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.

18
doc/docportal/get_started/ios.rst
View file

@ -147,7 +147,7 @@ Transfer game files
There are multiple ways to transfer game files to your iOS device.
ScummVM has built-in cloud functionality, which allows you to connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../using_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../using_scummvm/local_webserver` page.
ScummVM has built-in cloud functionality, which allows you to connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../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::
@ -158,7 +158,7 @@ Another way to transfer files (for macOS Catalina and newer) to your device is b
.. image:: ../images/ios/ios_transfer_files.gif
For more information on which files ScummVM requires, and how to add and play games, see :doc:`../using_scummvm/add_play_games`.
For more information on which files ScummVM requires, and how to add and play games, see :doc:`../use_scummvm/add_play_games`.
Controls
============
@ -180,20 +180,28 @@ Controls
F 0-9 keys,The F-bar above the keyboard.
Pause,Keyboard spacebar
Toggle `Click and drag mode`_,Swipe two fingers up from bottom to top.
Toggle `Touchpad mode`_,Swipe two fingers from left to right.
Toggles between :ref:`direct` and :ref:`touchpad` ,Swipe two fingers from left to right.
Click and drag mode
^^^^^^^^^^^^^^^^^^^^
In this mode, a left mouse click is simulated when you touch the screen. The mouse pointer drags to wherever you slide your finger, and releases where you lift your finger.
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.
.. _direct:
Direct mode
^^^^^^^^^^^^^
The mouse cursor is placed directly under where your finger touches the screen.
.. _touchpad:
Touchpad mode
^^^^^^^^^^^^^^^^
In this mode, the cursor doesn't stay underneath your finger, but is rather moved around from its current position depending on the direction of your finger movement, just like a touchpad on a laptop.
The mouse cursor doesn't stay underneath your finger. The cursor is moved around from its current position by the direction of your finger movement, just like a touchpad on a laptop.
Paths
=======

10
doc/docportal/help/faq.rst
View file

@ -30,7 +30,7 @@ How do I get game files onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The **Other platforms** section provides information about installing ScummVM on various platforms, as well as how to transfer files to your chosen device.
ScummVM now has Cloud and LAN functionality to simplify the file transfer process. For more information, see :doc:`../using_scummvm/connect_cloud` and :doc:`../using_scummvm/local_webserver`.
ScummVM now 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?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -53,7 +53,7 @@ See `Where to get the games <https://wiki.scummvm.org/index.php?title=Where_to_g
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. See :doc:`../using_scummvm/add_play_games`.
Generally speaking, you do not need to install the games. You only need to point ScummVM to the game files contained on these discs. See :doc:`../use_scummvm/add_play_games`.
Do I need the original game discs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -69,11 +69,11 @@ This is only supported for a select number of games. See the `wiki <https://wiki
How do I launch a game straight from the game folder?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Games must be added to and started from :doc:`../using_scummvm/the_launcher`, they cannot be started directly from the game files. See :doc:`../using_scummvm/add_play_games`. It is only necessary to add each game once; ScummVM will remember the game and it will be available to start from the Launcher.
Games must be added to and started from :doc:`../use_scummvm/the_launcher`, they cannot be started directly from the game files. See :doc:`../use_scummvm/add_play_games`. It is only necessary to add each game once; ScummVM will remember the game and it will be available to start from the Launcher.
What are the in-game keyboard shortcuts?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A list of default shortcuts can be found on the :doc:`../using_scummvm/keyboard_shortcuts` page. Since version 2.2.0 it is also possible to 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 it is also possible to create custom shortcuts on the :doc:`../settings/keymaps` tab.
Troubleshooting
===================
@ -100,7 +100,7 @@ Help! My game won't run!
1. Make sure your game is supported. Check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
2. Check that you have all the required datafiles. See the :doc:`../using_scummvm/add_play_games` page for more information.
2. Check that you have all the required datafiles. See the :doc:`../use_scummvm/add_play_games` page for more information.
3. Ask on the forums or on Discord whether your game is supported on the platform you're trying to play it on. :doc:`contact`

40
doc/docportal/index.rst
View file

@ -14,13 +14,13 @@
:glob:
:hidden:
using_scummvm/the_launcher
using_scummvm/add_play_games
using_scummvm/save_load_games
using_scummvm/connect_cloud
using_scummvm/local_webserver
using_scummvm/keyboard_shortcuts
using_scummvm/how_to_settings
use_scummvm/the_launcher
use_scummvm/add_play_games
use_scummvm/save_load_games
use_scummvm/connect_cloud
use_scummvm/LAN
use_scummvm/keyboard_shortcuts
use_scummvm/how_to_settings
.. toctree::
@ -100,7 +100,7 @@ While ScummVM was originally designed to run LucasArts' SCUMM games, over time s
First steps
================
We have guides available to show you :column: mb-4 how to get ScummVM up and running:
We have guides available to show you how to get ScummVM up and running:
.. panels::
:container: container-fluid text-center mb-4
@ -147,38 +147,38 @@ We have guides available to show you :column: mb-4 how to get ScummVM up and run
How do I use ScummVM?
=========================
So you have ScummVM installed, but now you need to know how to add and play some games! We have lots of useful information to help you out:
So you have ScummVM installed, but now you need to know how to play some games! We have lots of useful information to help you out:
.. panels::
:container: text-center mb-4
Understand the interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:doc:`using_scummvm/the_launcher`
:doc:`use_scummvm/the_launcher`
---
Play games
^^^^^^^^^^^^^^
:doc:`using_scummvm/add_play_games`
:doc:`use_scummvm/add_play_games`
:doc:`using_scummvm/save_load_games`
:doc:`use_scummvm/save_load_games`
:doc:`using_scummvm/keyboard_shortcuts`
:doc:`use_scummvm/keyboard_shortcuts`
---
Use the features
^^^^^^^^^^^^^^^^^^
:doc:`using_scummvm/connect_cloud`
:doc:`use_scummvm/connect_cloud`
:doc:`using_scummvm/local_webserver`
:doc:`use_scummvm/LAN`
---
Change settings
^^^^^^^^^^^^^^^^^^^^^
:doc:`using_scummvm/how_to_settings`
:doc:`use_scummvm/how_to_settings`
@ -232,7 +232,7 @@ If you are having problems with any aspect of ScummVM, take a look at our help s
What's changed since I was last here?
======================================
For a quick recap on what's been happening with the latest release, check out our Release Notes section.
For a quick recap on what's happening with the latest release, check out our Release Notes section.
The ScummVM Project
@ -241,8 +241,4 @@ ScummVM is an open-source project.
If you enjoy ScummVM, feel free to donate using the PayPal button on the `ScummVM homepage <https://www.scummvm.org>`__. This will help us buy the utilities to develop ScummVM faster and more efficiently.
If you cannot donate but you have coding or writing skills, you can help us by contributing!
To help us with our documentation, see the :doc:`contribute/tech_writers`.
To help us with our code, check out `Developer Central <https://wiki.scummvm.org/index.php?title=Developer_Central>`_ on the ScummVM wiki.
If you cannot donate but you have coding or writing skills, you can help us by contributing! Check out `Developer Central <https://wiki.scummvm.org/index.php?title=Developer_Central>`_ on the ScummVM wiki.

6
doc/docportal/other_platforms/amigaos_4.rst
View file

@ -29,16 +29,16 @@ To automatically keep ScummVM up to date through AmiUpdate, run the ``Autoinstal
Transfer game files
=======================
See :doc:`../using_scummvm/add_play_games` for more information.
See :doc:`../use_scummvm/add_play_games` for more information.
For games on PC or Mac formatted discs, use the native 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 may 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:`../using_scummvm/connect_cloud` and :doc:`../using_scummvm/local_webserver`.
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`.
Controls
=================
Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../using_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

2
doc/docportal/other_platforms/atari.rst
View file

@ -34,7 +34,7 @@ Controls
Controls can 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:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
Paths

4
doc/docportal/other_platforms/risc_os.rst
View file

@ -25,12 +25,12 @@ Transfer game files
Copy data files directly from the original discs on machines that have CD and/or floppy drives, or transfer the files from another system by using a USB stick.
See :doc:`../using_scummvm/add_play_games` for more information.
See :doc:`../use_scummvm/add_play_games` for more information.
Controls
=================
Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../using_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

3
doc/docportal/settings/accessibility.rst
View file

@ -4,7 +4,8 @@ Accessibility
Use the Accessibility tab to change accessibility settings.
From the Launcher, select :guilabel:`Options`, click the red right arrow :guilabel:`>` until the Accessibility tab is visible, and then select the :guilabel:`Accessibility` tab.
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
.. figure:: ../images/settings/accessibility.png

15
doc/docportal/settings/audio.rst
View file

@ -2,17 +2,17 @@
Audio
===============
Audio settings are found in four tabs:
Audio settings are found on four tabs:
:ref:`Audio <audiotab>` | :ref:`Volume <volumetab>` | :ref:`MIDI <miditab>` | :ref:`MT-32 <mt32tab>`
**To change settings globally:**
From the Launcher, select :guilabel:`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 :guilabel:`Edit Game`, and then select the applicable tab.
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.
@ -159,18 +159,19 @@ MIDI gain
FluidSynth
****************\
****************
Opens a new dialog, with three further tabs:
`Reverb`_ | `Chorus`_ | `Misc`_
:ref:`fsreverb` | `Chorus`_ | `Misc`_
.. figure:: ../images/settings/fluidsynth.png
The FluidSynth dialog, reached from the MIDI tab.
.. _fsreverb:
_`Reverb`
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.
@ -306,5 +307,7 @@ MT-32 Device
**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.
*enable_gs*

7
doc/docportal/settings/cloud.rst
View file

@ -6,7 +6,8 @@ Use the Cloud tab to manage connected cloud storage services.
ScummVM currently supports Dropbox, OneDrive, Google Drive and Box. Connecting ScummVM to a cloud storage service provides an easy way of sharing game files and saved games between multiple devices.
From the Launcher, select :guilabel:`Options`, click the red :guilabel:`>` until the Cloud tab is visible, and then select the :guilabel:`Cloud` tab.
From the Launcher, select **Options**, click the **>** scroll arrow until the Cloud tab is visible, and then select the **Cloud** tab.
.. figure:: ../images/settings/cloud.png
@ -20,13 +21,13 @@ Active storage
Once 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 again.
Disconnects the cloud storage account. To change accounts, disconnect and connect a new account.
.. note::

8
doc/docportal/settings/control.rst
View file

@ -4,7 +4,7 @@ Control
Use the Control tab to change aspects of joystick controls. This tab is only available when a joystick or game controller is connected, or for certain touch screen enabled platforms.
From the Launcher, select :guilabel:`Options`, and then select the :guilabel:`Control` tab.
From the Launcher, select **Options**, and then select the **Control** tab.
.. figure:: ../images/settings/control.png
@ -26,3 +26,9 @@ Joy deadzone
Sets the deadzone for an analog joystick. A lower value will reduce the size of the deadzone.
*joystick_deadzone*
Show on-screen control
Toggles the small on-screen keyboard icon on and off.
Touchpad mouse mode
Toggles between :ref:`direct` and :ref:`touchpad`.

4
doc/docportal/settings/engine.rst
View file

@ -4,7 +4,7 @@ Engine
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 :guilabel:`Edit Game`, and then select the :guilabel:`Engine` tab. This tab may not be 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 may not be 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>`_.
@ -248,7 +248,7 @@ Enable studio audience
*studio_audience*
.. _skip:
.. _skipsupport:
Skip support
Allows the user to skip text and cutscenes.

8
doc/docportal/settings/game.rst
View file

@ -5,7 +5,7 @@ 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 :guilabel:`Edit Game`. The :guilabel:`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
@ -17,21 +17,21 @@ From the Launcher, highlight a game on the games list, then select :guilabel:`Ed
.. _gameid:
**ID**
This field shows the short name of the game. This ID can be used for launching the game from the command line.
Shows the short name of the game. This ID can be used for launching the game from the command line.
*gameid*
.. _description:
**Name**
This field shows the full title of the game, as well as some basic information such as original platform and language.
Shows the full title of the game, as well as some basic information such as original platform and language.
*description*
.. _lang:
**Language**
For multi-language games, this option changes the language of the game. However, for games that have the language hardcoded, this option only changes the font of the subtitles. For instance, selecting German will add an umlaut to German subtitles, and selecting Spanish will add the tilde in Spanish subtitles.
For multi-language games, this changes the language of the game. For games that have a single language hardcoded, this changes the font of the subtitles. For instance, selecting German will add an umlaut to German subtitles, and selecting Spanish will add the tilde to Spanish subtitles.
*language*

6
doc/docportal/settings/graphics.rst
View file

@ -6,11 +6,11 @@ Use the Graphics tab to change how games look when they are played.
**To change settings globally:**
From the Launcher, select :guilabel:`Options`. The :guilabel:`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:**
Highlight the game in the games list, select :guilabel:`Edit Game` then select the :guilabel:`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.
@ -38,7 +38,7 @@ Render mode
.. _stretchmode:
Stretch mode
Changes the way the game is displayed in relation to the window size.
Changes the way the game is displayed in relation to the window or screen size.
*stretch_mode*

8
doc/docportal/settings/keymaps.rst
View file

@ -6,11 +6,11 @@ Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or mouse or
**To change settings globally:**
From the Launcher, select :guilabel:`Options`, then select the :guilabel:`Keymaps` tab.
From the Launcher, select **Options**, then select the **Keymaps** tab.
**To change settings for a specific game:**
Highlight the game in the games list, select :guilabel:`Edit Game` then select the :guilabel:`Keymaps` tab.
Highlight the game in the games list, select **Edit Game** then select the **Keymaps** tab.
.. figure:: ../images/settings/keymaps.png
@ -22,9 +22,9 @@ Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or mouse or
,,,,,,,,,,,,,,,,,
Click on the red box next to the desired action to add an additional key or button. Click on the :guilabel:`▼` dropdown expander for further 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 red box 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.

3
doc/docportal/settings/lan.rst
View file

@ -6,7 +6,8 @@ Use the LAN tab to control the web server.
ScummVM can run a local network web server which allows browser-based file management, including uploading and downloading game files.
From the Launcher, select :guilabel:`Options`, click the red :guilabel:`>` until the LAN tab is visible, and then select the :guilabel:`LAN` tab.
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
.. figure:: ../images/settings/LAN.png

4
doc/docportal/settings/misc.rst
View file

@ -4,7 +4,7 @@ Miscellaneous
Use the Misc tab to change miscellaneous settings that don’t belong on any of the other tabs.
From the Launcher, select :guilabel:`Options`, click the red :guilabel:`>` until the Misc tab is visible, and then select the :guilabel:`Misc` tab.
From the Launcher, select **Options**, click the **>** scroll arrow until the Misc tab is visible, and then select the **Misc** tab.
.. figure:: ../images/settings/misc.png
@ -28,7 +28,7 @@ GUI Renderer
.. _autosave:
Autosave
Adjusts the time period between autosaves. The default setting is 5 minutes. This is not available for all games.
Adjusts the time period between autosaves. The default setting is 5 minutes.
*autosave_period*

14
doc/docportal/settings/paths.rst
View file

@ -6,11 +6,11 @@ Use the Paths tab to tell ScummVM where to look for files.
**To change settings globally:**
From the Launcher, select :guilabel:`Options`, then select the :guilabel:`Paths` tab.
From the Launcher, select **Options**, then select the **Paths** tab.
**To change settings for a specific game:**
Highlight the game in the games list, select :guilabel:`Edit Game` then select the :guilabel:`Paths` tab.
Highlight the game in the games list, select **Edit Game** then select the **Paths** tab.
.. figure:: ../images/settings/paths.png
@ -21,25 +21,21 @@ Use the Paths tab to tell ScummVM where to look for files.
.. _savepath:
Save Path
The path to the folder in which ScummVM stores saved games. If this is not set, saved games will generally be stored in the current directory, although there are exceptions to this. For more information, see the :doc:`../using_scummvm/save_load_games` page.
Sets the path to the folder in which ScummVM stores saved games. If this is not set, saved games will generally be stored in the current directory, although there are exceptions to this. For more information, see the :ref:`Save and Load games <savelocation>` page.
*savepath*
.. _themepath:
Theme Path
The path to the folder in which ScummVM stores additional themes.
Sets the path to the folder in which ScummVM stores additional themes.
*themepath*
.. _extra:
Extra Path
The path to the folder in which ScummVM will look for various extra files. These may include:
* Additional datafiles required for certain games
* Soundfonts
* 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*

8
doc/docportal/using_scummvm/local_webserver.rst → doc/docportal/use_scummvm/LAN.rst
View file

@ -7,10 +7,10 @@ ScummVM can run a local web server, to allow the transfer of files between devic
How to use the web server
----------------------------
From the Launcher, select :guilabel:`Options`, click the red :guilabel:`>` until the LAN tab is visible, and then select the :guilabel:`LAN` tab.
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
Click :guilabel:`Run server` to start the server.
Click **Run server** to start the server.
.. figure:: ../images/cloud_and_lan/lan_server_running.png
@ -36,6 +36,6 @@ To upload files, click **Upload Files** and select files from the system file br
Upload files.
To change which files are accessible on the web server, set the :guilabel:`/root/ Path` to the directory containing the files you wish to access. You will be able to access anything inside that directory, but you will not able to access the parent directory.
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.
To stop the web server, either click :guilabel:`Stop server` or click :guilabel:`Ok` to close the settings dialog.
To stop the web server, click **Stop server** to stop the server, or **Ok** to close the settings dialog.

26
doc/docportal/using_scummvm/add_play_games.rst → doc/docportal/use_scummvm/add_play_games.rst
View file

@ -6,19 +6,19 @@ Add and play games
The games
----------------
One of the most commonly asked questions we get is, "Where do I get the games??". If you still have your old floppy discs and CDs lying around, and have a way to read them, then you can use the game files from these original discs.
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. As a quick summary, there are a few freeware games available for download on the ScummVM website's `Downloads page <scummvm.org/downloads>`_, or there are digital distributors such as `GOG.com <https://www.gog.com/>`__ and `Steam <https://store.steampowered.com/>`_. ScummVM has an affiliate referrer programme with GOG.com, so if you are going to buy a game, please use the links on the `wiki page <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ to help the ScummVM project!
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. As a quick summary, there are a few freeware games available for download on the ScummVM website's `Downloads page <https://www.scummvm.org/downloads/>`_, or there are digital distributors such as `GOG.com <https://www.gog.com/>`__ and `Steam <https://store.steampowered.com/>`_. ScummVM has an affiliate referrer programme with GOG.com, so if you are going to buy a game, please use the links on the `wiki page <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ to help the ScummVM project!
Make sure to check out the `compatibility list <https://www.scummvm.org/compatibility/>`_ on our website, and the `Supported Games page <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ and `Platform Overview page <https://wiki.scummvm.org/index.php/Platforms/Overview>`_ on the 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 our 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.
A note about copyright
------------------------
The ScummVM team does not condone piracy. However, there are cases where the game companies themselves bundled 'cracked' executables with their games. In these cases the data files still contain the copy protection scripts, but the interpreter bypasses them - similar to what an illegally cracked version might do, only that here the producer of the game did it. There is no way for ScummVM to tell the difference between legitimate and pirated data files, so for the games where a cracked version of the original interpreter was sold at some point, ScummVM has to bypass the copy protection.
The ScummVM team does not condone piracy, however there are cases where the game companies themselves bundled 'cracked' executables with their games. In these cases the data files still contain the copy protection scripts, but the interpreter bypasses them; similar to what an illegally cracked version might do, only that here the producer of the game did it. There is no way for ScummVM to tell the difference between legitimate and pirated data files, so for the games where a cracked version of the original interpreter was sold at some point, ScummVM has to bypass the copy protection.
In some cases ScummVM still shows the copy protection screen. Try entering any answer; chances are that it will work.
In some cases ScummVM still shows the copy protection screen. Enter any answer; chances are that it will work.
The game files
@ -47,7 +47,7 @@ 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>`__ sources:
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 game files, or
- If the data files are supplied as a ``.zip`` archive, extract the archive.
@ -58,9 +58,7 @@ For macOS or Linux users without access to a Windows machine, it is possible to
.. tip::
Use ScummVM's Cloud functionality to share game files and automatically back up and sync your saved game states. For detailed instructions see the :doc:`../using_scummvm/connect_cloud` guide.
For devices on the same local network, ScummVM can run a web server to allow hassle-free transfer of files. For detailed instructions, see the :doc:`../using_scummvm/local_webserver` guide. This is a good option if you do not wish to connect a Cloud service.
Use ScummVM's Cloud functionality to share game files and automatically back up and sync your saved game states. For detailed instructions see the :doc:`../use_scummvm/connect_cloud` guide. For devices on the same local network, ScummVM can run a web server to allow hassle-free transfer of files. For detailed instructions, see the :doc:`../use_scummvm/LAN` guide. This is a good option if you do not wish to connect a Cloud service.
Multi-disc games
@ -82,7 +80,7 @@ Some games contain one or more separate audio tracks on CD. To use these with Sc
Software suggestion:
`fre:ac <https://www.freac.org/>`_ is a multi-platform, open-source software, with the ability to both rip CDs and convert audio between .mp3, .ogg, .flac and .wav formats.
`fre:ac <https://www.freac.org/>`_ is a multi-platform, open-source software, with the ability to both rip CDs and convert audio between ``.mp3``, ``.ogg``, ``.flac`` and ``.wav`` formats.
Place the converted audio files in the same folder that contains the other game datafiles.
@ -96,7 +94,7 @@ All LucasArts SCUMM games also exist in versions for the Macintosh. Most of the
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 will need additional software to view and copy the files.
For Windows, HFSExplorer is a basic and free option, which allows read-only access to HFS drives. `Download the installer <http://www.catacombae.org/hfsexplorer/>`_ rather than the ZIP file, to ensure it is installed correctly.
For Windows, `HFS Explorer <http://www.catacombae.org/hfsexplorer/>`_ is a basic and free option, which allows read-only access to HFS drives. Use the installer rather than the ZIP file, to ensure it is installed correctly.
For Linux, hfsplus allows read-only access to HFS drives. To use hfsplus, use the command line:
@ -111,7 +109,7 @@ For Linux, hfsplus allows read-only access to HFS drives. To use hfsplus, use th
Add games to the Launcher
---------------------------------
1. Run ScummVM to open :doc:`../using_scummvm/the_launcher`.
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. To add multiple games at once, click the expander arrow next to **Add Game**, and select **Mass Add**.
@ -133,11 +131,11 @@ Add games to the Launcher
.. image:: ../images/Launcher/game_settings.png
:class: with-shadow
6. Games are now ready to play! To play, select a game and click **Start**.
6. Games are now ready to play! To play, highlight a game in the games list and click **Start**.
.. image:: ../images/Launcher/start_game.png
:class: with-shadow
Games can also be launched directly from the command line. For more information, see the `Command line options <../advanced_options/command_line>`_ page.
Games can also be launched directly from the command line. For more information, see the `Command line options <../advanced_topics/command_line>`_ page.

12
doc/docportal/using_scummvm/connect_cloud.rst → doc/docportal/use_scummvm/connect_cloud.rst
View file

@ -2,7 +2,7 @@
Connect a cloud service
===============================
From the Launcher, select :guilabel:`Options`, click the red :guilabel:`>` until the Cloud tab is visible, and then select the :guilabel:`Cloud` tab.
From the Launcher, select **Options**, click the **>** scroll arrow until the Cloud tab is visible, and then select the **Cloud** tab.
To connect your chosen cloud storage service to ScummVM, select it from the **Active storage** dropdown.
@ -12,16 +12,16 @@ Click on the link shown at **1.**, and log in to your cloud storage account. Onc
.. figure:: ../images/cloud_and_lan/cloud_code.png
Copy the 6-digit code, click into the empty field next to :guilabel:`Paste`, and then click :guilabel:`Paste`.
Copy the 6-digit code, click into the empty field next to **Paste**, and then click **Paste**.
.. figure:: ../images/cloud_and_lan/cloud_connect.png
Click :guilabel:`3. Connect`. Once the next page loads, click :guilabel:`Enable storage`.
Click **3. Connect**. Once 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 :guilabel:`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 the game files from your cloud ScummVM folder, click :guilabel:`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 :guilabel:`Disconnect`.
To change to a different cloud account, or to disconnect your cloud account from ScummVM, click **Disconnect**.

6
doc/docportal/using_scummvm/how_to_settings.rst → doc/docportal/use_scummvm/how_to_settings.rst
View file

@ -1,5 +1,5 @@
=======================
How to change settings
Change settings
=======================
From the Launcher
@ -8,9 +8,9 @@ The settings are arranged by subject, on different tabs:
:doc:`Game tab <../settings/game>` | :doc:`Engine tab <../settings/engine>` | :doc:`Graphics tab <../settings/graphics>` | :doc:`Control tab <../settings/control>` | :doc:`Keymaps tab <../settings/keymaps>` | :doc:`Audio tab <../settings/audio>` | :doc:`Volume tab <../settings/audio>` | :doc:`Midi tab <../settings/audio>` | :doc:`MT-32 tab <../settings/audio>` | :doc:`Paths tab <../settings/paths>` | :doc:`Misc tab <../settings/misc>` | :doc:`Cloud tab <../settings/cloud>` | :doc:`LAN tab <../settings/lan>` | :doc:`Accessibility tab <../settings/accessibility>`
To change a setting globally, so that it affects all games, select :guilabel:`Options` and then select the tab containing the setting you would like to change.
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 :guilabel:`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.

1
doc/docportal/using_scummvm/keyboard_shortcuts.rst → doc/docportal/use_scummvm/keyboard_shortcuts.rst
View file

@ -13,6 +13,7 @@ Default keyboard shortcuts
.. csv-table::
:widths: 30 70
:header-rows: 1
Shortcut, Description
:kbd:`Ctrl+F5` ,Displays the Global Main Menu

10
doc/docportal/using_scummvm/save_load_games.rst → doc/docportal/use_scummvm/save_load_games.rst
View file

@ -29,7 +29,7 @@ There are two views: list view and tile view. Click the list and tile icons at t
Autosave
------------
ScummVM automatically saves the game every 5 minutes. The :ref:`autosave period <autosave>` can be changed in the :doc:`Misc tab <../settings/misc>` or in the :doc:`configuration file <../advanced_topics/configuration_file>`.
ScummVM automatically saves the game every 5 minutes. The :ref:`autosave period <autosave>` can be changed in the Misc settings tab, or in the :doc:`configuration file <../advanced_topics/configuration_file>`.
Load a game
@ -37,7 +37,7 @@ Load a game
Saved games can be loaded directly from the Launcher without starting the game first, by selecting the **Load** button.
There are two views: list view and tile view. 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 states. Click on a saved state to highlight it. The pane on the right shows information about the highlighted state such as timestamps, screenshots and playtime.
@ -58,6 +58,7 @@ In tile view, each tile shows a screenshot of the saved state, as well as the de
To load a saved state from within a game, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac) to access the Global Main Menu. Select **Load**.
.. _savelocation:
Location of saved game files
-------------------------------
@ -112,11 +113,10 @@ Default saved game paths are shown below.
.. panels::
:column: col-lg-12 mb-2
We follow the XDG Base Directory Specification. This means our configuration can be found in ``$XDG_DATA_HOME/scummvm/saves/``
If XDG_DATA_HOME is not defined or empty, ``~/.local/share/`` will be used, where ``~`` is your Home directory.
We follow the XDG Base Directory Specification, so by default the saved games can be found at ``~/.local/share/scummvm/saves/``, but this location may vary depending on the value of the ``XDG_DATA_HOME`` environment variable.
Note that ``.local`` is a hidden directory; to view it use ``ls -a`` on the command line. If you are using a GUI file manager, go to **View > Show Hidden Files**, or use the keyboard shortcut :kbd:`Ctrl + H`.
``.local`` is a hidden directory. To view it use ``ls -a`` on the command line, or, if you are using a GUI file manager, press :kbd:`Ctrl + H`.
If ScummVM was installed using Snap, the saves can be found at ``~/snap/scummvm/current/.local/share/scummvm/saves/``

4
doc/docportal/using_scummvm/the_launcher.rst → doc/docportal/use_scummvm/the_launcher.rst
View file

@ -55,7 +55,7 @@ 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:`../using_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
@ -67,7 +67,7 @@ Removes the highlighted game from the list.
Options
-------
Opens the global settings window. Use this window to define global game settings, as well as change a number of the ScummVM Launcher settings. For more information, see the :doc:`../using_scummvm/how_to_settings` page
Opens the global settings window. Use this window to define global game settings, as well as change a number of the ScummVM Launcher settings. For more information, see the :doc:`../use_scummvm/how_to_settings` page
About
-----