Initial commit
This commit is contained in:
25
doc/docportal/settings/accessibility.rst
Normal file
25
doc/docportal/settings/accessibility.rst
Normal file
@@ -0,0 +1,25 @@
|
||||
=================
|
||||
Accessibility
|
||||
=================
|
||||
|
||||
Use the Accessibility tab to change accessibility settings.
|
||||
|
||||
From the Launcher, select **Global Options**, if necessary click the **>** scroll arrow until the Accessibility tab is visible, and then select the **Accessibility** tab.
|
||||
|
||||
|
||||
|
||||
.. figure:: ../images/settings/accessibility.png
|
||||
|
||||
The Accessibility tab in the Global Options menu.
|
||||
|
||||
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.
|
||||
|
||||
*tts_enabled*
|
||||
|
||||
315
doc/docportal/settings/audio.rst
Normal file
315
doc/docportal/settings/audio.rst
Normal file
@@ -0,0 +1,315 @@
|
||||
===============
|
||||
Audio
|
||||
===============
|
||||
|
||||
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 **Global Options**, then select the applicable tab.
|
||||
|
||||
**To change settings for a specific game:**
|
||||
|
||||
From the Launcher, highlight the game in the games list, and select the **Game Options** button. If the Launcher is in grid view, select the game and then select the gear icon in the popup window. 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.
|
||||
|
||||
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
|
||||
-----------------
|
||||
|
||||
Use the Audio tab to change the sound output of games.
|
||||
|
||||
.. figure:: ../images/settings/audio.png
|
||||
|
||||
The Audio tab in the Global Options menu.
|
||||
|
||||
.. figure:: ../images/settings/audio_game.png
|
||||
|
||||
The Audio tab in the Game Options menu.
|
||||
|
||||
|
||||
,,,,,,,,,,,,,,,,
|
||||
|
||||
|
||||
.. _device:
|
||||
|
||||
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*
|
||||
|
||||
.. _opl:
|
||||
|
||||
AdLib Emulator
|
||||
Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the **Preferred device**.
|
||||
|
||||
*opl_driver*
|
||||
|
||||
.. _speechmute:
|
||||
|
||||
Text and Speech
|
||||
For games with digitized speech, this setting lets the user decide whether to play the game with speech only, subtitles only, or both.
|
||||
|
||||
*speech_mute*
|
||||
|
||||
*subtitles*
|
||||
|
||||
.. _talkspeed:
|
||||
|
||||
Subtitle speed
|
||||
Adjusts the length of time that the subtitles are displayed on screen. The meaning of this value depends on the games. Some games treat it as a delay (a higher value means the subtitles are displayed for longer) while others treat it as a speed. Games that treat it as a delay include all LucasArts games, with the exception of Grim Fandango and Escape from Monkey Island, all Sierra games, and the Discworld games. Most other games treat it as a speed.
|
||||
|
||||
*talkspeed*
|
||||
|
||||
,,,,,,,,,,,,,,,,,,,,,,,,,,,
|
||||
|
||||
.. _volumetab:
|
||||
|
||||
The Volume tab
|
||||
-----------------
|
||||
|
||||
Use the Volume tab to set the relative volumes for various in-game sounds.
|
||||
|
||||
|
||||
.. figure:: ../images/settings/volume_game.png
|
||||
|
||||
The Volume tab in the Game Options menu.
|
||||
|
||||
,,,,,,,,,,,,,
|
||||
|
||||
|
||||
.. _music:
|
||||
|
||||
Music volume
|
||||
Adjusts the volume of the music in the game.
|
||||
|
||||
*music_volume*
|
||||
|
||||
.. _sfx:
|
||||
|
||||
SFX volume
|
||||
Adjusts the volume of the sound effects in the game.
|
||||
|
||||
*sfx_volume*
|
||||
|
||||
.. _speechvol:
|
||||
|
||||
Speech volume
|
||||
Adjusts the volume of the digitized speech in the game, if it has any.
|
||||
|
||||
*speech_volume*
|
||||
|
||||
.. _mute:
|
||||
|
||||
Mute All
|
||||
Mutes all game audio.
|
||||
|
||||
*mute*
|
||||
|
||||
,,,,,,,,,,,,,,,,,,
|
||||
|
||||
.. _miditab:
|
||||
|
||||
|
||||
The MIDI tab
|
||||
------------------------------
|
||||
|
||||
Use the MIDI tab to change the settings of General MIDI (GM) devices.
|
||||
|
||||
|
||||
.. figure:: ../images/settings/MIDI.png
|
||||
|
||||
The MIDI tab in the Global Options menu
|
||||
|
||||
,,,,,,,,,,,,,
|
||||
|
||||
.. _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.
|
||||
|
||||
*gm_device*
|
||||
|
||||
.. _soundfont:
|
||||
|
||||
Soundfont
|
||||
Specifies the path to a soundfont file, if this is required by the GM device.
|
||||
|
||||
*soundfont*
|
||||
|
||||
.. _multi:
|
||||
|
||||
Mixed AdLib/MIDI mode
|
||||
Combines MIDI music with AdLib sound effects.
|
||||
|
||||
*multi_midi*
|
||||
|
||||
.. _gain:
|
||||
|
||||
MIDI gain
|
||||
Adjusts the relative volume of the MIDI music. This is only supported by some music devices.
|
||||
|
||||
*midi_gain*
|
||||
|
||||
.. _fluid:
|
||||
|
||||
|
||||
FluidSynth
|
||||
****************
|
||||
|
||||
Opens a new dialog, with three further tabs:
|
||||
:ref:`fsreverb` | `Chorus`_ | `Misc`_
|
||||
|
||||
|
||||
.. figure:: ../images/settings/fluidsynth.png
|
||||
|
||||
The FluidSynth dialog, reached from the MIDI tab.
|
||||
|
||||
.. _fsreverb:
|
||||
|
||||
Reverb
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
Reverberation, or reverb, describes the pattern of echoes and reflections that occur when a sound is heard in an enclosed closed space, such as a room or a concert hall.
|
||||
|
||||
.. _revact:
|
||||
|
||||
Active
|
||||
If ticked, reverb is added to the software synthesizer output.
|
||||
|
||||
*fluidsynth_reverb_activate*
|
||||
|
||||
.. _revroom:
|
||||
|
||||
Room
|
||||
Sets the room size, which determines how much reverb there is.
|
||||
|
||||
*fluidsynth_reverb_roomsize*
|
||||
|
||||
.. _revdamp:
|
||||
|
||||
Damp
|
||||
Dampens higher-frequency reverb, which produces a warmer sound.
|
||||
|
||||
*fluidsynth_reverb_damping*
|
||||
|
||||
.. _revwidth:
|
||||
|
||||
Width
|
||||
Sets the stereo spread of the reverb signal.
|
||||
|
||||
*fluidsynth_reverb_width*
|
||||
|
||||
.. _revlevel:
|
||||
|
||||
Level
|
||||
Sets the reverb output amplitude.
|
||||
|
||||
*fluidsynth_reverb_level*
|
||||
|
||||
,,,,,,,,,,,,,,,,,
|
||||
|
||||
_`Chorus`
|
||||
^^^^^^^^^^^
|
||||
The chorus effect thickens and colors the audio signal so that it sounds as if there are a chorus of instruments playing one part.
|
||||
|
||||
.. _chact:
|
||||
|
||||
Active
|
||||
If ticked, chorus effects are added to the software synthesizer output.
|
||||
|
||||
*fluidsynth_chorus_activate*
|
||||
|
||||
.. _chnr:
|
||||
|
||||
N
|
||||
Sets the voice count of the chorus, in other words, how many instruments are playing one part.
|
||||
|
||||
*fluidsynth_chorus_nr*
|
||||
|
||||
.. _chlevel:
|
||||
|
||||
Level
|
||||
Specifies the output amplitude of the chorus signal.
|
||||
|
||||
*fluidsynth_chorus_level*
|
||||
|
||||
.. _chspeed:
|
||||
|
||||
Speed
|
||||
Sets the modulation speed of the output, in Hz.
|
||||
|
||||
*fluidsynth_chorus_speed*
|
||||
|
||||
.. _chdepth:
|
||||
|
||||
Depth
|
||||
Specifies the modulation depth of the chorus.
|
||||
|
||||
*fluidsynth_chorus_depth*
|
||||
|
||||
.. _chwave:
|
||||
|
||||
Type
|
||||
Specifies the chorus modulation waveform type.
|
||||
|
||||
*fluidsynth_chorus_waveform*
|
||||
|
||||
,,,,,,,,,,,,,
|
||||
|
||||
|
||||
_`Misc`
|
||||
^^^^^^^^^^^^^^
|
||||
.. _interp:
|
||||
|
||||
Interpolation
|
||||
Sets the interpolation method used by the software synthesizer.
|
||||
|
||||
*fluidsynth_misc_interpolation*
|
||||
|
||||
,,,,,,,,,,,,,,,
|
||||
|
||||
|
||||
.. _mt32tab:
|
||||
|
||||
The MT-32 tab
|
||||
-----------------
|
||||
|
||||
Use the MT-32 tab to change the settings of Roland MT-32 devices.
|
||||
|
||||
|
||||
.. figure:: ../images/settings/MT32.png
|
||||
|
||||
The MT-32 tab in the Global Options menu
|
||||
|
||||
,,,,,,,,,,,,,
|
||||
|
||||
.. _mt32:
|
||||
|
||||
MT-32 Device
|
||||
Specifies a preferred MT-32 device, which ScummVM uses if the **Preferred device** is set to **<default>** and MT-32 playback is required.
|
||||
|
||||
*mt32_device*
|
||||
|
||||
.. _nativemt32:
|
||||
|
||||
**True Roland MT-32 (disable GM emulation)**
|
||||
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 conjunction 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.
|
||||
|
||||
*enable_gs*
|
||||
|
||||
|
||||
|
||||
20
doc/docportal/settings/backend.rst
Normal file
20
doc/docportal/settings/backend.rst
Normal file
@@ -0,0 +1,20 @@
|
||||
=====================
|
||||
Backend
|
||||
=====================
|
||||
|
||||
Use the Backend tab to change settings that are unique to the platform being used. This tab is not available for all platforms.
|
||||
|
||||
**To change settings globally:**
|
||||
|
||||
From the Launcher, select **Global Options**, then select the **Backend** tab.
|
||||
|
||||
**To change settings for a specific game:**
|
||||
|
||||
From the Launcher, highlight the game in the games list, and select the **Game Options** button. If the Launcher is in grid view, select the game and then select the gear icon in the popup window. Select the **Backend** tab.
|
||||
|
||||
.. figure:: ../images/settings/backend.jpg
|
||||
|
||||
The Android Backend tab in the Global Options menu
|
||||
|
||||
For a comprehensive look at how to use these settings, check out the individual platform guides.
|
||||
|
||||
36
doc/docportal/settings/cloud.rst
Normal file
36
doc/docportal/settings/cloud.rst
Normal file
@@ -0,0 +1,36 @@
|
||||
================
|
||||
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.
|
||||
|
||||
From the Launcher, select **Global Options**, if necessary click the **>** scroll arrow until the Cloud tab is visible, and then select the **Cloud** tab.
|
||||
|
||||
|
||||
.. figure:: ../images/settings/cloud.png
|
||||
|
||||
The Cloud tab in the Global Options menu
|
||||
|
||||
|
||||
,,,,,,,,,,,,,,,,,,,,,
|
||||
|
||||
Active storage
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
.. note::
|
||||
|
||||
Cloud functionality is not supported on all platforms.
|
||||
|
||||
32
doc/docportal/settings/control.rst
Normal file
32
doc/docportal/settings/control.rst
Normal file
@@ -0,0 +1,32 @@
|
||||
=================
|
||||
Control
|
||||
=================
|
||||
|
||||
Use the Control tab to change settings for joysticks, game controllers, and touch screens. This tab is not always available.
|
||||
|
||||
From the Launcher, select **Global Options**, and then select the **Control** tab.
|
||||
|
||||
.. figure:: ../images/settings/control.png
|
||||
|
||||
The Control tab in the Global Options menu
|
||||
|
||||
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.
|
||||
|
||||
*kbdmouse_speed*
|
||||
|
||||
.. _deadzone:
|
||||
|
||||
Joy deadzone
|
||||
Sets the deadzone for an analog joystick. A lower value will reduce the size of the deadzone.
|
||||
|
||||
*joystick_deadzone*
|
||||
|
||||
Touchpad mouse mode
|
||||
Toggles between direct mode and touchpad mode.
|
||||
1629
doc/docportal/settings/game.rst
Normal file
1629
doc/docportal/settings/game.rst
Normal file
File diff suppressed because it is too large
Load Diff
115
doc/docportal/settings/graphics.rst
Normal file
115
doc/docportal/settings/graphics.rst
Normal file
@@ -0,0 +1,115 @@
|
||||
===============
|
||||
Graphics
|
||||
===============
|
||||
|
||||
Use the Graphics tab to change how games look when they are played.
|
||||
|
||||
**To change settings globally:**
|
||||
|
||||
From the Launcher, select **Global Options**. The Global Options menu opens on the **Graphics** tab.
|
||||
|
||||
**To change settings for a specific game:**
|
||||
|
||||
From the Launcher, highlight the game in the games list, and select the **Game Options** button. If the Launcher is in grid view, select the game and then select the gear icon in the popup window. Select the **Graphics** tab.
|
||||
|
||||
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 Options menu
|
||||
|
||||
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 graphics backend used to render the ScummVM window on the screen. Different graphics modes have different options available (such as scalers and stretch modes).
|
||||
|
||||
*gfx_mode*
|
||||
|
||||
.. _render:
|
||||
|
||||
Render mode
|
||||
Changes how the game is rendered. This is only applicable to certain games which were released on multiple systems, and will reproduce what the game looked like on that system.
|
||||
|
||||
*render_mode*
|
||||
|
||||
.. _stretchmode:
|
||||
|
||||
Stretch mode
|
||||
Changes the way the game is displayed in relation to the window or screen size.
|
||||
|
||||
*stretch_mode*
|
||||
|
||||
.. _scalers:
|
||||
|
||||
Scaler
|
||||
Changes the resolution of the game, while also selecting which filter is used to scale up the resolution. For example, a 2x scaler will take a 320x200 resolution game and scale it up to 640x400.
|
||||
|
||||
*scaler* and *scale_factor*
|
||||
|
||||
Shaders
|
||||
Similar to render mode, but applicable to all games, shaders are graphics filters that change the way a game looks. Select the **Shader** button, select a shader from the list and then select **Choose**. Alternatively, select **Pick file instead...** to browse your computer for shaders to use. ScummVM only accepts GLSL files in the .glslp format.
|
||||
|
||||
.. figure:: ../images/settings/shader_picker.png
|
||||
|
||||
The shader picker
|
||||
|
||||
Once back in the Graphics tab, select **Apply** to apply the chosen shader. A test pattern pops up to preview the chosen shader, along with a confirmation dialog. Choose **Yes** to keep the new shader, or **No** to revert to previous settings. ScummVM reverts to the previous setting in 10 seconds if no action is taken; this is a safety feature.
|
||||
|
||||
.. figure:: ../images/settings/test_pattern.png
|
||||
|
||||
The shader test pattern
|
||||
|
||||
Update Shaders
|
||||
Click on the Update Shaders button to download new or updated shaders. ScummVM will scan to find applicable shader packs; once these have been found, click on the **Download** button in the pop up window to start the download. Click the **Hide** button to close the window and continue the download in the background. Use the **Cancel download** button to cancel the download. Select **Clear Cache** to delete downloaded shaders.
|
||||
|
||||
The shader packs can also be downloaded manually from https://downloads.scummvm.org/frs/icons/ and must be placed in the :ref:`Icon Path <iconspath>`.
|
||||
|
||||
.. _ratio:
|
||||
|
||||
Aspect ratio correction
|
||||
If ticked, corrects the aspect ratio so that games appear the same as they would on original 320x200 resolution displays.
|
||||
|
||||
*aspect_ratio*
|
||||
|
||||
.. _fullscreen:
|
||||
|
||||
Fullscreen mode
|
||||
If ticked, games are played using the entire screen, instead of a window. The actual appearance is defined by the other graphics settings.
|
||||
|
||||
*fullscreen*
|
||||
|
||||
.. _filtering:
|
||||
|
||||
Filter graphics
|
||||
If ticked, uses bilinear interpolation instead of nearest neighbor resampling for the aspect ratio correction and stretch mode. It does not affect the graphics mode.
|
||||
|
||||
*filtering*
|
||||
|
||||
.. _vsync:
|
||||
|
||||
V-Sync in 3D games
|
||||
If ticked, synchronizes the frame rate of a game with the monitor's refresh rate to prevent screen tearing.
|
||||
|
||||
*vsync*
|
||||
|
||||
.. _renderer:
|
||||
|
||||
Game 3D renderer
|
||||
Changes how a 3D game is rendered. This setting has no effect on 2D games.
|
||||
|
||||
- OpenGL: renders on hardware (uses the GPU)
|
||||
- OpenGL with shaders: renders on hardware with shader support
|
||||
- Software: renders on software (uses the CPU).
|
||||
|
||||
*renderer*
|
||||
|
||||
.. _antialiasing:
|
||||
|
||||
3D Anti-aliasing
|
||||
Changes the anti-aliasing method. The number refers to how many samples are taken per pixel; 8x takes 8 samples per pixel and is the most accurate, but is also the most processor-intensive option.
|
||||
|
||||
*antialiasing*
|
||||
77
doc/docportal/settings/gui.rst
Normal file
77
doc/docportal/settings/gui.rst
Normal file
@@ -0,0 +1,77 @@
|
||||
=====================
|
||||
GUI
|
||||
=====================
|
||||
|
||||
Use this tab to the GUI tab to change the look and feel of the ScummVM graphical user interface.
|
||||
|
||||
From the Launcher, select **Global Options**, if necessary click the **>** scroll arrow until the GUI tab is visible, and then select the **GUI** tab.
|
||||
|
||||
|
||||
.. figure:: ../images/settings/gui.png
|
||||
|
||||
The GUI 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.
|
||||
|
||||
,,,,,,,,,,,,,,
|
||||
|
||||
.. _theme:
|
||||
|
||||
Theme
|
||||
Changes the visual appearance of the ScummVM Launcher
|
||||
|
||||
*gui_theme*
|
||||
|
||||
GUI scale
|
||||
Scale the ScummVM GUI to be bigger or smaller. Using a larger scale can help to make the text easier to read when using ScummVM on a big screen.
|
||||
|
||||
*gui_scale*
|
||||
|
||||
GUI renderer
|
||||
Defines how the ScummVM GUI is rendered; normal or antialiased.
|
||||
|
||||
*gui_renderer*
|
||||
|
||||
GUI language
|
||||
Chooses the language of the ScummVM Launcher.
|
||||
|
||||
*gui_language*
|
||||
|
||||
.. _guilanguage:
|
||||
|
||||
Switch the ScummVM GUI language to the game language
|
||||
If ticked, the Launcher language is the same as the game language.
|
||||
|
||||
*gui_use_game_language*
|
||||
|
||||
.. _guibrowser:
|
||||
|
||||
Use native system file browser
|
||||
Uses the system file browser instead of the ScummVM browser.
|
||||
|
||||
*gui_browser_native*
|
||||
|
||||
.. _guireturn:
|
||||
|
||||
Always return to the launcher when leaving a game
|
||||
If ticked, removes the **Quit** option from the Global Main Menu. Only the **Return to Launcher** option remains.
|
||||
|
||||
*gui_return_to_launcher_at_exit*
|
||||
|
||||
.. _guiconfirm:
|
||||
|
||||
Ask for confirmation on exit
|
||||
If ticked, a confirmation dialog appears when you choose **Quit** or **Return to Launcher** from the Global Main Menu.
|
||||
|
||||
*confirm_exit*
|
||||
|
||||
.. _updateicons:
|
||||
|
||||
Update Icons
|
||||
Click on the Update Icons button to download new or updated artwork for game icons. ScummVM will scan to find applicable icons; once these have been found, click on the **Download** button in the pop up window to start the download. Click the **Hide** button to close the window and continue the download in the background. Use the **Cancel download** button to cancel the download.
|
||||
|
||||
.. figure:: ../images/settings/update_icons.png
|
||||
|
||||
The Update Icons window
|
||||
|
||||
The icon packs can also be downloaded manually from https://downloads.scummvm.org/frs/icons/ and must be placed in the :ref:`Icon Path <iconspath>`. The packs are incremental and you need all of them to have all the available icons and not just the most recent pack.
|
||||
250
doc/docportal/settings/keymaps.rst
Normal file
250
doc/docportal/settings/keymaps.rst
Normal file
@@ -0,0 +1,250 @@
|
||||
===============
|
||||
Keymaps
|
||||
===============
|
||||
|
||||
Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or to mouse or joystick buttons.
|
||||
|
||||
|
||||
**To change settings globally:**
|
||||
|
||||
From the Launcher, select **Global Options**, then select the **Keymaps** tab.
|
||||
|
||||
**To change settings for a specific game:**
|
||||
|
||||
From the Launcher, highlight the game in the games list, and select the **Game Options** button. If the Launcher is in grid view, select the game and then select the gear icon in the popup window. Select the **Keymaps** tab.
|
||||
|
||||
.. figure:: ../images/settings/keymaps.png
|
||||
|
||||
The Keymaps tab in the Global Options menu
|
||||
|
||||
.. figure:: ../images/settings/keymaps_dropdown.png
|
||||
|
||||
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.
|
||||
|
||||
,,,,,,,,,,,,,,,,,
|
||||
|
||||
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.
|
||||
|
||||
Reset
|
||||
Resets all keymaps to default.
|
||||
|
||||
Reset to defaults
|
||||
Resets the keymaps for that action to default.
|
||||
|
||||
Clear mapping
|
||||
Clears all keymaps for that action.
|
||||
|
||||
,,,,,,,,,,,,,,,,,,,
|
||||
|
||||
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.
|
||||
|
||||
Global
|
||||
*********
|
||||
.. _gmm:
|
||||
|
||||
Global Main Menu
|
||||
*keymap_global_MENU*
|
||||
|
||||
.. _keymap_mute:
|
||||
|
||||
Toggle mute
|
||||
*keymap_global_MUTE*
|
||||
|
||||
.. _globalquit:
|
||||
|
||||
Quit
|
||||
*keymap_global_QUIT*
|
||||
|
||||
.. _keymap_debug:
|
||||
|
||||
Open Debugger
|
||||
*keymap_global_DEBUGGER*
|
||||
|
||||
.. _vmouseup:
|
||||
|
||||
Virtual mouse up
|
||||
*keymap_global_VMOUSEUP*
|
||||
|
||||
.. _vmousedown:
|
||||
|
||||
Virtual mouse down
|
||||
*keymap_global_VMOUSEDOWN*
|
||||
|
||||
.. _vmouseleft:
|
||||
|
||||
Virtual mouse left
|
||||
*keymap_global_VMOUSELEFT*
|
||||
|
||||
.. _vmouseright:
|
||||
|
||||
Virtual mouse right
|
||||
*keymap_global_VMOUSERIGHT*
|
||||
|
||||
.. _vmouseslow:
|
||||
|
||||
Slow down virtual mouse
|
||||
*keymap_global_VMOUSESLOW*
|
||||
|
||||
Graphics
|
||||
************
|
||||
|
||||
.. _FULS:
|
||||
|
||||
Toggle fullscreen
|
||||
*keymap_sdl-graphics_FULS*
|
||||
|
||||
.. _CAPT:
|
||||
|
||||
Toggle mouse capture
|
||||
*keymap_sdl-graphics_CAPT*
|
||||
|
||||
.. _SCRS:
|
||||
|
||||
Save screenshot
|
||||
*keymap_sdl-graphics_SCRS*
|
||||
|
||||
.. _ASPT:
|
||||
|
||||
Toggle aspect ratio correction
|
||||
*keymap_sdl-graphics_ASPT*
|
||||
|
||||
.. _FILT:
|
||||
|
||||
Toggle linear filtered scaling
|
||||
*keymap_sdl-graphics_FILT*
|
||||
|
||||
.. _STCH:
|
||||
|
||||
Cycle through stretch modes
|
||||
*keymap_sdl-graphics_STCH*
|
||||
|
||||
.. _SCL:
|
||||
|
||||
Increase the scale factor
|
||||
*keymap_sdl-graphics_SCL+*
|
||||
|
||||
Decrease the scale factor
|
||||
*keymap_sdl-graphics_SCL-*
|
||||
|
||||
.. _FLTN:
|
||||
|
||||
Switch to next graphical scale filter
|
||||
*keymap_sdl-graphics_FLTN*
|
||||
|
||||
.. _FLTP:
|
||||
|
||||
Switch to previous graphical scale filter
|
||||
*keymap_sdl-graphics_FLTP*
|
||||
|
||||
GUI
|
||||
*****
|
||||
.. _interact:
|
||||
|
||||
Interact
|
||||
*keymap_gui_INTRCT*
|
||||
|
||||
.. _close:
|
||||
|
||||
Close
|
||||
*keymap_gui_CLOS*
|
||||
|
||||
.. _guiup:
|
||||
|
||||
Up
|
||||
*keymap_gui_UP*
|
||||
|
||||
.. _guidown:
|
||||
|
||||
Down
|
||||
*keymap_gui_DOWN*
|
||||
|
||||
.. _guileft:
|
||||
|
||||
Left
|
||||
*keymap_gui_LEFT*
|
||||
|
||||
.. _guiright:
|
||||
|
||||
Right
|
||||
*keymap_gui_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.
|
||||
|
||||
Default game keymap
|
||||
********************
|
||||
|
||||
.. _LCLK:
|
||||
|
||||
Left mouse button
|
||||
*keymap_engine-default_LCLK*
|
||||
|
||||
.. _MCLK:
|
||||
|
||||
Middle click
|
||||
*keymap_engine-default_MCLK*
|
||||
|
||||
.. _RCLK:
|
||||
|
||||
Right click
|
||||
*keymap_engine-default_RCLK*
|
||||
|
||||
.. _pause:
|
||||
|
||||
Pause
|
||||
*keymap_engine-default_PAUSE*
|
||||
|
||||
.. _menu:
|
||||
|
||||
Game menu
|
||||
keymap_engine-default_MENU
|
||||
|
||||
.. _skip:
|
||||
|
||||
Skip
|
||||
*keymap_engine-default_SKIP*
|
||||
|
||||
.. _SKLI:
|
||||
|
||||
Skip line
|
||||
*keymap_engine-default_SKLI*
|
||||
|
||||
.. _PIND:
|
||||
|
||||
Predictive input dialog
|
||||
*keymap_engine-default_PIND*
|
||||
|
||||
.. _RETURN:
|
||||
|
||||
Confirm
|
||||
*keymap_engine-default_RETURN*
|
||||
|
||||
.. _up:
|
||||
|
||||
Up
|
||||
*keymap_engine-default_UP*
|
||||
|
||||
.. _down:
|
||||
|
||||
Down
|
||||
*keymap_engine-default_DOWN*
|
||||
|
||||
.. _left:
|
||||
|
||||
Left
|
||||
*keymap_engine-default_LEFT*
|
||||
|
||||
.. _right:
|
||||
|
||||
Right
|
||||
*keymap_engine-default_RIGHT*
|
||||
39
doc/docportal/settings/lan.rst
Normal file
39
doc/docportal/settings/lan.rst
Normal file
@@ -0,0 +1,39 @@
|
||||
==============
|
||||
LAN
|
||||
==============
|
||||
|
||||
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.
|
||||
|
||||
From the Launcher, select **Global Options**, if necessary click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
|
||||
|
||||
|
||||
.. figure:: ../images/cloud_and_lan/LAN.png
|
||||
|
||||
The LAN tab in the Global Options menu
|
||||
|
||||
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.
|
||||
|
||||
Stop server
|
||||
Stops the web server.
|
||||
|
||||
.. _serverport:
|
||||
|
||||
Server's port
|
||||
The port on which the web server is available.
|
||||
|
||||
*local_server_port*
|
||||
|
||||
.. _rootpath:
|
||||
|
||||
/root/ Path
|
||||
Specifies the root path of the server. Any sub-directories will be accessible.
|
||||
|
||||
*rootpath*
|
||||
|
||||
41
doc/docportal/settings/misc.rst
Normal file
41
doc/docportal/settings/misc.rst
Normal file
@@ -0,0 +1,41 @@
|
||||
======================
|
||||
Miscellaneous
|
||||
======================
|
||||
|
||||
Use the Misc tab to change miscellaneous settings that don’t belong on any of the other tabs.
|
||||
|
||||
From the Launcher, select **Global Options**, if necessary click the **>** scroll arrow until the Misc tab is visible, and then select the **Misc** tab.
|
||||
|
||||
.. figure:: ../images/settings/misc.png
|
||||
|
||||
The Misc tab in the Global Options menu
|
||||
|
||||
All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
|
||||
|
||||
,,,,,,,,,,,,,,,,,
|
||||
|
||||
.. _autosave:
|
||||
|
||||
Autosave
|
||||
Adjusts the time period between autosaves. The default setting is 5 minutes.
|
||||
|
||||
*autosave_period*
|
||||
|
||||
.. _seed:
|
||||
|
||||
Random seed
|
||||
Every time you start ScummVM, a random seed is generated. Use this option to set a fixed seed, which ensures that random events in games play out the same way every time.
|
||||
|
||||
*random_seed*
|
||||
|
||||
.. _discord:
|
||||
|
||||
Enable Discord Integration
|
||||
Show the currently running game in a Discord user's status (if Activity Status is also enabled in the Discord settings).
|
||||
|
||||
.. figure:: ../images/settings/discord_integration.png
|
||||
|
||||
.. _updatecheck:
|
||||
|
||||
Update check
|
||||
Use this option to automatically check for updates to ScummVM. Click the Check now button to manually check for updates.
|
||||
58
doc/docportal/settings/paths.rst
Normal file
58
doc/docportal/settings/paths.rst
Normal file
@@ -0,0 +1,58 @@
|
||||
==============
|
||||
Paths
|
||||
==============
|
||||
|
||||
Use the Paths tab to tell ScummVM where to look for files.
|
||||
|
||||
|
||||
**To change settings globally:**
|
||||
|
||||
From the Launcher, select **Global Options**, then select the **Paths** tab.
|
||||
|
||||
**To change settings for a specific game:**
|
||||
|
||||
From the Launcher, highlight the game in the games list, and select the **Game Options** button. If the Launcher is in grid view, select the game and then select the gear icon in the popup window. Select the **Paths** tab.
|
||||
|
||||
.. figure:: ../images/settings/paths.png
|
||||
|
||||
The Paths tab in the Global Options menu
|
||||
|
||||
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*
|
||||
|
||||
.. _themepath:
|
||||
|
||||
Theme Path
|
||||
Sets the path to the folder in which ScummVM stores additional themes.
|
||||
|
||||
*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.
|
||||
|
||||
*extrapath*
|
||||
|
||||
.. _iconspath:
|
||||
|
||||
Icon Path
|
||||
Sets the path to the folder in which ScummVM will look for additional icons for the launcher grid view.
|
||||
|
||||
*iconspath*
|
||||
|
||||
ScummVM config path:
|
||||
Shows where the :doc:`../advanced_topics/configuration_file` is saved.
|
||||
|
||||
Last browser path:
|
||||
Shows the last folder accessed by the file browser. See more about the :ref:`file browser <add and play games>` here.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user