[Scummvm-git-logs] scummvm master -> 16312141bbd462acb422e292040f74558c7d4533
Mataniko
mataniko at gmail.com
Mon Nov 30 22:42:08 UTC 2020
This automated email contains information about 57 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
acb3b18fdf DOCS: adds sphinx-panels extension
9b0c757e39 DOCS: tidies up PSP/Vita/switch pages
4b4f8300ea DOCS: fixes table width issues
d7a473becb DOCS: fixes tables PS Vita
271b760fdc DOCS: removes width directive
6f33248e1a DOCS: removes width directive from tables
add423b30d DOCS: tidies up the FAQ
b9311bd517 DOCS: adds first draft Dreamcast page
ad5916343e DOCS: changes Mac OSX to macOS/Mac OSX
183d7b325f DOCS: adds tech writer guidelines page
3dd5521a16 DOCS: adds custom css to change table display
e3054a1892 DOCS: tidies up CLI page
1a7b9d9214 DOCS: updates/corrects Dreamcast page
d8e94dd896 DOCS: adds first drafts 3DS/AmigaOS pages
ec4a3c3e94 DOCS: removes CLI info from add/play games page
4dd6ea3599 DOCS: adds gatekeeper info to mac install section
b4f3bc8b86 DOCS: tidies up platform pages
7a8790f052 DOCS: tidies up config file page
00d41e07e6 DOCS: rearranges doc structure
3311fc8097 DOCS: second draft 3DS page
f2472bad5f DOCS: second draft AmigaOS
78d536b4e5 DOCS: adds first draft RISC OS page
4cdcdd4181 DOCS: updates settings on 3DS page
1ca6f66d3a DOCS: final draft How to use ScummVM pages
d7caec5046 DOCS: renames section
5751f88892 DOCS: edits Settings pages
3ca78637b8 DOCS: fixes ref on config file page
9eb5c0f67c DOCS: adds port page template
7f0ca4d2c3 DOCS: rearranges the project
055d40b56b DOCS: adds Atari/FreeMiNT page
62598c8951 DOCS: final draft getting started section
446ffbf0e2 DOCS: style edits to multiple pages
711fa2422f DOCS: removes double up info from bug reporting
fd6af89663 DOCS: fixes link
fb3f2dad63 DOCS: change Getting Started to Get Started.
6d553eb5f9 DOCS: final drafts
2b9bcd6d7a DOCS: final drafts all pages
4206bc5035 DOCS: changes logo and theming
c50acc2014 DOCS: changes pdf output fonts
23853634a6 DOCS: changes PDF output font
73a6cc4306 DOCS: changes PDF fonts
e123f389fa DOCS: fixes PDF font spelling
9b50c278a6 DOCS: changes PDF output
7d39826b26 DOCS: multiple changes in response to review
9804f4e23b DOCS: changes layout of site
b80d05563f DOCS: adds missing cmd line/config file keys
6c20b03eb1 DOCS: refines templates - settings/platform pages
028a11c2d0 DOCS: tidies up FAQ
d42a2241be DOCS: adds ref to new game files page
e20ec44f80 DOCS: adds config file ref
547201b294 DOCS: changes title of install page
c1f6c2f638 DOCS: excludes 'contribute' folder from build
be131fdde6 DOCS: updates landing page with other platforms
81cb95b514 DOCS: changes location of templates
4177a80927 DOCS: clarifies config key table
f5123047ca DOCS: adds info to iOS page - trusting built app
16312141bb DOCS: fixes multiple small things
Commit: acb3b18fdf540c2db07cffb4af06313a013d29bd
https://github.com/scummvm/scummvm/commit/acb3b18fdf540c2db07cffb4af06313a013d29bd
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds sphinx-panels extension
- fixes table word-wrapping by adding custom css
- adds the ability to use bootstrap elements in the output
- trials a card-based front page
Changed paths:
A doc/docportal/_static/custom.css
doc/docportal/conf.py
doc/docportal/index.rst
doc/docportal/requirements.txt
diff --git a/doc/docportal/_static/custom.css b/doc/docportal/_static/custom.css
new file mode 100644
index 0000000000..06345495f9
--- /dev/null
+++ b/doc/docportal/_static/custom.css
@@ -0,0 +1,14 @@
+/* override table width restrictions */
+ at media screen and (min-width: 1080px) {
+
+ .wy-table-responsive table td {
+ /* !important prevents the common CSS stylesheets from overriding
+ this as on RTD they are loaded after this stylesheet */
+ white-space: normal !important;
+ }
+
+ .wy-table-responsive {
+ overflow: visible !important;
+ }
+ }
+
\ No newline at end of file
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index b8fa41ff42..88aa779ff1 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -34,10 +34,11 @@ extensions = [
"sphinx_rtd_theme",
"recommonmark",
-
+ "sphinx_panels"
]
extensions.append('sphinx_tabs.tabs')
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -54,10 +55,21 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
#
html_theme = "sphinx_rtd_theme"
+html_css_files = ["https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"]
+
+html_js_files = ["https://kit.fontawesome.com/b9732bf460.js"]
+
+html_static_path = ['_static']
+
+def setup(app):
+ app.add_css_file("custom.css")
+
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
master_doc = 'index'
-html_sidebars = {'**': ['localtoc.html']}
\ No newline at end of file
+html_sidebars = {'**': ['localtoc.html']}
+
+panels_add_fontawesome_latex = True
\ No newline at end of file
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index f308bc4f0a..308dd38c0a 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -99,26 +99,68 @@ First steps
We have guides available to show you how to get ScummVM up and running:
-- **Quickstart**: :doc:`getting_started/mac_linux_windows`
-- **Phones and Tablets**: :doc:`other_platforms/ios` | :doc:`other_platforms/android`
-- **Consoles**: :doc:`other_platforms/ps_vita` | :doc:`other_platforms/psp` | :doc:`other_platforms/nintendo_switch`
+.. panels::
+ :container: container-fluid text-center mb-4
+
+ Getting started
+ ^^^^^^^^^^^^
-How do I...?
-=============
+ :doc:`getting_started/mac_linux_windows`
+ ---
+
+ Phones and Tablets
+ ^^^^^^^^^^^^^^^^^^^
+ :doc:`other_platforms/ios`
+
+ :doc:`other_platforms/android`
+
+ ---
+
+ Consoles
+ ^^^^^^^^^^^^^^^^^^^
+ :doc:`other_platforms/ps_vita`
+
+ :doc:`other_platforms/psp`
+
+ :doc:`other_platforms/nintendo_switch`
+
+ ---
+
+ Other systems
+ ^^^^^^^^^^^^^^^
+
+
+
+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:
-- **Understanding the interface**: :doc:`using_scummvm/the_launcher`
-- **Playing games**: :doc:`using_scummvm/add_play_games` | :doc:`using_scummvm/save_load_games` | :doc:`using_scummvm/keyboard_shortcuts`
-- **Settings**: :doc:`using_scummvm/how_to_settings`
+.. panels::
+ :container: text-center mb-4
-Definitive guides
-=====================
+ Understand the interface
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ :doc:`using_scummvm/the_launcher`
+
+ ---
+
+ Play games
+ ^^^^^^^^^^^^^^
+ :doc:`using_scummvm/add_play_games`
+
+ :doc:`using_scummvm/save_load_games`
-We do some deep dives into ScummVM features - from audio settings to our brand new Cloud functionality. Check out our Guides section!
+ :doc:`using_scummvm/keyboard_shortcuts`
+
+ ---
+ :column: col-lg-12
+
+ Change settings
+ ^^^^^^^^^^^^^^^^^^^^^
+ :doc:`using_scummvm/how_to_settings`
-:doc:`guides/understand_audio` | :doc:`guides/understand_graphics`
The games!
============
@@ -130,12 +172,42 @@ If you haven't had a floppy disc or even a CD in your possession for a while, we
Make sure you check out the `compatibility list <https://www.scummvm.org/compatibility/>`_ on our website and the `Supported Games page <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ on our wiki before you buy a game, to ensure it can run with ScummVM.
+Definitive guides
+=====================
+
+In our Guides section, we do some deep dives into ScummVM features.
+
+.. panels::
+ :container: text-center mb-4
+
+ Settings
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ :doc:`guides/understand_audio`
+
+ :doc:`guides/understand_graphics`
+
+ ---
+
+ How to:
+ ^^^^^^^^^^^^^^
+ :doc:`guides/local_webserver`
+
+ :doc:`guides/connect_cloud`
+
+
Advanced options
============================
For our more experienced users, ScummVM has a command line interface, as well as the ability to edit settings directly in a configuration file.
-:doc:`advanced_options/configuration_file` | :doc:`advanced_options/command_line`
+
+.. panels::
+ :container: text-center mb-4
+ :column: col-lg-12
+
+ :doc:`advanced_options/configuration_file`
+
+ :doc:`advanced_options/command_line`
Getting help
@@ -145,7 +217,15 @@ ScummVM is still under development. While we do our best to make sure that as ma
If you are having problems with any aspect of ScummVM, take a look at our help section.
-:doc:`help/faq` | :doc:`How to report a bug <help/report_bugs>` | :doc:`help/contact`
+.. panels::
+ :container: text-center mb-4
+ :column: col-lg-12
+
+ :doc:`help/faq`
+
+ :doc:`How to report a bug <help/report_bugs>`
+
+ :doc:`help/contact`
What's changed since I was last here?
======================================
@@ -159,6 +239,6 @@ ScummVM is an open-source project.
If you enjoy ScummVM, feel free to donate using the PayPal button on the `ScummVM homepage <https://www.scummvm.org>`__. This will help us buy the utilities to develop ScummVM faster and more efficiently.
-If you cannot donate but you have the skills, you can help us by contributing a patch!
+If you cannot donate but you have coding or writing skills, you can help us by contributing!
-- **Contributing Guidelines**: `Code <#>`__ | `Documentation <#>`__
+For more information, see the `Contribution guide <#>`_ on our wiki.
\ No newline at end of file
diff --git a/doc/docportal/requirements.txt b/doc/docportal/requirements.txt
index 0c4cdeebe6..04912bf16e 100644
--- a/doc/docportal/requirements.txt
+++ b/doc/docportal/requirements.txt
@@ -1 +1,2 @@
-sphinx-tabs
\ No newline at end of file
+sphinx-tabs
+sphinx-panels
\ No newline at end of file
Commit: 9b0c757e398cb1b33b5649d33c626349dd168867
https://github.com/scummvm/scummvm/commit/9b0c757e398cb1b33b5649d33c626349dd168867
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: tidies up PSP/Vita/switch pages
- adds icons for square/circle/triagle/cross buttons
- rearranges control mapping to be more logical
-aligns button names with official hardware names
Changed paths:
doc/docportal/other_platforms/nintendo_switch.rst
doc/docportal/other_platforms/ps_vita.rst
doc/docportal/other_platforms/psp.rst
diff --git a/doc/docportal/other_platforms/nintendo_switch.rst b/doc/docportal/other_platforms/nintendo_switch.rst
index aa5fabc3e4..076654042b 100644
--- a/doc/docportal/other_platforms/nintendo_switch.rst
+++ b/doc/docportal/other_platforms/nintendo_switch.rst
@@ -40,29 +40,37 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+.. |plus| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M8 2a.75.75 0 01.75.75v4.5h4.5a.75.75 0 010 1.5h-4.5v4.5a.75.75 0 01-1.5 0v-4.5h-4.5a.75.75 0 010-1.5h4.5v-4.5A.75.75 0 018 2z"></path></svg>
+
+.. |minus| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M2 8a.75.75 0 01.75-.75h10.5a.75.75 0 010 1.5H2.75A.75.75 0 012 8z"></path></svg>
+
.. csv-table::
- :widths: 40 60
+ :width: 100%
:header-rows: 1
Button,Action
Left stick,Mouse
- R + Left stick,Slow Mouse
- B,Left mouse button
- A,Right mouse button
- DPad,"Keypad 'Cursor' Keys"
- R + DPad,"Diagonal Keypad 'Cursor' Keys"
- L Trigger,Game menu (F5)
- R Trigger,Shift
- Y,Period
- R + Y,Space
- X,Escape
- R + X,Return
- Plus,Global main menu (GMM)
- Minus,Toggle virtual keyboard
- R + Minus,AGI predictive input dialog
+ Left stick + R button,Slow Mouse
+ :kbd:`B`,Left mouse button
+ :kbd:`A`,Right mouse button
+ Directional buttons,"Keypad 'Cursor' Keys"
+ Directional buttons + R button ,"Diagonal Keypad 'Cursor' Keys"
+ L button,Game menu (F5)
+ R button,Shift
+ :kbd:`Y`,Period
+ :kbd:`Y` + R button,Space
+ :kbd:`X`,Escape
+ :kbd:`X` + R button,Return
+ |plus|,Global main menu (GMM)
+ |minus|,Toggle virtual keyboard
+ |minus| + R button,AGI predictive input dialog
.. csv-table::
- :widths: 40 60
+ :width: 100%
:header-rows: 2
"Touch Controls (Touchpad Mouse Mode Off, Default)",
@@ -74,7 +82,7 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
`Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
.. csv-table::
- :widths: 40 60
+ :width: 100%
:header-rows: 2
Touch Controls (Touchpad Mouse Mode On),
@@ -97,7 +105,7 @@ Touch support
For multi-touch gestures, the fingers have to be far enough apart from each other that the Switch will not erroneously recognize them as a single finger, otherwise the pointer will jump around.
-The touch control scheme can be switched in the global settings. Go to **Options > Controls > Touchpad mouse mode**.
+The touch control scheme can be switched in the global settings. Go to **Options > Control > Touchpad mouse mode**.
- When touchpad mouse mode is off (default), the touch controls are direct. The pointer always jumps to the finger.
diff --git a/doc/docportal/other_platforms/ps_vita.rst b/doc/docportal/other_platforms/ps_vita.rst
index f5f1dc122c..f5e0a8d9cb 100644
--- a/doc/docportal/other_platforms/ps_vita.rst
+++ b/doc/docportal/other_platforms/ps_vita.rst
@@ -50,30 +50,47 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+
+.. |square| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="5 2 16 16" width="20" height="20"><path fill-rule="evenodd" d="M6 7.75C6 6.784 6.784 6 7.75 6h8.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0116.25 18h-8.5A1.75 1.75 0 016 16.25v-8.5zm1.75-.25a.25.25 0 00-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 00.25-.25v-8.5a.25.25 0 00-.25-.25h-8.5z"></path></svg>
+
+.. |circle| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.404 3.404a6.5 6.5 0 109.192 9.192 6.5 6.5 0 00-9.192-9.192zm-1.06 10.253A8 8 0 1113.656 2.343 8 8 0 012.343 13.657z"></path></svg>
+
+.. |x| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.72 3.72a.75.75 0 011.06 0L8 6.94l3.22-3.22a.75.75 0 111.06 1.06L9.06 8l3.22 3.22a.75.75 0 11-1.06 1.06L8 9.06l-3.22 3.22a.75.75 0 01-1.06-1.06L6.94 8 3.72 4.78a.75.75 0 010-1.06z"></path></svg>
+
+.. |triangle| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24"><path d="M11.574 3.712c.195-.323.662-.323.857 0l9.37 15.545c.2.333-.039.757-.429.757l-18.668-.006c-.385 0-.629-.422-.428-.758l9.298-15.538zm.429-2.483c-.76 0-1.521.37-1.966 1.111l-9.707 16.18c-.915 1.523.182 3.472 1.965 3.472h19.416c1.783 0 2.879-1.949 1.965-3.472l-9.707-16.18c-.446-.741-1.205-1.111-1.966-1.111z"/></svg>
+
.. csv-table::
- :widths: 40 60
+ :width: 100%
:header-rows: 2
Game Controller Mapping,
Button,Action
Left stick,Mouse
- R + Left stick,Slow Mouse
- Cross,Left mouse button
- Circle,Right mouse button
- DPad,Keypad 'Cursor' Keys
- R + DPad,Diagonal Keypad 'Cursor' Keys
- L Trigger,Game menu (F5)
- R Trigger,Shift
- Square,Period
- R + Square,Space '
- Triangle,Escape
- R + Triangle,Return
- Start,Global main menu (GMM)
- Select,Toggle virtual keyboard
- R + Select,AGI predictive input dialog
+ Left stick + R button,Slow Mouse
+ |x|,Left mouse button
+ |circle|,Right mouse button
+ Directional buttons,Keypad 'Cursor' Keys
+ Directional buttons + R button,Diagonal Keypad 'Cursor' Keys
+ L button,Game menu (F5)
+ R button,Shift
+ |square|,Period (.)
+ R button + |square|,Spacebar
+ |triangle|,Escape
+ R button + |triangle|,Return
+ START,Global main menu (GMM)
+ SELECT,Toggle virtual keyboard
+ SELECT + R button,AGI predictive input dialog
.. csv-table::
- :widths: 40 60
+ :width:100%
:header-rows: 2
"Front Touchscreen Controls, always enabled",
@@ -85,7 +102,7 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
`Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
.. csv-table::
- :widths: 40 60
+ :width:100%
:header-rows: 2
"Back Touchpad Controls, enabled via settings",
@@ -110,20 +127,20 @@ Real bluetooth mice and keyboards work on the Vita and are supported by ScummVM.
Touch support
****************
-For multi-touch gestures, the fingers have to be far enough apart from each other that the Switch will not erroneously recognize them as a single finger, otherwise the pointer will jump around.
+For multi-touch gestures, the fingers have to be far enough apart from each other that the Vita will not recognize them as a single finger, otherwise the pointer will jump around.
-The touch control scheme can be switched in the global settings. Go to **Options > Controls**:
+The touch control scheme can be switched in the global settings. Go to **Options > Control**:
- When **Touchpad mouse mode** is off:
- The touch controls are direct, which means the pointer always jumps to the finger position.
- - The rear touchpad is disabled.
+ - The rear touch pad is disabled.
- When **Touchpad mouse mode** is on:
- The touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
- - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
- - The rear touchpad is enabled.
+ - The pointer speed setting in the :doc:`Control tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
+ - The rear touch pad is enabled.
The front touchscreen uses the direct mode by default, but this can be changed by editing the :doc:`configuration file <../advanced_options/configuration_file>` with the following keyword:
@@ -132,7 +149,7 @@ The front touchscreen uses the direct mode by default, but this can be changed b
*frontpanel_touchpad_mode*
-When set to true, this forces the front touchscreen into an indirect mode similar to the rear touchpad.
+When set to true, the touch controls on the front touchscreen are indirect.
Two finger drag
^^^^^^^^^^^^^^^^^^^
diff --git a/doc/docportal/other_platforms/psp.rst b/doc/docportal/other_platforms/psp.rst
index 0542eabd03..2e269062d4 100644
--- a/doc/docportal/other_platforms/psp.rst
+++ b/doc/docportal/other_platforms/psp.rst
@@ -19,7 +19,7 @@ The PSP package is available for download on our website's `Downloads page <http
Download the ``.zip`` archive to a computer, and extract the files.
-Connect the PSP to the computer by USB cable. Go to **Settings > USB Connection** on the PSP. The computer should automatically open the root folder of the PSP. Alternatively, if you have a Memory Stick adapter, copy the files directly to the Memory Stick.
+Connect the PSP to the computer by USB cable. Go to **Settings > USB Connection** on the PSP. Ensure the **USB Device** option is set to **Memory Stick**. The computer should automatically open the root folder of the PSP. Alternatively, if you have a Memory Stick adapter, copy the files directly to the Memory Stick.
Copy the extracted ``scummvm`` folder to your PSP, into the ``/PSP/GAME/`` folder.
@@ -42,63 +42,81 @@ These controls can also be manually configured in the :doc:`Keymaps tab <../sett
See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+
+.. |square| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="5 2 16 16" width="20" height="20"><path fill-rule="evenodd" d="M6 7.75C6 6.784 6.784 6 7.75 6h8.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0116.25 18h-8.5A1.75 1.75 0 016 16.25v-8.5zm1.75-.25a.25.25 0 00-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 00.25-.25v-8.5a.25.25 0 00-.25-.25h-8.5z"></path></svg>
+
+.. |circle| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.404 3.404a6.5 6.5 0 109.192 9.192 6.5 6.5 0 00-9.192-9.192zm-1.06 10.253A8 8 0 1113.656 2.343 8 8 0 012.343 13.657z"></path></svg>
+
+.. |x| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.72 3.72a.75.75 0 011.06 0L8 6.94l3.22-3.22a.75.75 0 111.06 1.06L9.06 8l3.22 3.22a.75.75 0 11-1.06 1.06L8 9.06l-3.22 3.22a.75.75 0 01-1.06-1.06L6.94 8 3.72 4.78a.75.75 0 010-1.06z"></path></svg>
+
+.. |triangle| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24"><path d="M11.574 3.712c.195-.323.662-.323.857 0l9.37 15.545c.2.333-.039.757-.429.757l-18.668-.006c-.385 0-.629-.422-.428-.758l9.298-15.538zm.429-2.483c-.76 0-1.521.37-1.966 1.111l-9.707 16.18c-.915 1.523.182 3.472 1.965 3.472h19.416c1.783 0 2.879-1.949 1.965-3.472l-9.707-16.18c-.446-.741-1.205-1.111-1.966-1.111z"/></svg>
+
+
.. csv-table::
- :widths: 40 60
+ :width: 100%
:header-rows: 2
Game Controller Mapping,
Button,Action
- Right trigger,Modifier key
- Left trigger,ESC
- Analog,Mouse movement
- Right trigger + Analog,Fine mouse movement
- D-Pad,Arrow keys
- D-Pad + Right Trigger,Diagonal arrow keys
- Triangle,Enter
- Cross,Left Mouse Button
- Circle,Right Mouse Button
- Square,Period
- Right trigger + Square,Spacebar
- Right trigger + Start,F5
- Select,Show/Hide Virtual Keyboard. Hold down to move keyboard onscreen (with D-Pad).
- Right trigger + Select,Show Image Viewer
- Start,Global main menu
+ R button,Modifier key
+ L button,ESC
+ Analog stick,Mouse movement
+ Analog stick + R button,Fine mouse movement
+ Directional buttons,Arrow keys
+ Directional buttons + R button,Diagonal arrow keys
+ |triangle|,Enter
+ |x|,Left Mouse Button
+ |circle|,Right Mouse Button
+ |square|,Period
+ |square| + R button,Spacebar
+ SELECT,Show/Hide Virtual Keyboard. Hold down to move keyboard onscreen (with Directional buttons).
+ SELECT + R button ,Show Image Viewer
+ START,Global main menu
+ START + R button,F5
.. csv-table::
- :widths: 40 60
+ :width: 100%
:header-rows: 1
Virtual Keyboard Mode,
- Start,Enter. Also exits virtual keyboard mode
- Select,Exit the virtual keyboard mode
- Right trigger,Input: lowercase/uppercase letters (press to toggle)
- Left trigger,Input: numbers/symbols (press to toggle)
- D-Pad,"Select square of characters (up, down, left or right)"
- Buttons/Triggers,Choose a specific character in the square. The four center characters are chosen by the button in the corresponding position. The 2 top characters are chosen by the triggers.
- Analog,Moves in a direction (left/right/up/down)
+ START,Enter. Also exits virtual keyboard mode
+ SELECT,Exit the virtual keyboard mode
+ R button,Input: lowercase/uppercase letters (press to toggle)
+ L button,Input: numbers/symbols (press to toggle)
+ Directional buttons,"Select square of characters (up, down, left or right)"
+ |triangle| |x| |circle| |square| and L/R buttons,Choose a specific character in the square. The four center characters are chosen by the button in the corresponding position. The 2 top characters are chosen by the L/R buttons.
+ Analog stick,Moves in a direction (left/right/up/down)
.. csv-table::
- :widths: 40 60
+ :width: 100%
:header-rows: 1
Image Viewer,
- Left/Right,Previous/next image
- Up/down,Zoom in/out
- Analog,Move around the image
- "Triggers, Start",Exit image viewer
+ Left/right directional buttons,Previous/next image
+ Up/down directional buttons ,Zoom in/out
+ Analog stick,Move around the image
+ "L/R buttons + START",Exit image viewer
.. csv-table::
- :widths: 40 60
+ :width: 100%
:header-rows: 1
1st Person Game Mode ,
- Right Trigger + Left Trigger + Square,Enable 1st Person Mode
- Square,Modifier key (instead of Right Trigger)
- Left/Right Trigger,Strafe left/right
- D-Pad Left/Right,Turn left/right
- Square + D-Pad,F1/F2/F3/F4
- Square + Select,Image Viewer
- Square + Start,Esc
+ |square| + R button + L button,Enable 1st Person Mode
+ |square|,Modifier key (instead of R button)
+ L/R button,Strafe left/right
+ Directional buttons left/right,Turn left/right
+ |square| + Directional buttons,F1/F2/F3/F4
+ |square| + SELECT,Image Viewer
+ |square| + START,Esc
Settings
===========================
@@ -107,12 +125,6 @@ For more information, see the Settings section of the documentation. Only platfo
Audio
*******
-Supported audio file formats:
-
-- ``.mp3``
-- ``.ogg``
-- Uncompressed audio
-
Games will generally run faster if audio files are in the ``.mp3`` file format.
@@ -133,5 +145,3 @@ Known issues
==============
- Plugin files are not interchangeable between ScummVM versions. You must copy all the plugin files found in the ``PSP/GAME/scummvm/plugin/`` folder for every new version you install. If ScummVM crashes on startup, delete the existing plugin files in the plugin directory and copy the new ones again.
-
-- The PSP does not support audio files in the ``.flac`` file format. For games with voice (talkies), ensure the ``monster.sou`` file is not compressed to ``monster.sof``.
\ No newline at end of file
Commit: 4b4f8300ea8164d7b15b3c2c23f23df28b5fceb6
https://github.com/scummvm/scummvm/commit/4b4f8300ea8164d7b15b3c2c23f23df28b5fceb6
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: fixes table width issues
- sets tables to take up 100% of screen width
Changed paths:
doc/docportal/advanced_options/command_line.rst
doc/docportal/advanced_options/configuration_file.rst
doc/docportal/using_scummvm/keyboard_shortcuts.rst
diff --git a/doc/docportal/advanced_options/command_line.rst b/doc/docportal/advanced_options/command_line.rst
index 56a6169405..84717a4bc2 100755
--- a/doc/docportal/advanced_options/command_line.rst
+++ b/doc/docportal/advanced_options/command_line.rst
@@ -11,7 +11,8 @@ Short options are listed where they are available.
.. csv-table::
:header-rows: 1
-
+ :width: 100%
+
Option,Short,Description
\--add,-a,"Add all games from current or specified directory.
diff --git a/doc/docportal/advanced_options/configuration_file.rst b/doc/docportal/advanced_options/configuration_file.rst
index d99d02b79e..26146e9c57 100755
--- a/doc/docportal/advanced_options/configuration_file.rst
+++ b/doc/docportal/advanced_options/configuration_file.rst
@@ -14,40 +14,83 @@ The configuration file saves to different default locations, depending on the pl
-.. tabs::
+.. tabbed:: macOS
- .. tab:: Mac OSX
+ .. panels::
+ :column: col-lg-12 mb-2
- ``~/Library/Preferences/ScummVM Preferences``, where ``~`` is your Home directory. To see the Libraries folder you will need to view hidden files.
+ ``~/Library/Preferences/ScummVM Preferences``, where ``~`` is your Home directory.
- Note that if an earlier version of ScummVM was installed on your system, the previous default location of ``~/.scummvmrc`` will be kept.
+ .. note::
+
+ If an earlier version of ScummVM was installed on your system, the configuration file remains in the previous default location of ``~/.scummvmrc``.
+
+ .. tip::
+
+ To see the Libraries folder you will need to view hidden files by using the keyboard shortcut :kbd:`Cmd + Shift + . `
+
- .. tab:: Windows
+.. tabbed:: Windows
- **95/98/ME**:
+ .. panels::
+ :column: col-lg-12 mb-2
+
+ 95/98/ME
+ ^^^^^^^^^^
+
``<windir>\scummvm.ini``
+
+ ---
+ :column: col-lg-12 mb-2
+
+ Windows NT4
+ ^^^^^^^^^^^^
+
+ ``<windir>\Profiles\username\Application Data\ScummVM\scummvm.ini``
+
+ ---
+ :column: col-lg-12 mb-2
+
+ Windows 2000/XP
+ ^^^^^^^^^^^^^^^^^
+ ``\Documents and Settings\username\Application Data\ScummVM\scummvm.ini``
- **Windows NT4**: ``<windir>\Profiles\username\Application Data\ScummVM\scummvm.ini``
+ ---
+ :column: col-lg-12 mb-2
+
+ Window 7/Vista
+ ^^^^^^^^^^^^^^^^
+ ``\Users\username\AppData\Roaming\ScummVM\scummvm.ini``
+
+ .. tip::
``<windir>`` refers to the Windows directory. Most commonly, this is ``C:\WINDOWS``.
-
- **Windows 2000/XP**: ``\Documents and Settings\username\Application Data\ScummVM\scummvm.ini``
- **Window 7/Vista**: ``\Users\username\AppData\Roaming\ScummVM\scummvm.ini``
+ .. note::
+
+ If an earlier version of ScummVM was installed under Windows, the configuration file remains in the previous default location of ``<windir>\scummvm.ini``
- Note that if an earlier version of ScummVM was installed under Windows, the previous default location of ``<windir>\scummvm.ini`` will be kept.
+.. tabbed:: Linux/Unix
- .. tab:: Linux/Unix
+ .. panels::
+ :column: col-lg-12 mb-2
We follow the XDG Base Directory Specification. This means our configuration can be found in ``$XDG_CONFIG_HOME/scummvm/scummvm.ini``
- If XDG_CONFIG_HOME is not defined or empty, ``~/.config`` will be used, where ``~`` is your Home directory.
+ If XDG_CONFIG_HOME is not defined or empty, ``~/.config`` is used, where ``~`` is your Home directory.
- Note that ``.config`` is a hidden directory; to view it use ``ls -a`` on the command line. If you are using a GUI file manager, go to **View > Show Hidden Files**, or use the keyboard shortcut :kbd:`Ctrl + H`.
-
If ScummVM was installed using Snap, the configuration file can be found at ``~/snap/scummvm/current/.config/scummvm/scummvm.ini``
- .. tab:: Other
+ .. note::
+
+ ``.config`` is a hidden directory. To view it use ``ls -a`` on the command line. If you are using a GUI file manager, go to **View > Show Hidden Files**, or use the keyboard shortcut :kbd:`Ctrl + H`.
+
+
+
+.. tabbed:: Other
+
+ .. panels::
+ :column: col-lg-12 mb-2
See the relevant Platform page for details.
@@ -55,7 +98,7 @@ The configuration file saves to different default locations, depending on the pl
Using the configuration file
==================================
-Global settings are listed under the ``[scummvm]`` heading. Global ../settings/keymaps settings are listed under the ``[keymapper]`` heading. Game-specific settings, including keymaps, are listed under the heading for that game, for example ``[queen]`` for Flight of the Amazon Queen. Use the configuration keywords_ to change settings.
+Global settings are listed under the ``[scummvm]`` heading. Global :doc:`Keymaps settings <../settings/keymaps>` are listed under the ``[keymapper]`` heading. Game-specific settings, including keymaps, are listed under the heading for that game, for example ``[queen]`` for Flight of the Amazon Queen. Use the configuration keywords_ to change settings.
Example of a configuration file
@@ -105,7 +148,8 @@ Keywords
There are many recognized configuration keywords. In the table below, each keyword is linked to an explanatory description in the Settings pages.
.. csv-table::
- :widths: 25, 25, 15, 35
+ :width: 100%
+ :widths: 20 20 10 50
:header-rows: 1
Keyword,Type,Default,Options
@@ -293,11 +337,7 @@ There are many recognized configuration keywords. In the table below, each keywo
- timidity
"
"music_driver [game]",string, auto, "
- The same options as
-
- ``music_driver in [scummvm]``
-
- plus:
+ The same options as ``music_driver in [scummvm]`` plus:
- towns
- C64
diff --git a/doc/docportal/using_scummvm/keyboard_shortcuts.rst b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
index feaf9730dd..9a10bef463 100755
--- a/doc/docportal/using_scummvm/keyboard_shortcuts.rst
+++ b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
@@ -4,15 +4,17 @@ Keyboard shortcuts
ScummVM supports various in-game keyboard and mouse shortcuts, and since version 2.2.0 these can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`, or in the :doc:`configuration file <../advanced_options/configuration_file>`.
+For game-specific shortcuts, see the `wiki entry <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ for the game you are playing.
+
The shortcuts listed below are the defaults.
Common shortcuts (all games)
-------------------------------
.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
+ :width: 100%
+ :widths: 30 70
+
Shortcut, Description
:kbd:`Ctrl + F5` ,Displays the Global Menu
:kbd:`Cmd + q` ,Quit (Mac OS X)
@@ -28,371 +30,4 @@ Common shortcuts (all games)
:kbd:`Ctrl + Alt + s` ,Cycles through stretch modes
:kbd:`Alt + Enter` ,Toggles full screen/windowed
:kbd:`Alt + s` ,Takes a screenshot (SDL backend only)
- :kbd:`Ctrl + F7`,"Opens virtual keyboard (if enabled).
- This can also be opened with a long press of the middle mouse button or wheel."
-
-SCUMM games
-----------------
-
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Alt + x` ,Quit
- :kbd:`Ctrl + 0-9` ,Saves game state
- :kbd:`Alt + 0-9`,Loads saved game state
- :kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Ctrl + f` ,Toggles fast mode
- :kbd:`Ctrl + g` ,Runs in really REALLY fast mode
- :kbd:`Ctrl + t` ,"Switches between 'Speech only', 'Speech and Subtitles' and 'Subtitles only'"
- :kbd:`~` ,Shows/hides the debugging console
- :kbd:`[` and :kbd:`]`,"Music volume, down/up"
- :kbd:`-` and :kbd:`+` ,"Text speed, slower/faster"
- :kbd:`F5` ,Displays a save/load box
- :kbd:`Alt + F5` ,"Displays the original save/load box, if the game has one. May crash the game."
- :kbd:`Space` ,Pause
- :kbd:`.` ,Skips current line of text in some games
- :kbd:`Enter` ,Simulates left mouse button press
- :kbd:`Tab`,Simulates right mouse button press
-
-Beneath a Steel Sky
----------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Ctrl + f` ,Toggles fast mode
- :kbd:`Ctrl + g` ,Runs in REALLY fast mode
- :kbd:`F5` ,Displays a save/load box
- :kbd:`Esc` ,Skips the game intro
- :kbd:`.` ,Skips current line of text
-
-
-
-Blade Runner
----------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Space` ,Toggles combat mode
- :kbd:`Enter` or :kbd:`Esc` ,Skips a video or a line of dialogue
- :kbd:`Esc` ,Shows game menu
- :kbd:`Tab` ,Activates last database
- :kbd:`F1` ,Online help
- :kbd:`F2` ,Save game menu
- :kbd:`F3` ,Load game menu
- :kbd:`F4` ,Crime scene database
- :kbd:`F5` ,Suspect database
- :kbd:`F6` ,Clue database
- :kbd:`F10` ,Quit game
-
-Broken Sword
----------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`F5` or `Esc` ,Displays save/load box
-
-Broken Sword II
------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Ctrl + f` ,Toggles fast mode
- :kbd:`p` ,Pause
-
-Dragon History
------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`F5` ,Displays the Global Main Menu
- left click ,"Walk, explore"
- right click,"Use, talk"
- "move mouse up, :kbd:`i` ",Inventory
- "move mouse down, :kbd:`m` ",Map
- :kbd:`Esc` ,"Skips the intro, exit map/inventory"
- any click ,Skips the currently dubbed sentence
- :kbd:`q` ,
-
-
-
-Flight of the Amazon Queen
-----------------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Ctrl + f` ,Toggles fast mode
- :kbd:`F1`,Use Journal (saving/loading)
- :kbd:`F11` ,Quicksave
- :kbd:`F12` ,Quickload
- :kbd:`Esc` ,Skips cutscenes
- :kbd:`Space` ,Skips current line of text
-
-Future Wars
---------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`F1` ,Examine
- :kbd:`F2` ,Take
- :kbd:`F3`,Inventory
- :kbd:`F4` ,Use
- :kbd:`F5` ,Activate
- :kbd:`F6`,Speak
- :kbd:`F9` ,"'Activate' menu"
- :kbd:`F10`,"'Use' menu"
- :kbd:`Esc`,Command menu
-
-Indiana Jones and the Fate of Atlantis
---------------------------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`i` ,Displays IQ points
-
-Indiana Jones and the Last Crusade
-------------------------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`i` ,Displays IQ points
-
-Myst
-------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- Left Click, Move/action
- :kbd:`Space`, Pause the game
- :kbd:`Esc`, Skip cutscene
- :kbd:`F5`, Menu
-
-Nippon Safes
----------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`l`,Load game
- :kbd:`s`,Save game
-
-Riven
-------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- Left Click, Move/action
- Arrow Keys, Movement
- :kbd:`PgUp`, Look up
- :kbd:`PgDn`, Look down
- :kbd:`Space`, Pause the game
- :kbd:`Esc`, Skip cutscene
- :kbd:`F5`, Menu
- :kbd:`Ctrl + o`, Load game
- :kbd:`Ctrl + s`, Save game
-
-
-
-Simon the Sorcerer 1 and 2
----------------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + 0-9` ,Saves game state
- :kbd:`Alt + 0-9`, Loads saved game state
- :kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Ctrl + f` ,Toggles fast mode
- :kbd:`F1` and :kbd:`F3` ,"Text speed, faster - slower"
- :kbd:`F10` ,Shows all characters and objects you can interact with
- :kbd:`Esc` ,Skips cutscenes
- :kbd:`-` and :kbd:`+` ,"Music volume, down/up"
- :kbd:`m` ,Music on/off
- :kbd:`s` ,Toggles sound effects on/off
- :kbd:`b` ,Toggles background sounds on/off
- :kbd:`t` ,Switches between speech only and combined speech and subtitles
- :kbd:`v` ,Switches between subtitles only and combined speech and subtitles
- :kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Ctrl + f` ,Toggles fast mode
- :kbd:`F12` ,Toggles high speed mode on/off in Swampy Adventures
- :kbd:`-` and :kbd:`+` ,"Music volume, down/up"
- :kbd:`m` ,Toggles music on/off
- :kbd:`s` ,Toggles sound effects on/off
-
-Starship Titanic
--------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + c` ,Opens the developer's cheat room
- :kbd:`Ctrl + d` ,Starts the debugger
- Left click ,Move action
- :kbd:`Shift` + Left click ,Edit room glyph chevrons and quick movement transitions
- Right click ,Edit room glyph chevrons and quick transitions
- Mouse wheel ,"Scroll through items such as inventory and conversation log"
- Arrow keys,Movement. Down arrow/back is only available if the given view explicitly has a backwards movement available.
- :kbd:`F1` ,Switches to Chat-O-Mat
- :kbd:`F2`,Switches to Personal Baggage
- :kbd:`F3` ,Switches to Remote Thingummy
- :kbd:`F4` ,Switches to Designer Room Numbers (chevron list)
- :kbd:`F5` ,Opens GMM save menu
- :kbd:`F6` ,Switches to Real Life
- :kbd:`F7` ,Opens GMM restore menu
-
-
-Starship Titanic (Starfield Puzzle)
--------------------------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Tab` ,Toggles between starmap and skyscape
- Mouse click,Skyscape star selection and starmap star fast travel
- Mouse movement - ,Starmap orientation
- :kbd:`Space` ,Starmap stop movement
- :kbd:`z` ,Starmap turn left
- :kbd:`x`,Starmap turn right
- :kbd:`'`,Starmap turn up
- :kbd:`/`,Starmap turn down
- :kbd:`;`,Starmap move forward
- :kbd:`.`,Starmap move backward
- :kbd:`l`,Starmap lock coordinate
- :kbd:`d`,Starmap unlock coordinate
-
-The Feeble Files
--------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + d` ,Starts the debugger
- :kbd:`Ctrl + f` ,Toggles fast mode
- :kbd:`F7`,Switches characters
- :kbd:`F9`,Toggles hitbox names on/off
- :kbd:`s`,Toggles sound effects on/off
- :kbd:`Pause`,Pause
- :kbd:`t` ,Switches between speech only and combined speech and subtitles
- :kbd:`v`,Switches between subtitles only and combined speech and subtitles
-
-The Legend of Kyrandia
------------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + 0-9` ,Saves game state
- :kbd:`Alt + 0-9`, Loads saved game state
- :kbd:`Ctrl + d` ,Starts the debugger
-
-TeenAgent
-----------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`F5`,Displays the Global Main Menu
-
-Touche: The Adventures of the Fifth Musketeer
-----------------------------------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + f` ,Toggles fast mode
- :kbd:`F5`,Displays options
- :kbd:`F9`,Turns fast walk mode on
- :kbd:`F10`,Turns fast walk mode off
- :kbd:`Esc`,Quit
- :kbd:`Space`,Skips current line of text
- :kbd:`t` ,Switches between speech only and combined speech and subtitles
-
-Zork: Grand Inquisitor
-------------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + s` ,Save
- :kbd:`Ctrl + r` ,Restore
- :kbd:`Ctrl + p` ,Preferences
- :kbd:`F1` ,Help
- :kbd:`F5` ,Inventory
- :kbd:`F6` ,Spellbook
- :kbd:`F7` ,Score
- :kbd:`F8` ,Puts away current object/forget spell
- :kbd:`F9`,Extracts coin (must have the coin bag)
- :kbd:`Space` ,Skips movies
-
-
-Zork Nemesis: The Forbidden Lands
-----------------------------------
-
-.. csv-table::
- :widths: 40 60
- :header-rows: 1
-
- Shortcut, Description
- :kbd:`Ctrl + s` ,Save
- :kbd:`Ctrl + r` ,Restore
- :kbd:`Ctrl + q` ,Quit
- :kbd:`Ctrl + p` ,Preferences
- :kbd:`Space` ,Skips movies
\ No newline at end of file
+ :kbd:`Ctrl + F7`,"Opens virtual keyboard (if enabled). This can also be opened with a long press of the middle mouse button or wheel."
Commit: d7a473becb27eb5230f9791428cdba75a50a7b8d
https://github.com/scummvm/scummvm/commit/d7a473becb27eb5230f9791428cdba75a50a7b8d
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: fixes tables PS Vita
Changed paths:
doc/docportal/other_platforms/ps_vita.rst
diff --git a/doc/docportal/other_platforms/ps_vita.rst b/doc/docportal/other_platforms/ps_vita.rst
index f5e0a8d9cb..d197c2e071 100644
--- a/doc/docportal/other_platforms/ps_vita.rst
+++ b/doc/docportal/other_platforms/ps_vita.rst
@@ -68,8 +68,9 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24"><path d="M11.574 3.712c.195-.323.662-.323.857 0l9.37 15.545c.2.333-.039.757-.429.757l-18.668-.006c-.385 0-.629-.422-.428-.758l9.298-15.538zm.429-2.483c-.76 0-1.521.37-1.966 1.111l-9.707 16.18c-.915 1.523.182 3.472 1.965 3.472h19.416c1.783 0 2.879-1.949 1.965-3.472l-9.707-16.18c-.446-.741-1.205-1.111-1.966-1.111z"/></svg>
.. csv-table::
- :width: 100%
- :header-rows: 2
+ :widths: 50 50
+ :width: 100%
+ :header-rows: 2
Game Controller Mapping,
Button,Action
@@ -90,7 +91,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
SELECT + R button,AGI predictive input dialog
.. csv-table::
- :width:100%
:header-rows: 2
"Front Touchscreen Controls, always enabled",
@@ -101,9 +101,10 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
`Two finger drag`_ ,Move pointer while left mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
`Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
-.. csv-table::
- :width:100%
- :header-rows: 2
+.. csv-table::
+ :width: 100%
+ :widths: 50 50
+ :header-rows: 2
"Back Touchpad Controls, enabled via settings",
Touch,Action
Commit: 271b760fdc70e750700dcc3104c5cfa2aaba3d63
https://github.com/scummvm/scummvm/commit/271b760fdc70e750700dcc3104c5cfa2aaba3d63
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: removes width directive
- attempts to fix build issue on RTD
Changed paths:
doc/docportal/other_platforms/ps_vita.rst
diff --git a/doc/docportal/other_platforms/ps_vita.rst b/doc/docportal/other_platforms/ps_vita.rst
index d197c2e071..796d07c061 100644
--- a/doc/docportal/other_platforms/ps_vita.rst
+++ b/doc/docportal/other_platforms/ps_vita.rst
@@ -69,7 +69,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
.. csv-table::
:widths: 50 50
- :width: 100%
:header-rows: 2
Game Controller Mapping,
@@ -102,7 +101,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
`Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
.. csv-table::
- :width: 100%
:widths: 50 50
:header-rows: 2
Commit: 6f33248e1a5cbca38a0d5669e71198727858a412
https://github.com/scummvm/scummvm/commit/6f33248e1a5cbca38a0d5669e71198727858a412
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: removes width directive from tables
- temporary fix for issue with RTD build
Changed paths:
doc/docportal/advanced_options/configuration_file.rst
doc/docportal/other_platforms/nintendo_switch.rst
doc/docportal/other_platforms/psp.rst
diff --git a/doc/docportal/advanced_options/configuration_file.rst b/doc/docportal/advanced_options/configuration_file.rst
index 26146e9c57..69a0ea2c85 100755
--- a/doc/docportal/advanced_options/configuration_file.rst
+++ b/doc/docportal/advanced_options/configuration_file.rst
@@ -148,7 +148,6 @@ Keywords
There are many recognized configuration keywords. In the table below, each keyword is linked to an explanatory description in the Settings pages.
.. csv-table::
- :width: 100%
:widths: 20 20 10 50
:header-rows: 1
diff --git a/doc/docportal/other_platforms/nintendo_switch.rst b/doc/docportal/other_platforms/nintendo_switch.rst
index 076654042b..dfbd1917cb 100644
--- a/doc/docportal/other_platforms/nintendo_switch.rst
+++ b/doc/docportal/other_platforms/nintendo_switch.rst
@@ -49,7 +49,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M2 8a.75.75 0 01.75-.75h10.5a.75.75 0 010 1.5H2.75A.75.75 0 012 8z"></path></svg>
.. csv-table::
- :width: 100%
:header-rows: 1
Button,Action
@@ -70,7 +69,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
|minus| + R button,AGI predictive input dialog
.. csv-table::
- :width: 100%
:header-rows: 2
"Touch Controls (Touchpad Mouse Mode Off, Default)",
@@ -82,7 +80,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
`Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
.. csv-table::
- :width: 100%
:header-rows: 2
Touch Controls (Touchpad Mouse Mode On),
diff --git a/doc/docportal/other_platforms/psp.rst b/doc/docportal/other_platforms/psp.rst
index 2e269062d4..033824b016 100644
--- a/doc/docportal/other_platforms/psp.rst
+++ b/doc/docportal/other_platforms/psp.rst
@@ -61,7 +61,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
.. csv-table::
- :width: 100%
:header-rows: 2
Game Controller Mapping,
@@ -83,7 +82,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
START + R button,F5
.. csv-table::
- :width: 100%
:header-rows: 1
Virtual Keyboard Mode,
@@ -96,7 +94,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
Analog stick,Moves in a direction (left/right/up/down)
.. csv-table::
- :width: 100%
:header-rows: 1
Image Viewer,
@@ -106,7 +103,6 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
"L/R buttons + START",Exit image viewer
.. csv-table::
- :width: 100%
:header-rows: 1
1st Person Game Mode ,
Commit: add423b30de8e6ef1c11eab0f389785468b4ddc7
https://github.com/scummvm/scummvm/commit/add423b30de8e6ef1c11eab0f389785468b4ddc7
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: tidies up the FAQ
- adds TOC
- adds a few questions to highlight features
- tidies up formatting of answers
Changed paths:
doc/docportal/help/faq.rst
diff --git a/doc/docportal/help/faq.rst b/doc/docportal/help/faq.rst
index bc99d9540d..5591bb771c 100644
--- a/doc/docportal/help/faq.rst
+++ b/doc/docportal/help/faq.rst
@@ -3,65 +3,77 @@
Frequently Asked Questions
============================
+.. contents::
+
+
General
==================
About
*******
-Q: Is ScummVM an emulator?
+Is ScummVM an emulator?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** No. ScummVM replaces the original executable files that shipped with the game. This means that your games can run on many different platforms they were never designed to run on! For an in-depth look at how ScummVM works, see our `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
+No. ScummVM replaces the original executable files that shipped with the game. This means that your games can run on many different platforms they were never designed to run on! For an in-depth look at how ScummVM works, see our `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
-Q: Is ScummVM free?
+Is ScummVM free?
^^^^^^^^^^^^^^^^^^^^
-**A:** ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is freely available and you can do whatever you want with it. If you make modifications and redistribute your work, you must make the source code available.
+ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is freely available for you to do whatever you want with it. If you make modifications and redistribute your work, you must make your source code available.
-The ScummVM team would be delighted if you send them your modifications, so that the changes can be merged into the main source code. See :doc:`../contributing/code`.
+The ScummVM team would be delighted if you send them your modifications, so that the changes can be merged into the main source code. See the `Contributing guide <#>`_ on our wiki.
-How do I install ScummVM onto my [device]?
+How do I install ScummVM onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** See :ref:`firststeps`.
+See :ref:`firststeps`.
+
+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:`../guides/connect_cloud` and :doc:`../guides/local_webserver`.
On what platform(s) will ScummVM run?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** See our `Platforms list <https://wiki.scummvm.org/index.php/Platforms>`_ wiki page.
+See our `Platforms list <https://wiki.scummvm.org/index.php/Platforms>`_ wiki page.
Games
********
-Q: Can I only play LucasArts SCUMM games?
+Can I only play LucasArts SCUMM games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the `Supported games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ page on our wiki for a comprehensive list. There is a caveat; not all supported games are playable on all platforms. Sometimes this is because the game is simply too CPU intensive for the device, or there may be many other reasons. If a game is not available on a platform, you will not be able to add it to ScummVM.
+Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the `Supported games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ page on our wiki for a comprehensive list. There is a caveat; not all supported games are playable on all platforms. Sometimes this is because the game is simply too CPU intensive for the device, or there may be many other reasons. If a game is not available on a platform, you will not be able to add it to ScummVM.
.. _getgames:
-Q: Where do I get the games?
+Where do I get the games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** See `Where to get the games <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ on our wiki.
+See `Where to get the games <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ on our wiki.
.. _installgames:
-Q: How do I install games from my floppy discs/CDs?
+How do I install games from my floppy discs/CDs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** Generally speaking, you do not need to install the games. You only need to point ScummVM to the game files contained on these discs. See :doc:`../using_scummvm/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:`../using_scummvm/add_play_games`.
-Q: Do I need the original game discs?
+Do I need the original game discs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** If you do not have any hard copy games, there are some digital options, including some games that have been released as freeware. See :ref:`getgames`.
+If you do not have any hard copy games, there are some digital options available, including some games that have been released as freeware. See :ref:`getgames`.
-Q: How do I know if I can play my game using ScummVM?
+How do I know if I can play my game using ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The best place to check is the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
-Q: I have saved games from when I played the original game - can I use these with ScummVM?
+I have saved games from when I played the original game - can I use these with ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** This is only supported for a select number of games. See the `wiki <wiki.scummvm.org>`_.
+This is only supported for a select number of games. See the `wiki <https://wiki.scummvm.org/index.php/Category:Supported_Games>`_ page for the game you are playing.
-Q: How do I launch a game from the game folder?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** Games must be added to and started from :doc:`../using_scummvm/the_launcher`, they cannot be started directly from the game files. See :doc:`../using_scummvm/add_play_games`.
+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.
+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.
Troubleshooting
===================
@@ -69,84 +81,85 @@ Troubleshooting
ScummVM
***********
-Q: ScummVM crashes, but the console window disappears too quickly to see the error message.
+ScummVM crashes, but the console window disappears too quickly to see the error message.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** If you are using a computer, you can run ScummVM from the :doc:`command line <../advanced_options/command_line>`. Error messages remain visible even after ScummVM exits.
+If you are using a computer, you can run ScummVM from the :doc:`command line <../advanced_options/command_line>`. By doing this, error messages remain visible even after ScummVM exits.
You can also find error messages in the ScummVM log file. See :ref:`logfile`.
-Q: I think I found a bug. What do I do?
+I think I found a bug. What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** See :doc:`report_bugs`.
+See :doc:`report_bugs`.
Games
********
-Q: Help! My game won't run!
+Help! My game won't run!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A: First, make sure your game is supported. See the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
+1. Make sure your game is supported. Check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
-Check that you have all the required datafiles. See :doc:`../using_scummvm/add_play_games`.
+2. Check that you have all the required datafiles. See the :doc:`../using_scummvm/add_play_games` page for more information.
-Ask on the forums or on Discord whether your game is supported on the platform you're trying to play it on. See :doc:`contact`.
+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`
-If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
+4. If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
-Q: I installed my game but ScummVM can't find it... What do I do?
+I installed my game but ScummVM can't find it... What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Installing the game does not necessarily provide ScummVM with the files it needs. See :ref:`installgames`.
+Installing the game does not necessarily provide ScummVM with the files it needs. In most cases you will need to copy the files from the disc into a folder ScummVM can access. See :ref:`installgames`.
-Q: Why are the subtitles in my non-English game messed up?
+Why are the subtitles in my non-English game messed up?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** You need to specify the correct :ref:`language <lang>` in the game-specific settings.
+You need to specify the correct :ref:`language <lang>` in the game-specific settings.
Audio
*******
.. _nosound:
-Q: Help! There's no sound!
+Help! There's no sound!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** Sometimes it's worth checking the obvious. Are your speakers on? Are your headphones properly connected? Try playing an audio clip from another source to see if you have sound in general. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM should fall back on an audio setting that works, but if it doesn't, you may need to do so yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
+Sometimes it's worth checking the obvious.
+
+1. Are your speakers on? Are your headphones properly connected?
+2. Try playing an audio clip from another source to see if you have sound in general.
+3. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM should fall back on an audio setting that works, but if it doesn't, you may need to change the settings yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
-Q: Help! There's no sound on my iPhone/iPad!
+Help! There's no sound on my iPhone/iPad!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** ScummVM will not play any sound if your device is in Silent Mode. If this is not the problem, see :ref:`nosound`.
+ScummVM will not play any sound if your device is in Silent Mode. If this is not the problem, see :ref:`nosound`.
-Q: I have a "talkie" version of a LucasArts game but I can't hear the voices. What's the problem?
+I have a "talkie" version of a LucasArts game but I can't hear the voices. What's the problem?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** The original games shipped with an uncompressed ``MONSTER.SOU`` file - this is the voice file. If you have compressed this file to either a ``MONSTER.SO3`` (``.mp3``), ``MONSTER.SOG`` (``.ogg``), or ``MONSTER.SOF`` (``.flac``) format, make sure that the ScummVM you're using has support for those formats.
+The original games shipped with an uncompressed ``MONSTER.SOU`` file - this is the voice file. If you have compressed this file to either a ``MONSTER.SO3`` (``.mp3``), ``MONSTER.SOG`` (``.ogg``), or ``MONSTER.SOF`` (``.flac``) format, make sure that the ScummVM you're using has support for those formats.
-Q: The audio is really glitchy. What can I do?
+The audio is really glitchy. What can I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** There may be a few things at play here:
+There may be a few things at play here.
- Try to increase the :ref:`audio buffer size <buffer>` in the :doc:`configuration file <../advanced_options/configuration_file>`.
- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU may not have the processing power to keep up. In this case, you may have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, as long as your platform supports it.
- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU may not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
- If you are using the :ref:`adlib` emulator, try selecting the least CPU-intensive option; MAME.
-Q: I have a CD version of a game, how do I get the sound to work without running the game from the CD?
+I have a CD version of a game, how do I get the sound to work without running the game from the CD?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** See using :ref:`cd`.
+See using :ref:`cd`.
Graphics
***********
-Q: There are so many options... How do I know what to pick?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** Start by checking out our :doc:`../settings/graphics` settings page. It has comprehensive information on how it all works.
+There are so many options... How do I know what to pick?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Start by checking out our :doc:`../guides/understand_graphics` page. It has comprehensive information on how it all works.
-Q: Can I just make the image larger (for example, 1 pixel becomes 4 pixels) without any smoothing or antialiasing?
+Can I just make the image larger (for example, 1 pixel becomes 4 pixels) without any smoothing or antialiasing?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** Yes. Using the **Normal (no scaling)** graphics mode in conjunction with pixel-perfect scaling will result in a larger image without any smoothing. The **2x** and **3x** graphics modes also do not involve any filtering.
-
-Ensure **Filter graphics** is not enabled.
-
-See the :doc:`../settings/graphics` settings for a more detailed explanation.
+Yes. Using the **Normal (no scaling)** graphics mode in conjunction with pixel-perfect scaling will result in a larger image without any smoothing. The **2x** and **3x** graphics modes also do not involve any filtering. Also check that **Filter graphics** is not enabled.
+
-Q: The game colors are messed up, how do I fix them?
+The game colors are messed up, how do I fix them?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**A:** Ensure the correct game has been detected. For example, with Amiga game files, check that the :ref:`platform <platform>` is set to Amiga.
\ No newline at end of file
+Ensure the correct game platform has been detected. For example, with Amiga game files, check that the :ref:`platform <platform>` is set to Amiga.
\ No newline at end of file
Commit: b9311bd517b33110b6cb3434e525e221686517a7
https://github.com/scummvm/scummvm/commit/b9311bd517b33110b6cb3434e525e221686517a7
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds first draft Dreamcast page
Changed paths:
A doc/docportal/other_platforms/dreamcast.rst
doc/docportal/index.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 308dd38c0a..1ef41352b7 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -125,11 +125,13 @@ We have guides available to show you how to get ScummVM up and running:
:doc:`other_platforms/nintendo_switch`
+ :doc:`other_platforms/dreamcast`
+
---
Other systems
^^^^^^^^^^^^^^^
-
+
How do I use ScummVM?
diff --git a/doc/docportal/other_platforms/dreamcast.rst b/doc/docportal/other_platforms/dreamcast.rst
new file mode 100644
index 0000000000..b11875d853
--- /dev/null
+++ b/doc/docportal/other_platforms/dreamcast.rst
@@ -0,0 +1,129 @@
+=============================
+Sega Dreamcast
+=============================
+
+Installing ScummVM
+===================
+
+Prerequisites
+****************
+- A CD-R disc (80min/700mb).
+- A CD-RW drive.
+- A computer running Windows.
+- CD burning software capable of creating a disc image, such as Bootdreams, Nero Burning ROM, or ImgBurn.
+
+Installing ScummVM
+*******************
+
+There are two ways to install ScummVM on the Dreamcast:
+
+1. Download a ready-to-go Nero Image and Demos package and burn the extracted ``.nrg`` image to a CD-R using Nero Burning ROM or ImgBurn software.
+2. Download the Dreamcast plain files package and use the extracted files to create a custom disc image to burn to a CD-R.
+
+Both packages are available from the ScummVM `Downloads page <https://www.scummvm.org/downloads/>`_
+
+Dreamcast Nero Image and Demos
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Use Nero Burning ROM or ImgBurn to burn the ``.nrg`` file contained in the package to a CD-R disc.
+
+Dreamcast plain files
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+Create a directory on your computer. In this example, we will call the directory ``ScummVMDC``.
+
+Copy the downloaded ``SCUMMVM.BIN`` and ``IP.BIN`` files into the ScummVMDC directory. These are the main boot and engine files required for ScummVM to run.
+
+The ``.PLG`` files in the plain files package are the plugins that are required to run the games. For the best performance, only include the plugins for games you want to play. For example, if you want to play LucasArts games, include ``SCUMM.PLG``.
+
+These plugin files are also placed directly into the ScummVMDC directory.
+
+Next, make a new directory for each game. In this example, we will add Day of the Tentacle into a subdirectory named ``DOTT``.
+
+Our file structure now looks like this:
+
+::
+
+ ScummVMDC
+ |--DOTT
+ | |-- MONSTER.SOU
+ | |-- TENTACLE.000
+ | `-- TENTACLE.001
+ |--IP.BIN
+ |-- SCUMM.PLG
+ `-- SCUMMVM.BIN
+
+Now that we have the ScummVMDC directory complete with all the required files, we need to create a disc image. The recommended disc image type is ``.cdi`` or ``.nrg``. A ``.iso`` image will not work.
+
+Bootdreams is the software often recommended for creating and burning a ``.cdi`` image. It's an old piece of software, but it is free and still available for download.
+
+ImgBurn is also free, and can also be used to create and burn ``.cdi`` images. It is compatible with all Windows operating systems.
+
+Alternatively, you can use Nero Burning ROM to create and burn a ``.nrg`` image.
+
+.. caution::
+
+ Use a lower burning speed (4x) for best results; the Dreamcast is an older system and as such can have problems reading discs burned at high speeds.
+
+Transferring game files
+=======================
+
+Game files can be included on the same CD as the ScummVM binary file, or on separate CDs.
+
+The Dreamcast port uses its own custom Graphical User Interface, which automatically scans the disc for games, and adds the games to the list through ScummVM's built-in autodetection.
+
+ScummVM for the Dreamcast supports disc swapping from the GUI. It will rescan once a new disc is inserted and repopulate the games list.
+
+Controls
+=================
+
+The mouse cursor can be controlled with the standard Dreamcast controller.
+There is a virtual keyboard that can be brought up by pressing the left trigger button, that will emulate keyboard input.
+The Dreamcast mouse and keyboard peripherals are also supported.
+
+.. csv-table::
+ :header-rows: 2
+
+ Game Controller Mapping:,,
+ Button,Action,Notes
+ Joystick,Moves pointer,
+ Directional pad,Moves pointer slowly,Also controls the on-screen keyboard
+ A,Left Click,
+ B,Right Click,
+ Y,Spacebar,Pause
+ Start,F5,Load and save
+ Trigger L,Toggles the on-screen keyboard on/off,
+ X,5,For boxing in Indiana Jones and the Last Crusade
+ Directional pad + X,"1, 2, 3, 4, 6, 7, 8, 9",For boxing in Indiana Jones and the Last Crusade
+
+Paths
+=======
+
+Saved games
+*****************
+
+The Visual Memory Unit (VMU) is used for saving and loading games.
+
+Autosave is enabled on the Dreamcast, so each game will use some memory blocks (between 2 and 13) for the autosave in save slot 0.
+
+When a game is saved, the VMU beeps, and a prompt is displayed on the screen letting you know that the game has been saved.
+
+Configuration file
+*********************
+
+
+
+Settings
+==========
+
+
+
+Known issues
+==============
+
+- The Dreamcast has no external storage medium, and only has 16MB of RAM. As such, the Dreamcast port of ScummVM does not support The Curse of Monkey Island or the Dig. The resources required for these games are too great for the Dreamcast to handle. Full Throttle is not completable.
+
+
+- There is currently no way to manually add games to the games list. The autodetect feature usually works well, but sometimes games will show up on the list twice, incorrect games will show up with the correct game, and, quite rarely, the game will not show up on the list at all.
+
+
+- Some games, for example SPY Fox 1: Dry Cereal, use filenames which are incompatible with the ISO 9660 filesystem standard. The Dreamcast port does not support filename extensions like RockRidge or Joliet, so the CD mastering software needs to be instructed not to change the filenames to comply to ISO 9660, or the engine will not be able to open the files.
+
Commit: ad5916343e01d1779350eb6caf5d57ffe593efa7
https://github.com/scummvm/scummvm/commit/ad5916343e01d1779350eb6caf5d57ffe593efa7
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: changes Mac OSX to macOS/Mac OSX
Changed paths:
doc/docportal/getting_started/mac_linux_windows.rst
doc/docportal/guides/understand_audio.rst
diff --git a/doc/docportal/getting_started/mac_linux_windows.rst b/doc/docportal/getting_started/mac_linux_windows.rst
index 6817cabc1b..f98b4aa266 100644
--- a/doc/docportal/getting_started/mac_linux_windows.rst
+++ b/doc/docportal/getting_started/mac_linux_windows.rst
@@ -5,8 +5,8 @@ Mac, Linux or Windows
All downloads referenced on this page are available from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_.
-Mac OSX
----------
+macOS/Mac OSX
+------------------
Download the Disk Image. Once the download has completed, double click the file to mount the Disk Image. A dialog will open with the ScummVM icon. Drag this icon into your Applications folder to install ScummVM.
diff --git a/doc/docportal/guides/understand_audio.rst b/doc/docportal/guides/understand_audio.rst
index 15def31647..13d3bfe9a5 100644
--- a/doc/docportal/guides/understand_audio.rst
+++ b/doc/docportal/guides/understand_audio.rst
@@ -132,8 +132,8 @@ Selecting an option that does not match the MIDI port selected may have unintend
Soundcards or audio interfaces do not necessarily have anything to do with MIDI; while some older soundcards (and a few modern ones) have their own hardware-based synthesizers, it is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
-Mac OSX
-**********
+macOS/Mac OSX
+***************
Mac has a built-in MIDI synthesizer; Apple DLS software synthesizer. It uses the Mac's built-in sounds (which are based on Roland GS).
Commit: 183d7b325f239ff4d3c859e0449ce5931005bc75
https://github.com/scummvm/scummvm/commit/183d7b325f239ff4d3c859e0449ce5931005bc75
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds tech writer guidelines page
Changed paths:
A doc/docportal/contribute/tech_writers.md
doc/docportal/index.rst
diff --git a/doc/docportal/contribute/tech_writers.md b/doc/docportal/contribute/tech_writers.md
new file mode 100644
index 0000000000..0091d4b627
--- /dev/null
+++ b/doc/docportal/contribute/tech_writers.md
@@ -0,0 +1,57 @@
+# Contribution guide for technical writers
+The user documentation is located at [docs.scummvm.org](https://docs.scummvm.org/en/latest/) . It is written in reStructuredText or markdown, built using Sphinx, and deployed by Read the Docs. The recommonmark extension is used to enable parsing of markdown files. The [sphinx-panels](https://sphinx-panels.readthedocs.io/en/latest/) extension is used to provide Bootstrap functionality by using custom rST directives. All documentation is written to conform to the Google developer documentation [style guide](https://developers.google.com/style).
+
+There are two ways to contribute to documentation; working online directly on Github, or by forking and cloning the scummvm repository to work locally.
+
+## Small changes to existing documentation
+
+This may include correcting a mistake, or fixing spelling or grammar.
+
+The easiest way to make a change is to use the **Edit this page on GitHub** link on the applicable page to edit documentation online, on GitHub. This method does not require you to fork the repository, but do bear in mind that you won’t be able to upload images while working in this way.
+
+Once you are happy with your changes, create a pull request (PR). The ScummVM team will review the pull request, and if there are no issues, it will be merged into the existing code.
+
+## Large changes, new or existing documentation
+
+This may include documenting a new feature, documenting a new or existing port, or writing a guide.
+
+### Set up your environment
+
+* Install Python3:
+ * Linux: Comes with Python3 installed.
+ * macOS: See [this tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-local-programming-environment-on-macos) .
+ * Windows: See [this tutorial](https://phoenixnap.com/kb/how-to-install-python-3-windows).
+* Install pip3:
+ * 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).
+* [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.
+
+### Create and edit documentation
+
+Documentation files are found in `scummvm/doc/docportal/`
+Images, screenshots and GIFs are found in `scummvm/doc/docportal/images/`.
+
+There are many options for editing and creating documents. A particularly good one is [VS Code](https://code.visualstudio.com), which features extensions to help you write in reStructuredText/markdown, as well as featuring Git integration.
+
+Here is a [handy guide](https://rest-sphinx-memo.readthedocs.io/en/latest/intro.html) to reStructuredText as it is used by Sphinx.
+
+If you are creating a new Platform or Settings page, use the template provided in the docportal directory: `platform_template.rst` or `settings_template.rst`. This is to ensure our documentation remains consistent and predictable for the end user.
+
+### Preview your documentation
+
+To build a preview of the documentation, open a new Terminal window, and change your working directory until you are in the `docportal` directory. Use the `make html` command. The output HTML files will be in the `scummvm/doc/docportal/_build/html/` directory. Open the `index.html` file in a browser to view the index page of the site.
+
+Note:
+Do not commit the `_build` folder to your branch. The documentation is built by Read the Docs before deployment, so the local build is not required.
+
+### Commit your work
+
+Follow the ScummVM [commit guidelines](https://wiki.scummvm.org/index.php/Commit_Guidelines) when you [make a commit](https://github.com/git-guides/git-commit) .
+
+### Create a Pull Request
+
+For documentation related to the CURRENT release, create a pull request against the branch for the current version. For example, to make a change or add documentation applicable to ScummVM version 2.2.0, open a pull request against `branch-2-2-0`. For documentation related to the NEXT release, open a pull request against the `master` branch.
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 1ef41352b7..c8ff3b806d 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -82,6 +82,13 @@
release_notes/*
+.. toctree::
+ :caption: Contribute to Documentation
+ :glob:
+ :hidden:
+
+ contribute/*
+
====================
Welcome to ScummVM!
====================
Commit: 3dd5521a16845ef7b6a9f39be0c85132c8bd248e
https://github.com/scummvm/scummvm/commit/3dd5521a16845ef7b6a9f39be0c85132c8bd248e
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds custom css to change table display
Changed paths:
doc/docportal/_static/custom.css
diff --git a/doc/docportal/_static/custom.css b/doc/docportal/_static/custom.css
index 06345495f9..f2995fe7d6 100644
--- a/doc/docportal/_static/custom.css
+++ b/doc/docportal/_static/custom.css
@@ -1,14 +1,22 @@
/* override table width restrictions */
- at media screen and (min-width: 1080px) {
+ at media (min-width: 385px){
.wy-table-responsive table td {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
+
}
.wy-table-responsive {
overflow: visible !important;
+
}
- }
-
\ No newline at end of file
+ .wy-table-responsive table {
+
+ table-layout: fixed !important;
+ width: 100% !important;
+
+ }
+ }
+
Commit: e3054a18928b83742fc05bd7b730624692f8ffc2
https://github.com/scummvm/scummvm/commit/e3054a18928b83742fc05bd7b730624692f8ffc2
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: tidies up CLI page
- fixes table width issue
- adds macOS example
- fixes tabs
- edits option descriptions for consistency
Changed paths:
doc/docportal/advanced_options/command_line.rst
diff --git a/doc/docportal/advanced_options/command_line.rst b/doc/docportal/advanced_options/command_line.rst
index 84717a4bc2..196ff513fd 100755
--- a/doc/docportal/advanced_options/command_line.rst
+++ b/doc/docportal/advanced_options/command_line.rst
@@ -3,144 +3,165 @@
Command line interface
=======================
-Launching ScummVM from the command line allows you to pass a number of options, some of which override the applicable global or game-specific settings.
+Launching ScummVM from the command line allows you to pass a number of options, some of which override the applicable global or game-specific settings. It also allows you to launch straight into a game without going to the Launcher first.
-Some other options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without opening the Launcher or starting a game.
+Some options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without launching ScummVM or starting a game.
-Short options are listed where they are available.
+Usage
+=========
-.. csv-table::
- :header-rows: 1
- :width: 100%
-
- Option,Short,Description
- \--add,-a,"Add all games from current or specified directory.
+.. code-block::
+
+ scummvm [option] [game]
- If \--game=ID is passed only the game with id ID is added.
+To launch ScummVM, enter the path to ScummVM. Optionally, follow this by any of the options documented below, and/or the path to the game you wish to start. If a game has already been added to the games list in the Launcher, you can pass the game id instead of the path to the game.
- See also \--detect.
- Use \--path=PATH before -a, \--add to specify a directory."
- \--alt-intro, ,":ref:`Use alternative intro for CD versions <altintro>`"
- \--aspect-ratio,,":ref:`Enable aspect ratio correction <ratio>`"
- \--auto-detect,,"Display a list of games from current or specified directory
+.. tabbed:: macOS
+
+ .. panels::
+ :column: col-lg-12
+
+ The following examples assume the path to the ScummVM app is ``Applications/ScummVM.app``.
+
+ If you are unsure of the path to the app, drag and drop the ScummVM app icon into the Terminal window, which prints the path to the ScummVM app.
- and start the first one.
+ To run ScummVM from the command line, add ``/Contents/MacOS/scummvm`` to that path.
- 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
+ To run Monkey Island, fullscreen (``-f``):
- (default: 0 = best choice drive)"
- \--config=FILE,-c,"Use alternate configuration file"
- \--copy-protection,,"Enable copy protection"
- \--debug-channels-only,,"Show only the specified debug channels"
- \--debugflags=FLAGS,,"Enable engine specific debug flags"
- \--debuglevel=NUM,-d,"Set debug verbosity level"
- \--demo-mode,,"Start demo mode of Maniac Mansion or The 7th Guest"
- \--detect,,"Display a list of games with their ID from current or specified directory
+ .. code::
- without adding it to the config.
+ /Applications/ScummVM.app/Contents/MacOS/scummvm -f monkey
- Use \--path=PATH before \--detect to specify a directory."
- \--dimuse-tempo=NUM,,"Set internal Digital iMuse tempo (10 - 100) per second (default: 10)"
- \--dump-scripts,-u,"Enable script dumping if a directory called
-
- 'dumps' exists in the current directory"
- \--enable-gs,,"Enable Roland GS mode for MIDI playback"
- \--extrapath=PATH,,":ref:`Extra path to additional game data <extra>`"
- \--filtering,,":ref:`Force filtered graphics mode <filtering>`"
- \--fullscreen,-f,":ref:`Force full-screen mode <fullscreen>`"
- \--game=ID,,"In combination with \--add or \--detect
-
- only adds or attempts to detect the game with id ID."
- \--gfx-mode,-g,":ref:`Select graphics scaler <gfxmode>`"
- \--gui-theme=THEME,,":ref:`Select GUI theme <theme>`"
- \--help,-h,"Display a brief help text and exit"
- \--joystick[=NUM],,"Enable joystick input (default: 0 = first joystick)"
- \--language,-q,":ref:`Select language <lang>` (en,de,fr,it,
-
- pt,es,jp,zh,kr,se,gb,hb,ru,cz)"
- \--list-audio-devices,,"List all available audio devices"
- \--list-saves --game=TARGET,,"Display a list of saved games for the game (TARGET) specified"
- \--list-targets,-t,"Display list of configured targets and exit"
- \--list-themes,,"Display list of all usable GUI themes"
- --midi-gain=NUM,,":ref:`Set the gain for MIDI playback <gain>`
-
- 0-1000 (default: 100)
-
- Only supported by some MIDI drivers"
- \--multi-midi,,":ref:`Enable combination AdLib and native MIDI <multi>`"
- \--music-driver=MODE,-e,":ref:`Select preferred music device <device>`"
- \--music-volume=NUM,-m,":ref:`Set the music volume <music>`, 0-255 (default: 192)"
- \--native-mt32,,":ref:`True Roland MT-32 (disable GM emulation) <mt32>`"
- \--no-filtering,,"Force unfiltered graphics mode"
- \--no-fullscreen,-F,"Force windowed mode"
- \--opl-driver=DRIVER,,":ref:`Select AdLib (OPL) emulator <opl>`"
- \--output-rate=RATE,,"Select output sample rate in Hz"
- \--path=PATH,-p,"Path to where the game is installed"
- \--platform=STRING,,":ref:`Specify 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 recurse down all subdirectories"
- \--render-mode=MODE,,":ref:`Enable additional render modes <render>`"
- \--save-slot=NUM,-x,"Saved game slot to load (default: autosave)"
- \--savepath=PATH,,":ref:`Path to where saved games are stored <savepath>`"
- \--sfx-volume=NUM,-s,":ref:`Set the sfx volume <sfx>`, 0-255 (default: 192)"
- \--soundfont=FILE,,":ref:`Select the SoundFont for MIDI playback. <soundfont>`
-
- Only supported by some MIDI drivers."
- \--speech-volume=NUM,-r,":ref:`Set the speech volume <speechvol>`, 0-255 (default: 192)"
- \--subtitles,-n,":ref:`Enable subtitles <speechmute>`"
- \--talkspeed=NUM,,":ref:`Set talk speed for games <talkspeed>` (default: 60)"
- \--tempo=NUM,,"Set music tempo (in percent, 50-200) for SCUMM games (default: 100)"
- \--themepath=PATH,,"Path to where GUI themes are stored"
- \--version,-v,"Display ScummVM version information and exit"
-The meaning of most long options can be inverted by prefixing them with ``no-``. For example, ``--no-aspect-ratio`` will turn aspect ratio correction off.
+ To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
+ .. code::
-Example
-------------
+ /Applications/ScummVM.app/Contents/MacOS/scummvm -f -n -p/cdrom/resource/ft
-.. tabs::
+.. tabbed:: Windows
+
+ .. panels::
+ :column: col-lg-12
- .. tab::
+ The following examples assume that the path to ScummVM is ``C:\Games\LucasArts\scummvm.exe``.
- **Windows**
+ ^^^^
- Running Monkey Island, fullscreen, from a hard disk:
+ To run Monkey Island, fullscreen (``-f``):
- .. code::
+ .. code-block::
- C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\monkey
-
+ C:\Games\LucasArts\scummvm.exe -f monkey
+
+
- Running Full Throttle from CD, fullscreen and with subtitles enabled:
+ To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
- .. code::
+ .. code-block::
C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ft
- .. tab::
+.. tabbed:: Linux/Unix
+
+ .. panels::
+ :column: col-lg-12
- **Linux/Unix**
-
- Running Monkey Island, fullscreen, from a hard disk:
+ The following examples assume the path to ScummVM is ``/usr/games/scummvm``.
+
+ ^^^^^^
+ To run Monkey Island, fullscreen (``-f``):
+
.. code::
- /path/to/scummvm -f -p/games/LucasArts/monkey/monkey
+ /usr/games/scummvm -f monkey
- Running Full Throttle from CD, fullscreen and with subtitles enabled:
+ To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
.. code::
- /path/to/scummvm -f -n -p/cdrom/resource/ft
+ /usr/games/scummvm -f -n -p/cdrom/resource/ft
+
+ .. tip::
+
+ If ScummVM is on PATH, there is no need to enter the full path to ScummVM. Similarly, if a game is already added to the Launcher, there is no need to specify the path to the game.
+
+
+Options
+========
+
+The meaning of most options can be inverted by prefixing them with ``no-``. For example, ``--no-aspect-ratio`` will turn aspect ratio correction off. This does not apply to short options.
+
+Option parameters are shown in capitals, and need to be replaced with real values.
+
+Short options are listed where they are available.
+
+.. csv-table::
+ :widths: 30 10 60
+ :header-rows: 1
+
+ Option,Short,Description
+ \--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"
+
+
+
Commit: 1a7b9d9214207cf3677896a7bf184c6c723d75f2
https://github.com/scummvm/scummvm/commit/1a7b9d9214207cf3677896a7bf184c6c723d75f2
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: updates/corrects Dreamcast page
Changed paths:
A doc/docportal/images/dreamcast/bootdreams.png
doc/docportal/other_platforms/dreamcast.rst
diff --git a/doc/docportal/images/dreamcast/bootdreams.png b/doc/docportal/images/dreamcast/bootdreams.png
new file mode 100644
index 0000000000..07fe310a1a
Binary files /dev/null and b/doc/docportal/images/dreamcast/bootdreams.png differ
diff --git a/doc/docportal/other_platforms/dreamcast.rst b/doc/docportal/other_platforms/dreamcast.rst
index b11875d853..a3385dfe87 100644
--- a/doc/docportal/other_platforms/dreamcast.rst
+++ b/doc/docportal/other_platforms/dreamcast.rst
@@ -2,41 +2,44 @@
Sega Dreamcast
=============================
-Installing ScummVM
-===================
+Run ScummVM
+================
Prerequisites
-****************
+****************************
+
- A CD-R disc (80min/700mb).
- A CD-RW drive.
-- A computer running Windows.
-- CD burning software capable of creating a disc image, such as Bootdreams, Nero Burning ROM, or ImgBurn.
-
-Installing ScummVM
-*******************
+- A computer running Windows.
+- Software to create a bootable disc image, such as `BootDreams <https://dcemulation.org/index.php?title=BootDreams>`_
+- CD burning software such as Nero Burning ROM, ImgBurn or Alcohol120%.
-There are two ways to install ScummVM on the Dreamcast:
+Download the package
+*************************
+There are two ways to get ScummVM running on the Dreamcast:
-1. Download a ready-to-go Nero Image and Demos package and burn the extracted ``.nrg`` image to a CD-R using Nero Burning ROM or ImgBurn software.
+1. Download the ready-to-go Nero Image and Demos package and burn the extracted ``.nrg`` image to a CD-R using Nero Burning ROM.
2. Download the Dreamcast plain files package and use the extracted files to create a custom disc image to burn to a CD-R.
Both packages are available from the ScummVM `Downloads page <https://www.scummvm.org/downloads/>`_
-Dreamcast Nero Image and Demos
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Use Nero Burning ROM or ImgBurn to burn the ``.nrg`` file contained in the package to a CD-R disc.
+Create a disc from the Dreamcast Nero Image and Demos package
+********************************************************************
+Use Nero Burning ROM to burn the ``.nrg`` file contained in the package to a CD-R disc.
-Dreamcast plain files
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-Create a directory on your computer. In this example, we will call the directory ``ScummVMDC``.
+Create a disc from the Dreamcast plain files package
+******************************************************
+Create a directory on your computer. In this example, the directory is called ``ScummVMDC``.
-Copy the downloaded ``SCUMMVM.BIN`` and ``IP.BIN`` files into the ScummVMDC directory. These are the main boot and engine files required for ScummVM to run.
+Copy the downloaded ``SCUMMVM.BIN`` and ``IP.BIN`` files into the ``ScummVMDC`` directory. These are the main boot and engine files required for ScummVM to run.
The ``.PLG`` files in the plain files package are the plugins that are required to run the games. For the best performance, only include the plugins for games you want to play. For example, if you want to play LucasArts games, include ``SCUMM.PLG``.
-These plugin files are also placed directly into the ScummVMDC directory.
+In the plain files package there are also ``.DAT`` files. These files may be listed as required Datafiles on the `Datafiles wiki page <https://wiki.scummvm.org/index.php/Datafiles>`_.
-Next, make a new directory for each game. In this example, we will add Day of the Tentacle into a subdirectory named ``DOTT``.
+Copy the required ``.PLG`` and ``.DAT`` files into the root of the ScummVMDC directory.
+
+Next, make a new directory for each game. In this example, we will add all the required Day of the Tentacle data files into a subdirectory named ``DOTT``.
Our file structure now looks like this:
@@ -51,24 +54,38 @@ Our file structure now looks like this:
|-- SCUMM.PLG
`-- SCUMMVM.BIN
-Now that we have the ScummVMDC directory complete with all the required files, we need to create a disc image. The recommended disc image type is ``.cdi`` or ``.nrg``. A ``.iso`` image will not work.
+The next step is to create a bootable disc image from the ``ScummVMDC`` folder.
+
+Use Bootdreams to create either a ``.dci``, ``.nrg`` or ``.mds``/``.mdf`` disc image.
+
+.. figure:: ../images/dreamcast/bootdreams.png
+
+1. Choose the preferred disc image type by clicking on the corresponding icon at the top of the window.
+2. Choose the ``ScummVMDC`` folder as the **Selfboot foler**
+3. Enter a title for the disc image in the **CD label** field.
+4. Leave the **Disc format** as **Audio/Data**
+5. Click **Process** to create the disc image.
+
-Bootdreams is the software often recommended for creating and burning a ``.cdi`` image. It's an old piece of software, but it is free and still available for download.
+To burn the resulting image to disc, use any software capable of using those image formats, such as Nero Burning ROM for ``.nrg``, Alcohol120% for ``.mds``, and Padus DiscJuggler or ImgBurn for ``.cdi``.
-ImgBurn is also free, and can also be used to create and burn ``.cdi`` images. It is compatible with all Windows operating systems.
+.. tip::
+
+ The image created from the plain files package can also be used with Optical Disc Emulators and similar external hardware.
-Alternatively, you can use Nero Burning ROM to create and burn a ``.nrg`` image.
.. caution::
- Use a lower burning speed (4x) for best results; the Dreamcast is an older system and as such can have problems reading discs burned at high speeds.
+ Use the lowest possible burning speed for best results; the Dreamcast is an older system and as such can have problems reading discs burned at high speeds. If available, the 4x speed is ideal.
+
+ Ensure that you use good quality discs from a reputable manufacturer. If possible, use archival grade discs.
-Transferring game files
+Transfer game files
=======================
-Game files can be included on the same CD as the ScummVM binary file, or on separate CDs.
+Game files can be included on the same CD as the ScummVM binary file, or on a separate disc
-The Dreamcast port uses its own custom Graphical User Interface, which automatically scans the disc for games, and adds the games to the list through ScummVM's built-in autodetection.
+The Dreamcast port does not use the normal ScummVM Launcher. It uses its own custom graphical user interface, which automatically scans the disc for games, and adds the games to a games list through ScummVM's built-in autodetection.
ScummVM for the Dreamcast supports disc swapping from the GUI. It will rescan once a new disc is inserted and repopulate the games list.
@@ -77,6 +94,7 @@ Controls
The mouse cursor can be controlled with the standard Dreamcast controller.
There is a virtual keyboard that can be brought up by pressing the left trigger button, that will emulate keyboard input.
+
The Dreamcast mouse and keyboard peripherals are also supported.
.. csv-table::
@@ -106,15 +124,17 @@ Autosave is enabled on the Dreamcast, so each game will use some memory blocks (
When a game is saved, the VMU beeps, and a prompt is displayed on the screen letting you know that the game has been saved.
+Games are saved and loaded through the native in-game menus.
+
Configuration file
*********************
-
+ScummVM for the Dreamcast does not use a configuration file.
Settings
==========
-
+There is no way to change ScummVM settings on the Dreamcast.
Known issues
==============
Commit: d8e94dd896c565b6cabe7ed2c11be4d9273271f7
https://github.com/scummvm/scummvm/commit/d8e94dd896c565b6cabe7ed2c11be4d9273271f7
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds first drafts 3DS/AmigaOS pages
Changed paths:
A doc/docportal/other_platforms/amigaos4.rst
A doc/docportal/other_platforms/nintendo_3ds.rst
doc/docportal/index.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index c8ff3b806d..75270b17d4 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -132,12 +132,16 @@ We have guides available to show you how to get ScummVM up and running:
:doc:`other_platforms/nintendo_switch`
+ :doc:`other_platforms/nintendo_3ds`
+
:doc:`other_platforms/dreamcast`
---
Other systems
^^^^^^^^^^^^^^^
+ :doc:`other_platforms/amigaos4`
+
@@ -250,4 +254,6 @@ If you enjoy ScummVM, feel free to donate using the PayPal button on the `ScummV
If you cannot donate but you have coding or writing skills, you can help us by contributing!
-For more information, see the `Contribution guide <#>`_ on our wiki.
\ No newline at end of file
+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.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/amigaos4.rst b/doc/docportal/other_platforms/amigaos4.rst
new file mode 100644
index 0000000000..c5041ec34a
--- /dev/null
+++ b/doc/docportal/other_platforms/amigaos4.rst
@@ -0,0 +1,68 @@
+=============================
+Amiga OS 4
+=============================
+
+Install ScummVM
+===================
+
+Prerequisites
+****************
+
+- A system running Amiga OS 4
+
+Download and install ScummVM
+*********************************
+
+There are three ways to install ScummVM on AmigaOS 4:
+
+- Use AmiUpdate
+- Use the installer script that comes with every release
+- Download and unarchive the ``.lha`` file. It does not matter where the files are kept.
+
+
+Transfer game files
+=======================
+
+See :doc:`../using_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:`../guides/connect_cloud` and :doc:`../guides/local_webserver`.
+
+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.
+
+
+Paths
+=======
+
+Saved games
+*******************
+``Games:ScummVM/saves``
+
+Configuration file
+**************************
+``Games:ScummVM/scummvm.ini``
+
+
+Settings
+==========
+
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+Audio
+******
+
+The CAMD driver allows the use of MIDI hardware. Select CAMD as the :ref:`Preferred device <device>`.
+
+
+Known issues
+==============
+
+Due to the Big Endian nature of Amiga OS, there can sometimes be graphics and sounds issues with games. Check out the Platform Overview `wiki page <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ for a list of compatible engines.
+
+If a game crashes and it's listed as compatible, report it as a :doc:`bug <../help/report_bugs>`.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/nintendo_3ds.rst b/doc/docportal/other_platforms/nintendo_3ds.rst
new file mode 100644
index 0000000000..dc7d731d73
--- /dev/null
+++ b/doc/docportal/other_platforms/nintendo_3ds.rst
@@ -0,0 +1,104 @@
+=============================
+Nintendo 3DS
+=============================
+
+Install ScummVM
+===================
+
+Prerequisites
+****************
+
+- A Nintendo 3DS with a Homebrew Launcher. Installing a Homebrew Launcher is outside the scope of this documentation.
+
+Download and install ScummVM
+*********************************
+
+Download the Nintendo 3DS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_.
+
+Extract the archive, and copy the extracted files to your SD card into the ``/3ds/scummvm`` directory.
+
+Launch ScummVM using the Homebrew Launcher.
+
+
+Transfer game files
+=======================
+
+See :doc:`../using_scummvm/add_play_games` for more information.
+
+
+Controls
+=============
+
+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.
+
+.. csv-table::
+ :widths: 50 50
+ :header-rows: 1
+
+ Game Controller Mapping:,
+ Button,Action
+ Circle Pad,Moves the cursor
+ R + Circle Pad,Slow Mouse
+ A,Left mouse button
+ B,Right mouse button
+ X,Opens virtual keyboard
+ Y,ESC
+ Control Pad,Keypad Cursor Keys
+ L Button,Toggles magnify mode on/off
+ R Button,Toggles hover/drag modes
+ START,Opens global main menu
+ SELECT,Opens 3DS config menu
+
+.. _hover:
+
+Hover mode
+************
+
+When using the touchscreen, you are simulating the movement of the mouse. You can click with taps, however you can't drag or hold down a mouse button unless you use the buttons mapped to the right/left mouse buttons.
+
+Drag mode
+**************
+Every time you touch and release the touchscreen, you are simulating the click and release of the mouse buttons. At the moment, this is only a left mouse button click.
+
+Magnify mode
+****************
+Due to the low resolutions of the 3DS screens (400x240 for the top, and 320x240 for the bottom), games that run at a higher resolution will inevitably lose some visual detail from being scaled down. This can result in situations where essential information, such as text, is indiscernable.
+
+Magnify mode increases the scale factor of the top screen back to 1, but the bottom screen remains unchanged. The touchscreen can then be used to change which part of the game display is being magnified. This can be done even in situations where the cursor is disabled, such as during full-motion video segments.
+
+When activating magnify mode, touchscreen controls are automatically switched to :ref:`hover` mode to reduce the risk of the user accidentally inputting a click when changing the magnified area with the stylus. Clicking can still be done as in normal hover mode. Turning off magnify mode will revert controls back to what was used previously. It will also restore the top screen's previous scale factor.
+
+Currently magnify mode can only be used when the following conditions are met:
+
+- In the 3DS config menu, **Use Screen** is set to **Both**
+- A game is played
+- The horizontal and/or vertical resolution in-game is greater than that of the top screen
+
+Magnify mode cannot be used in the Launcher menu.
+
+Paths
+=======
+
+Saved games
+*******************
+
+
+Configuration file
+**************************
+
+
+
+Settings
+==========
+
+
+
+Known issues
+==============
+
+Some games are not playable due to the slow CPU speed on the 3DS. If there are any games that run really slowly, this is considered a hardware limitation, not a bug.
Commit: ec4a3c3e941760ec65545760cc540dcefa79dfb1
https://github.com/scummvm/scummvm/commit/ec4a3c3e941760ec65545760cc540dcefa79dfb1
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: removes CLI info from add/play games page
Changed paths:
doc/docportal/using_scummvm/add_play_games.rst
diff --git a/doc/docportal/using_scummvm/add_play_games.rst b/doc/docportal/using_scummvm/add_play_games.rst
index 7748801a95..8f8a8de3dd 100644
--- a/doc/docportal/using_scummvm/add_play_games.rst
+++ b/doc/docportal/using_scummvm/add_play_games.rst
@@ -120,17 +120,6 @@ Adding the games to the Launcher
.. image:: ../images/Launcher/start_game.png
:class: with-shadow
-Games can also be launched directly from the command line.
+Games can also be launched directly from the command line. For more information, see the `Command line options <../advanced_options/command_line>`_ page.
-- To launch a game with no additional options, run ``scummvm`` followed by the game id.
-- To launch a game with options, run ``scummvm``, followed by any desired options, and then the game id. For more information, see the `Command line options <../advanced_options/command_line>`_ page.
-
-In the following example, Flight of the Amazon Queen will be launched in full screen:
-
-.. code::
-
- scummvm -f queen
-
-.. image:: ../images/Launcher/start_game_cli.jpg
- :class: with-shadow
Commit: 4dd6ea359924027484ae57ab1dbeea2ba15dd2f2
https://github.com/scummvm/scummvm/commit/4dd6ea359924027484ae57ab1dbeea2ba15dd2f2
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds gatekeeper info to mac install section
Changed paths:
doc/docportal/getting_started/mac_linux_windows.rst
diff --git a/doc/docportal/getting_started/mac_linux_windows.rst b/doc/docportal/getting_started/mac_linux_windows.rst
index f98b4aa266..13906831a0 100644
--- a/doc/docportal/getting_started/mac_linux_windows.rst
+++ b/doc/docportal/getting_started/mac_linux_windows.rst
@@ -8,10 +8,17 @@ All downloads referenced on this page are available from the `ScummVM downloads
macOS/Mac OSX
------------------
-Download the Disk Image. Once the download has completed, double click the file to mount the Disk Image. A dialog will open with the ScummVM icon. Drag this icon into your Applications folder to install ScummVM.
+Download the Disk Image. Once the download has completed, double click the file to mount the Disk Image. A window will open with the ScummVM icon. Drag this icon into your Applications folder to install ScummVM.
To run ScummVM, click on the icon in the Applications folder.
+.. note::
+
+ macOS includes a technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac.
+
+ Since ScummVM is not available from the App Store, see this `Apple support page <https://support.apple.com/en-us/HT202491>`_ if you have any difficulty running ScummVM.
+
+
Linux
--------
@@ -85,9 +92,6 @@ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through
Windows
---------
-ScummVM requires Windows XP or higher.
-
-
The easiest way to install ScummVM is to download the Windows installer. This installer will guide you through the install process, as well as adding a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop. To run ScummVM, navigate to desktop and double click the ScummVM shortcut. To run ScummVM from the Start menu, go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Programs > Games > ScummVM**.
Alternatively, you can download the Windows zipped file appropriate to your operating system (32bit or 64bit). To unzip the contents, right-click the folder, select Extract All, and then follow the instructions. To run ScummVM from this folder, find the ``scummvm.exe`` file and double click it.
Commit: b4f3bc8b868bbfd90a8f0cbcef143e3bb0555779
https://github.com/scummvm/scummvm/commit/b4f3bc8b868bbfd90a8f0cbcef143e3bb0555779
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: tidies up platform pages
- edits for consistency
Changed paths:
A doc/docportal/other_platforms/amigaos_4.rst
A doc/docportal/other_platforms/playstation_3.rst
A doc/docportal/other_platforms/playstation_portable.rst
A doc/docportal/other_platforms/sega_dreamcast.rst
R doc/docportal/other_platforms/amigaos4.rst
R doc/docportal/other_platforms/dreamcast.rst
R doc/docportal/other_platforms/psp.rst
doc/docportal/index.rst
doc/docportal/other_platforms/android.rst
doc/docportal/other_platforms/ios.rst
doc/docportal/other_platforms/nintendo_switch.rst
doc/docportal/other_platforms/ps_vita.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 75270b17d4..943e57720e 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -128,19 +128,19 @@ We have guides available to show you how to get ScummVM up and running:
^^^^^^^^^^^^^^^^^^^
:doc:`other_platforms/ps_vita`
- :doc:`other_platforms/psp`
+ :doc:`other_platforms/playstation_portable`
:doc:`other_platforms/nintendo_switch`
:doc:`other_platforms/nintendo_3ds`
- :doc:`other_platforms/dreamcast`
+ :doc:`other_platforms/sega_dreamcast`
---
Other systems
^^^^^^^^^^^^^^^
- :doc:`other_platforms/amigaos4`
+ :doc:`other_platforms/amigaos_4`
diff --git a/doc/docportal/other_platforms/amigaos4.rst b/doc/docportal/other_platforms/amigaos_4.rst
similarity index 97%
rename from doc/docportal/other_platforms/amigaos4.rst
rename to doc/docportal/other_platforms/amigaos_4.rst
index c5041ec34a..76b98e2e1b 100644
--- a/doc/docportal/other_platforms/amigaos4.rst
+++ b/doc/docportal/other_platforms/amigaos_4.rst
@@ -1,5 +1,5 @@
=============================
-Amiga OS 4
+AmigaOS 4
=============================
Install ScummVM
diff --git a/doc/docportal/other_platforms/android.rst b/doc/docportal/other_platforms/android.rst
index d2db264574..5ffe63f8d2 100644
--- a/doc/docportal/other_platforms/android.rst
+++ b/doc/docportal/other_platforms/android.rst
@@ -3,7 +3,7 @@
Android
===============
-Installing ScummVM
+Install ScummVM
====================================
There are multiple ways to install ScummVM on your Android device depending on what version of Android you have.
@@ -35,7 +35,7 @@ Click on the correct package to start the download. Once it has downloaded, go t
- For Android 7 or earlier, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
- For Android 8 or later, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
-Transferring game files
+Transfer game files
========================================
You need to transfer all the required game data files to your device, into a folder accessible by the ScummVM app.
diff --git a/doc/docportal/other_platforms/ios.rst b/doc/docportal/other_platforms/ios.rst
index 07609f57bc..954f6a0beb 100644
--- a/doc/docportal/other_platforms/ios.rst
+++ b/doc/docportal/other_platforms/ios.rst
@@ -3,7 +3,7 @@
iOS
==============
-Installing ScummVM
+Install ScummVM
=====================
There are two methods to install ScummVM onto your iOS device, and the method you use depends on whether or not your device is jailbroken.
@@ -23,7 +23,7 @@ Prerequisites
If you have a free Apple developer account, each build will only be valid for 7 days, which means you will need to repeat these steps and re-install ScummVM every week.
-Creating the Xcode project
+Create the Xcode project
***************************
The first step is to download the repository containing the code we'll need to build the app with. The easiest way to do this is from the command line. Go to **Applications > Utilities > Terminal** and enter the following:
@@ -63,7 +63,7 @@ Your present working directory will now be the new ``build`` directory. Unzip th
unzip ~/Downloads/scummvm-ios7-libs-v2.zip
-Generating the Xcode project
+Generate the Xcode project
*****************************
It's time to generate the Xcode project. Ensure your present working directory is still the ``build`` directory, and then run the following on the command line:
@@ -94,7 +94,7 @@ Open the ``scummvm.xcodeproj`` file from the Finder, or via the command line:
open scummvm.xcodeproj
-Building ScummVM
+Build ScummVM
*****************
Once Xcode is open, connect the device you are installing ScummVM onto. At the top of the window, select **ScummVM-iOS** and then the device you connected. You will need to trust the device before it will show up on the list of connected devices.
@@ -130,7 +130,7 @@ Prerequisites
- A file manager app such as Filza on your iOS device
-Installing ScummVM
+Install ScummVM
*******************
Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended .deb package. Your device will ask how to open the file. Choose Filza.
@@ -141,14 +141,14 @@ The .ipa package can be installed in the same way.
You will need to restart your device for the install to complete.
-Transferring game files
+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:`../settings/cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../settings/lan` page.
-.. note:
+.. note::
ScummVM's Cloud functionality does not currently support iCloud, however it is possible to upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder.
diff --git a/doc/docportal/other_platforms/nintendo_switch.rst b/doc/docportal/other_platforms/nintendo_switch.rst
index dfbd1917cb..ecefe45d29 100644
--- a/doc/docportal/other_platforms/nintendo_switch.rst
+++ b/doc/docportal/other_platforms/nintendo_switch.rst
@@ -2,7 +2,7 @@
Nintendo Switch
=============================
-Installing ScummVM
+Install ScummVM
===================
Prerequisites
@@ -11,8 +11,8 @@ Prerequisites
- A homebrew-enabled Nintendo Switch console. How to enable homebrew is outside the scope of this documentation.
- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
-Installing ScummVM
-*******************
+Download and install ScummVM
+*******************************
The Nintendo Switch package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
@@ -21,7 +21,7 @@ Download the ``.zip`` archive to a computer, and extract the files.
Copy the extracted ``scummvm`` folder to your Nintendo Switch microSD card, into the ``/switch/`` folder.
-Transferring game files
+Transfer game files
=======================
Copy the folders containing game files into the ``/switch/scummvm/`` folder on the microSD card.
diff --git a/doc/docportal/other_platforms/playstation_3.rst b/doc/docportal/other_platforms/playstation_3.rst
new file mode 100644
index 0000000000..b1864fbb3e
--- /dev/null
+++ b/doc/docportal/other_platforms/playstation_3.rst
@@ -0,0 +1,98 @@
+=============================
+PlayStation 3
+=============================
+
+Install ScummVM
+===================
+
+Prerequisites
+****************
+
+- A Homebrew enabled Playstation 3 console. How to enable homebrew is outside the scope of this documentation.
+- A USB drive
+- A computer
+
+Download and install ScummVM
+*********************************
+
+Download the Playstation 3 package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Copy the ``.pkg`` file to a USB drive.
+
+Plug the USB drive into the PS3. Go to the XMB, then go to **Games > Install Package** to install the ScummVM package.
+
+To launch ScummVM, go to the XMB, then go to **Games > PlayStation 3 > ScummVM**.
+
+
+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 <../guides/connect_cloud>`.
+
+See :doc:`../using_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.
+
+
+Default control mapping
+*************************
+
+.. |square| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="5 2 16 16" width="20" height="20"><path fill-rule="evenodd" d="M6 7.75C6 6.784 6.784 6 7.75 6h8.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0116.25 18h-8.5A1.75 1.75 0 016 16.25v-8.5zm1.75-.25a.25.25 0 00-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 00.25-.25v-8.5a.25.25 0 00-.25-.25h-8.5z"></path></svg>
+
+.. |circle| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.404 3.404a6.5 6.5 0 109.192 9.192 6.5 6.5 0 00-9.192-9.192zm-1.06 10.253A8 8 0 1113.656 2.343 8 8 0 012.343 13.657z"></path></svg>
+
+.. |x| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.72 3.72a.75.75 0 011.06 0L8 6.94l3.22-3.22a.75.75 0 111.06 1.06L9.06 8l3.22 3.22a.75.75 0 11-1.06 1.06L8 9.06l-3.22 3.22a.75.75 0 01-1.06-1.06L6.94 8 3.72 4.78a.75.75 0 010-1.06z"></path></svg>
+
+.. |triangle| raw:: html
+
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24"><path d="M11.574 3.712c.195-.323.662-.323.857 0l9.37 15.545c.2.333-.039.757-.429.757l-18.668-.006c-.385 0-.629-.422-.428-.758l9.298-15.538zm.429-2.483c-.76 0-1.521.37-1.966 1.111l-9.707 16.18c-.915 1.523.182 3.472 1.965 3.472h19.416c1.783 0 2.879-1.949 1.965-3.472l-9.707-16.18c-.446-.741-1.205-1.111-1.966-1.111z"/></svg>
+
+
+.. csv-table::
+ :widths: 50 50
+ :header-rows: 2
+
+ Touchscreen:,
+ Buttons/Control,Action
+ Left stick,Moves pointer
+ |x|,Left mouse button
+ |circle|,Right mouse button
+ |triangle|,Game menu
+ |square|,Esc
+ START,Global Main Menu
+ SELECT,Toggle virtual keyboard
+ L1 button,AGI predictive input dialog
+
+
+Paths
+=======
+
+Saved games
+*******************
+
+``/hdd0/game/SCUM12000/saves``
+
+Configuration file
+**************************
+
+
+
+Settings
+==========
+
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+
+Known issues
+==============
diff --git a/doc/docportal/other_platforms/psp.rst b/doc/docportal/other_platforms/playstation_portable.rst
similarity index 97%
rename from doc/docportal/other_platforms/psp.rst
rename to doc/docportal/other_platforms/playstation_portable.rst
index 033824b016..b8112a7e0e 100644
--- a/doc/docportal/other_platforms/psp.rst
+++ b/doc/docportal/other_platforms/playstation_portable.rst
@@ -1,8 +1,8 @@
=====================
-Playstation Portable
+PlayStation Portable
=====================
-Installing ScummVM
+Install ScummVM
===================
Prerequisites
@@ -11,8 +11,8 @@ Prerequisites
- A homebrew-enabled PSP. How to enable homebrew is outside the scope of this documentation.
- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
-Installing ScummVM
-*******************
+Download and install ScummVM
+*******************************
The PSP package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
@@ -25,7 +25,7 @@ Copy the extracted ``scummvm`` folder to your PSP, into the ``/PSP/GAME/`` folde
Go to **Game > Memory Stick** and choose **ScummVM** to launch ScummVM!
-Transferring game files
+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.
diff --git a/doc/docportal/other_platforms/ps_vita.rst b/doc/docportal/other_platforms/ps_vita.rst
index 796d07c061..7477628f99 100644
--- a/doc/docportal/other_platforms/ps_vita.rst
+++ b/doc/docportal/other_platforms/ps_vita.rst
@@ -1,8 +1,8 @@
=====================
-Playstation Vita
+PlayStation Vita
=====================
-Installing ScummVM
+Install ScummVM
=======================
Prerequisites
@@ -11,15 +11,15 @@ Prerequisites
- A homebrew-enabled PS Vita console with `Vitashell <https://github.com/TheOfficialFloW/VitaShell/releases/tag/v2.02>`_ installed. How to enable homebrew is outside the scope of this documentation.
- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
-Installing ScummVM
-*******************
+Download and install ScummVM
+******************************
The PS Vita package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
Copy the ``.vpk`` to the PS Vita and install it using VitaShell.
-Transferring game files
+Transfer game files
=======================
There are a few ways to transfer game files to the PS Vita.
diff --git a/doc/docportal/other_platforms/dreamcast.rst b/doc/docportal/other_platforms/sega_dreamcast.rst
similarity index 100%
rename from doc/docportal/other_platforms/dreamcast.rst
rename to doc/docportal/other_platforms/sega_dreamcast.rst
Commit: 7a8790f052cad137b6a8ddaf9012d41df7c5f480
https://github.com/scummvm/scummvm/commit/7a8790f052cad137b6a8ddaf9012d41df7c5f480
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: tidies up config file page
- fixes table width issues
- changes heading hierarchy for readability
Changed paths:
doc/docportal/advanced_options/configuration_file.rst
diff --git a/doc/docportal/advanced_options/configuration_file.rst b/doc/docportal/advanced_options/configuration_file.rst
index 69a0ea2c85..4965a60c96 100755
--- a/doc/docportal/advanced_options/configuration_file.rst
+++ b/doc/docportal/advanced_options/configuration_file.rst
@@ -27,7 +27,7 @@ The configuration file saves to different default locations, depending on the pl
.. tip::
- To see the Libraries folder you will need to view hidden files by using the keyboard shortcut :kbd:`Cmd + Shift + . `
+ To see the Library folder you will need to view hidden files by using the keyboard shortcut :kbd:`Cmd + Shift + .`
.. tabbed:: Windows
@@ -38,7 +38,8 @@ The configuration file saves to different default locations, depending on the pl
95/98/ME
^^^^^^^^^^
- ``<windir>\scummvm.ini``
+ ``<windir>\scummvm.ini``, where ``<windir>`` is the Windows directory. Most commonly, this is ``C:\WINDOWS``.
+
---
:column: col-lg-12 mb-2
@@ -46,7 +47,7 @@ The configuration file saves to different default locations, depending on the pl
Windows NT4
^^^^^^^^^^^^
- ``<windir>\Profiles\username\Application Data\ScummVM\scummvm.ini``
+ ``<windir>\Profiles\username\Application Data\ScummVM\scummvm.ini``, where ``<windir>`` is the Windows directory. Most commonly, this is ``C:\WINDOWS``.
---
:column: col-lg-12 mb-2
@@ -58,13 +59,16 @@ The configuration file saves to different default locations, depending on the pl
---
:column: col-lg-12 mb-2
- Window 7/Vista
- ^^^^^^^^^^^^^^^^
+ Window Vista/7/8/10
+ ^^^^^^^^^^^^^^^^^^^^^^
``\Users\username\AppData\Roaming\ScummVM\scummvm.ini``
- .. tip::
+ .. tip::
+
+ The AppData folder is hidden. The steps to view hidden files and folders depends on the Windows version.
+
+ For more information, see the `Windows support page <https://support.microsoft.com/en-us/help/14201/windows-show-hidden-files>`_.
- ``<windir>`` refers to the Windows directory. Most commonly, this is ``C:\WINDOWS``.
.. note::
@@ -98,11 +102,11 @@ The configuration file saves to different default locations, depending on the pl
Using the configuration file
==================================
-Global settings are listed under the ``[scummvm]`` heading. Global :doc:`Keymaps settings <../settings/keymaps>` are listed under the ``[keymapper]`` heading. Game-specific settings, including keymaps, are listed under the heading for that game, for example ``[queen]`` for Flight of the Amazon Queen. Use the configuration keywords_ to change settings.
+Global settings are listed under the ``[scummvm]`` heading. Global :doc:`keymaps settings <../settings/keymaps>` are listed under the ``[keymapper]`` heading. Game-specific settings, including keymaps, are listed under the heading for that game, for example ``[queen]`` for Flight of the Amazon Queen. Use the configuration keywords_ to change settings.
Example of a configuration file
-=================================
+************************************
.. code::
@@ -148,7 +152,7 @@ Keywords
There are many recognized configuration keywords. In the table below, each keyword is linked to an explanatory description in the Settings pages.
.. csv-table::
- :widths: 20 20 10 50
+ :widths: 35 15 25 25
:header-rows: 1
Keyword,Type,Default,Options
Commit: 00d41e07e6402a99300f44e19547666a37aaff1f
https://github.com/scummvm/scummvm/commit/00d41e07e6402a99300f44e19547666a37aaff1f
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: rearranges doc structure
- new sections: phones and tablets, consoles, other platforms
Changed paths:
A doc/docportal/consoles/nintendo_3ds.rst
A doc/docportal/consoles/nintendo_switch.rst
A doc/docportal/consoles/playstation_3.rst
A doc/docportal/consoles/playstation_portable.rst
A doc/docportal/consoles/ps_vita.rst
A doc/docportal/consoles/sega_dreamcast.rst
A doc/docportal/phones_tablets/android.rst
A doc/docportal/phones_tablets/ios.rst
R doc/docportal/other_platforms/android.rst
R doc/docportal/other_platforms/ios.rst
R doc/docportal/other_platforms/nintendo_3ds.rst
R doc/docportal/other_platforms/nintendo_switch.rst
R doc/docportal/other_platforms/playstation_3.rst
R doc/docportal/other_platforms/playstation_portable.rst
R doc/docportal/other_platforms/ps_vita.rst
R doc/docportal/other_platforms/sega_dreamcast.rst
doc/docportal/index.rst
diff --git a/doc/docportal/other_platforms/nintendo_3ds.rst b/doc/docportal/consoles/nintendo_3ds.rst
similarity index 100%
rename from doc/docportal/other_platforms/nintendo_3ds.rst
rename to doc/docportal/consoles/nintendo_3ds.rst
diff --git a/doc/docportal/other_platforms/nintendo_switch.rst b/doc/docportal/consoles/nintendo_switch.rst
similarity index 100%
rename from doc/docportal/other_platforms/nintendo_switch.rst
rename to doc/docportal/consoles/nintendo_switch.rst
diff --git a/doc/docportal/other_platforms/playstation_3.rst b/doc/docportal/consoles/playstation_3.rst
similarity index 100%
rename from doc/docportal/other_platforms/playstation_3.rst
rename to doc/docportal/consoles/playstation_3.rst
diff --git a/doc/docportal/other_platforms/playstation_portable.rst b/doc/docportal/consoles/playstation_portable.rst
similarity index 100%
rename from doc/docportal/other_platforms/playstation_portable.rst
rename to doc/docportal/consoles/playstation_portable.rst
diff --git a/doc/docportal/other_platforms/ps_vita.rst b/doc/docportal/consoles/ps_vita.rst
similarity index 100%
rename from doc/docportal/other_platforms/ps_vita.rst
rename to doc/docportal/consoles/ps_vita.rst
diff --git a/doc/docportal/other_platforms/sega_dreamcast.rst b/doc/docportal/consoles/sega_dreamcast.rst
similarity index 100%
rename from doc/docportal/other_platforms/sega_dreamcast.rst
rename to doc/docportal/consoles/sega_dreamcast.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 943e57720e..6c33ef6008 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -1,19 +1,37 @@
.. toctree::
:glob:
- :caption: Quickstart Guide
+ :caption: Quickstart guide
:maxdepth: 2
:hidden:
getting_started/mac_linux_windows
-
+
+
+.. toctree::
+ :glob:
+ :caption: Phones and tablets
+ :maxdepth: 2
+ :hidden:
+
+ phones_tablets/*
+
+.. toctree::
+ :glob:
+ :caption: Consoles
+ :maxdepth: 2
+ :hidden:
+
+ consoles/*
+
.. toctree::
:glob:
- :caption: Other Platforms
+ :caption: Other platforms
:maxdepth: 2
:hidden:
other_platforms/*
+
.. toctree::
:caption: Using ScummVM
:glob:
@@ -58,7 +76,7 @@
.. toctree::
- :caption: Advanced Options
+ :caption: Advanced options
:glob:
:hidden:
@@ -83,7 +101,7 @@
release_notes/*
.. toctree::
- :caption: Contribute to Documentation
+ :caption: Contribute to documentation
:glob:
:hidden:
@@ -118,27 +136,27 @@ We have guides available to show you how to get ScummVM up and running:
Phones and Tablets
^^^^^^^^^^^^^^^^^^^
- :doc:`other_platforms/ios`
+ :doc:`phones_tablets/ios`
- :doc:`other_platforms/android`
+ :doc:`phones_tablets/android`
---
Consoles
^^^^^^^^^^^^^^^^^^^
- :doc:`other_platforms/ps_vita`
+ :doc:`consoles/ps_vita`
- :doc:`other_platforms/playstation_portable`
+ :doc:`consoles/playstation_portable`
- :doc:`other_platforms/nintendo_switch`
+ :doc:`consoles/nintendo_switch`
- :doc:`other_platforms/nintendo_3ds`
+ :doc:`consoles/nintendo_3ds`
- :doc:`other_platforms/sega_dreamcast`
+ :doc:`consoles/sega_dreamcast`
---
- Other systems
+ Other platforms
^^^^^^^^^^^^^^^
:doc:`other_platforms/amigaos_4`
diff --git a/doc/docportal/other_platforms/android.rst b/doc/docportal/phones_tablets/android.rst
similarity index 100%
rename from doc/docportal/other_platforms/android.rst
rename to doc/docportal/phones_tablets/android.rst
diff --git a/doc/docportal/other_platforms/ios.rst b/doc/docportal/phones_tablets/ios.rst
similarity index 100%
rename from doc/docportal/other_platforms/ios.rst
rename to doc/docportal/phones_tablets/ios.rst
Commit: 3311fc8097b7233af1dae0114223bacdef971cd8
https://github.com/scummvm/scummvm/commit/3311fc8097b7233af1dae0114223bacdef971cd8
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: second draft 3DS page
Changed paths:
A doc/docportal/images/3ds/config.png
doc/docportal/consoles/nintendo_3ds.rst
diff --git a/doc/docportal/consoles/nintendo_3ds.rst b/doc/docportal/consoles/nintendo_3ds.rst
index dc7d731d73..a46fdfc635 100644
--- a/doc/docportal/consoles/nintendo_3ds.rst
+++ b/doc/docportal/consoles/nintendo_3ds.rst
@@ -8,22 +8,36 @@ Install ScummVM
Prerequisites
****************
-- A Nintendo 3DS with a Homebrew Launcher. Installing a Homebrew Launcher is outside the scope of this documentation.
+- A Nintendo 3DS with a Homebrew Launcher or custom firmware. Enabling homebrew is outside the scope of this documentation.
Download and install ScummVM
*********************************
-Download the Nintendo 3DS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_.
+Download the Nintendo 3DS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Extract the archive.
-Extract the archive, and copy the extracted files to your SD card into the ``/3ds/scummvm`` directory.
+There are two ways to install ScummVM: using the 3DSX format, or the CIA format.
+
+3DSX
+^^^^^^
+Copy the extracted files to your SD card into the ``/3ds/scummvm`` directory.
Launch ScummVM using the Homebrew Launcher.
+CIA
+^^^^^
+
+Use any CIA installation software to install the ``scummvm.cia`` file.
+
+The CIA format requires a DSP binary dump saved on your SD card as ``/3ds/dspfirm.cdc``. This is not an optional step, since without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
Transfer game files
=======================
-See :doc:`../using_scummvm/add_play_games` for more information.
+Transfer game folders onto the SD card. The exact location is not important.
+
+ScummVM for the Nintendo 3DS also has Cloud functionality. See :doc:`../guides/connect_cloud`.
+
+See :doc:`../using_scummvm/add_play_games` for more information about how to add games to ScummVM.
Controls
@@ -46,11 +60,11 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
R + Circle Pad,Slow Mouse
A,Left mouse button
B,Right mouse button
- X,Opens virtual keyboard
+ X,Opens the virtual keyboard
Y,ESC
- Control Pad,Keypad Cursor Keys
+ Control Pad,Keypad cursor keys
L Button,Toggles magnify mode on/off
- R Button,Toggles hover/drag modes
+ R Button,Toggles between hover/drag modes
START,Opens global main menu
SELECT,Opens 3DS config menu
@@ -87,16 +101,37 @@ Paths
Saved games
*******************
+``sdmc:/3ds/scummvm/saves/``
Configuration file
**************************
+``sdmc:/3ds/scummvm/scummvm.ini``
Settings
==========
+For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+.. figure:: ../images/3ds/config.png
+
+ The 3DS config menu.
+
+Show mouse cursor
+ Toggles a visible mouse cursor on/off.
+
+Stretch to fit
+ Stretches the image to fit the screen
+
+Snap to edges
+ Makes it easier for mouse controls to reach the edge of the screen.
+Use Screen:
+ Sets whether ScummVM uses the **Top**, **Bottom** or **Both** screens.
+
+C-Pad Sensitivity
+ Sets the sensitivity of the Circle Pad.
Known issues
==============
diff --git a/doc/docportal/images/3ds/config.png b/doc/docportal/images/3ds/config.png
new file mode 100644
index 0000000000..98c65b0cac
Binary files /dev/null and b/doc/docportal/images/3ds/config.png differ
Commit: f2472bad5f533a06a815e21d7e616f7406da884c
https://github.com/scummvm/scummvm/commit/f2472bad5f533a06a815e21d7e616f7406da884c
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: second draft AmigaOS
Changed paths:
A doc/docportal/images/amigaos_4/installer.png
doc/docportal/other_platforms/amigaos_4.rst
diff --git a/doc/docportal/images/amigaos_4/installer.png b/doc/docportal/images/amigaos_4/installer.png
new file mode 100644
index 0000000000..7c509e6a56
Binary files /dev/null and b/doc/docportal/images/amigaos_4/installer.png differ
diff --git a/doc/docportal/other_platforms/amigaos_4.rst b/doc/docportal/other_platforms/amigaos_4.rst
index 76b98e2e1b..3827c34c82 100644
--- a/doc/docportal/other_platforms/amigaos_4.rst
+++ b/doc/docportal/other_platforms/amigaos_4.rst
@@ -13,11 +13,17 @@ Prerequisites
Download and install ScummVM
*********************************
-There are three ways to install ScummVM on AmigaOS 4:
+ScummVM is available for download from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_ or the `OS4 Depot <http://www.os4depot.net>`_.
-- Use AmiUpdate
-- Use the installer script that comes with every release
-- Download and unarchive the ``.lha`` file. It does not matter where the files are kept.
+Download and extract the ``.lha`` file.
+
+Run the extracted ``ScummVM_Install`` script. This installer guides you through the installation process.
+
+.. figure:: ../images/amigaos_4/installer.png
+
+ The ScummVM installer.
+
+To automatically keep ScummVM up to date through AmiUpdate, run the ``Autoinstall`` script.
Transfer game files
@@ -32,9 +38,7 @@ ScummVM for Amiga OS has Cloud and LAN functionality, to help manage the transfe
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.
+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.
Paths
@@ -52,7 +56,7 @@ Configuration file
Settings
==========
-For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
Audio
******
Commit: 78d536b4e577cc13571418223bb0dcb7d6c1e1de
https://github.com/scummvm/scummvm/commit/78d536b4e577cc13571418223bb0dcb7d6c1e1de
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds first draft RISC OS page
Changed paths:
A doc/docportal/other_platforms/risc_os.rst
doc/docportal/advanced_options/configuration_file.rst
diff --git a/doc/docportal/advanced_options/configuration_file.rst b/doc/docportal/advanced_options/configuration_file.rst
index 4965a60c96..9358873403 100755
--- a/doc/docportal/advanced_options/configuration_file.rst
+++ b/doc/docportal/advanced_options/configuration_file.rst
@@ -197,6 +197,7 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`enable_hq_video <hq>`",boolean,true,
":ref:`enable_larryscale <larry>`",boolean,true,
":ref:`enable_video_upscale <upscale>`",boolean,true,
+ ":ref:`enable_reporter <reporter>`",boolean,false,RISC OS only.
":ref:`enable_tts <ttsenabled>`",boolean,false,
":ref:`extrapath <extra>`",string,None," path"
":ref:`fade_style <fade>`",boolean,true,
diff --git a/doc/docportal/other_platforms/risc_os.rst b/doc/docportal/other_platforms/risc_os.rst
new file mode 100644
index 0000000000..12a4a38a5b
--- /dev/null
+++ b/doc/docportal/other_platforms/risc_os.rst
@@ -0,0 +1,69 @@
+=============================
+RISC OS
+=============================
+
+Install ScummVM
+===================
+
+Prerequisites
+****************
+
+- A system running RISC OS 5
+- The `SharedUnixLibrary <https://www.riscos.info/index.php/SharedUnixLibrary>`_, `DRenderer <https://www.riscos.info/packages/LibraryDetails.html#DRendererarm>`_ and `Iconv <https://www.netsurf-browser.org/projects/iconv/>`_ modules installed. SharedUnixLibrary and DRenderer can be installed using `Packman <https://www.riscos.info/index.php/PackMan>`_.
+
+Download and install ScummVM
+*********************************
+
+Download the RISC OS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_.
+
+Use a tool such as SparkFS to extract the archive. It is important that the archive is not extracted on any other system, since this results in a loss of file type information. ScummVM requires this file type information to run properly.
+
+
+
+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.
+
+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.
+
+
+Paths
+=======
+
+Saved games
+*******************
+
+``<Choices$Write>.ScummVM.Saves``
+
+Configuration file
+**************************
+``<Choices$Write>.ScummVM.scummvmrc``
+
+The ``<Choices$Write>`` environment variable is usually ``$.!Boot.Choices``.
+
+
+Settings
+==========
+
+
+For more information about settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+.. _reporter:
+
+There is one additional configuration option, *enable_reporter*. When set to true in :doc:`../advanced_options/configuration_file`, log messages are sent to the `!Reporter <http://www.avisoft.force9.co.uk/Reporter.html>`_ application, which can be useful to developers.
+
+
+Known issues
+==============
+
+- Due to ongoing issues with executable size, releases are built without Cloud or LAN functionality.
+- FluidSynth is not supported.
+- The releases are only compatible with RISC OS 5, and not RISC OS 3, 4, or 6.
+
+
\ No newline at end of file
Commit: 4cdcdd4181586be4c5331be85d9e700575d71958
https://github.com/scummvm/scummvm/commit/4cdcdd4181586be4c5331be85d9e700575d71958
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: updates settings on 3DS page
Changed paths:
doc/docportal/consoles/nintendo_3ds.rst
diff --git a/doc/docportal/consoles/nintendo_3ds.rst b/doc/docportal/consoles/nintendo_3ds.rst
index a46fdfc635..7621f7a25f 100644
--- a/doc/docportal/consoles/nintendo_3ds.rst
+++ b/doc/docportal/consoles/nintendo_3ds.rst
@@ -125,8 +125,8 @@ Stretch to fit
Stretches the image to fit the screen
Snap to edges
- Makes it easier for mouse controls to reach the edge of the screen.
-
+ The 3DS touch screen has difficulty reaching the very end of the screen. Enabling this options means that if you're within a few pixels of the edge, the cursor will snap to the edge.
+
Use Screen:
Sets whether ScummVM uses the **Top**, **Bottom** or **Both** screens.
Commit: 1ca6f66d3a4d62dcccdbad5759ffec750bc2e5ad
https://github.com/scummvm/scummvm/commit/1ca6f66d3a4d62dcccdbad5759ffec750bc2e5ad
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: final draft How to use ScummVM pages
- edits for consistency + adherence to style guide
- edits for clarity
- removes some notes regarding game saves, now avail all engines v2.2.0
Changed paths:
doc/docportal/using_scummvm/add_play_games.rst
doc/docportal/using_scummvm/keyboard_shortcuts.rst
doc/docportal/using_scummvm/save_load_games.rst
doc/docportal/using_scummvm/the_launcher.rst
diff --git a/doc/docportal/using_scummvm/add_play_games.rst b/doc/docportal/using_scummvm/add_play_games.rst
index 8f8a8de3dd..118d4bb194 100644
--- a/doc/docportal/using_scummvm/add_play_games.rst
+++ b/doc/docportal/using_scummvm/add_play_games.rst
@@ -3,55 +3,52 @@
Add and play games
=================================
-Accessing the game files
+The game files
------------------------
-ScummVM needs access to the data files for each game. A comprehensive list of required data files for each game can be found on the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page. ScummVM can run the game data files from any directory it has access to, including external media.
+ScummVM needs access to the data files for each game. A comprehensive list of required data files for each game is found on the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page. ScummVM can run the game data files from any directory it has access to, including external media.
.. note::
For ease of use, you can create a dedicated games directory into which subdirectories containing game files can be copied. The resulting directory structure will look somewhat like this::
- mygames
- |-- myfirstgame
- | |-- readme.txt
- | |-- firstgame.cpt
- | |-- firstgame.dnr
- | `-- firstgame.dsk
- `-- mysecondgame
- |-- secondgame.1c
- `-- readme.txt
+ ScummVM Games
+ |-- Day of the Tentacle
+ | |-- MONSTER.SOU
+ | |-- TENTACLE.000
+ | `-- TENTACLE.001
+ `-- Flight of the Amazon Queen
+ |-- QUEEN.1
+ `-- queen.tbl
+ The exact layout of files and folders within the game folder is not important, as long as all the files are there.
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.
+- If the data files are not accessible, run the installer on the platform the game was designed for, to extract the individual files.
For games downloaded from digital distributors such as `GOG.com <gog.com>`__, `Steam <https://store.steampowered.com>`__, or from various `freeware sources <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games#Freeware_Games>`__ sources:
-- Run the installer or
+- Run the installer, or
- If the data files are supplied as a .zip file, extract the archive.
+
.. tip::
- A great way to share game files and automatically back up and sync your saved game states between devices running ScummVM is to connect a Cloud storage service such as Dropbox or Google Drive. Detailed instructions for setting this up can be found on the :doc:`../guides/connect_cloud` guide.
+ A great way to share game files and automatically back up and sync your saved game states between devices is to connect a Cloud storage service to ScummVM. For detailed instructions see the :doc:`../guides/connect_cloud` guide.
- For devices on the same local network, ScummVM can run a web server to allow the transfer of files. Detailed instructions can be found on the :doc:`../guides/local_webserver`. This is a good option if you do not wish to connect a Cloud service, although it doesn't offer as much functionality.
+ 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:`../guides/local_webserver` guide. This is a good option if you do not wish to connect a Cloud service.
Multi-disc games
*****************
-ScummVM needs access to all the data files, so it will not be able to run directly from a CD in the case where the game has multiple discs. To add a multi-CD game, copy the required data files directly from the CD to a dedicated game folder on your hard drive.
+ScummVM needs access to all the data files, so it will not be able to run directly from a CD if the game has multiple discs. To add a multi-CD game, copy the required data files from the CD to a folder on your hard drive.
- Where there are duplicate, identical files (same name, same file size) on more than one disc, only one copy of the file is required.
-- Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the files to ``music1.clu`` and ``music2.clu``.
-
-.. tip::
-
- The exact layout of files and folders within the game folder is not important, as long as all the files are there.
+- Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.
.. _cd:
@@ -74,48 +71,48 @@ Place the converted audio files in the same folder that contains the other game
Macintosh games
******************
-All LucasArts SCUMM games also exist in versions for the Macintosh. Most of the newer games shipped with only a single data file; ScummVM can use this file like it does any other data files. Some discs shipped with hidden files. To view hidden files in Mac OSX, use the keyboard shortcut :kbd:`Cmd` + :kbd:`Shift` + :kbd:`Period (.)`.
+All LucasArts SCUMM games also exist in versions for the Macintosh. Most of the newer games shipped with only a single data file; ScummVM can use this file like it does any other data file. Some discs shipped with hidden files. To view hidden files in macOS, press :kbd:`Cmd+Shift+.` in a Finder window.
-Mac uses a different file system to other systems (HFS+), so if you are accessing the CD or floppy from a Windows or Linux machine you will need additional software in order to view and copy the files.
+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 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, 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 Linux, hfsplus allows read-only access to HFS drives. To use hfsplus, use the command line:
1. Install hfsplus using the software manager. On Debian-based distributions, use ``sudo apt install hfsplus``.
- 2. Find the game disc by running ``sudo fdisk -l`` and finding the one with type ``Apple HFS/HFS+``. In this example we will say this is ``/dev/fd0``.
+ 2. Find the game disc by running ``sudo fdisk -l`` and finding the one with type ``Apple HFS/HFS+``. In this example, this is ``/dev/fd0``.
3. Create a mount point, for example: ``sudo mkdir /media/macgamedrive``
4. Mount the device to that moint point: ``sudo mount -t hfsplus /dev/fd0 /media/macgamedrive``
5. Access the device at ``/media/macgamedrive``.
.. _add and play games:
-Adding the games to the Launcher
+Add games to the Launcher
---------------------------------
1. Run ScummVM to open :doc:`../using_scummvm/the_launcher`.
-2. In the Launcher window, click **Add Game**. This opens a file browser; either the system file browser or the ScummVM file browser. To add multiple games at once, click on the dropdown arrow next to **Add Game**, and select **Mass Add...**.
+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**.
.. image:: ../images/Launcher/add_game.png
:class: with-shadow
-3. Use the file browser to locate the folder containing the game you wish to add. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Once you have selected the folder that contains the data files, click **Choose**.
+3. Use the file browser to locate the folder containing the game data files. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Click **Choose** to select the folder.
.. image:: ../images/Launcher/choose_game_directory.png
:class: with-shadow
.. note::
- You may choose which file browser to use by setting the **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings.
+ The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the native system file browser, or its own file browser.
-5. A dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should work at the default settings. Click **Ok**.
+5. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should work at the default settings. Click **Ok**.
.. image:: ../images/Launcher/game_settings.png
:class: with-shadow
-6. Added games are now ready to play! To play, select a game and click **Start** to play.
+6. Games are now ready to play! To play, select a game and click **Start**.
.. image:: ../images/Launcher/start_game.png
:class: with-shadow
diff --git a/doc/docportal/using_scummvm/keyboard_shortcuts.rst b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
index 9a10bef463..dc55575c92 100755
--- a/doc/docportal/using_scummvm/keyboard_shortcuts.rst
+++ b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
@@ -6,10 +6,10 @@ ScummVM supports various in-game keyboard and mouse shortcuts, and since version
For game-specific shortcuts, see the `wiki entry <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ for the game you are playing.
-The shortcuts listed below are the defaults.
-Common shortcuts (all games)
--------------------------------
+
+Default keyboard shortcuts
+============================
.. csv-table::
:width: 100%
diff --git a/doc/docportal/using_scummvm/save_load_games.rst b/doc/docportal/using_scummvm/save_load_games.rst
index 62f566e371..35249062cd 100644
--- a/doc/docportal/using_scummvm/save_load_games.rst
+++ b/doc/docportal/using_scummvm/save_load_games.rst
@@ -6,18 +6,17 @@ Save and load games
Save a game
==============
-
-Games can be saved from the Global Main Menu (GMM), which can be accessed during game play by using the default :kbd:`Ctrl` + :kbd:`F5` keyboard shortcut, or by using the shortcut set in the :doc:`../settings/keymaps` setting.
+Press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac) to access the Global Main Menu. Select **Save**.
.. figure:: ../images/Launcher/gmm_save.png
The Global Main Menu, or GMM.
-There are two views: list view and tile view. Toggle between the two by clicking the list and tile icons at the bottom left of the window.
+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.
.. figure:: ../images/Launcher/save_game_tile.png
- Saving a game, tile view.
+ Save a game, tile view.
.. figure:: ../images/Launcher/save_game_tile_desc.png
@@ -25,18 +24,12 @@ There are two views: list view and tile view. Toggle between the two by clicking
.. figure:: ../images/Launcher/save_game_list.png
- Saving a game, list view.
-
-.. caution::
-
- Saving via the Global Main Menu does not work for all games. Some games have support for saving and loading games using the in-game menu.
-
+ Save a game, list view.
Autosave
------------
-ScummVM will automatically save the game every 5 minutes. The :ref:`autosave period <autosave>` can be changed in the :doc:`Misc tab <../settings/misc>` or in the :doc:`configuration file <../advanced_options/configuration_file>`.
-
+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_options/configuration_file>`.
Load a game
@@ -44,62 +37,80 @@ 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. Toggle between the two by clicking the list and tile icons at the bottom left of the window.
+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 displays a list of your saved states. Click on a saved state to highlight it. On the right, information about the highlighted state such as timestamps, screenshots and playtime is displayed.
+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.
-When you have located the desired saved game:
+To load a saved game, highlight the saved state and click **Load**.
-- Click **Load** to launch the game using that state.
-- Click **Delete** to delete the saved state.
+To delete a saved game, highlight the saved state and click **Delete**.
.. figure:: ../images/Launcher/load_game_list.png
- Loading a game, list view.
+ Load a game, list view.
In tile view, each tile shows a screenshot of the saved state, as well as the description and save slot number. Click on the tile to load that saved state.
.. figure:: ../images/Launcher/load_game_tile.png
- Loading a game, tile view.
+ Load a game, tile view.
-Saved games can also be loaded from the Global Main Menu, which can be accessed during game play by using the default :kbd:`Ctrl` + :kbd:`F5` keyboard shortcut, or by using the shortcut set in the :doc:`../settings/keymaps` setting.
+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**.
-.. caution::
-
- Not all games support saving and loading games via the Global Main Menu.
+Location of saved game files
+-------------------------------
- In some games you can still access the original game menu by using :kbd:`Alt` + :kbd:`F5`. You can save and load games this way, however this may crash ScummVM in some games.
+The save directory can be changed via the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_options/configuration_file>`.
+Default saved game paths are shown below.
+.. tabbed:: macOS
+ .. panels::
+ :column: col-lg-12 mb-2
-Location of saved game files
--------------------------------
+ macOS/Mac OSX
+ ^^^^^^^^^^
+ ``~/Documents/ScummVM Savegames/``, where ``~`` is your Home directory.
+
+.. tabbed:: Windows
-Saved game files can be found in the current ScummVM directory for some platforms, and in default directories for others. The defaults for Windows, Mac and Linux/Unix are shown below.
+ .. panels::
+ :column: col-lg-12 mb-2
-The save directory can be changed via the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_options/configuration_file>`.
+ Windows NT4
+ ^^^^^^^^^^^^
-.. tabs::
+ ``<windir>\Profiles\username\Application Data\ScummVM\Saved games\`` where ``<windir>`` refers to the Windows directory. Most commonly, this is ``C:\WINDOWS``.
- .. tab:: Mac OSX
+ ---
+ :column: col-lg-12 mb-2
- ``~/Documents/ScummVM Savegames/``, where ``~`` is your Home directory. To see the Libraries folder you will need to view hidden files.
-
- .. tab:: Windows
+ Windows 2000/XP
+ ^^^^^^^^^^^^^^^^^
+ ``\Documents and Settings\username\Application Data\ScummVM\Saved games\``
- **Windows NT4**: ``<windir>\Profiles\username\Application Data\ScummVM\Saved games\`` where ``<windir>`` refers to the Windows directory. Most commonly, this is ``C:\WINDOWS``.
-
- **Windows 2000/XP**: ``\Documents and Settings\username\Application Data\ScummVM\Saved games\``
-
- **Window 7/Vista**: ``\Users\username\AppData\Roaming\ScummVM\Saved games\``
+ ---
+ :column: col-lg-12 mb-2
+
+ Window Vista/7/8/10
+ ^^^^^^^^^^^^^^^^^^^^^^
+ ``\Users\username\AppData\Roaming\ScummVM\Saved games\``
- The Application Data/AppData directory is hidden. To view it, use the Run utility or the command prompt, and enter ``%APPDATA%\ScummVM\Saved Games``, or enable hidden files in Windows Explorer.
+ .. tip::
+
+ The AppData folder is hidden. The steps to view hidden files and folders depends on the Windows version.
+
+ For more information, see the `Windows support page <https://support.microsoft.com/en-us/help/14201/windows-show-hidden-files>`_.
- .. tab:: Linux/Unix
+
+
+.. tabbed:: Linux/Unix
+
+ .. 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/``
@@ -109,5 +120,12 @@ The save directory can be changed via the savepath setting in the :doc:`Paths ta
If ScummVM was installed using Snap, the saves can be found at ``~/snap/scummvm/current/.local/share/scummvm/saves/``
-.. _originalsaves:
+
+
+.. tabbed:: Other
+
+ .. panels::
+ :column: col-lg-12 mb-2
+
+ See the relevant Platform page for details.
diff --git a/doc/docportal/using_scummvm/the_launcher.rst b/doc/docportal/using_scummvm/the_launcher.rst
index 7c6ed14bb5..a4ffbd5910 100755
--- a/doc/docportal/using_scummvm/the_launcher.rst
+++ b/doc/docportal/using_scummvm/the_launcher.rst
@@ -12,23 +12,24 @@ The main ScummVM window is called the Launcher. The Launcher opens whenever you
The games list
===============
-The pane on the left lists the games you have added to ScummVM. This list usually offers some additional information about each game, such as original platform and language. To highlight any game on the list, type the first letter(s) of its title, or click on it.
+The pane on the left is the games list, which lists all the games that have been added to ScummVM. The games list usually offers some additional information about each game, such as original platform and language. To highlight any game on the list, type the first letter(s) of its title, or click on it.
Quick search
=============
-Quick search allows you to filter the list of added games.
-The quick search input is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, select the **X** button next to the input box.
+Quick search allows you to filter the games list.
+The quick search input is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, click **X** next to the input field.
-There are many ways to filter games. For instance, you can type "Monkey Island" to quickly locate all "Monkey Island" games on the list, or you can type "German" if you wish to play a game in German.
+There are many ways to filter games. For instance, you can type "Monkey Island" to quickly locate all "Monkey Island" games on the list, or you can type "German" to find German games.
.. figure:: ../images/Launcher/quicksearch.png
- Using the quick search function.
+ The quick search function.
The buttons
============
+
To the right of the games list there are a number of buttons. Their functions are as follows:
Start
@@ -38,24 +39,23 @@ Launches the highlighted game.
Load
----
-Opens the Load window, from which you can run a previously saved state without having to start the game first.
+Opens the load game window, from which you can run a previously saved state without having to start the game first.
See the :doc:`save_load_games` page.
Add Game
---------
-Opens a file browser to select a folder containing game files.
+Opens a file browser. To add a game, select a folder containing game files.
-See the :doc:`save_load_games` page.
+See the :doc:`add_play_games` page.
Edit Game
----------
+Opens the game settings window. This window also opens whenever a game is added to the games list in the Launcher.
-Opens the game settings window. This window also opens whenever a game is added from the Launcher.
-
-Use this window to configure a game individually by overriding the default global game settings you have set via the **Options** window. You can also change the game's language and original platform, if applicable. For more information, see the :doc:`../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:`../using_scummvm/how_to_settings` page.
Remove Game
@@ -71,7 +71,7 @@ Opens the global settings window. Use this window to define global game settings
About
-----
-Shows credits and miscellaneous information about your version of ScummVM.
+Shows credits and miscellaneous information about ScummVM.
Quit
-------
@@ -84,14 +84,45 @@ The Global Main Menu
The Global Main Menu, or GMM.
-The Global Main Menu (GMM) is available while playing any game by pressing :kbd:`Ctrl` + :kbd:`F5`, or :kbd:`Ctrl` + :kbd:`fn` + :kbd:`F5` on a Mac. It provides the following options:
+The Global Main Menu (GMM) is available while playing any game. Press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac). The GMM provides the following options:
+
+Resume
+--------
+
+Closes the GMM and resumes the game.
+
+Load
+--------
+
+Opens the load game window, to load a saved game state.
+
+Save
+------
+
+Opens the save game window, to save a game state.
+
+Options
+----------
+
+Opens a dialog which provides gameplay options, such as sound volume, subtitle and keymap settings.
+
+
+About
+--------
+
+Displays the ScummVM **About** dialog. This is also available from the Launcher.
-- **Resume:** Closes the GMM and resume the game.
-- **Load:** Loads a saved game state. This is not available for all games.
-- **Save:** Saves a game state. This is not available for all games.
-- **Options:** Provides gameplay options, such as sound volume, subtitle and keymap settings.
-- **About:** Displays the ScummVM About box. This is also available from the The Launcher.
-- **Help:** Displays a list of keyboard shortcuts for the game. This not available for all games.
-- **Return to Launcher:** Quits the game and returns to The Launcher. This is not available for all games.
-- **Quit:** Quits the game and ScummVM, and returns to the Operating System.
+Help
+------
+
+Displays a list of keyboard shortcuts for the game.
+
+Return to Launcher
+---------------------
+
+Quits the game and returns to The Launcher. This is not available for all games.
+
+Quit
+--------
+Quits the game and ScummVM, and returns to the Operating System.
Commit: d7caec5046c932dc3215f7ca12d4b41240af0020
https://github.com/scummvm/scummvm/commit/d7caec5046c932dc3215f7ca12d4b41240af0020
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: renames section
Changed paths:
doc/docportal/index.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 6c33ef6008..7fc86141a2 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -33,7 +33,7 @@
.. toctree::
- :caption: Using ScummVM
+ :caption: How to use ScummVM
:glob:
:hidden:
Commit: 5751f88892cfa1f15c9cf0102f2c2965b5d1592a
https://github.com/scummvm/scummvm/commit/5751f88892cfa1f15c9cf0102f2c2965b5d1592a
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: edits Settings pages
- edits for consistency with style guide
Changed paths:
doc/docportal/settings/accessibility.rst
doc/docportal/settings/audio.rst
doc/docportal/settings/cloud.rst
doc/docportal/settings/engine.rst
doc/docportal/settings/graphics.rst
doc/docportal/settings/keymaps.rst
doc/docportal/settings/lan.rst
doc/docportal/settings/misc.rst
doc/docportal/settings/paths.rst
diff --git a/doc/docportal/settings/accessibility.rst b/doc/docportal/settings/accessibility.rst
index 53edc2e7f6..215e708dcc 100644
--- a/doc/docportal/settings/accessibility.rst
+++ b/doc/docportal/settings/accessibility.rst
@@ -8,7 +8,7 @@ Overview
The Accessibility tab
----------------------
-From the Launcher, go to **Options**, click the red **>** button until the Accessibility tab is visible, then go to **Accessibility**.
+From the Launcher, go to **Options**, click the red **>** until the Accessibility tab is visible, then go to **Accessibility**.
Use this tab to change accessibility settings.
@@ -22,7 +22,7 @@ Use this tab to change accessibility settings.
.. _ttsenabled:
Use Text to Speech
- If ticked, enables text to speech. As the cursor hovers over any text field in the Launcher it is converted to speech. Use the dropdown menu to choose from a variety of voices.
+ 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*
diff --git a/doc/docportal/settings/audio.rst b/doc/docportal/settings/audio.rst
index e9af9ca6a8..0bb29f91a7 100644
--- a/doc/docportal/settings/audio.rst
+++ b/doc/docportal/settings/audio.rst
@@ -31,14 +31,14 @@ Use the audio tab to change the sound output for games.
.. _device:
**Preferred device (global settings)** or **Music device (game-specific settings)**
- Specifies the device ScummVM uses to output audio. When set to <default>, ScummVM will automatically choose the most appropriate option for the played game. If set to an MT-32 or a MIDI device, or if ScummVM chooses one of these automatically, the settings on the MT-32 or MIDI tabs also apply.
+ 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.
+ Chooses which emulator is used by ScummVM when the AdLib emulator is chosen as the **Preferred device**.
*opl_driver*
@@ -78,14 +78,14 @@ Use the volume tab to set the relative volumes for various sounds.
.. _music:
**Music volume**
- Adjusts the volume of the music played back in the game.
+ Adjusts the volume of the music in the game.
*music_volume*
.. _sfx:
**SFX volume**
- Adjusts the volume of the sound effects within the game.
+ Adjusts the volume of the sound effects in the game.
*sfx_volume*
diff --git a/doc/docportal/settings/cloud.rst b/doc/docportal/settings/cloud.rst
index 773d86ec83..b72ecc4f78 100644
--- a/doc/docportal/settings/cloud.rst
+++ b/doc/docportal/settings/cloud.rst
@@ -8,7 +8,7 @@ ScummVM currently supports Dropbox, OneDrive, Google Drive and Box. Connecting S
The Cloud tab
----------------
-From the Launcher, go to **Options**, click the red **>** button until the Cloud tab is visible, then go to **Cloud**.
+From the Launcher, go to **Options**, click the red **>** until the Cloud tab is visible, then go to **Cloud**.
Use the cloud tab to manage connected cloud storage services.
@@ -24,13 +24,13 @@ Active storage
Once a Cloud service has been selected, further options are available:
Sync Now
- Manually sync saved games with the Cloud service. Saved games automatically sync on launch, after saving, and on game load.
+ Manually syncs saved games with the Cloud service. Saved games automatically sync on launch, after saving, and on game load.
Download game files
- Use this option to download game files from your Cloud ScummVM folder.
+ Downloads game files from your Cloud ScummVM folder.
Disconnect
- Use this option to disconnect the Cloud storage account. To change accounts, disconnect and connect again.
+ Disconnects the Cloud storage account. To change accounts, disconnect and connect again.
.. note::
diff --git a/doc/docportal/settings/engine.rst b/doc/docportal/settings/engine.rst
index 75137988fb..8f7d3b1d47 100644
--- a/doc/docportal/settings/engine.rst
+++ b/doc/docportal/settings/engine.rst
@@ -29,28 +29,28 @@ ADL
.. _ntsc:
TV emulation
- Emulate composite output to an NTSC TV.
+ Emulates the composite output to an NTSC TV.
*ntsc*
.. _color:
Color Graphics
- Use color graphics instead of monochrome.
+ Uses color graphics instead of monochrome.
*color*
.. _scan:
Show scanlines
- Darken every other scanline to mimic the look of CRT.
+ Darkens every other scanline to mimic the look of a CRT display.
*scanlines*
.. _mono:
Always use sharp monochrome text
- Do not emulate NTSC artifacts for text
+ Does not emulate NTSC artifacts for text
*monotext*
@@ -59,47 +59,47 @@ Always use sharp monochrome text
.. _AGI:
AGI
-******
+*****
.. _osl:
Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
+ Uses the original save and load dialogs instead of the ScummVM ones
*originalsaveload*
.. _altamiga:
Use an alternative palette
- Use an alternative palette, common for all Amiga games. This was the old behavior
+ Uses an alternative palette, common to all Amiga games.
*altamigapalette*
.. _support:
Mouse support
- Enables mouse support. Allows to use mouse for movement and in game menus.
+ Enables mouse support. Allows use of the mouse for movement and in game menus.
*mousesupport*
.. _herc:
Use Hercules hires font
- Uses Hercules hi-res font, when font file is available.
+ Uses the Hercules hi-resolution font, when the font file is available.
*herculesfont*
.. _cmd:
Pause when entering commands
- Shows a command prompt window and pauses the game (like in SCI) instead of a real-time prompt.
+ Shows a command prompt window and pauses the game, instead of a real-time prompt.
*commandpromptwindow*
.. _2gs:
Add speed menu
- Add game speed menu (similar to PC version)
+ Adds a game speed menu, similar to the PC version.
*apple2gs_speedmenu*
@@ -113,35 +113,35 @@ BLADERUNNER
.. _sitcom:
Sitcom mode
- Game will add laughter after actor's line or narration
+ Adds laughter after actor's line or narration
*sitcom*
.. _shorty:
Shorty mode
- Game will shrink the actors and make their voices high pitched
+ Shrinks the actors and makes their voices high pitched
*shorty*
.. _nodelay:
Frame limiter high performance mode
- This mode may result in high CPU usage! It avoids use of delayMillis() function.
+ Avoids use of delayMillis() function. This mode may result in high CPU usage.
*nodelaymillisfl*
.. _fpsfl:
Max frames per second limit
- This mode targets a maximum of 120 fps. When disabled, the game targets 60 fps
+ Targets a maximum of 120 fps. When disabled, the game targets 60 fps.
*frames_per_secondfl*
.. _stamina:
Disable McCoy's quick stamina drain
- When running, McCoy won't start slowing down as soon as the player stops clicking the mouse
+ When running, McCoy won't start slowing down as soon as the player stops clicking the mouse.
*disable_stamina_drain*
@@ -155,7 +155,7 @@ CGE
.. _blind:
Color Blind Mode
- Enable Color Blind Mode by default
+ Enables Color Blind Mode by default
*enable_color_blind*
@@ -167,14 +167,14 @@ CINE
*********
Use original save/load screen
- Use the original save/load screens instead of the ScummVM one
+ Uses the original save/load screens instead of the ScummVM one
*originalsaveload*
.. _transparentdialog:
Use transparent dialog boxes in 16 color scenes
- Use transparent dialog boxes in 16 color scenes even if the original game version did not support them
+ Uses transparent dialog boxes in 16 color scenes even if the original game version did not support them.
*transparentdialogboxes*
@@ -186,7 +186,7 @@ DRASCULA
*************
Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
+ Uses the original save and load screens instead of the ScummVM ones
*originalsaveload*
@@ -198,14 +198,14 @@ DREAMWEB
**********
Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
+ Uses the original save and load screens instead of the ScummVM ones.
*originalsaveload*
.. _bright:
Use bright palette mode
- Display graphics using the game's bright palette
+ Displays graphics using the game's bright palette.
*bright_palette*
@@ -219,7 +219,7 @@ HDB
.. _hyper:
Enable cheat mode
- Debug info and level selection becomes available
+ Enables debug info and level selection.
*hypercheat*
@@ -233,7 +233,7 @@ HOPKINS
.. _gore:
Gore Mode
- Enable Gore Mode when available
+ Enables Gore Mode when available.
*enable_gore*
@@ -247,54 +247,54 @@ KYRA
.. _studio:
Enable studio audience
- Studio audience adds an applause and cheering sounds whenever Malcolm makes a joke
+ Studio audience adds an applause and cheering sounds whenever Malcolm makes a joke.
*studio_audience*
.. _skip:
Skip support
- This option allows the user to skip text and cutscenes.
+ Allows the user to skip text and cutscenes.
*skip_support*
.. _helium:
Enable helium mode
- Helium mode makes people sound like they've inhaled Helium.
+ Makes people sound like they've inhaled Helium.
*helium_mode*
.. _smooth:
Enable smooth scrolling when walking
- When enabled, this option makes scrolling smoother when changing from one screen to another.
+ Makes scrolling smoother when changing from one screen to another.
*smooth_scrolling*
.. _floating:
Enable floating cursors
- When enabled, this option changes the cursor when it floats to the edge of the screen to a directional arrow. The player can then click to walk towards that direction.
+ Changes the cursor when it floats to the edge of the screen to a directional arrow. The player can then click to walk towards that direction.
*floating_cursors*
Suggest save names
- When enabled, this option will fill in an autogenerated savegame escription into the input prompt.
+ Fills in an autogenerated save game description into the input prompt.
*auto_savenames*
.. _hp:
HP bar graphs
- Enable hit point bar graphs
+ Enables hit point bar graphs.
*hpbargraphs*
.. _btswap:
Fight Button L/R Swap
- Left button to attack, right button to pick up items
+ Swaps the buttons so that the left button attacks, and the right button picks up items.
*mousebtswap*
@@ -309,7 +309,7 @@ LURE
.. _ttsnarrator:
TTS Narrator
- Use text-to-speech to read the descriptions, if test-to-speech is available)
+ Uses text-to-speech to read the descriptions, if text-to-speech is available.
*tts_narrator*
@@ -323,35 +323,35 @@ MADS
.. _easy:
Easy mouse interface
- Shows object names when hovering the mouse over them
+ Shows object names when the mouse pointer is held over the object.
*EasyMouse*
.. _objanimated:
Animated inventory items
- Animated inventory items
+ Animates the inventory items.
*InvObjectsAnimated*
.. _windowanimated:
Animated game interface
- Animated game interface
+ Animates the game interface.
*TextWindowAnimated*
.. _naughty:
Naughty game mode
- Naughty game mode
+ Enables naughty game mode.
*NaughtyMode*
.. _gdither:
Graphics dithering
- Graphics dithering
+ Enables graphics dithering.
*GraphicsDithering*
@@ -363,21 +363,21 @@ NEVERHOOD
************
Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
+ Uses the original save and load screens instead of the ScummVM ones
*originalsaveload*
.. _skiphall:
Skip the Hall of Records storyboard scenes
- Allows the player to skip past the Hall of Records storyboard scenes
+ Allows the player to skip past the Hall of Records storyboard scenes.
*skiphallofrecordsscenes*
.. _scale:
Scale the making of videos to full screen
- Scale the making of videos, so that they use the whole screen
+ Scales the making-of videos, so that they use the whole screen.
*scalemakingofvideos*
@@ -403,90 +403,90 @@ SCI
.. _dither:
Skip EGA dithering pass (full color backgrounds)
- Skip dithering pass in EGA games, graphics are shown with full colors
+ Skips dithering pass in EGA games, graphics are shown with full colors
*disable_dithering*
.. _hires:
Enable high resolution graphics
- Enable high resolution graphics/content
+ Enables high resolution graphics and content.
*enable_high_resolution_graphics*
.. _blackline:
Enable black-lined video
- Draw black lines over videos to increase their apparent sharpness
+ Draws black lines over videos to increase their apparent sharpness.
*enable_black_lined_video*
.. _hq:
Use high-quality video scaling
- Use linear interpolation when upscaling videos, where possible
+ Uses linear interpolation when upscaling videos, where possible.
*enable_hq_video*
.. _larry:
Use high-quality "LarryScale" cel scaling
- Use special cartoon scaler for drawing character sprites
+ Uses special cartoon scaler for drawing character sprites.
*enable_larryscale*
.. _dsfx:
Prefer digital sound effects
- Prefer digital (sampled) sound effects instead of synthesized ones
+ Prefers digital (sampled) sound effects instead of synthesized ones.
*prefer_digitalsfx*
Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
+ Uses the original save/load screens instead of the ScummVM ones.
*originalsaveload*
.. _fb01:
Use IMF/Yamaha FB-01 for MIDI output
- Use an IBM Music Feature card or a Yamaha FB-01 FM synth module for MIDI output
+ Uses an IBM Music Feature card or a Yamaha FB-01 FM synth module for MIDI output.
*native_fb01*
.. _cd:
Use CD audio
- Use CD audio instead of in-game audio, if available
+ Uses CD audio instead of in-game audio, if available.
*use_cdaudio*
.. _wincursors:
Use Windows cursors
- Use the Windows cursors (smaller and monochrome) instead of the DOS ones
+ Uses the Windows cursors (smaller and monochrome) instead of the DOS cursors.
*windows_cursors*
.. _silver:
Use silver cursors
- Use the alternate set of silver cursors instead of the normal golden ones
+ Uses the alternate set of silver cursors instead of the normal golden cursors.
*silver_cursors*
.. _upscale:
Upscale videos
- Upscale videos to double their size
+ Upscales videos to double their size
*enable_video_upscale*
.. _censor:
Enable content censoring
- Enable the game's built-in optional content censoring"),
-
+ Enables the game's built-in optional content censoring.
+
*enable_censoring*
,,,,,,,,,,
@@ -499,14 +499,14 @@ SCUMM
.. _labels:
Show Object Line
- Show the names of objects at the bottom of the screen
+ Show the names of objects at the bottom of the screen.
*object_labels*
.. _classic:
Use NES Classic Palette
- Use a more neutral color palette that closely emulates the NES Classic
+ Uses a more neutral color palette that closely emulates the NES Classic
*mm_nes_classic_palette*
@@ -518,47 +518,47 @@ SHERLOCK
*********
Use original load/save screens
- Use the original save/load screens instead of the ScummVM ones"),
+ Uses the original save and load screens instead of the ScummVM ones"),
*originalsaveload*
.. _fade:
Pixellated scene transitions
- When changing scenes, a randomized pixel transition is done
+ Enables randomized pixel transitions between scenes.
*fade_style*
.. _help:
Don't show hotspots when moving mouse
- Only show hotspot names after you actually click on a hotspot or action button
+ Only shows hotspot names after you click on a hotspot or action button.
*help_style*
.. _portraits:
Show character portraits
- Show portraits for the characters when conversing
+ Shows portraits of the characters when the characters converse.
*portraits_on*
.. _style:
Slide dialogs into view
- Slide UI dialogs into view, rather than simply showing them immediately
+ Slides UI dialogs into view.
*window_style*
.. _transparentwindows:
Transparent windows
- Show windows with a partially transparent background
+ Shows windows with a partially transparent background.
*transparent_windows*
TTS Narrator
- Use text-to-speech to read the descriptions, if text-to-speech is available.
+ Uses text-to-speech to read the descriptions, if text-to-speech is available.
*tts_narrator*
@@ -572,7 +572,7 @@ SKY
.. _altintro:
Floppy intro
- Use the floppy version's intro (CD version only)
+ Uses the floppy version's intro (CD version only)
*alt_intro*
@@ -586,7 +586,7 @@ SUPERNOVA
.. _improved:
Improved mode
- Removes some repetitive actions, adds possibility to change verbs by keyboard.
+ Removes some repetitive actions, and adds the possibility to change verbs by keyboard.
*improved*
@@ -598,7 +598,7 @@ TOLTECS
**************
Use original save/load screens
- Use the original save/load screens instead of the ScummVM ones
+ Uses the original save and load screens instead of the ScummVM ones
*originalsaveload*
@@ -612,14 +612,14 @@ WINTERMUTE
.. _fps:
Show FPS-counter
- Show the current number of frames per second in the upper left corner
+ Shows the current number of frames per second in the upper left corner.
*show_fps*
.. _bilinear:
Sprite bilinear filtering (SLOW)
- Apply bilinear filtering to individual sprites
+ Applies bilinear filtering to individual sprites.
*bilinear_filtering*
@@ -633,14 +633,14 @@ XEEN
.. _cost:
Show item costs in standard inventory mode
- Shows item costs in standard inventory mode, allowing the value of items to be compared
+ Shows item costs in standard inventory mode, which allows the value of items to be compared.
*ShowItemCosts*
.. _durable:
More durable armor
- Armor won't break until character is at -80HP, rather than merely -10HP
+ Armor won't break until character is at -80HP, rather than -10HP.
*DurableArmor*
diff --git a/doc/docportal/settings/graphics.rst b/doc/docportal/settings/graphics.rst
index c1ca7ff82b..a2141ddc99 100644
--- a/doc/docportal/settings/graphics.rst
+++ b/doc/docportal/settings/graphics.rst
@@ -49,7 +49,7 @@ Aspect ratio correction
.. _fullscreen:
Fullscreen mode
- Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt + F5` while in a game.
+ Switches between playing games in a window, or playing them in fullscreen mode. Switch between the two by using :kbd:`Alt+F5` while in a game.
*fullscreen*
diff --git a/doc/docportal/settings/keymaps.rst b/doc/docportal/settings/keymaps.rst
index 348720bc14..536a388c39 100644
--- a/doc/docportal/settings/keymaps.rst
+++ b/doc/docportal/settings/keymaps.rst
@@ -19,9 +19,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 dropdown arrow for further options.
+Click on the red box next to the desired action to add an additional key or button. Click on the dropdown expander for further options.
-If all the mapped keys are not visible, hover over the red box to see all the mapped keys.
+If all the mapped keys are not visible, hold the pointer over the red box to see all the mapped keys.
Reset
Resets all keymaps to default.
diff --git a/doc/docportal/settings/lan.rst b/doc/docportal/settings/lan.rst
index a074d4c502..83d39a6c01 100644
--- a/doc/docportal/settings/lan.rst
+++ b/doc/docportal/settings/lan.rst
@@ -5,12 +5,12 @@ LAN
Overview
============
-ScummVM can run local network web server which allows browser-based file management, including uploading and downloading game files.
+ScummVM can run a local network web server which allows browser-based file management, including uploading and downloading game files.
The LAN tab
------------
-From the Launcher, go to **Options**, click the red **>** button until the LAN tab is visible, then go to **LAN**.
+From the Launcher, go to **Options**, click the red **>** until the LAN tab is visible, then go to **LAN**.
Use the LAN tab to control the web server.
@@ -38,7 +38,7 @@ Server's port
.. _rootpath:
/root/ Path
- Allows you to specify the root path. Any sub-directories will be accessible.
+ Specifies the root path of the server. Any sub-directories will be accessible.
*rootpath*
diff --git a/doc/docportal/settings/misc.rst b/doc/docportal/settings/misc.rst
index 2f8e49413a..487c02c2ee 100644
--- a/doc/docportal/settings/misc.rst
+++ b/doc/docportal/settings/misc.rst
@@ -8,7 +8,7 @@ Overview
The Miscellaneous tab
--------------------------
-From the Launcher, go to **Options**, click the red **>** button, and then go to **Misc**.
+From the Launcher, go to **Options**, click the red **>**, and then go to **Misc**.
The Misc tab contains options that don’t belong on any of the other tabs.
@@ -34,17 +34,17 @@ GUI Renderer
.. _autosave:
Autosave
- Adjusts the time period that ScummVM waits between autosaves. The default setting is 5 minutes. This is not available for all games.
+ Adjusts the time period between autosaves. The default setting is 5 minutes. This is not available for all games.
*autosave_period*
GUI Language
- Choose the language of the ScummVM Launcher
+ Chooses the language of the ScummVM Launcher.
*gui_language*
Switch the ScummVM GUI language to the game language
- If ticked, the Launcher language will be the same as the game language.
+ If ticked, the Launcher language is the same as the game language.
*gui_use_game_language*
diff --git a/doc/docportal/settings/paths.rst b/doc/docportal/settings/paths.rst
index 6b9f200f59..5075134fed 100644
--- a/doc/docportal/settings/paths.rst
+++ b/doc/docportal/settings/paths.rst
@@ -19,21 +19,21 @@ Use the paths tab to tell ScummVM where to look for files.
.. _savepath:
Save Path
- The folder in which ScummVM will store saved games. If this is not set, saved games will generally be stored in the current directory, although there are exceptions to this. For more information, see the :doc:`../using_scummvm/save_load_games` page.
+ 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.
*savepath*
.. _themepath:
Theme Path
- The folder that additional themes for the ScummVM Launcher are stored in.
+ The path to the folder in which ScummVM stores additional themes.
*themepath*
.. _extra:
Extra Path
- This is the folder that ScummVM will look in for various extra files. These could include one or more of:
+ The path to the folder in which ScummVM will look for various extra files. These may include:
* Additional datafiles required for certain games
* Soundfonts
Commit: 3ca78637b8ac25baff54dbcbb8290058fed85674
https://github.com/scummvm/scummvm/commit/3ca78637b8ac25baff54dbcbb8290058fed85674
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: fixes ref on config file page
Changed paths:
doc/docportal/advanced_options/configuration_file.rst
doc/docportal/using_scummvm/add_play_games.rst
diff --git a/doc/docportal/advanced_options/configuration_file.rst b/doc/docportal/advanced_options/configuration_file.rst
index 9358873403..c0c33d7bc5 100755
--- a/doc/docportal/advanced_options/configuration_file.rst
+++ b/doc/docportal/advanced_options/configuration_file.rst
@@ -418,7 +418,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 <cd>`",boolean,true,
+ ":ref:`use_cdaudio <cdaudio>`",boolean,true,
versioninfo,string,,
":ref:`window_style <style>`",boolean,true,
":ref:`windows_cursors <wincursors>`",boolean,false,
diff --git a/doc/docportal/using_scummvm/add_play_games.rst b/doc/docportal/using_scummvm/add_play_games.rst
index 118d4bb194..fd0e0aa1cc 100644
--- a/doc/docportal/using_scummvm/add_play_games.rst
+++ b/doc/docportal/using_scummvm/add_play_games.rst
@@ -50,7 +50,7 @@ ScummVM needs access to all the data files, so it will not be able to run direct
- Where there are duplicate, identical files (same name, same file size) on more than one disc, only one copy of the file is required.
- Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.
-.. _cd:
+.. _cdaudio:
CD audio
**********
Commit: 9eb5c0f67c440d5cf54dec8bf021febae3bffdd0
https://github.com/scummvm/scummvm/commit/9eb5c0f67c440d5cf54dec8bf021febae3bffdd0
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds port page template
Changed paths:
A doc/docportal/port_template.rst
diff --git a/doc/docportal/port_template.rst b/doc/docportal/port_template.rst
new file mode 100644
index 0000000000..68bf0c2935
--- /dev/null
+++ b/doc/docportal/port_template.rst
@@ -0,0 +1,76 @@
+=============================
+Title
+=============================
+
+Install ScummVM
+===================
+
+Prerequisites
+****************
+
+- Bullet points listing all prerequisites.
+
+Download and install ScummVM
+*********************************
+
+Detailed install instructions.
+
+Transfer game files
+=======================
+
+Detailed instructions for getting game files onto the device.
+
+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.
+
+Default control mapping
+*************************
+
+Use a CSV-list table. Set widths to equal 100%. Choose how many header rows you have.
+
+It's easiest to use Google Sheets or Excel to export a spreadsheet as a CSV file.
+
+.. csv-table::
+ :widths: 30 30 40
+ :header-rows: 1
+
+ Button, Action, Description
+ Left stick, Move pointer,
+
+
+
+[Other control information] - Optional
+*****************************************
+
+Paths
+=======
+
+Saved games
+*******************
+
+``path/to/savedgames``
+
+Configuration file
+**************************
+``path/to/configurationfile``
+
+
+Settings
+==========
+
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+[Applicable tab] e.g. Audio
+*******************************
+
+
+
+
+Known issues
+==============
+
+Anything specific to this port that is a known issue.
\ No newline at end of file
Commit: 7f0ca4d2c394a569dd3e2efc68cd67d4c15802c4
https://github.com/scummvm/scummvm/commit/7f0ca4d2c394a569dd3e2efc68cd67d4c15802c4
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: rearranges the project
- moves android/ios back to getting started section
- moves other platforms further down sidebar navigation
- renames advanced options to advanced topics
- moves cloud/lan pages into using scummvm section
- changes index page to be only a landing page; some info moved out
- updates refs/links for new structure
Changed paths:
A doc/docportal/advanced_topics/command_line.rst
A doc/docportal/advanced_topics/configuration_file.rst
A doc/docportal/advanced_topics/understand_audio.rst
A doc/docportal/advanced_topics/understand_graphics.rst
A doc/docportal/getting_started/android.rst
A doc/docportal/getting_started/ios.rst
A doc/docportal/using_scummvm/connect_cloud.rst
A doc/docportal/using_scummvm/local_webserver.rst
R doc/docportal/advanced_options/command_line.rst
R doc/docportal/advanced_options/configuration_file.rst
R doc/docportal/games/copy_protection.rst
R doc/docportal/guides/connect_cloud.rst
R doc/docportal/guides/local_webserver.rst
R doc/docportal/guides/understand_audio.rst
R doc/docportal/guides/understand_graphics.rst
R doc/docportal/phones_tablets/android.rst
R doc/docportal/phones_tablets/ios.rst
doc/docportal/consoles/nintendo_3ds.rst
doc/docportal/consoles/nintendo_switch.rst
doc/docportal/consoles/playstation_3.rst
doc/docportal/consoles/ps_vita.rst
doc/docportal/getting_started/mac_linux_windows.rst
doc/docportal/help/faq.rst
doc/docportal/index.rst
doc/docportal/other_platforms/amigaos_4.rst
doc/docportal/settings/audio.rst
doc/docportal/using_scummvm/add_play_games.rst
doc/docportal/using_scummvm/how_to_settings.rst
doc/docportal/using_scummvm/keyboard_shortcuts.rst
doc/docportal/using_scummvm/save_load_games.rst
diff --git a/doc/docportal/advanced_options/command_line.rst b/doc/docportal/advanced_topics/command_line.rst
similarity index 100%
rename from doc/docportal/advanced_options/command_line.rst
rename to doc/docportal/advanced_topics/command_line.rst
diff --git a/doc/docportal/advanced_options/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
similarity index 100%
rename from doc/docportal/advanced_options/configuration_file.rst
rename to doc/docportal/advanced_topics/configuration_file.rst
diff --git a/doc/docportal/guides/understand_audio.rst b/doc/docportal/advanced_topics/understand_audio.rst
similarity index 98%
rename from doc/docportal/guides/understand_audio.rst
rename to doc/docportal/advanced_topics/understand_audio.rst
index 13d3bfe9a5..2ba5c9fbc7 100644
--- a/doc/docportal/guides/understand_audio.rst
+++ b/doc/docportal/advanced_topics/understand_audio.rst
@@ -211,7 +211,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_options/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>`. 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.
diff --git a/doc/docportal/guides/understand_graphics.rst b/doc/docportal/advanced_topics/understand_graphics.rst
similarity index 100%
rename from doc/docportal/guides/understand_graphics.rst
rename to doc/docportal/advanced_topics/understand_graphics.rst
diff --git a/doc/docportal/consoles/nintendo_3ds.rst b/doc/docportal/consoles/nintendo_3ds.rst
index 7621f7a25f..2aca3633de 100644
--- a/doc/docportal/consoles/nintendo_3ds.rst
+++ b/doc/docportal/consoles/nintendo_3ds.rst
@@ -35,7 +35,7 @@ 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:`../guides/connect_cloud`.
+ScummVM for the Nintendo 3DS also has Cloud functionality. See :doc:`../using_scummvm/connect_cloud`.
See :doc:`../using_scummvm/add_play_games` for more information about how to add games to ScummVM.
diff --git a/doc/docportal/consoles/nintendo_switch.rst b/doc/docportal/consoles/nintendo_switch.rst
index ecefe45d29..f7b262176a 100644
--- a/doc/docportal/consoles/nintendo_switch.rst
+++ b/doc/docportal/consoles/nintendo_switch.rst
@@ -26,7 +26,7 @@ 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 <../guides/connect_cloud>`.
+ScummVM on the Nintendo switch supports :doc:`Cloud functionality <../using_scummvm/connect_cloud>`.
For more information on how to add and play games, see the :doc:`../using_scummvm/add_play_games` page.
diff --git a/doc/docportal/consoles/playstation_3.rst b/doc/docportal/consoles/playstation_3.rst
index b1864fbb3e..e142ec99e6 100644
--- a/doc/docportal/consoles/playstation_3.rst
+++ b/doc/docportal/consoles/playstation_3.rst
@@ -27,7 +27,7 @@ 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 <../guides/connect_cloud>`.
+To copy game files to the hard drive, use the USB drive, or use ScummVM's :doc:`Cloud functionality <../using_scummvm/connect_cloud>`.
See :doc:`../using_scummvm/add_play_games` for more information.
diff --git a/doc/docportal/consoles/ps_vita.rst b/doc/docportal/consoles/ps_vita.rst
index 7477628f99..fb1dc1794c 100644
--- a/doc/docportal/consoles/ps_vita.rst
+++ b/doc/docportal/consoles/ps_vita.rst
@@ -35,7 +35,7 @@ If you're using SD2Vita:
Folders containing game files can be copied into any folder.
-ScummVM on the PS Vita supports :doc:`Cloud functionality <../guides/connect_cloud>`.
+ScummVM on the PS Vita supports :doc:`Cloud functionality <../using_scummvm/connect_cloud>`.
For more information on how to add and play games, see the :doc:`../using_scummvm/add_play_games` page.
@@ -142,7 +142,7 @@ The touch control scheme can be switched in the global settings. Go to **Options
- The rear touch pad is enabled.
-The front touchscreen uses the direct mode by default, but this can be changed by editing the :doc:`configuration file <../advanced_options/configuration_file>` with the following keyword:
+The front touchscreen uses the direct mode by default, but this can be changed by editing the :doc:`configuration file <../advanced_topics/configuration_file>` with the following keyword:
.. _frontpanel:
diff --git a/doc/docportal/games/copy_protection.rst b/doc/docportal/games/copy_protection.rst
deleted file mode 100644
index 408e755d11..0000000000
--- a/doc/docportal/games/copy_protection.rst
+++ /dev/null
@@ -1,26 +0,0 @@
-
-====================
-Copy protection
-====================
-
-The ScummVM team does not condone piracy. However, there are cases where the game companies themselves bundled 'cracked' executables with their games. In these cases the data files still contain the copy protection scripts, but the interpreter bypasses them - similar to what an illegally cracked version might do, only that here the producer of the game did it. There is no way for us to tell the difference between legitimate and pirated data files, so for the games where we know that a cracked version of the original interpreter was sold at some point, ScummVM has to bypass the copy protection.
-
-In some cases ScummVM still shows the copy protection screen. Try entering any answer; chances are that it will work.
-
-ScummVM skips copy protection in the following games:
-
-- Beneath a Steel Sky. Bypassed with kind permission from Revolution Software.
-- Dreamweb.
-- Inherit the Earth: Quest for the Orb (Floppy version). Bypassed with kind permission from Wyrmkeep Entertainment, since it was bypassed in all CD releases of the game.
-- Loom (EGA DOS)
-- Lure of the Temptress
-- Maniac Mansion
-- Might and Magic: World of Xeen
-- Monkey Island 2: LeChuck's Revenge
-- Rex Nebular and The Cosmic Gender Bender
-- Simon the Sorcerer 1 (Floppy version)
-- Simon the Sorcerer 2 (Floppy version). Bypassed with kind permission from Adventure Soft, since it was bypassed in all CD releases of the game.
-- The Secret of Monkey Island (VGA)
-- Voyeur
-- Waxworks
-- Zak McKracken and the Alien Mindbenders
diff --git a/doc/docportal/phones_tablets/android.rst b/doc/docportal/getting_started/android.rst
similarity index 100%
rename from doc/docportal/phones_tablets/android.rst
rename to doc/docportal/getting_started/android.rst
diff --git a/doc/docportal/phones_tablets/ios.rst b/doc/docportal/getting_started/ios.rst
similarity index 100%
rename from doc/docportal/phones_tablets/ios.rst
rename to doc/docportal/getting_started/ios.rst
diff --git a/doc/docportal/getting_started/mac_linux_windows.rst b/doc/docportal/getting_started/mac_linux_windows.rst
index 13906831a0..1a20ab2f3d 100644
--- a/doc/docportal/getting_started/mac_linux_windows.rst
+++ b/doc/docportal/getting_started/mac_linux_windows.rst
@@ -61,7 +61,7 @@ To run ScummVM, enter the following on the command line:
The Flatpak version of ScummVM is sandboxed, meaning that any games will need to be copied into the Documents folders to be accessible by ScummVM.
- :doc:`Command line arguments <../advanced_options/command_line>` can still be passed by adding them after the Flatpak run command.
+ :doc:`Command line arguments <../advanced_topics/command_line>` can still be passed by adding them after the Flatpak run command.
Some distributions have the option to install Flatpaks via the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog will appear; choose the **Open with Software Install (default)** option, and click **OK**. You will then be guided through the install process.
diff --git a/doc/docportal/help/faq.rst b/doc/docportal/help/faq.rst
index 5591bb771c..3a0b21aaee 100644
--- a/doc/docportal/help/faq.rst
+++ b/doc/docportal/help/faq.rst
@@ -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:`../guides/connect_cloud` and :doc:`../guides/local_webserver`.
+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`.
On what platform(s) will ScummVM run?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -84,7 +84,7 @@ ScummVM
ScummVM crashes, but the console window disappears too quickly to see the error message.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If you are using a computer, you can run ScummVM from the :doc:`command line <../advanced_options/command_line>`. By doing this, error messages remain visible even after ScummVM exits.
+If you are using a computer, you can run ScummVM from the :doc:`command line <../advanced_topics/command_line>`. By doing this, error messages remain visible even after ScummVM exits.
You can also find error messages in the ScummVM log file. See :ref:`logfile`.
@@ -139,21 +139,21 @@ The audio is really glitchy. What can I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There may be a few things at play here.
-- Try to increase the :ref:`audio buffer size <buffer>` in the :doc:`configuration file <../advanced_options/configuration_file>`.
+- Try to increase the :ref:`audio buffer size <buffer>` in the :doc:`configuration file <../advanced_topics/configuration_file>`.
- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU may not have the processing power to keep up. In this case, you may have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, as long as your platform supports it.
- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU may not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
- If you are using the :ref:`adlib` emulator, try selecting the least CPU-intensive option; MAME.
I have a CD version of a game, how do I get the sound to work without running the game from the CD?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See using :ref:`cd`.
+See using :ref:`cdaudio`.
Graphics
***********
There are so many options... How do I know what to pick?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Start by checking out our :doc:`../guides/understand_graphics` page. It has comprehensive information on how it all works.
+Start by checking out our :doc:`../advanced_topics/understand_graphics` page. It has comprehensive information on how it all works.
Can I just make the image larger (for example, 1 pixel becomes 4 pixels) without any smoothing or antialiasing?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 7fc86141a2..1c28c7d20e 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -5,31 +5,8 @@
:hidden:
getting_started/mac_linux_windows
-
-
-.. toctree::
- :glob:
- :caption: Phones and tablets
- :maxdepth: 2
- :hidden:
-
- phones_tablets/*
-
-.. toctree::
- :glob:
- :caption: Consoles
- :maxdepth: 2
- :hidden:
-
- consoles/*
-
-.. toctree::
- :glob:
- :caption: Other platforms
- :maxdepth: 2
- :hidden:
-
- other_platforms/*
+ getting_started/android
+ getting_started/ios
.. toctree::
@@ -40,9 +17,12 @@
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
+
.. toctree::
:caption: Settings
:glob:
@@ -60,29 +40,33 @@
settings/lan
settings/accessibility
+
.. toctree::
- :caption: Guides
+ :caption: Advanced topics
:glob:
:hidden:
- guides/*
+ advanced_topics/command_line
+ advanced_topics/configuration_file
+ advanced_topics/understand_audio
+ advanced_topics/understand_graphics
+
.. toctree::
- :caption: Games
:glob:
+ :caption: Consoles
+ :maxdepth: 2
:hidden:
- games/copy_protection
-
+ consoles/*
.. toctree::
- :caption: Advanced options
:glob:
+ :caption: Other platforms
+ :maxdepth: 2
:hidden:
- advanced_options/command_line
- advanced_options/configuration_file
-
+ other_platforms/*
.. toctree::
:caption: Help
@@ -100,12 +84,6 @@
release_notes/*
-.. toctree::
- :caption: Contribute to documentation
- :glob:
- :hidden:
-
- contribute/*
====================
Welcome to ScummVM!
@@ -122,25 +100,23 @@ While ScummVM was originally designed to run LucasArts' SCUMM games, over time s
First steps
================
-We have guides available to show you how to get ScummVM up and running:
+We have guides available to show you :column: mb-4 how to get ScummVM up and running:
.. panels::
:container: container-fluid text-center mb-4
-
+ :column: col-lg-12 mb-4
Getting started
^^^^^^^^^^^^
:doc:`getting_started/mac_linux_windows`
- ---
- Phones and Tablets
- ^^^^^^^^^^^^^^^^^^^
- :doc:`phones_tablets/ios`
-
- :doc:`phones_tablets/android`
+ :doc:`getting_started/ios`
+
+ :doc:`getting_started/android`
---
+ :column: col-lg-6
Consoles
^^^^^^^^^^^^^^^^^^^
@@ -155,11 +131,16 @@ We have guides available to show you how to get ScummVM up and running:
:doc:`consoles/sega_dreamcast`
---
+ :column: col-lg-6
Other platforms
^^^^^^^^^^^^^^^
:doc:`other_platforms/amigaos_4`
+ :doc:`other_platforms/risc_os`
+
+ :doc:`other_platforms/atari`
+
@@ -186,59 +167,49 @@ So you have ScummVM installed, but now you need to know how to add and play some
:doc:`using_scummvm/keyboard_shortcuts`
---
- :column: col-lg-12
+
+ Use the features
+ ^^^^^^^^^^^^^^^^^^
+ :doc:`using_scummvm/connect_cloud`
+
+ :doc:`using_scummvm/local_webserver`
+
+ ---
Change settings
^^^^^^^^^^^^^^^^^^^^^
:doc:`using_scummvm/how_to_settings`
-The games!
-============
-One of the most commonly asked questions we get is, "Where do I get the games??". If you still have your old floppy discs and CDs lying around (and have a way to read them!), then you can use the game files from these original discs. For a list of which files you need for each game, check out the `Datafiles page <https://wiki.scummvm.org/index.php?title=Datafiles>`__ on our wiki.
-If you haven't had a floppy disc or even a CD in your possession for a while, we have a `wiki page <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ dedicated to helping you find some games to play. As a quick summary, there are a few freeware games available for download on our website's `Downloads page <scummvm.org/downloads>`_, or there are digital distributors such as `GOG.com <gog.com>`_ and `Steam <https://store.steampowered.com/>`_.
-Make sure you check out the `compatibility list <https://www.scummvm.org/compatibility/>`_ on our website and the `Supported Games page <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ on our wiki before you buy a game, to ensure it can run with ScummVM.
+Advanced topics
+============================
+For our more experienced users, ScummVM features a command line interface, as well as the ability to edit settings directly in a configuration file.
-Definitive guides
-=====================
+In this section, we also take a deep dive into understanding the graphics and audio settings.
-In our Guides section, we do some deep dives into ScummVM features.
.. panels::
:container: text-center mb-4
- Settings
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- :doc:`guides/understand_audio`
-
- :doc:`guides/understand_graphics`
+ Advanced features
+ ^^^^^^^^^^^^^^^^^^^^
+ :doc:`advanced_topics/configuration_file`
+
+ :doc:`advanced_topics/command_line`
---
+
+ Understand the settings
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- How to:
- ^^^^^^^^^^^^^^
- :doc:`guides/local_webserver`
-
- :doc:`guides/connect_cloud`
-
-
-Advanced options
-============================
-
-For our more experienced users, ScummVM has a command line interface, as well as the ability to edit settings directly in a configuration file.
-
+ :doc:`advanced_topics/understand_audio`
-.. panels::
- :container: text-center mb-4
- :column: col-lg-12
+ :doc:`advanced_topics/understand_graphics`
- :doc:`advanced_options/configuration_file`
-
- :doc:`advanced_options/command_line`
Getting help
diff --git a/doc/docportal/other_platforms/amigaos_4.rst b/doc/docportal/other_platforms/amigaos_4.rst
index 3827c34c82..8f6349be84 100644
--- a/doc/docportal/other_platforms/amigaos_4.rst
+++ b/doc/docportal/other_platforms/amigaos_4.rst
@@ -33,7 +33,7 @@ See :doc:`../using_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:`../guides/connect_cloud` and :doc:`../guides/local_webserver`.
+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`.
Controls
=================
diff --git a/doc/docportal/settings/audio.rst b/doc/docportal/settings/audio.rst
index 0bb29f91a7..247064220b 100644
--- a/doc/docportal/settings/audio.rst
+++ b/doc/docportal/settings/audio.rst
@@ -7,7 +7,7 @@ Audio settings are found in four tabs:
:ref:`Audio <audiotab>` | :ref:`Volume <volumetab>` | :ref:`MIDI <miditab>` | :ref:`MT-32 <mt32tab>`
-For a comprehensive look at how to use ScummVM's extensive audio settings, check out our :doc:`../guides/understand_audio` guide.
+For a comprehensive look at how to use ScummVM's extensive audio settings, check out our :doc:`../advanced_topics/understand_audio` guide.
.. _audiotab:
diff --git a/doc/docportal/using_scummvm/add_play_games.rst b/doc/docportal/using_scummvm/add_play_games.rst
index fd0e0aa1cc..8d2f5b4d45 100644
--- a/doc/docportal/using_scummvm/add_play_games.rst
+++ b/doc/docportal/using_scummvm/add_play_games.rst
@@ -3,6 +3,24 @@
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.
+
+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 <gog.com>`_ and `Steam <https://store.steampowered.com/>`_.
+
+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.
+
+
+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.
+
+In some cases ScummVM still shows the copy protection screen. Try entering any answer; chances are that it will work.
+
+
The game files
------------------------
@@ -10,7 +28,7 @@ ScummVM needs access to the data files for each game. A comprehensive list of re
.. note::
- For ease of use, you can create a dedicated games directory into which subdirectories containing game files can be copied. The resulting directory structure will look somewhat like this::
+ For ease of use, you can create a dedicated games folder into which folder containing game files can be copied. The resulting directory structure will look somewhat like this::
ScummVM Games
|-- Day of the Tentacle
@@ -37,9 +55,9 @@ For games downloaded from digital distributors such as `GOG.com <gog.com>`__, `
.. tip::
- A great way to share game files and automatically back up and sync your saved game states between devices is to connect a Cloud storage service to ScummVM. For detailed instructions see the :doc:`../guides/connect_cloud` guide.
+ A great way to share game files and automatically back up and sync your saved game states between devices is to connect a Cloud storage service to ScummVM. 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:`../guides/local_webserver` guide. This is a good option if you do not wish to connect a Cloud service.
+ 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.
Multi-disc games
diff --git a/doc/docportal/guides/connect_cloud.rst b/doc/docportal/using_scummvm/connect_cloud.rst
similarity index 100%
rename from doc/docportal/guides/connect_cloud.rst
rename to doc/docportal/using_scummvm/connect_cloud.rst
diff --git a/doc/docportal/using_scummvm/how_to_settings.rst b/doc/docportal/using_scummvm/how_to_settings.rst
index ae34ecde48..d037f0a2b4 100644
--- a/doc/docportal/using_scummvm/how_to_settings.rst
+++ b/doc/docportal/using_scummvm/how_to_settings.rst
@@ -17,4 +17,4 @@ Not all settings are available for all games; for example, where there is no MID
In the configuration file
==========================
-See the :doc:`configuration file <../advanced_options/configuration_file>` page for more information on how to do this. Configuration keywords are listed in the Settings pages below the description of each setting, in italics.
\ No newline at end of file
+See the :doc:`configuration file <../advanced_topics/configuration_file>` page for more information on how to do this. Configuration keywords are listed in the Settings pages below the description of each setting, in italics.
\ No newline at end of file
diff --git a/doc/docportal/using_scummvm/keyboard_shortcuts.rst b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
index dc55575c92..76f17f3de9 100755
--- a/doc/docportal/using_scummvm/keyboard_shortcuts.rst
+++ b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
@@ -2,7 +2,7 @@
Keyboard shortcuts
===================
-ScummVM supports various in-game keyboard and mouse shortcuts, and since version 2.2.0 these can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`, or in the :doc:`configuration file <../advanced_options/configuration_file>`.
+ScummVM supports various in-game keyboard and mouse shortcuts, and since version 2.2.0 these can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`, or in the :doc:`configuration file <../advanced_topics/configuration_file>`.
For game-specific shortcuts, see the `wiki entry <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ for the game you are playing.
@@ -12,7 +12,6 @@ Default keyboard shortcuts
============================
.. csv-table::
- :width: 100%
:widths: 30 70
Shortcut, Description
diff --git a/doc/docportal/guides/local_webserver.rst b/doc/docportal/using_scummvm/local_webserver.rst
similarity index 100%
rename from doc/docportal/guides/local_webserver.rst
rename to doc/docportal/using_scummvm/local_webserver.rst
diff --git a/doc/docportal/using_scummvm/save_load_games.rst b/doc/docportal/using_scummvm/save_load_games.rst
index 35249062cd..6ef280a83f 100644
--- a/doc/docportal/using_scummvm/save_load_games.rst
+++ b/doc/docportal/using_scummvm/save_load_games.rst
@@ -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_options/configuration_file>`.
+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>`.
Load a game
@@ -62,7 +62,7 @@ To load a saved state from within a game, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5
Location of saved game files
-------------------------------
-The save directory can be changed via the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_options/configuration_file>`.
+The save directory can be changed via the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_topics/configuration_file>`.
Default saved game paths are shown below.
Commit: 055d40b56b53595dd134a4748b51edaa85f816f1
https://github.com/scummvm/scummvm/commit/055d40b56b53595dd134a4748b51edaa85f816f1
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds Atari/FreeMiNT page
Changed paths:
A doc/docportal/other_platforms/atari.rst
diff --git a/doc/docportal/other_platforms/atari.rst b/doc/docportal/other_platforms/atari.rst
new file mode 100644
index 0000000000..70f10fd5a9
--- /dev/null
+++ b/doc/docportal/other_platforms/atari.rst
@@ -0,0 +1,73 @@
+=============================
+Atari/FreeMiNT
+=============================
+
+Install ScummVM
+===================
+
+Prerequisites
+****************
+
+- A powerful Atari system or clone; minimum CPU 68060.
+- FreeMiNT, TOS or MagiC.
+
+Download and install ScummVM
+*********************************
+
+A binary package is provided for the m68000 CPU, one for the m68020 to m68060 range of CPUs, and one for the Coldfire (FireBee) CPU. All are available for download from the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_. To install ScummVM, extract the selected ScummVM archive into a folder on the hard disk.
+
+Run ``scummvm.gtp`` to start Scummvm. The ``scummvm.gtp`` command will take :doc:`command line options <../advanced_topics/command_line>` to set parameters for the ScummVM session.
+
+To run ScummVM from a FreeMiNT Command Line Interface, make the program executable with the following command:
+
+ chmod +x scummvm.gtp
+
+For the best performance, run ScummVM under FreeMiNT, from the command line, and without the AES started.
+
+Transfer game files
+=======================
+
+Transfer files to the Atari as you normally would, such as through a network connection or by optical disc.
+
+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.
+
+
+Paths
+=======
+
+FreeMiNT
+***************
+Saved games and the configuration file are found in the user’s defined home directory.
+
+MagiC/TOS
+***************
+Saved games and the configuration file are found in the ScummVM installation directory.
+
+
+
+Settings
+==========
+
+For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+Graphics
+************
+
+For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. XBIOS works better than GEM, since GEM rendering seems to be slower. Note that this is not a ScummVM setting, but rather a system-wide setting.
+
+
+Known issues
+==============
+
+- There is no Cloud/LAN functionality.
+
+- The native MIDI driver (STMIDI) does not work. This is due to an issue with SDL timers not functioning properly from the Atari version of SDL 1.2.
+
+- While support for ``.FLAC``, ``.OGG`` and ``.MP3`` audio formats is available in the Atari port of ScummVM, these decoding libraries are extremely CPU intensive and greatly slow down the user experience. ScummVM is best run with uncompressed audio, when available.
+
+- While all supported engines are included in the Atari ScummVM release, not all games will run well due to the lack of resources. For example, the Curse of Monkey Island will run on a CT60-equipped Atari Falcon, but very poorly.
\ No newline at end of file
Commit: 62598c89516f894068a5a8b3efc7636bbe79b56d
https://github.com/scummvm/scummvm/commit/62598c89516f894068a5a8b3efc7636bbe79b56d
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: final draft getting started section
Changed paths:
doc/docportal/getting_started/android.rst
doc/docportal/getting_started/ios.rst
doc/docportal/getting_started/mac_linux_windows.rst
diff --git a/doc/docportal/getting_started/android.rst b/doc/docportal/getting_started/android.rst
index 5ffe63f8d2..d1e88bcd91 100644
--- a/doc/docportal/getting_started/android.rst
+++ b/doc/docportal/getting_started/android.rst
@@ -6,16 +6,16 @@ Android
Install ScummVM
====================================
-There are multiple ways to install ScummVM on your Android device depending on what version of Android you have.
+There are multiple ways to install ScummVM on your Android device depending on what version of Android is installed on the device.
Google Play Store
*********************
-For Android 7 (Nougat) or earlier, the easiest way to install ScummVM is by downloading it from the Google Play Store. You will be guided through the installation.
+For Android 7 (Nougat) or earlier, download ScummVM from the Google Play Store. It guides you through the installation.
.. caution::
- Currently the Google Play version of ScummVM will not work on Android versions 8.0 and later. If your version of Android is not compatible with the app on the Google Play store, follow the instructions for installing ScummVM using the APK package.
+ Currently the Google Play version of ScummVM does not work on Android versions 8.0 and later. If the version of Android on the device is not compatible with the app on the Google Play store, install ScummVM using the APK package.
APK package install
**********************
@@ -24,13 +24,13 @@ On your device, use a web browser app to navigate to the `ScummVM downloads page
.. tip::
- To find the correct package for your device, you will need to know whether you are running a 32 or 64-bit operating system, and which chipset your device has. A quick internet search using your device model number should allow you to find these details.
+ To find the correct package for your device, find out whether the device has a 32 or 64-bit operating system, and which chipset the device has. An internet search using the device model number should allow you to find these details.
-Click on the correct package to start the download. Once it has downloaded, go to the file and tap on it to start the install process. Do this by using either a file manager app and navigating to the Downloads folder, or by selecting the file directly from the web browser downloads. The file manager or the web browser will ask for permission to install the package, and once permission has been granted, will return you to the install.
+Click on the correct package to start the download. Once it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or by select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and once permission is granted, returns to the install.
.. note::
- The downloaded APK package is treated as an app from an unknown source, since it doesn't originate in the Google Play store. If you are having any problems with the install, you will need to allow unknown apps.
+ The downloaded APK package is treated as an app from an unknown source, since it doesn't originate in the Google Play store. To allow unknown apps:
- For Android 7 or earlier, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
- For Android 8 or later, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
@@ -38,17 +38,17 @@ Click on the correct package to start the download. Once it has downloaded, go t
Transfer game files
========================================
-You need to transfer all the required game data files to your device, into a folder accessible by the ScummVM app.
+Transfer all the required game data files to your device, into a folder accessible by the ScummVM app.
-ScummVM has built-in Cloud functionality, which allows you to connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../settings/cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../settings/lan` page.
+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.
-There are a few other options for transferring the game files:
+There are a few other options to transfer the game files:
- - Copying the files directly onto the microSD card, if your device has one.
- - USB transfer from a computer. To complete file transfer via USB cable, tap the **Charging this device via USB notification** when the device is connected. Select **Use USB for** and then **File Transfer**. An Android File Transfer window will open.
- - Downloading games such as freeware games or those from digital distributors such `GOG.com <gog.com>`_ or `Steam <steam.steampowered.com>`_ directly to your device.
+ - 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 `adding and playing games <adding_games>`_.
+For more information on which files ScummVM requires, and how to add and play games, see :doc:`../using_scummvm/add_play_games`.
diff --git a/doc/docportal/getting_started/ios.rst b/doc/docportal/getting_started/ios.rst
index 954f6a0beb..2b545dfc33 100644
--- a/doc/docportal/getting_started/ios.rst
+++ b/doc/docportal/getting_started/ios.rst
@@ -5,7 +5,7 @@ iOS
Install ScummVM
=====================
-There are two methods to install ScummVM onto your iOS device, and the method you use depends on whether or not your device is jailbroken.
+There are two methods to install ScummVM onto your iOS device, and the method you use depends on whether or not the device is jailbroken.
No Jailbreak
^^^^^^^^^^^^^^^^
@@ -26,7 +26,7 @@ Prerequisites
Create the Xcode project
***************************
-The first step is to download the repository containing the code we'll need to build the app with. The easiest way to do this is from the command line. Go to **Applications > Utilities > Terminal** and enter the following:
+The first step is to download the repository containing the code required to build the app. The next steps require use of the command line. Go to **Applications > Utilities > Terminal** and copy and paste the following, then press :kbd:`return` :
.. code-block:: bash
@@ -39,16 +39,16 @@ The first step is to download the repository containing the code we'll need to b
git checkout branch-2-2-0
-If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time will also install the command line tools we require for the next steps.
+If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time will also install the command line tools required for the next steps.
-The next step changes our present working directory and then generates the tools we need to create the Xcode project.
+The next step changes the present working directory and then generates the tools required to create the Xcode project.
.. code-block:: bash
cd scummvm/devtools/create_project/xcode
xcodebuild
-Now we move back a few directories, to create a new build directory at the same level as the repository.
+The next command creates a new directory called ``build`` at the same level as the repository:
.. code-block:: bash
@@ -56,17 +56,21 @@ Now we move back a few directories, to create a new build directory at the same
mkdir build
cd build
-Your present working directory will now be the new ``build`` directory. Unzip the downloaded iOS libraries package into the build folder by using the following command:
+The present working directory will now be the new ``build`` directory. Unzip the contents of the downloaded iOS libraries package into the build folder by using the following command:
.. code-block:: bash
unzip ~/Downloads/scummvm-ios7-libs-v2.zip
+.. note::
+
+ For newer versions of macOS, the unzip is done automatically. If this is the case, the unzip command will not work as expected. Instead, copy the contents of the ``scummvm-ios7-libs-v2`` folder into the ``build`` directory. It is simplest to do this in the Finder.
+
Generate the Xcode project
*****************************
-It's time to generate the Xcode project. Ensure your present working directory is still the ``build`` directory, and then run the following on the command line:
+It's time to generate the Xcode project. Ensure the present working directory is still the ``build`` directory, and then run the following on the command line:
.. code::
@@ -86,7 +90,7 @@ The resulting directory structure will look like this:
.. tip::
- To view the Home directory in the Finder, click on **Go** in the top menu bar, and then click **Home**, or alternatively use the keyboard shortcut :kbd:`shift` + :kbd:`command` + :kbd:`H`.
+ To view the Home directory in the Finder, go to **Go > Home** in the top menu bar, or press :kbd:`command+shift+H`.
Open the ``scummvm.xcodeproj`` file from the Finder, or via the command line:
@@ -97,12 +101,12 @@ Open the ``scummvm.xcodeproj`` file from the Finder, or via the command line:
Build ScummVM
*****************
-Once Xcode is open, connect the device you are installing ScummVM onto. At the top of the window, select **ScummVM-iOS** and then the device you connected. You will need to trust the device before it will show up on the list of connected devices.
+Once Xcode is open, connect the device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then the device you just connected. "Trust" the device for it to show up on the list of connected devices.
.. figure:: ../images/ios/choose_device.gif
-The last step before building the app is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** you should see a field labeled **Bundle Identifier**. Here you will need to input a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
+The last step before building the app is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** you should see a field labeled **Bundle Identifier**. Input a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
.. figure:: ../images/ios/identifier.gif
@@ -113,52 +117,52 @@ Next to **General**, click on **Signing & Capabilities**. Under **Signing**, tic
-If you have not added your developer account to Xcode, do this now by clicking **Add an Account...** in the dropdown menu.
+If you have not added your developer account to Xcode, do this now. Click **Add an Account...** in the dropdown menu.
-In the upper left-hand corner, press the play button to start building ScummVM. When the build has finished, it will launch on your connected device.
+In the upper left-hand corner, press the play button to build ScummVM. When the build has finished, it launches on your connected device.
Jailbreak
^^^^^^^^^^^^
-How to jailbreak an iOS device is outside the scope of this documentation. However, should you have a device that is jailbroken, iOS .deb and .ipa packages are available for install from the `ScummVM downloads page <https://www.scummvm.org/downloads>`_.
+How to jailbreak an iOS device is outside the scope of this documentation. However, should you have a device that is jailbroken, iOS ``.deb`` and ``.ipa`` packages are available for install from the `ScummVM downloads page <https://www.scummvm.org/downloads>`_.
Prerequisites
***************
- A jailbroken iOS device
-- A file manager app such as Filza on your iOS device
+- A file manager app such as Filza on the device
Install ScummVM
*******************
-Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended .deb package. Your device will ask how to open the file. Choose Filza.
+Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended ``.deb`` package. When the device asks how to open the file, choose Filza.
-Ensure the .deb package is saved somewhere in the ``/var/mobile`` directory. It should default to ``/var/mobile/Documents``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
+Ensure the ``.deb`` package is saved somewhere in the ``/var/mobile`` directory. It should default to ``/var/mobile/Documents``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
-The .ipa package can be installed in the same way.
+The ``.ipa`` package can be installed in the same way.
-You will need to restart your device for the install to complete.
+Restart your device for the install to complete.
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:`../settings/cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../settings/lan` 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:`../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.
.. note::
ScummVM's Cloud functionality does not currently support iCloud, however it is possible to upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder.
-Another way to transfer files (for macOS Catalina and newer) to your device is by using the Finder while your device is connected to your Mac. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag and drop the folder containing the game files into the **ScummVM** folder.
+Another way to transfer files (for macOS Catalina and newer) to your device is by using the Finder while your device is connected to your Mac. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag and drop the folder containing the game files into the **ScummVM** folder. For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
.. image:: ../images/ios/ios_transfer_files.gif
-For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
-For more information on which files ScummVM requires, and how to add and play games, see `adding and playing games <adding_games>`_.
+
+For more information on which files ScummVM requires, and how to add and play games, see :doc:`../using_scummvm/add_play_games`.
Controls
============
@@ -185,42 +189,25 @@ Controls
Click and drag mode
^^^^^^^^^^^^^^^^^^^^
-In this mode, a mouse click is sent immediately when you touch the screen, drags to wherever you slide your finger, and releases where you lift your finger. If you press down a second finger in this mode, you effectively release the left mouse button, and press down the right one, which is then released when you lift your finger again.
+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.
+
+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.
-This is especially useful for Monkey Island 3: The Curse of Monkey Island and Full Throttle.
Touchpad mode
^^^^^^^^^^^^^^^^
In this mode, the cursor doesn't stay underneath your finger, but is rather moved around from its current position depending on the direction of your finger movement, just like a touchpad on a laptop.
-Settings
-============
-
-
Paths
=======
Saved games
^^^^^^^^^^^^^^^^^
-``/var/mobile/Library/ScummVM/Savegames/`` or ``/ScummVM/Savegames/`` for a sandboxed version.
+``/var/mobile/Library/ScummVM/Savegames/`` if the device is jailbroken, or ``Savegames/`` in the ScummVM folder for a non-jailbroken device. Access this folder via the Finder or iTunes.
Configuration file
^^^^^^^^^^^^^^^^^^^^^^^
-``/var/mobile/Library/ScummVM/Preferences`` or ``/Preferences`` for a sandboxed version.
-
-Known issues
-===============
-
-
-
-
-
-
-
-
-
-
-
+``/var/mobile/Library/ScummVM/Preferences`` if the device is jailbroken, or ``Preferences`` in the ScummVM folder for a non-jailbroken device. Access this folder via the Finder or iTunes.
\ No newline at end of file
diff --git a/doc/docportal/getting_started/mac_linux_windows.rst b/doc/docportal/getting_started/mac_linux_windows.rst
index 1a20ab2f3d..2d9af0bf08 100644
--- a/doc/docportal/getting_started/mac_linux_windows.rst
+++ b/doc/docportal/getting_started/mac_linux_windows.rst
@@ -16,13 +16,12 @@ To run ScummVM, click on the icon in the Applications folder.
macOS includes a technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac.
- Since ScummVM is not available from the App Store, see this `Apple support page <https://support.apple.com/en-us/HT202491>`_ if you have any difficulty running ScummVM.
+ Since ScummVM is not available from the App Store, see this `Apple support page <https://support.apple.com/en-us/HT202491>`_ . Follow the steps to allow ScummVM to run.
Linux
--------
-
There are multiple ways to install ScummVM onto a computer running Linux.
The Snap Store
@@ -32,7 +31,7 @@ A Snap is an app that is bundled with its dependencies, which makes the install
The ScummVM Snap comes with a selection of freeware games and demos pre-loaded.
-Enter the following on the command line (using your preferred Terminal application) to install the ScummVM Snap:
+Enter the following on the command line to install the ScummVM Snap:
.. code:: bash
@@ -45,7 +44,7 @@ Flathub
Flathub is another way to easily install apps for Linux by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
-Once Flatpak has been installed, enter the following on the command line to install ScummVM:
+Once Flatpak is installed, enter the following on the command line to install ScummVM:
.. code:: bash
@@ -59,11 +58,11 @@ To run ScummVM, enter the following on the command line:
.. note::
- The Flatpak version of ScummVM is sandboxed, meaning that any games will need to be copied into the Documents folders to be accessible by ScummVM.
+ The Flatpak version of ScummVM is sandboxed, meaning that any games need to be copied into the Documents folder to be accessible by ScummVM.
:doc:`Command line arguments <../advanced_topics/command_line>` can still be passed by adding them after the Flatpak run command.
-Some distributions have the option to install Flatpaks via the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog will appear; choose the **Open with Software Install (default)** option, and click **OK**. You will then be guided through the install process.
+Some distributions have the option to install Flatpaks via the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog will appear; choose the **Open with Software Install (default)** option, and click **OK**.
Software Repository
*********************************
@@ -75,8 +74,8 @@ If you are unsure how to install software packages from the software repository
To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**
-Installing release binaries
-*********************************
+Release binaries
+*********************
At this time, binary packages are only released for Debian and Ubuntu. Find and download the ScummVM version that corresponds to your operating system and architecture. To install a ``.deb`` package:
@@ -92,11 +91,11 @@ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through
Windows
---------
-The easiest way to install ScummVM is to download the Windows installer. This installer will guide you through the install process, as well as adding a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop. To run ScummVM, navigate to desktop and double click the ScummVM shortcut. To run ScummVM from the Start menu, go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Programs > Games > ScummVM**.
+The easiest way to install ScummVM is to download the Windows installer. This installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop. To run ScummVM, navigate to desktop and double click the ScummVM shortcut. To run ScummVM from the Start menu, go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Programs > Games > ScummVM**.
-Alternatively, you can download the Windows zipped file appropriate to your operating system (32bit or 64bit). To unzip the contents, right-click the folder, select Extract All, and then follow the instructions. To run ScummVM from this folder, find the ``scummvm.exe`` file and double click it.
+Alternatively, download the Windows zipped file appropriate to your operating system (32bit or 64bit). To unzip the contents, right-click the folder, select Extract All, and then follow the instructions. To run ScummVM from this folder, find the ``scummvm.exe`` file and double click it.
-Next steps...
------------------------
+Next steps
+-----------
-ScummVM is now installed and ready for you to :doc:`add your games <../using_scummvm/add_play_games>`!
+ScummVM is now installed and ready to :doc:`add and play games <../using_scummvm/add_play_games>`.
Commit: 446ffbf0e205963e8eef29c73c272a240364cef3
https://github.com/scummvm/scummvm/commit/446ffbf0e205963e8eef29c73c272a240364cef3
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: style edits to multiple pages
- aligns docs with style guide
Changed paths:
A doc/docportal/images/cloud_and_lan/lan_server_running.png
doc/docportal/advanced_topics/command_line.rst
doc/docportal/advanced_topics/configuration_file.rst
doc/docportal/consoles/nintendo_3ds.rst
doc/docportal/consoles/nintendo_switch.rst
doc/docportal/consoles/sega_dreamcast.rst
doc/docportal/getting_started/android.rst
doc/docportal/getting_started/ios.rst
doc/docportal/getting_started/mac_linux_windows.rst
doc/docportal/settings/accessibility.rst
doc/docportal/settings/audio.rst
doc/docportal/settings/cloud.rst
doc/docportal/settings/control.rst
doc/docportal/settings/engine.rst
doc/docportal/settings/game.rst
doc/docportal/settings/graphics.rst
doc/docportal/settings/keymaps.rst
doc/docportal/settings/lan.rst
doc/docportal/settings/misc.rst
doc/docportal/settings/paths.rst
doc/docportal/using_scummvm/add_play_games.rst
doc/docportal/using_scummvm/connect_cloud.rst
doc/docportal/using_scummvm/how_to_settings.rst
doc/docportal/using_scummvm/keyboard_shortcuts.rst
doc/docportal/using_scummvm/local_webserver.rst
diff --git a/doc/docportal/advanced_topics/command_line.rst b/doc/docportal/advanced_topics/command_line.rst
index 196ff513fd..c64a1e3deb 100755
--- a/doc/docportal/advanced_topics/command_line.rst
+++ b/doc/docportal/advanced_topics/command_line.rst
@@ -5,7 +5,7 @@ Command line interface
Launching ScummVM from the command line allows you to pass a number of options, some of which override the applicable global or game-specific settings. It also allows you to launch straight into a game without going to the Launcher first.
-Some options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without launching ScummVM or starting a game.
+Some options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without starting the Launcher or starting a game.
Usage
=========
@@ -14,7 +14,7 @@ Usage
scummvm [option] [game]
-To launch ScummVM, enter the path to ScummVM. Optionally, follow this by any of the options documented below, and/or the path to the game you wish to start. If a game has already been added to the games list in the Launcher, you can pass the game id instead of the path to the game.
+To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any of the options documented below, and/or the path to the game you wish to start. If a game has already been added to the games list in the Launcher, you can pass the game id instead of the path to the game.
.. tabbed:: macOS
@@ -24,7 +24,7 @@ To launch ScummVM, enter the path to ScummVM. Optionally, follow this by any of
The following examples assume the path to the ScummVM app is ``Applications/ScummVM.app``.
- If you are unsure of the path to the app, drag and drop the ScummVM app icon into the Terminal window, which prints the path to the ScummVM app.
+ If you are unsure of the path to the app, drag the ScummVM app icon into the Terminal window. This prints the path to the ScummVM app.
To run ScummVM from the command line, add ``/Contents/MacOS/scummvm`` to that path.
@@ -98,7 +98,7 @@ Options
The meaning of most options can be inverted by prefixing them with ``no-``. For example, ``--no-aspect-ratio`` will turn aspect ratio correction off. This does not apply to short options.
-Option parameters are shown in capitals, and need to be replaced with real values.
+Option parameters are shown below in capitals, and need to be replaced with real values.
Short options are listed where they are available.
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index c0c33d7bc5..b443607efd 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -1,19 +1,17 @@
=======================
-The configuration file
+Configuration file
=======================
-The configuration file provides a way to edit both global and game-specific settings by using a text file containing configuration keywords and parameters.
+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>` . To edit global settings, click **Options**. To edit game-specific settings, highlight a game and then click **Edit Game**.
+Settings are also accessible directly from :doc:`the Launcher <../using_scummvm/the_launcher>`. See :doc:`../using_scummvm/how_to_settings`.
Location
==========
The configuration file saves to different default locations, depending on the platform.
-
-
.. tabbed:: macOS
.. panels::
@@ -67,7 +65,7 @@ The configuration file saves to different default locations, depending on the pl
The AppData folder is hidden. The steps to view hidden files and folders depends on the Windows version.
- For more information, see the `Windows support page <https://support.microsoft.com/en-us/help/14201/windows-show-hidden-files>`_.
+ For more information, see this `Windows support page <https://support.microsoft.com/en-us/help/14201/windows-show-hidden-files>`_.
.. note::
@@ -79,15 +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. This means our configuration can be found in ``$XDG_CONFIG_HOME/scummvm/scummvm.ini``
-
- If XDG_CONFIG_HOME is not defined or empty, ``~/.config`` is used, where ``~`` is your Home directory.
+ 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.
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. If you are using a GUI file manager, go to **View > Show Hidden Files**, or use the keyboard shortcut :kbd:`Ctrl + H`.
+ ``.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`.
@@ -155,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,Options
+ Keyword,Type,Default,Description or Available options
alsa_port,number,,
":ref:`alt_intro <altintro>`",boolean,false,
":ref:`altamigapalette <altamiga>`",boolean,false,
@@ -260,50 +256,50 @@ There are many recognized configuration keywords. In the table below, each keywo
":ref:`joystick_deadzone <deadzone>`",integer, 3
joystick_num,number,,
":ref:`kbdmouse_speed <mousespeed>`", integer, 10
- ":doc:`keymap_engine-default_DOWN <../settings/keymaps>`",string,JOY_DOWN
- ":doc:`keymap_engine-default_LCLK <../settings/keymaps>`",string,MOUSE_LEFT JOY_A
- ":doc:`keymap_engine-default_LEFT <../settings/keymaps>`",string,JOY_LEFT
- ":doc:`keymap_engine-default_MCLK <../settings/keymaps>`",string,MOUSE_MIDDLE
- ":doc:`keymap_engine-default_MENU <../settings/keymaps>`",string,F5 JOY_LEFT_SHOULDER
- ":doc:`keymap_engine-default_PAUSE <../settings/keymaps>`",string,SPACE
- ":doc:`keymap_engine-default_PIND <../settings/keymaps>`",string,
- ":doc:`keymap_engine-default_RCLK <../settings/keymaps>`",string,MOUSE_RIGHT JOY_B
- ":doc:`keymap_engine-default_RETURN <../settings/keymaps>`",string,RETURN
- ":doc:`keymap_engine-default_RIGHT <../settings/keymaps>`",string,JOY_RIGHT
- ":doc:`keymap_engine-default_SKIP <../settings/keymaps>`",string,ESCAPE JOY
- ":doc:`keymap_engine-default_SKLI <../settings/keymaps>`",string,PERIOD JOY_X
- ":doc:`keymap_engine-default_UP <../settings/keymaps>`",string,JOY_UP
- ":doc:`keymap_global_DEBUGGER <../settings/keymaps>`",string,C+A+d
- ":doc:`keymap_global_MENU <../settings/keymaps>`",string,C+F5 JOY_START
- ":doc:`keymap_global_MUTE <../settings/keymaps>`",string,C+u
- ":doc:`keymap_global_QUIT <../settings/keymaps>`",string,C+q
- ":doc:`keymap_global_VMOUSEDOWN <../settings/keymaps>`",string,JOY_LEFT_STICK_Y+
- ":doc:`keymap_global_VMOUSELEFT <../settings/keymaps>`",string,JOY_LEFT_STICK_X-
- ":doc:`keymap_global_VMOUSERIGHT <../settings/keymaps>`",string,JOY_LEFT_STICK_X+
- ":doc:`keymap_global_VMOUSESLOW <../settings/keymaps>`",string,JOY_RIGHT_SHOULDER
- ":doc:`keymap_global_VMOUSEUP <../settings/keymaps>`",string,JOY_LEFT_STICK_Y-
- ":doc:`keymap_gui_CLOS <../settings/keymaps>`",string,ESCAPE JOY_Y
- ":doc:`keymap_gui_DOWN <../settings/keymaps>`",string,JOY_DOWN
- ":doc:`keymap_gui_INTRCT <../settings/keymaps>`",string,JOY_A
- ":doc:`keymap_gui_LEFT <../settings/keymaps>`",string,
- ":doc:`keymap_gui_RIGHT <../settings/keymaps>`",string,JOY_RIGHT
- ":doc:`keymap_gui_UP <../settings/keymaps>`",string,JOY_UP
- ":doc:`keymap_sdl-graphics_ASPT <../settings/keymaps>`",string,C+A+a
- ":doc:`keymap_sdl-graphics_CAPT <../settings/keymaps>`",string,C+m
- ":doc:`keymap_sdl-graphics_FILT <../settings/keymaps>`",string,C+A+f
- ":doc:`keymap_sdl-graphics_FLT1 <../settings/keymaps>`",string,C+A+1
- ":doc:`keymap_sdl-graphics_FLT2 <../settings/keymaps>`",string,C+A+2
- ":doc:`keymap_sdl-graphics_FLT3 <../settings/keymaps>`",string,C+A+3
- ":doc:`keymap_sdl-graphics_FLT4 <../settings/keymaps>`",string,C+A+4
- ":doc:`keymap_sdl-graphics_FLT5 <../settings/keymaps>`",string,C+A+5
- ":doc:`keymap_sdl-graphics_FLT6 <../settings/keymaps>`",string, C+A+6
- ":doc:`keymap_sdl-graphics_FLT7 <../settings/keymaps>`",string,C+A+7
- ":doc:`keymap_sdl-graphics_FLT8 <../settings/keymaps>`",string,C+A+8
- ":doc:`keymap_sdl-graphics_FULS <../settings/keymaps>`",string,A+RETURN
- ":doc:`keymap_sdl-graphics_SCL- <../settings/keymaps>`",string,C+A+MINUS
- ":doc:`keymap_sdl-graphics_SCL+ <../settings/keymaps>`",string,C+A+PLUS
- ":doc:`keymap_sdl-graphics_SCRS <../settings/keymaps>`",string,A+s
- ":doc:`keymap_sdl-graphics_STCH <../settings/keymaps>`",string,C+A+s
+ ":ref:`keymap_engine-default_DOWN <down>`",string,JOY_DOWN
+ ":ref:`keymap_engine-default_LCLK <LCLK>`",string,MOUSE_LEFT JOY_A
+ ":ref:`keymap_engine-default_LEFT <left>`",string,JOY_LEFT
+ ":ref:`keymap_engine-default_MCLK <MCLK>`",string,MOUSE_MIDDLE
+ ":ref:`keymap_engine-default_MENU <menu>`",string,F5 JOY_LEFT_SHOULDER
+ ":ref:`keymap_engine-default_PAUSE <pause>`",string,SPACE
+ ":ref:`keymap_engine-default_PIND <PIND>`",string,
+ ":ref:`keymap_engine-default_RCLK <RCLK>`",string,MOUSE_RIGHT JOY_B
+ ":ref:`keymap_engine-default_RETURN <RETURN>`",string,RETURN
+ ":ref:`keymap_engine-default_RIGHT <right>`",string,JOY_RIGHT
+ ":ref:`keymap_engine-default_SKIP <skip>`",string,ESCAPE JOY
+ ":ref:`keymap_engine-default_SKLI <SKLI>`",string,PERIOD JOY_X
+ ":ref:`keymap_engine-default_UP <up>`",string,JOY_UP
+ ":ref:`keymap_global_DEBUGGER <debug>`",string,C+A+d
+ ":ref:`keymap_global_MENU <gmm>`",string,C+F5 JOY_START,
+ ":ref:`keymap_global_MUTE <mute>`",string,C+u,
+ ":ref:`keymap_global_QUIT <globalquit>`",string,C+q,
+ ":ref:`keymap_global_VMOUSEDOWN <vmousedown>`",string,JOY_LEFT_STICK_Y+,
+ ":ref:`keymap_global_VMOUSELEFT <vmouseleft>`",string,JOY_LEFT_STICK_X-,
+ ":ref:`keymap_global_VMOUSERIGHT <vmouseright>`",string,JOY_LEFT_STICK_X+,
+ ":ref:`keymap_global_VMOUSESLOW <vmouseslow>`",string,JOY_RIGHT_SHOULDER,
+ ":ref:`keymap_global_VMOUSEUP <vmouseup>`",string,JOY_LEFT_STICK_Y-,
+ ":ref:`keymap_gui_CLOS <close>`",string,ESCAPE JOY_Y,
+ ":ref:`keymap_gui_DOWN <guidown>`",string,JOY_DOWN,
+ ":ref:`keymap_gui_INTRCT <interact>`",string,JOY_A,
+ ":ref:`keymap_gui_LEFT <guileft>`",string,
+ ":ref:`keymap_gui_RIGHT <guiright>`",string,JOY_RIGHT,
+ ":ref:`keymap_gui_UP <guiup>`",string,JOY_UP,
+ ":ref:`keymap_sdl-graphics_ASPT <ASPT>`",string,C+A+a,
+ ":ref:`keymap_sdl-graphics_CAPT <CAPT>`",string,C+m,
+ ":ref:`keymap_sdl-graphics_FILT <FILT>`",string,C+A+f
+ ":ref:`keymap_sdl-graphics_FLT1 <FLT1>`",string,C+A+1
+ ":ref:`keymap_sdl-graphics_FLT2 <FLT2>`",string,C+A+2
+ ":ref:`keymap_sdl-graphics_FLT3 <FLT3>`",string,C+A+3
+ ":ref:`keymap_sdl-graphics_FLT4 <FLT4>`",string,C+A+4
+ ":ref:`keymap_sdl-graphics_FLT5 <FLT5>`",string,C+A+5
+ ":ref:`keymap_sdl-graphics_FLT6 <FLT6>`",string, C+A+6
+ ":ref:`keymap_sdl-graphics_FLT7 <FLT7>`",string,C+A+7
+ ":ref:`keymap_sdl-graphics_FLT8 <FLT8>`",string,C+A+8
+ ":ref:`keymap_sdl-graphics_FULS <FULS>`",string,A+RETURN
+ ":ref:`keymap_sdl-graphics_SCL- <SCL>`",string,C+A+MINUS
+ ":ref:`keymap_sdl-graphics_SCL+ <SCL>`",string,C+A+PLUS
+ ":ref:`keymap_sdl-graphics_SCRS <SCRS>`",string,A+s
+ ":ref:`keymap_sdl-graphics_STCH <STCH>`",string,C+A+s
":ref:`language <lang>`",string,,
":ref:`local_server_port <serverport>`",integer,12345,
":ref:`midi_gain <gain>`",number,,"- 0 - 1000"
diff --git a/doc/docportal/consoles/nintendo_3ds.rst b/doc/docportal/consoles/nintendo_3ds.rst
index 2aca3633de..d5750d6034 100644
--- a/doc/docportal/consoles/nintendo_3ds.rst
+++ b/doc/docportal/consoles/nintendo_3ds.rst
@@ -58,10 +58,10 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
Button,Action
Circle Pad,Moves the cursor
R + Circle Pad,Slow Mouse
- A,Left mouse button
- B,Right mouse button
- X,Opens the virtual keyboard
- Y,ESC
+ â’¶,Left mouse button
+ â’·,Right mouse button
+ â“,Opens the virtual keyboard
+ â“Ž,ESC
Control Pad,Keypad cursor keys
L Button,Toggles magnify mode on/off
R Button,Toggles between hover/drag modes
diff --git a/doc/docportal/consoles/nintendo_switch.rst b/doc/docportal/consoles/nintendo_switch.rst
index f7b262176a..70b49a45cc 100644
--- a/doc/docportal/consoles/nintendo_switch.rst
+++ b/doc/docportal/consoles/nintendo_switch.rst
@@ -54,16 +54,16 @@ See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shor
Button,Action
Left stick,Mouse
Left stick + R button,Slow Mouse
- :kbd:`B`,Left mouse button
- :kbd:`A`,Right mouse button
+ â’·,Left mouse button
+ â’¶,Right mouse button
Directional buttons,"Keypad 'Cursor' Keys"
Directional buttons + R button ,"Diagonal Keypad 'Cursor' Keys"
L button,Game menu (F5)
R button,Shift
- :kbd:`Y`,Period
- :kbd:`Y` + R button,Space
- :kbd:`X`,Escape
- :kbd:`X` + R button,Return
+ â“Ž,Period
+ â“Ž + R button,Space
+ â“,Escape
+ â“ + R button,Return
|plus|,Global main menu (GMM)
|minus|,Toggle virtual keyboard
|minus| + R button,AGI predictive input dialog
diff --git a/doc/docportal/consoles/sega_dreamcast.rst b/doc/docportal/consoles/sega_dreamcast.rst
index a3385dfe87..a7196c3109 100644
--- a/doc/docportal/consoles/sega_dreamcast.rst
+++ b/doc/docportal/consoles/sega_dreamcast.rst
@@ -104,13 +104,13 @@ The Dreamcast mouse and keyboard peripherals are also supported.
Button,Action,Notes
Joystick,Moves pointer,
Directional pad,Moves pointer slowly,Also controls the on-screen keyboard
- A,Left Click,
- B,Right Click,
- Y,Spacebar,Pause
+ â’¶,Left Click,
+ â’·,Right Click,
+ â“Ž,Spacebar,Pause
Start,F5,Load and save
Trigger L,Toggles the on-screen keyboard on/off,
- X,5,For boxing in Indiana Jones and the Last Crusade
- Directional pad + X,"1, 2, 3, 4, 6, 7, 8, 9",For boxing in Indiana Jones and the Last Crusade
+ â“,5,For boxing in Indiana Jones and the Last Crusade
+ â“ + Directional pad,"1, 2, 3, 4, 6, 7, 8, 9",For boxing in Indiana Jones and the Last Crusade
Paths
=======
diff --git a/doc/docportal/getting_started/android.rst b/doc/docportal/getting_started/android.rst
index d1e88bcd91..d36151a60b 100644
--- a/doc/docportal/getting_started/android.rst
+++ b/doc/docportal/getting_started/android.rst
@@ -3,22 +3,28 @@
Android
===============
+Prerequisites
+================
+
+- An Android device running Android 4.1 (Jelly Bean) or newer.
+
+.. note::
+
+ ScummVM has been tested to work up to Android 10. Currently there are some file browsing limitations with Android 11. The ScummVM team are working to resolve these.
+
Install ScummVM
====================================
-There are multiple ways to install ScummVM on your Android device depending on what version of Android is installed on the device.
-
+There are two ways to install ScummVM on an Android device; install it from the Google Play Store, or manually download and install the APK package from the ScummVM downloads page.
Google Play Store
*********************
-For Android 7 (Nougat) or earlier, download ScummVM from the Google Play Store. It guides you through the installation.
-.. caution::
+Go to the Google Play Store to download and install ScummVM.
- Currently the Google Play version of ScummVM does not work on Android versions 8.0 and later. If the version of Android on the device is not compatible with the app on the Google Play store, install ScummVM using the APK package.
-APK package install
-**********************
+APK package
+************
On your device, use a web browser app to navigate to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_. The recommended download section on the page should suggest the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
@@ -26,7 +32,7 @@ On your device, use a web browser app to navigate to the `ScummVM downloads page
To find the correct package for your device, find out whether the device has a 32 or 64-bit operating system, and which chipset the device has. An internet search using the device model number should allow you to find these details.
-Click on the correct package to start the download. Once it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or by select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and once permission is granted, returns to the install.
+Click on the correct package to start the download. Once it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and once permission is granted, returns to the install.
.. note::
diff --git a/doc/docportal/getting_started/ios.rst b/doc/docportal/getting_started/ios.rst
index 2b545dfc33..671bff90f2 100644
--- a/doc/docportal/getting_started/ios.rst
+++ b/doc/docportal/getting_started/ios.rst
@@ -5,12 +5,12 @@ iOS
Install ScummVM
=====================
-There are two methods to install ScummVM onto your iOS device, and the method you use depends on whether or not the device is jailbroken.
+There are two methods to install ScummVM onto an iOS device, and the method use depends on whether or not the device is jailbroken.
No Jailbreak
^^^^^^^^^^^^^^^^
-This method is a little complex, however it is currently the only way to install ScummVM to an iOS device that is not jailbroken. While a rudimentary knowledge of the command line would be useful, the following instructions, if followed carefully, can be completed by anyone.
+This method is a little complex, however it is currently the only way to install ScummVM onto an iOS device that is not jailbroken. While a rudimentary knowledge of the command line would be useful, the following instructions, if followed carefully, can be completed by anyone.
Prerequisites
****************
@@ -21,7 +21,7 @@ Prerequisites
.. note::
- If you have a free Apple developer account, each build will only be valid for 7 days, which means you will need to repeat these steps and re-install ScummVM every week.
+ If you have a free Apple developer account, each build will only be valid for 7 days, which means you will need to repeat these steps and rebuild ScummVM every week.
Create the Xcode project
***************************
@@ -33,13 +33,13 @@ The first step is to download the repository containing the code required to bui
git clone https://github.com/scummvm/scummvm.git
.. note::
- The default branch of the ScummVM repository will be the master branch. To build a specific version, checkout the appropriate branch. For example, to build version 2.2.0, use the following command:
+ The default branch of the ScummVM repository will be the master branch. To build a specific version of ScummVM, checkout the appropriate branch. For example, to build version 2.2.0, use the following command:
.. code-block::
git checkout branch-2-2-0
-If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time will also install the command line tools required for the next steps.
+If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time will also install the command line tools required.
The next step changes the present working directory and then generates the tools required to create the Xcode project.
@@ -56,7 +56,7 @@ The next command creates a new directory called ``build`` at the same level as t
mkdir build
cd build
-The present working directory will now be the new ``build`` directory. Unzip the contents of the downloaded iOS libraries package into the build folder by using the following command:
+The present working directory will now be the new ``build`` directory. Extract the contents of the downloaded iOS libraries package into the build folder by using the following command:
.. code-block:: bash
@@ -64,7 +64,7 @@ The present working directory will now be the new ``build`` directory. Unzip the
.. note::
- For newer versions of macOS, the unzip is done automatically. If this is the case, the unzip command will not work as expected. Instead, copy the contents of the ``scummvm-ios7-libs-v2`` folder into the ``build`` directory. It is simplest to do this in the Finder.
+ In newer versions of macOS, the archive is extracted automatically. If this is the case, the ``unzip`` command will not work as expected. Instead, copy the contents of the ``scummvm-ios7-libs-v2`` folder into the ``build`` directory. It is simplest to do this in the Finder.
Generate the Xcode project
@@ -76,7 +76,7 @@ It's time to generate the Xcode project. Ensure the present working directory is
../scummvm/devtools/create_project/xcode/build/Release/create_project ../scummvm --xcode --enable-fluidsynth --disable-nasm --disable-opengl --disable-theora --disable-taskbar --disable-tts --disable-fribidi
-The resulting directory structure will look like this:
+The resulting directory structure looks like this:
.. code-block:: bash
@@ -90,9 +90,9 @@ The resulting directory structure will look like this:
.. tip::
- To view the Home directory in the Finder, go to **Go > Home** in the top menu bar, or press :kbd:`command+shift+H`.
+ To view the Home directory in the Finder, select **Go > Home** in the menu bar, or press :kbd:`command+shift+H`.
-Open the ``scummvm.xcodeproj`` file from the Finder, or via the command line:
+Open the ``scummvm.xcodeproj`` file from the Finder, or from the command line:
.. code-block:: bash
@@ -101,12 +101,12 @@ Open the ``scummvm.xcodeproj`` file from the Finder, or via the command line:
Build ScummVM
*****************
-Once Xcode is open, connect the device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then the device you just connected. "Trust" the device for it to show up on the list of connected devices.
+Once Xcode is open, connect a device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then select the device you just connected. You will need to "Trust" the device for it to show up on the list of connected devices.
.. figure:: ../images/ios/choose_device.gif
-The last step before building the app is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** you should see a field labeled **Bundle Identifier**. Input a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
+The last step before building ScummVM is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** you should see a field labeled **Bundle Identifier**. Input a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
.. figure:: ../images/ios/identifier.gif
@@ -117,51 +117,47 @@ Next to **General**, click on **Signing & Capabilities**. Under **Signing**, tic
-If you have not added your developer account to Xcode, do this now. Click **Add an Account...** in the dropdown menu.
+If you have not added your developer account to Xcode, do this now. Click **Add an Account** in the dropdown menu.
-In the upper left-hand corner, press the play button to build ScummVM. When the build has finished, it launches on your connected device.
+In the upper left-hand corner, press the play button to build ScummVM. When the build is finished, it launches on your connected device.
Jailbreak
^^^^^^^^^^^^
-How to jailbreak an iOS device is outside the scope of this documentation. However, should you have a device that is jailbroken, iOS ``.deb`` and ``.ipa`` packages are available for install from the `ScummVM downloads page <https://www.scummvm.org/downloads>`_.
Prerequisites
***************
-- A jailbroken iOS device
-- A file manager app such as Filza on the device
+- A jailbroken iOS device. How to jailbreak a device is outside the scope of this documentation.
+- A file manager app such as Filza installed on the device.
Install ScummVM
*******************
-Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended ``.deb`` package. When the device asks how to open the file, choose Filza.
+Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended ``.deb`` or ``.ipa`` package. When the device asks how to open the file, choose Filza.
-Ensure the ``.deb`` package is saved somewhere in the ``/var/mobile`` directory. It should default to ``/var/mobile/Documents``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
-
-The ``.ipa`` package can be installed in the same way.
+Ensure the package is saved somewhere in the ``/var/mobile/`` directory. It should default to ``/var/mobile/Documents/``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
Restart your device for the install to complete.
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:`../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.
.. note::
- ScummVM's Cloud functionality does not currently support iCloud, however it is possible to upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder.
+ ScummVM's cloud functionality does not currently support iCloud, however it is possible to upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder.
-Another way to transfer files (for macOS Catalina and newer) to your device is by using the Finder while your device is connected to your Mac. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag and drop the folder containing the game files into the **ScummVM** folder. For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
+Another way to transfer files (for macOS Catalina and newer) to your device is by using the Finder while your device is connected to your Mac. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag the folder containing the game files into the **ScummVM** folder. For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
.. image:: ../images/ios/ios_transfer_files.gif
-
For more information on which files ScummVM requires, and how to add and play games, see :doc:`../using_scummvm/add_play_games`.
Controls
@@ -179,8 +175,8 @@ Controls
ESC,"Hold one finger on screen, double tap another, or use the Esc key in the bar above the keyboard."
Tab,The Tab button in the bar above the keyboard.
Return,The Return button in the bar above the keyboard.
- Global Main Menu,"Swipe two fingers down from top to bottom, or the left-most button in the bar above the keyboard."
- Enable/disable keyboard,"The pinch gesture enables or disables the keyboard. If no external keyboard is connected, this shows and hides the On Screen keyboard. When an external keyboard is connected, instead of showing/hiding the On Screen keyboard this enables/disables inputs from the external keyboard."
+ Global Main Menu,"Swipe two fingers down from top to bottom, or the tap the left-most button in the bar above the keyboard."
+ Enable/disable keyboard,"The pinch gesture enables or disables the keyboard. If no external keyboard is connected, this shows and hides the onscreen keyboard. When an external keyboard is connected, the pinch gesture enables/disables inputs from the external keyboard."
F 0-9 keys,The F-bar above the keyboard.
Pause,Keyboard spacebar
Toggle `Click and drag mode`_,Swipe two fingers up from bottom to top.
diff --git a/doc/docportal/getting_started/mac_linux_windows.rst b/doc/docportal/getting_started/mac_linux_windows.rst
index 2d9af0bf08..7124da46dc 100644
--- a/doc/docportal/getting_started/mac_linux_windows.rst
+++ b/doc/docportal/getting_started/mac_linux_windows.rst
@@ -3,26 +3,24 @@
Mac, Linux or Windows
========================
-All downloads referenced on this page are available from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_.
+All downloads are available from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_.
macOS/Mac OSX
------------------
-Download the Disk Image. Once the download has completed, double click the file to mount the Disk Image. A window will open with the ScummVM icon. Drag this icon into your Applications folder to install ScummVM.
+Download the recommended Disk Image. Once the download has completed, double click the file to mount the Disk Image. A window will open with the ScummVM icon. Drag this icon into your Applications folder to install ScummVM.
To run ScummVM, click on the icon in the Applications folder.
.. note::
- macOS includes a technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac.
-
- Since ScummVM is not available from the App Store, see this `Apple support page <https://support.apple.com/en-us/HT202491>`_ . Follow the steps to allow ScummVM to run.
+ macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. Since ScummVM is not available from the App Store, follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
Linux
--------
-There are multiple ways to install ScummVM onto a computer running Linux.
+There are multiple ways to install ScummVM onto a computer running Linux; use the Snap Store, Flathub or the software repository, or install the release binary.
The Snap Store
*********************
@@ -37,12 +35,12 @@ Enter the following on the command line to install the ScummVM Snap:
sudo snap install scummvm
-To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
+To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking :menuselection:`Menu --> Games --> ScummVM`.
Flathub
-******************
+**********
-Flathub is another way to easily install apps for Linux by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
+Flathub is another way to quickly install apps for Linux by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
Once Flatpak is installed, enter the following on the command line to install ScummVM:
@@ -50,40 +48,44 @@ Once Flatpak is installed, enter the following on the command line to install Sc
flatpak install flathub org.scummvm.ScummVM
+Some distributions have the option to install Flatpaks via the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog opens; choose the **Open with Software Install (default)** option, and then click **OK**.
+
To run ScummVM, enter the following on the command line:
.. code:: bash
flatpak run org.scummvm.ScummVM
+To pass :doc:`Command line arguments <../advanced_topics/command_line>`, add them after the Flatpak ``run`` command.
+
.. note::
The Flatpak version of ScummVM is sandboxed, meaning that any games need to be copied into the Documents folder to be accessible by ScummVM.
- :doc:`Command line arguments <../advanced_topics/command_line>` can still be passed by adding them after the Flatpak run command.
-
-Some distributions have the option to install Flatpaks via the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog will appear; choose the **Open with Software Install (default)** option, and click **OK**.
-
Software Repository
*********************************
-ScummVM can be found in the software repositories of many Linux distributions. Please note that these may not contain the most up to date version of ScummVM.
+ScummVM is found in the software repositories of many Linux distributions.
-If you are unsure how to install software packages from the software repository for your distribution, you may find `this article <https://www.maketecheasier.com/install-software-in-various-linux-distros/>`_ useful.
+.. caution::
-To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**
+ The repositories may not contain the most up-to-date version of ScummVM.
+
+If you are unsure about how to install software packages from the software repository for your distribution, you may find `this help article <https://www.maketecheasier.com/install-software-in-various-linux-distros/>`_ useful.
+
+To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
Release binaries
*********************
-At this time, binary packages are only released for Debian and Ubuntu. Find and download the ScummVM version that corresponds to your operating system and architecture. To install a ``.deb`` package:
+At this time, binary packages are only released for Debian and Ubuntu. Find and download the ScummVM version that corresponds to your operating system and architecture. To install a ``.deb`` package, either double click on the downloaded ``.deb`` file to use the graphical installer, or, if that's not available, use the command line.
.. code:: bash
- sudo apt install /path/to/package/name.deb
+ sudo apt install /path/to/downloaded/file.deb
-In this situation, replace the ``/path/to/package/name.deb`` with the actual path to the downloaded ``.deb`` package. The APT software manager will handle the installation.
+Replace ``/path/to/downloaded/file.deb`` with the actual path to the downloaded ``.deb`` package. The APT software manager will handle the installation.
To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
@@ -91,11 +93,18 @@ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through
Windows
---------
-The easiest way to install ScummVM is to download the Windows installer. This installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop. To run ScummVM, navigate to desktop and double click the ScummVM shortcut. To run ScummVM from the Start menu, go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Programs > Games > ScummVM**.
+There are two ways to install ScummVM onto a computer running Windows; download and use the installer, or install manually.
+
+Installer
+************
+
+Download the Windows installer for your operating system, and double click the downloaded file. The installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
+
+To run ScummVM, either navigate to desktop and double click the ScummVM shortcut, or go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Apps > ScummVM**.
-Alternatively, download the Windows zipped file appropriate to your operating system (32bit or 64bit). To unzip the contents, right-click the folder, select Extract All, and then follow the instructions. To run ScummVM from this folder, find the ``scummvm.exe`` file and double click it.
+Manual
+**********
-Next steps
------------
+Download the Windows ``.zip`` file for your operating system (32bit or 64bit). To unzip the contents, right-click the folder and select **Extract All**.
-ScummVM is now installed and ready to :doc:`add and play games <../using_scummvm/add_play_games>`.
+To run ScummVM from the extracted folder, find the ``scummvm.exe`` file and double click it.
diff --git a/doc/docportal/images/cloud_and_lan/lan_server_running.png b/doc/docportal/images/cloud_and_lan/lan_server_running.png
new file mode 100644
index 0000000000..82b3d4e619
Binary files /dev/null and b/doc/docportal/images/cloud_and_lan/lan_server_running.png differ
diff --git a/doc/docportal/settings/accessibility.rst b/doc/docportal/settings/accessibility.rst
index 215e708dcc..28d2f5be1f 100644
--- a/doc/docportal/settings/accessibility.rst
+++ b/doc/docportal/settings/accessibility.rst
@@ -2,15 +2,10 @@
Accessibility
=================
-Overview
-===========
+Use the Accessibility tab to change accessibility settings.
-The Accessibility tab
-----------------------
+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, go to **Options**, click the red **>** until the Accessibility tab is visible, then go to **Accessibility**.
-
-Use this tab to change accessibility settings.
.. figure:: ../images/settings/accessibility.png
diff --git a/doc/docportal/settings/audio.rst b/doc/docportal/settings/audio.rst
index 247064220b..69052b05dd 100644
--- a/doc/docportal/settings/audio.rst
+++ b/doc/docportal/settings/audio.rst
@@ -2,11 +2,18 @@
Audio
===============
-
Audio settings are found in 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.
+
+**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.
+
For a comprehensive look at how to use ScummVM's extensive audio settings, check out our :doc:`../advanced_topics/understand_audio` guide.
.. _audiotab:
@@ -14,7 +21,7 @@ For a comprehensive look at how to use ScummVM's extensive audio settings, check
The Audio tab
-----------------
-Use the audio tab to change the sound output for games.
+Use the Audio tab to change the sound output for games.
.. figure:: ../images/settings/audio.png
@@ -30,7 +37,7 @@ Use the audio tab to change the sound output for games.
.. _device:
-**Preferred device (global settings)** or **Music device (game-specific settings)**
+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*
@@ -44,7 +51,7 @@ AdLib Emulator
.. _speechmute:
-**Text and Speech**
+Text and Speech
For games with digitized speech, this setting allows the user to decide whether to play the game with speech only, subtitles only, or both.
*speech_mute*
@@ -53,7 +60,7 @@ AdLib Emulator
.. _talkspeed:
-**Subtitle speed**
+Subtitle speed
Adjusts the length of time that the subtitles are displayed on screen. The lower the speed is set, the longer the subtitles are displayed.
*talkspeed*
@@ -65,40 +72,40 @@ AdLib Emulator
The Volume tab
-----------------
-Use the volume tab to set the relative volumes for various sounds.
+Use the Volume tab to set the relative volumes for various sounds.
.. figure:: ../images/settings/volume_game.png
- The Audio tab in the game-specific settings.
+ The Volume tab in the game-specific settings.
,,,,,,,,,,,,,
.. _music:
-**Music volume**
+Music volume
Adjusts the volume of the music in the game.
*music_volume*
.. _sfx:
-**SFX volume**
+SFX volume
Adjusts the volume of the sound effects in the game.
*sfx_volume*
.. _speechvol:
-**Speech volume**
+Speech volume
Adjusts the volume of the digitized speech in the game, if it has any.
*speech_volume*
.. _mute:
-**Mute All**
+Mute All
Mutes all game audio.
*mute*
@@ -122,14 +129,14 @@ Use the MIDI tab to change the settings of General MIDI devices.
.. _gm:
-**GM Device**
+GM Device
Specifies a preferred General MIDI (GM) device, which ScummVM uses if the **Preferred device** is set to **<default>** and General MIDI playback is required.
*gm_device*
.. _soundfont:
-**Soundfont**
+Soundfont
Specifies the path to a soundfont file, if this is required by the GM device.
*soundfont*
@@ -143,7 +150,7 @@ Mixed AdLib/MIDI mode
.. _gain:
-**MIDI gain**
+MIDI gain
Adjusts the relative volume of the MIDI music. This is only supported by some music devices.
*midi_gain*
@@ -152,7 +159,7 @@ Mixed AdLib/MIDI mode
FluidSynth
-************************************************************************
+****************\
Opens a new dialog, with three further tabs:
`Reverb`_ | `Chorus`_ | `Misc`_
@@ -160,7 +167,7 @@ Opens a new dialog, with three further tabs:
.. figure:: ../images/settings/fluidsynth.png
- The FluidSynth dialog, from the MIDI tab.
+ The FluidSynth dialog, reached from the MIDI tab.
_`Reverb`
@@ -269,7 +276,7 @@ Interpolation
.. _mt32tab:
The MT-32 tab
-----------------------------------------------------
+-----------------
Use the MT-32 tab to change the settings of MT-32 devices.
@@ -290,14 +297,14 @@ MT-32 Device
.. _nativemt32:
**True Roland MT-32 (disable GM emulation)**
- Enable this option only if you are using an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500 or other MT-32 compatible device. Note that this cannot be used in conjuntion with the Roland GS device option.
+ Tells ScummVM that the MIDI device is an actual Roland MT-32, LAPC-I, CM-64, CM-32L, CM-500 or other MT-32 device. Note that this cannot be used in conjuntion with the Roland GS device option.
*native_mt32*
.. _gs:
**Roland GS device (enable MT-32 mappings)**
- Enable this option if you are using a GS device that has an MT-32 map, such as an SC-55, SC-88 or SC-8820. Note that this cannot be used in conjunction with the True Roland MT-32 option.
+ 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.
diff --git a/doc/docportal/settings/cloud.rst b/doc/docportal/settings/cloud.rst
index b72ecc4f78..c0e1daa466 100644
--- a/doc/docportal/settings/cloud.rst
+++ b/doc/docportal/settings/cloud.rst
@@ -2,15 +2,11 @@
Cloud
================
-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.
-
+Use the Cloud tab to manage connected cloud storage services.
-The Cloud tab
-----------------
-
-From the Launcher, go to **Options**, click the red **>** until the Cloud tab is visible, then go to **Cloud**.
+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.
-Use the cloud tab to manage connected cloud storage services.
+From the Launcher, select :guilabel:`Options`, click the red :guilabel:`>` until the Cloud tab is visible, and then select the :guilabel:`Cloud` tab.
.. figure:: ../images/settings/cloud.png
diff --git a/doc/docportal/settings/control.rst b/doc/docportal/settings/control.rst
index ba5791aa50..1d3dca1f90 100644
--- a/doc/docportal/settings/control.rst
+++ b/doc/docportal/settings/control.rst
@@ -2,10 +2,9 @@
Control
=================
-The Control tab
-----------------
+Use the Control tab to change aspects of joystick controls. This tab is only available when a joystick or game controller is connected, or for certain touch screen enabled platforms.
-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.
.. figure:: ../images/settings/control.png
diff --git a/doc/docportal/settings/engine.rst b/doc/docportal/settings/engine.rst
index 8f7d3b1d47..d78f4c1137 100644
--- a/doc/docportal/settings/engine.rst
+++ b/doc/docportal/settings/engine.rst
@@ -2,18 +2,14 @@
Engine
=====================
-Engine settings are those settings that are unique to a particular game or game engine. To find out which engine powers your game, have a look at the Supported Games `Wiki page
-<https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_.
-
-Engines: ADL_ | AGI_ | BLADERUNNER_ | CGE_ | CINE_ | DRASCULA_ | DREAMWEB_ | HDB_ | HOPKINS_ | KYRA_ | LURE_ | MADS_ | NEVERHOOD_ | SCI_ | SCUMM_ | SHERLOCK_ | SKY_ | SUPERNOVA_ | TOLTECS_ | WINTERMUTE_ | XEEN_ |
-
+Use the Engine tab to change settings that are unique to the game being played.
-The Engine tab
---------------
+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.
-Choose a game, then go to **Edit Game > Engine**. Note that 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>`_.
-Use the engine tab to change settings that are unique to the game being played. Only available settings are shown.
+Engines: ADL_ | AGI_ | BLADERUNNER_ | CGE_ | CINE_ | DRASCULA_ | DREAMWEB_ | HDB_ | HOPKINS_ | KYRA_ | LURE_ | MADS_ | NEVERHOOD_ | SCI_ | SCUMM_ | SHERLOCK_ | SKY_ | SUPERNOVA_ | TOLTECS_ | WINTERMUTE_ | XEEN_ |
.. figure:: ../images/settings/engine.png
@@ -26,6 +22,7 @@ Use the engine tab to change settings that are unique to the game being played.
ADL
*****
+
.. _ntsc:
TV emulation
@@ -36,7 +33,7 @@ TV emulation
.. _color:
Color Graphics
- Uses color graphics instead of monochrome.
+ Uses color graphics instead of monochrome graphics.
*color*
@@ -50,7 +47,7 @@ Show scanlines
.. _mono:
Always use sharp monochrome text
- Does not emulate NTSC artifacts for text
+ Does not emulate NTSC artifacts for text.
*monotext*
@@ -64,7 +61,7 @@ AGI
.. _osl:
Use original save/load screens
- Uses the original save and load dialogs instead of the ScummVM ones
+ Uses the original save/load screens instead of the ScummVM screens.
*originalsaveload*
@@ -113,28 +110,28 @@ BLADERUNNER
.. _sitcom:
Sitcom mode
- Adds laughter after actor's line or narration
+ Adds laughter after the actor's line or narration.
*sitcom*
.. _shorty:
Shorty mode
- Shrinks the actors and makes their voices high pitched
+ Shrinks the actors and makes their voices high pitched.
*shorty*
.. _nodelay:
Frame limiter high performance mode
- Avoids use of delayMillis() function. This mode may result in high CPU usage.
+ Avoids use of ``delayMillis()`` function. This mode may result in high CPU usage.
*nodelaymillisfl*
.. _fpsfl:
Max frames per second limit
- Targets a maximum of 120 fps. When disabled, the game targets 60 fps.
+ Targets a maximum of 120 frames per second (fps). When disabled, the game targets 60 fps.
*frames_per_secondfl*
@@ -155,7 +152,7 @@ CGE
.. _blind:
Color Blind Mode
- Enables Color Blind Mode by default
+ Enables Color Blind Mode by default.
*enable_color_blind*
@@ -167,7 +164,7 @@ CINE
*********
Use original save/load screen
- Uses the original save/load screens instead of the ScummVM one
+ Uses the original save/load screens instead of the ScummVM screens.
*originalsaveload*
@@ -186,7 +183,7 @@ DRASCULA
*************
Use original save/load screens
- Uses the original save and load screens instead of the ScummVM ones
+ Uses the original save/load screens instead of the ScummVM screens.
*originalsaveload*
@@ -198,7 +195,7 @@ DREAMWEB
**********
Use original save/load screens
- Uses the original save and load screens instead of the ScummVM ones.
+ Uses the original save/load screens instead of the ScummVM screens.
*originalsaveload*
@@ -261,7 +258,7 @@ Skip support
.. _helium:
Enable helium mode
- Makes people sound like they've inhaled Helium.
+ Makes characters sound like they inhaled Helium.
*helium_mode*
@@ -275,7 +272,7 @@ Enable smooth scrolling when walking
.. _floating:
Enable floating cursors
- Changes the cursor when it floats to the edge of the screen to a directional arrow. The player can then click to walk towards that direction.
+ Changes the cursor when it floats to the edge of the screen to a directional arrow. Click to walk in that direction.
*floating_cursors*
@@ -363,7 +360,7 @@ NEVERHOOD
************
Use original save/load screens
- Uses the original save and load screens instead of the ScummVM ones
+ Uses the original save/load screens instead of the ScummVM screens.
*originalsaveload*
@@ -403,7 +400,7 @@ SCI
.. _dither:
Skip EGA dithering pass (full color backgrounds)
- Skips dithering pass in EGA games, graphics are shown with full colors
+ Skips dithering pass in EGA games. Graphics are shown with full colors.
*disable_dithering*
@@ -443,7 +440,7 @@ Prefer digital sound effects
*prefer_digitalsfx*
Use original save/load screens
- Uses the original save/load screens instead of the ScummVM ones.
+ Uses the original save/load screens instead of the ScummVM screens.
*originalsaveload*
@@ -464,7 +461,7 @@ Use CD audio
.. _wincursors:
Use Windows cursors
- Uses the Windows cursors (smaller and monochrome) instead of the DOS cursors.
+ Uses the Windows cursor (smaller and monochrome) instead of the DOS cursor.
*windows_cursors*
@@ -506,7 +503,7 @@ Show Object Line
.. _classic:
Use NES Classic Palette
- Uses a more neutral color palette that closely emulates the NES Classic
+ Uses a more neutral color palette that closely emulates the NES Classic.
*mm_nes_classic_palette*
@@ -518,7 +515,7 @@ SHERLOCK
*********
Use original load/save screens
- Uses the original save and load screens instead of the ScummVM ones"),
+ Uses the original save/load screens instead of the ScummVM screens.
*originalsaveload*
@@ -598,7 +595,7 @@ TOLTECS
**************
Use original save/load screens
- Uses the original save and load screens instead of the ScummVM ones
+ Uses the original save/load screens instead of the ScummVM screens.
*originalsaveload*
@@ -640,7 +637,7 @@ Show item costs in standard inventory mode
.. _durable:
More durable armor
- Armor won't break until character is at -80HP, rather than -10HP.
+ Armor won't break until character is at -80HP, instead of the default -10HP.
*DurableArmor*
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index 4897fc1e68..a6254ccc8b 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -2,13 +2,11 @@
Game
=============
-The Game tab
----------------
+Use the Game tab to display and change information about how the game is
+identified by ScummVM.
-Choose a game, then go to **Edit Game**.
+From the Launcher, highlight a game on the games list, then select :guilabel:`Edit Game`. The :guilabel:`Game` tab is the first tab shown.
-Use the game tab to display and change information about how the game is
-identified by ScummVM.
.. figure:: ../images/settings/game.png
diff --git a/doc/docportal/settings/graphics.rst b/doc/docportal/settings/graphics.rst
index a2141ddc99..b42a05376d 100644
--- a/doc/docportal/settings/graphics.rst
+++ b/doc/docportal/settings/graphics.rst
@@ -2,14 +2,17 @@
Graphics
===============
-The Graphics tab
------------------
+Use the Graphics tab to change how games look when they are played.
-To change settings globally, go to **Options > Graphics**. To change settings for a game, select the game, then go to **Edit Game > Graphics**.
+**To change settings globally:**
-Use the graphics tab to change how games look when they are played.
+ From the Launcher, select :guilabel:`Options`. The :guilabel:`Graphics` tab is the first tab shown.
-For a comprehensive look at how to use these settings, check out our :doc:`../guides/understand_graphics` guide.
+**To change settings for a specific game:**
+
+ Highlight the game in the games list, select :guilabel:`Edit Game` then select the :guilabel:`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
@@ -28,7 +31,7 @@ Graphics mode
.. _render:
Render mode
- Changes how the game is rendered, which affects how the game looks.
+ Changes how the game is rendered.
*render_mode*
diff --git a/doc/docportal/settings/keymaps.rst b/doc/docportal/settings/keymaps.rst
index 536a388c39..be77cdb8c1 100644
--- a/doc/docportal/settings/keymaps.rst
+++ b/doc/docportal/settings/keymaps.rst
@@ -2,12 +2,15 @@
Keymaps
===============
-The Keymaps tab
-----------------
+Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or mouse or joystick buttons.
-To change settings globally, go to **Options > Keymaps**. To change settings for a game, select the game, then go to **Edit Game > Keymaps**.
+**To change settings globally:**
-Use the keymaps tab to assign actions to keyboard keys or shortcuts, or mouse or joystick buttons.
+ From the Launcher, select :guilabel:`Options`, then select the :guilabel:`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.
.. figure:: ../images/settings/keymaps.png
@@ -19,7 +22,7 @@ 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 dropdown expander for further options.
+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.
If all the mapped keys are not visible, hold the pointer over the red box to see all the mapped keys.
@@ -30,4 +33,244 @@ Reset to defaults
Resets the keymaps for that action to default.
Clear mapping
- Clears all keymaps for that action.
\ No newline at end of file
+ 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*
+
+.. _mute:
+
+Toggle mute
+ *keymap_global_MUTE*
+
+.. _globalquit:
+
+Quit
+ *keymap_global_QUIT*
+
+.. _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-*
+
+.. _FLT1:
+
+Switch to nearest neighbour scaling
+ *keymap_sdl-graphics_FLT1*
+
+.. _FLT2:
+
+Switch to AdvMame 2x/3x scaling
+ *keymap_sdl-graphics_FLT2*
+
+.. _FLT3:
+
+Switch to HQ 2x/3x scaling
+ *keymap_sdl-graphics_FLT3*
+
+.. _FLT4:
+
+Switch to 2XSai scaling
+ *keymap_sdl-graphics_FLT4*
+
+.. _FLT5:
+
+Switch to Super2xSai scaling
+ *keymap_sdl-graphics_FLT5*
+
+.. _FLT6:
+
+Switch to SuperEagle scaling
+ *keymap_sdl-graphics_FLT6*
+
+.. _FLT7:
+
+Switch to TV 2x scaling
+ *keymap_sdl-graphics_FLT7*
+
+.. _FLT8:
+
+Switch to DotMatrix scaling
+ *keymap_sdl-graphics_FLT8*
+
+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*
\ No newline at end of file
diff --git a/doc/docportal/settings/lan.rst b/doc/docportal/settings/lan.rst
index 83d39a6c01..6f4a17e7bb 100644
--- a/doc/docportal/settings/lan.rst
+++ b/doc/docportal/settings/lan.rst
@@ -2,18 +2,11 @@
LAN
==============
-Overview
-============
+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.
-The LAN tab
-------------
-
-From the Launcher, go to **Options**, click the red **>** until the LAN tab is visible, then go to **LAN**.
-
-Use the LAN tab to control 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.
.. figure:: ../images/settings/LAN.png
diff --git a/doc/docportal/settings/misc.rst b/doc/docportal/settings/misc.rst
index 487c02c2ee..86777a713a 100644
--- a/doc/docportal/settings/misc.rst
+++ b/doc/docportal/settings/misc.rst
@@ -2,15 +2,9 @@
Miscellaneous
======================
-Overview
-==========
+Use the Misc tab to change miscellaneous settings that don’t belong on any of the other tabs.
-The Miscellaneous tab
---------------------------
-
-From the Launcher, go to **Options**, click the red **>**, and then go to **Misc**.
-
-The Misc tab contains options 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.
.. figure:: ../images/settings/misc.png
diff --git a/doc/docportal/settings/paths.rst b/doc/docportal/settings/paths.rst
index 5075134fed..2a18d2dafc 100644
--- a/doc/docportal/settings/paths.rst
+++ b/doc/docportal/settings/paths.rst
@@ -2,13 +2,15 @@
Paths
==============
-Overview
-============
+Use the Paths tab to tell ScummVM where to look for files.
-The Paths tab
----------------
+**To change settings globally:**
-Use the paths tab to tell ScummVM where to look for files.
+ From the Launcher, select :guilabel:`Options`, then select the :guilabel:`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.
.. figure:: ../images/settings/paths.png
diff --git a/doc/docportal/using_scummvm/add_play_games.rst b/doc/docportal/using_scummvm/add_play_games.rst
index 8d2f5b4d45..c73b624c65 100644
--- a/doc/docportal/using_scummvm/add_play_games.rst
+++ b/doc/docportal/using_scummvm/add_play_games.rst
@@ -8,7 +8,7 @@ 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.
-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 <gog.com>`_ and `Steam <https://store.steampowered.com/>`_.
+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!
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.
@@ -45,17 +45,20 @@ ScummVM needs access to the data files for each game. A comprehensive list of re
For games on floppies or CDs:
- If the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above.
-- If the data files are not accessible, run the installer on the platform the game was designed for, to extract the individual files.
+- 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 such as `GOG.com <gog.com>`__, `Steam <https://store.steampowered.com>`__, or from various `freeware sources <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games#Freeware_Games>`__ sources:
+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:
+
+- Run the installer to extract the game files, or
+- If the data files are supplied as a ``.zip`` archive, extract the archive.
+
+For macOS or Linux users without access to a Windows machine, it is possible to get the game files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer on macOS or Linux. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.
-- Run the installer, or
-- If the data files are supplied as a .zip file, extract the archive.
.. tip::
- A great way to share game files and automatically back up and sync your saved game states between devices is to connect a Cloud storage service to ScummVM. For detailed instructions see the :doc:`../using_scummvm/connect_cloud` guide.
+ 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.
@@ -73,7 +76,7 @@ ScummVM needs access to all the data files, so it will not be able to run direct
CD audio
**********
-Some games contain one or more separate audio tracks on CD. To use these with ScummVM, they need to be extracted from the CD in ``.wav`` or ``.aiff`` format, and then converted to either ``.mp3``, ``.flac`` or ``.ogg`` file formats.
+Some games contain one or more separate audio tracks on CD. To use these with ScummVM, extract the audio tracks from the CD in ``.wav`` or ``.aiff`` format, and then convert them to either ``.mp3``, ``.flac`` or ``.ogg`` file formats.
.. tip::
diff --git a/doc/docportal/using_scummvm/connect_cloud.rst b/doc/docportal/using_scummvm/connect_cloud.rst
index 79296457c1..3a61ced97b 100644
--- a/doc/docportal/using_scummvm/connect_cloud.rst
+++ b/doc/docportal/using_scummvm/connect_cloud.rst
@@ -1,9 +1,9 @@
===============================
-Connect a Cloud service
+Connect a cloud service
===============================
-From the Launcher, go to **Options > Cloud**.
-
+From the Launcher, select :guilabel:`Options`, click the red :guilabel:`>` until the Cloud tab is visible, and then select the :guilabel:`Cloud` tab.
+
To connect your chosen cloud storage service to ScummVM, select it from the **Active storage** dropdown.
.. figure:: ../images/cloud_and_lan/cloud_storage.png
@@ -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 box next to the **Paste** button, and then click the **Paste** button.
+Copy the 6-digit code, click into the empty field next to :guilabel:`Paste`, and then click :guilabel:`Paste`.
.. figure:: ../images/cloud_and_lan/cloud_connect.png
-Click **3. Connect**, then, once the next information loads, click on **Enable storage**.
+Click :guilabel:`3. Connect`. Once the next page loads, click :guilabel:`Enable storage`.
.. figure:: ../images/cloud_and_lan/cloud_enable.png
-Saved games automatically sync on launch, after saving, and on loading a saved game. You can also manually sync by using the **Sync now** button.
+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.
-To download the game files from your cloud ScummVM folder, click **Download game files**.
+To download the game files from your cloud ScummVM folder, click :guilabel:`Download game files`.
-To change to a different cloud account, or to disconnect your cloud account from ScummVM, click **Disconnect**.
\ No newline at end of file
+To change to a different cloud account, or to disconnect your cloud account from ScummVM, click :guilabel:`Disconnect`.
\ No newline at end of file
diff --git a/doc/docportal/using_scummvm/how_to_settings.rst b/doc/docportal/using_scummvm/how_to_settings.rst
index d037f0a2b4..c89bf2ad66 100644
--- a/doc/docportal/using_scummvm/how_to_settings.rst
+++ b/doc/docportal/using_scummvm/how_to_settings.rst
@@ -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, go to **Options** and select the tab containing the setting you would like to change.
+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 for just one game, select the game, then go to **Edit Game** and select the tab containing the setting you would like to change. To make the game use the settings on that tab instead of the global settings, select **Override global settings**.
+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**.
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.
diff --git a/doc/docportal/using_scummvm/keyboard_shortcuts.rst b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
index 76f17f3de9..48e88ce28c 100755
--- a/doc/docportal/using_scummvm/keyboard_shortcuts.rst
+++ b/doc/docportal/using_scummvm/keyboard_shortcuts.rst
@@ -15,18 +15,18 @@ Default keyboard shortcuts
:widths: 30 70
Shortcut, Description
- :kbd:`Ctrl + F5` ,Displays the Global Menu
- :kbd:`Cmd + q` ,Quit (Mac OS X)
- :kbd:`Ctrl + q` ,Quit (other unices including Linux)
- :kbd:`Alt + F4`,Quit (Windows)
- :kbd:`Ctrl + z`,Quit (other platforms)
- :kbd:`Ctrl + u` ,Mutes all sounds
- :kbd:`Ctrl + m` ,Toggles mouse capture
- :kbd:`Ctrl + Alt + 1-8` ,Switches between graphics filters
- :kbd:`Ctrl + Alt` and :kbd:`+` or :kbd:`-`,Increases/decreases the scale factor
- :kbd:`Ctrl + Alt + a` ,Toggles aspect ratio correction on/off
- :kbd:`Ctrl + Alt + f` ,Toggles between nearest neighbor and bilinear interpolation (graphics filtering on/off)
- :kbd:`Ctrl + Alt + s` ,Cycles through stretch modes
- :kbd:`Alt + Enter` ,Toggles full screen/windowed
- :kbd:`Alt + s` ,Takes a screenshot (SDL backend only)
- :kbd:`Ctrl + F7`,"Opens virtual keyboard (if enabled). This can also be opened with a long press of the middle mouse button or wheel."
+ :kbd:`Ctrl+F5` ,Displays the Global Main Menu
+ :kbd:`Cmd+q` ,Quit (macOS)
+ :kbd:`Ctrl+q` ,Quit (Linux/Unix)
+ :kbd:`Alt+F4`,Quit (Windows)
+ :kbd:`Ctrl+z`,Quit (other platforms)
+ :kbd:`Ctrl+u` ,Mutes all sounds
+ :kbd:`Ctrl+m` ,Toggles mouse capture
+ :kbd:`Ctrl+Alt+ 1-8` ,Switches between graphics filters
+ :kbd:`Ctrl+Alt` and :kbd:`+` or :kbd:`-`,Increases/decreases the scale factor
+ :kbd:`Ctrl+Alt+a` ,Toggles aspect ratio correction on/off
+ :kbd:`Ctrl+Alt+f` ,Toggles between nearest neighbor and bilinear interpolation (graphics filtering on/off)
+ :kbd:`Ctrl+Alt+s` ,Cycles through stretch modes
+ :kbd:`Alt+Enter` ,Toggles full screen/windowed mode
+ :kbd:`Alt+s` ,Takes a screenshot
+ :kbd:`Ctrl+F7`,"Opens virtual keyboard (if enabled). This can also be opened with a long press of the middle mouse button or wheel."
diff --git a/doc/docportal/using_scummvm/local_webserver.rst b/doc/docportal/using_scummvm/local_webserver.rst
index 74c783012b..21985de8e1 100644
--- a/doc/docportal/using_scummvm/local_webserver.rst
+++ b/doc/docportal/using_scummvm/local_webserver.rst
@@ -1,36 +1,41 @@
==============================
-Set up a local webserver
+Set up a local web server
==============================
-ScummVM has the ability to run a local webserver, to make the transfer of game files easier.
+ScummVM can run a local web server, to allow the transfer of files between devices on the same network.
How to use the web server
----------------------------
-Go to **Options > LAN**. You may need to use the red **>** button to bring the LAN tab into view.
+From the Launcher, select :guilabel:`Options`, click the red :guilabel:`>` until the LAN tab is visible, and then select the :guilabel:`LAN` tab.
-Click **Run server**.
-.. figure:: ../images/settings/LAN.png
+Click :guilabel:`Run server` to start the server.
- The LAN tab.
+.. figure:: ../images/cloud_and_lan/lan_server_running.png
+
+ The LAN tab, with the server running.
To access the server, type the URL shown into the address bar of any web browser:
.. figure:: ../images/settings/LAN_server.png
- The server running in the browser.
+ The server's browser interface.
-To download a file, click on the file you wish to download. A system download dialog box opens.
+To download a file, click on the file. A system download dialog box opens.
To create a new directory, click **Create Directory**.
.. figure:: ../images/settings/LAN_server_new.png
- Creating a new directory.
+ Create a new directory.
-To upload files, click **Upload Files** and select files from the system file explorer.
+To upload files, click **Upload Files** and select files from the system file browser.
.. figure:: ../images/settings/LAN_server_upload.png
- Uploading files.
+ 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 stop the web server, either click :guilabel:`Stop server` or click :guilabel:`Ok` to close the settings dialog.
Commit: 711fa2422f36ac586b4d29c4d96ef41b51023624
https://github.com/scummvm/scummvm/commit/711fa2422f36ac586b4d29c4d96ef41b51023624
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: removes double up info from bug reporting
Changed paths:
doc/docportal/help/report_bugs.rst
diff --git a/doc/docportal/help/report_bugs.rst b/doc/docportal/help/report_bugs.rst
index ade495b787..26b3e047d0 100644
--- a/doc/docportal/help/report_bugs.rst
+++ b/doc/docportal/help/report_bugs.rst
@@ -5,42 +5,42 @@ Report a bug
To report a bug, go to the ScummVM `Issue Tracker <https://bugs.scummvm.org/>`_ and log in with your GitHub account.
-Please make sure the bug is reproducible, and still occurs in the latest git/Daily build version. Also check the `compatibility list <https://www.scummvm.org/compatibility/>`_ for that game, to ensure the issue is not already known.
-Please do not report bugs for games that are not listed as being completeable on the `Supported Games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ wiki page, or on the compatibility list. We know those games have bugs.
+.. _logfile:
-Please include the following information in the bug report:
+The ScummVM log file
+=====================
-- ScummVM version (PLEASE test the latest git/Daily build)
-- Bug details, including instructions for how to reproduce the bug
-- Language of the game
-- Version of the game (talkie, floppy, and so on)
-- Platform and Compiler (Win32, Linux, FreeBSD, and so on)
-- Attach a saved game if possible
-- If this bug only occurred recently, please note the last version without the bug, and the first version including the bug. That way we can fix it quicker by looking at the changes made.
+To help you report a bug, you can find error messages in the ScummVM log file. The location of this file varies depending on your operating system.
-Finally, please report each issue separately; do not file multiple issues on the same ticket. It gets difficult to track the status of each individual bug when they aren't on their own tickets.
-.. _logfile:
+.. tabbed:: macOS
-The ScummVM log file
-=====================
+ .. panels::
+ :column: col-lg-12 mb-2
+
+ ``~/Library/Logs/scummvm.log``, where ``~`` is your Home directory.
+
+.. tabbed:: Linux
-You can find error messages in the ScummVM log file. The location of this file varies depending on your operating system.
+ .. panels::
+ :column: col-lg-12 mb-2
-.. tabs::
+ We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location may vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
- .. tab:: Linux
+.. tabbed:: Windows
- We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location may vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
+ .. panels::
+ :column: col-lg-12 mb-2
+ Window Vista/7/8/10
+ ^^^^^^^^^^^^^^^^^^^^^^
+
+ ``\Users\username\AppData\Roaming\ScummVM\scummvm.log``
- .. tab:: Windows
+ .. tip::
- ``%appdata%\ScummVM\Logs\scummvm.log``
+ The AppData folder is hidden. The steps to view hidden files and folders depends on the Windows version.
-
- .. tab:: macOS
- ``~/Library/Logs/scummvm.log``, where ``~`` is your Home directory.
-
+ For more information, see the `Windows support page <https://support.microsoft.com/en-us/help/14201/windows-show-hidden-files>`_.
\ No newline at end of file
Commit: fd6af8966335e674da8998105a9aacd744891eb9
https://github.com/scummvm/scummvm/commit/fd6af8966335e674da8998105a9aacd744891eb9
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: fixes link
Changed paths:
doc/docportal/other_platforms/risc_os.rst
diff --git a/doc/docportal/other_platforms/risc_os.rst b/doc/docportal/other_platforms/risc_os.rst
index 12a4a38a5b..7b3c9bdbe3 100644
--- a/doc/docportal/other_platforms/risc_os.rst
+++ b/doc/docportal/other_platforms/risc_os.rst
@@ -56,7 +56,7 @@ For more information about settings, see the Settings section of the documentati
.. _reporter:
-There is one additional configuration option, *enable_reporter*. When set to true in :doc:`../advanced_options/configuration_file`, log messages are sent to the `!Reporter <http://www.avisoft.force9.co.uk/Reporter.html>`_ application, which can be useful to developers.
+There is one additional configuration option, *enable_reporter*. When set to true in :doc:`../advanced_topics/configuration_file`, log messages are sent to the `!Reporter <http://www.avisoft.force9.co.uk/Reporter.html>`_ application, which can be useful to developers.
Known issues
Commit: fb3f2dad63c8ae7b671fedaeb052d692be07fca4
https://github.com/scummvm/scummvm/commit/fb3f2dad63c8ae7b671fedaeb052d692be07fca4
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: change Getting Started to Get Started.
Changed paths:
A doc/docportal/get_started/android.rst
A doc/docportal/get_started/ios.rst
A doc/docportal/get_started/mac_linux_windows.rst
R doc/docportal/getting_started/android.rst
R doc/docportal/getting_started/ios.rst
R doc/docportal/getting_started/mac_linux_windows.rst
doc/docportal/index.rst
diff --git a/doc/docportal/getting_started/android.rst b/doc/docportal/get_started/android.rst
similarity index 100%
rename from doc/docportal/getting_started/android.rst
rename to doc/docportal/get_started/android.rst
diff --git a/doc/docportal/getting_started/ios.rst b/doc/docportal/get_started/ios.rst
similarity index 100%
rename from doc/docportal/getting_started/ios.rst
rename to doc/docportal/get_started/ios.rst
diff --git a/doc/docportal/getting_started/mac_linux_windows.rst b/doc/docportal/get_started/mac_linux_windows.rst
similarity index 100%
rename from doc/docportal/getting_started/mac_linux_windows.rst
rename to doc/docportal/get_started/mac_linux_windows.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 1c28c7d20e..4da9610842 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -4,9 +4,9 @@
:maxdepth: 2
:hidden:
- getting_started/mac_linux_windows
- getting_started/android
- getting_started/ios
+ get_started/mac_linux_windows
+ get_started/android
+ get_started/ios
.. toctree::
@@ -109,11 +109,11 @@ We have guides available to show you :column: mb-4 how to get ScummVM up and run
Getting started
^^^^^^^^^^^^
- :doc:`getting_started/mac_linux_windows`
+ :doc:`get_started/mac_linux_windows`
- :doc:`getting_started/ios`
+ :doc:`get_started/ios`
- :doc:`getting_started/android`
+ :doc:`get_started/android`
---
:column: col-lg-6
Commit: 6d553eb5f93f5e58d3fb9ff0ff67d705064ef484
https://github.com/scummvm/scummvm/commit/6d553eb5f93f5e58d3fb9ff0ff67d705064ef484
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: final drafts
- final drafts Quickstart, Use, Settings, and Advanced topics sections
- renames some files/folders and updates links
Changed paths:
A doc/docportal/use_scummvm/LAN.rst
A doc/docportal/use_scummvm/add_play_games.rst
A doc/docportal/use_scummvm/connect_cloud.rst
A doc/docportal/use_scummvm/how_to_settings.rst
A doc/docportal/use_scummvm/keyboard_shortcuts.rst
A doc/docportal/use_scummvm/save_load_games.rst
A doc/docportal/use_scummvm/the_launcher.rst
R doc/docportal/using_scummvm/add_play_games.rst
R doc/docportal/using_scummvm/connect_cloud.rst
R doc/docportal/using_scummvm/how_to_settings.rst
R doc/docportal/using_scummvm/keyboard_shortcuts.rst
R doc/docportal/using_scummvm/local_webserver.rst
R doc/docportal/using_scummvm/save_load_games.rst
R doc/docportal/using_scummvm/the_launcher.rst
doc/docportal/advanced_topics/command_line.rst
doc/docportal/advanced_topics/configuration_file.rst
doc/docportal/advanced_topics/understand_audio.rst
doc/docportal/advanced_topics/understand_graphics.rst
doc/docportal/consoles/nintendo_3ds.rst
doc/docportal/consoles/nintendo_switch.rst
doc/docportal/consoles/playstation_3.rst
doc/docportal/consoles/playstation_portable.rst
doc/docportal/consoles/ps_vita.rst
doc/docportal/contribute/tech_writers.md
doc/docportal/get_started/android.rst
doc/docportal/get_started/ios.rst
doc/docportal/help/faq.rst
doc/docportal/index.rst
doc/docportal/other_platforms/amigaos_4.rst
doc/docportal/other_platforms/atari.rst
doc/docportal/other_platforms/risc_os.rst
doc/docportal/settings/accessibility.rst
doc/docportal/settings/audio.rst
doc/docportal/settings/cloud.rst
doc/docportal/settings/control.rst
doc/docportal/settings/engine.rst
doc/docportal/settings/game.rst
doc/docportal/settings/graphics.rst
doc/docportal/settings/keymaps.rst
doc/docportal/settings/lan.rst
doc/docportal/settings/misc.rst
doc/docportal/settings/paths.rst
diff --git a/doc/docportal/advanced_topics/command_line.rst b/doc/docportal/advanced_topics/command_line.rst
index c64a1e3deb..4577e25ad1 100755
--- a/doc/docportal/advanced_topics/command_line.rst
+++ b/doc/docportal/advanced_topics/command_line.rst
@@ -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"
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index b443607efd..052b9db50d 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -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,
diff --git a/doc/docportal/advanced_topics/understand_audio.rst b/doc/docportal/advanced_topics/understand_audio.rst
index 2ba5c9fbc7..c26e7f6fbb 100644
--- a/doc/docportal/advanced_topics/understand_audio.rst
+++ b/doc/docportal/advanced_topics/understand_audio.rst
@@ -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.
-
-.. note::
+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.
- 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.
diff --git a/doc/docportal/advanced_topics/understand_graphics.rst b/doc/docportal/advanced_topics/understand_graphics.rst
index b7fbede4ec..d5ca949b42 100644
--- a/doc/docportal/advanced_topics/understand_graphics.rst
+++ b/doc/docportal/advanced_topics/understand_graphics.rst
@@ -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`.
\ No newline at end of file
+To toggle between bilinear interpolation and nearest neighbor, press :kbd:`Ctrl+Alt+f`.
\ No newline at end of file
diff --git a/doc/docportal/consoles/nintendo_3ds.rst b/doc/docportal/consoles/nintendo_3ds.rst
index d5750d6034..73c952780e 100644
--- a/doc/docportal/consoles/nintendo_3ds.rst
+++ b/doc/docportal/consoles/nintendo_3ds.rst
@@ -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
diff --git a/doc/docportal/consoles/nintendo_switch.rst b/doc/docportal/consoles/nintendo_switch.rst
index 70b49a45cc..f163abec39 100644
--- a/doc/docportal/consoles/nintendo_switch.rst
+++ b/doc/docportal/consoles/nintendo_switch.rst
@@ -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
diff --git a/doc/docportal/consoles/playstation_3.rst b/doc/docportal/consoles/playstation_3.rst
index e142ec99e6..54aeef72ed 100644
--- a/doc/docportal/consoles/playstation_3.rst
+++ b/doc/docportal/consoles/playstation_3.rst
@@ -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
diff --git a/doc/docportal/consoles/playstation_portable.rst b/doc/docportal/consoles/playstation_portable.rst
index b8112a7e0e..148cb08b66 100644
--- a/doc/docportal/consoles/playstation_portable.rst
+++ b/doc/docportal/consoles/playstation_portable.rst
@@ -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
diff --git a/doc/docportal/consoles/ps_vita.rst b/doc/docportal/consoles/ps_vita.rst
index fb1dc1794c..b38d52f6a9 100644
--- a/doc/docportal/consoles/ps_vita.rst
+++ b/doc/docportal/consoles/ps_vita.rst
@@ -35,9 +35,9 @@ If you're using SD2Vita:
Folders containing game files can be copied into any folder.
-ScummVM on the PS Vita supports :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
diff --git a/doc/docportal/contribute/tech_writers.md b/doc/docportal/contribute/tech_writers.md
index 0091d4b627..c368a1a453 100644
--- a/doc/docportal/contribute/tech_writers.md
+++ b/doc/docportal/contribute/tech_writers.md
@@ -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.
diff --git a/doc/docportal/get_started/android.rst b/doc/docportal/get_started/android.rst
index d36151a60b..85f70be553 100644
--- a/doc/docportal/get_started/android.rst
+++ b/doc/docportal/get_started/android.rst
@@ -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.
+ - 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:`../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
+=============
+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.
diff --git a/doc/docportal/get_started/ios.rst b/doc/docportal/get_started/ios.rst
index 671bff90f2..e945ec0940 100644
--- a/doc/docportal/get_started/ios.rst
+++ b/doc/docportal/get_started/ios.rst
@@ -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
=======
diff --git a/doc/docportal/help/faq.rst b/doc/docportal/help/faq.rst
index 3a0b21aaee..c86ecf0a72 100644
--- a/doc/docportal/help/faq.rst
+++ b/doc/docportal/help/faq.rst
@@ -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`
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 4da9610842..72542b22eb 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -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.
\ No newline at end of file
+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.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/amigaos_4.rst b/doc/docportal/other_platforms/amigaos_4.rst
index 8f6349be84..6599b34ac4 100644
--- a/doc/docportal/other_platforms/amigaos_4.rst
+++ b/doc/docportal/other_platforms/amigaos_4.rst
@@ -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
diff --git a/doc/docportal/other_platforms/atari.rst b/doc/docportal/other_platforms/atari.rst
index 70f10fd5a9..076373417a 100644
--- a/doc/docportal/other_platforms/atari.rst
+++ b/doc/docportal/other_platforms/atari.rst
@@ -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
diff --git a/doc/docportal/other_platforms/risc_os.rst b/doc/docportal/other_platforms/risc_os.rst
index 7b3c9bdbe3..d9e52762c9 100644
--- a/doc/docportal/other_platforms/risc_os.rst
+++ b/doc/docportal/other_platforms/risc_os.rst
@@ -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
diff --git a/doc/docportal/settings/accessibility.rst b/doc/docportal/settings/accessibility.rst
index 28d2f5be1f..507cc5a664 100644
--- a/doc/docportal/settings/accessibility.rst
+++ b/doc/docportal/settings/accessibility.rst
@@ -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
diff --git a/doc/docportal/settings/audio.rst b/doc/docportal/settings/audio.rst
index 69052b05dd..472313142f 100644
--- a/doc/docportal/settings/audio.rst
+++ b/doc/docportal/settings/audio.rst
@@ -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*
+
diff --git a/doc/docportal/settings/cloud.rst b/doc/docportal/settings/cloud.rst
index c0e1daa466..6bfe4ff5e6 100644
--- a/doc/docportal/settings/cloud.rst
+++ b/doc/docportal/settings/cloud.rst
@@ -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::
diff --git a/doc/docportal/settings/control.rst b/doc/docportal/settings/control.rst
index 1d3dca1f90..d17db96ff8 100644
--- a/doc/docportal/settings/control.rst
+++ b/doc/docportal/settings/control.rst
@@ -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
@@ -25,4 +25,10 @@ Pointer Speed
Joy deadzone
Sets the deadzone for an analog joystick. A lower value will reduce the size of the deadzone.
- *joystick_deadzone*
\ No newline at end of file
+ *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`.
\ No newline at end of file
diff --git a/doc/docportal/settings/engine.rst b/doc/docportal/settings/engine.rst
index d78f4c1137..075aba8fed 100644
--- a/doc/docportal/settings/engine.rst
+++ b/doc/docportal/settings/engine.rst
@@ -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.
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index a6254ccc8b..f01e10e992 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -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*
diff --git a/doc/docportal/settings/graphics.rst b/doc/docportal/settings/graphics.rst
index b42a05376d..d39c7932c3 100644
--- a/doc/docportal/settings/graphics.rst
+++ b/doc/docportal/settings/graphics.rst
@@ -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*
diff --git a/doc/docportal/settings/keymaps.rst b/doc/docportal/settings/keymaps.rst
index be77cdb8c1..1bbf743209 100644
--- a/doc/docportal/settings/keymaps.rst
+++ b/doc/docportal/settings/keymaps.rst
@@ -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.
diff --git a/doc/docportal/settings/lan.rst b/doc/docportal/settings/lan.rst
index 6f4a17e7bb..8373aa44ae 100644
--- a/doc/docportal/settings/lan.rst
+++ b/doc/docportal/settings/lan.rst
@@ -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
diff --git a/doc/docportal/settings/misc.rst b/doc/docportal/settings/misc.rst
index 86777a713a..950f852203 100644
--- a/doc/docportal/settings/misc.rst
+++ b/doc/docportal/settings/misc.rst
@@ -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*
diff --git a/doc/docportal/settings/paths.rst b/doc/docportal/settings/paths.rst
index 2a18d2dafc..36915c770e 100644
--- a/doc/docportal/settings/paths.rst
+++ b/doc/docportal/settings/paths.rst
@@ -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*
diff --git a/doc/docportal/using_scummvm/local_webserver.rst b/doc/docportal/use_scummvm/LAN.rst
similarity index 65%
rename from doc/docportal/using_scummvm/local_webserver.rst
rename to doc/docportal/use_scummvm/LAN.rst
index 21985de8e1..9fb9e825cf 100644
--- a/doc/docportal/using_scummvm/local_webserver.rst
+++ b/doc/docportal/use_scummvm/LAN.rst
@@ -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.
diff --git a/doc/docportal/using_scummvm/add_play_games.rst b/doc/docportal/use_scummvm/add_play_games.rst
similarity index 70%
rename from doc/docportal/using_scummvm/add_play_games.rst
rename to doc/docportal/use_scummvm/add_play_games.rst
index c73b624c65..7d9d274b76 100644
--- a/doc/docportal/using_scummvm/add_play_games.rst
+++ b/doc/docportal/use_scummvm/add_play_games.rst
@@ -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.
diff --git a/doc/docportal/using_scummvm/connect_cloud.rst b/doc/docportal/use_scummvm/connect_cloud.rst
similarity index 53%
rename from doc/docportal/using_scummvm/connect_cloud.rst
rename to doc/docportal/use_scummvm/connect_cloud.rst
index 3a61ced97b..91e8a077cc 100644
--- a/doc/docportal/using_scummvm/connect_cloud.rst
+++ b/doc/docportal/use_scummvm/connect_cloud.rst
@@ -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`.
\ No newline at end of file
+To change to a different cloud account, or to disconnect your cloud account from ScummVM, click **Disconnect**.
\ No newline at end of file
diff --git a/doc/docportal/using_scummvm/how_to_settings.rst b/doc/docportal/use_scummvm/how_to_settings.rst
similarity index 76%
rename from doc/docportal/using_scummvm/how_to_settings.rst
rename to doc/docportal/use_scummvm/how_to_settings.rst
index c89bf2ad66..b5891f6721 100644
--- a/doc/docportal/using_scummvm/how_to_settings.rst
+++ b/doc/docportal/use_scummvm/how_to_settings.rst
@@ -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.
diff --git a/doc/docportal/using_scummvm/keyboard_shortcuts.rst b/doc/docportal/use_scummvm/keyboard_shortcuts.rst
similarity index 98%
rename from doc/docportal/using_scummvm/keyboard_shortcuts.rst
rename to doc/docportal/use_scummvm/keyboard_shortcuts.rst
index 48e88ce28c..55bde42357 100755
--- a/doc/docportal/using_scummvm/keyboard_shortcuts.rst
+++ b/doc/docportal/use_scummvm/keyboard_shortcuts.rst
@@ -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
diff --git a/doc/docportal/using_scummvm/save_load_games.rst b/doc/docportal/use_scummvm/save_load_games.rst
similarity index 84%
rename from doc/docportal/using_scummvm/save_load_games.rst
rename to doc/docportal/use_scummvm/save_load_games.rst
index 6ef280a83f..b604bf478d 100644
--- a/doc/docportal/using_scummvm/save_load_games.rst
+++ b/doc/docportal/use_scummvm/save_load_games.rst
@@ -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.
- 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`.
+ 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.
+
+ ``.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/``
diff --git a/doc/docportal/using_scummvm/the_launcher.rst b/doc/docportal/use_scummvm/the_launcher.rst
similarity index 95%
rename from doc/docportal/using_scummvm/the_launcher.rst
rename to doc/docportal/use_scummvm/the_launcher.rst
index a4ffbd5910..b455b6570b 100755
--- a/doc/docportal/using_scummvm/the_launcher.rst
+++ b/doc/docportal/use_scummvm/the_launcher.rst
@@ -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
-----
Commit: 2b9bcd6d7a76c772d652dfc4457eed43ad3bf64e
https://github.com/scummvm/scummvm/commit/2b9bcd6d7a76c772d652dfc4457eed43ad3bf64e
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: final drafts all pages
Changed paths:
doc/docportal/advanced_topics/command_line.rst
doc/docportal/advanced_topics/configuration_file.rst
doc/docportal/advanced_topics/understand_audio.rst
doc/docportal/advanced_topics/understand_graphics.rst
doc/docportal/consoles/nintendo_3ds.rst
doc/docportal/consoles/nintendo_switch.rst
doc/docportal/consoles/playstation_3.rst
doc/docportal/consoles/playstation_portable.rst
doc/docportal/consoles/ps_vita.rst
doc/docportal/consoles/sega_dreamcast.rst
doc/docportal/get_started/android.rst
doc/docportal/get_started/ios.rst
doc/docportal/get_started/mac_linux_windows.rst
doc/docportal/help/contact.rst
doc/docportal/help/faq.rst
doc/docportal/help/report_bugs.rst
doc/docportal/other_platforms/amigaos_4.rst
doc/docportal/other_platforms/atari.rst
doc/docportal/other_platforms/risc_os.rst
doc/docportal/release_notes/release_notes_2.2.0.rst
doc/docportal/settings/audio.rst
doc/docportal/settings/cloud.rst
doc/docportal/settings/control.rst
doc/docportal/settings/engine.rst
doc/docportal/settings/game.rst
doc/docportal/settings/lan.rst
doc/docportal/use_scummvm/add_play_games.rst
doc/docportal/use_scummvm/connect_cloud.rst
doc/docportal/use_scummvm/save_load_games.rst
doc/docportal/use_scummvm/the_launcher.rst
diff --git a/doc/docportal/advanced_topics/command_line.rst b/doc/docportal/advanced_topics/command_line.rst
index 4577e25ad1..aee80345cd 100755
--- a/doc/docportal/advanced_topics/command_line.rst
+++ b/doc/docportal/advanced_topics/command_line.rst
@@ -3,7 +3,7 @@
Command line interface
=======================
-Launching ScummVM from the command line allows you to pass a number of options, some of which override the applicable global or game-specific settings. It also allows you to launch straight into a game without going to the Launcher first.
+Launching ScummVM from the command line lets you pass a number of options, some of which override the applicable global or game-specific settings. It also lets you launch straight into a game without going to the Launcher first.
Some options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without starting the Launcher or starting a game.
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index 052b9db50d..c18e2e630d 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -77,7 +77,7 @@ 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 is 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 might 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``
diff --git a/doc/docportal/advanced_topics/understand_audio.rst b/doc/docportal/advanced_topics/understand_audio.rst
index c26e7f6fbb..d3e7622569 100644
--- a/doc/docportal/advanced_topics/understand_audio.rst
+++ b/doc/docportal/advanced_topics/understand_audio.rst
@@ -12,7 +12,7 @@ The **Preferred device** in the global settings Audio tab, or the **Music device
If **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses either an MT-32 or General MIDI device automatically, the settings on the MT-32 or MIDI tabs also apply, and the devices selected on these tabs are the ones that will be used. If **Preferred device** or **Music device** is set to either an MT-32 device or a GM device, ScummVM will use that device and ignore the devices chosen on the MT-32 and MIDI tabs.
-Many of the settings are highly dependent on the soundtrack(s) of the game you are playing; some offer only MIDI, while others have MP3 soundtracks, and so on.
+Not all settings are applicable to all games. For example, changing the General MIDI settings will not have any effect on a game that only has CD audio.
The evolution of PC audio
@@ -59,7 +59,7 @@ To find out which emulation is compatible with the game you're playing, have a l
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.
+MIDI is a communications protocol for musical information; it can be likened to digital sheet music. By itself, MIDI is not sound. Hardware or software synthesizers create (synthesize) audio by interpreting the information given to them by the MIDI protocol.
While some older soundcards (and a few modern ones) have their own hardware-based synthesizers, this is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
@@ -79,9 +79,9 @@ General MIDI device emulation (FluidSynth)
If the ScummVM you're using has libfluidsynth support it will be able to play MIDI music by using the FluidSynth emulator if set as the **Preferred device** or **Music device**, or if specified in the MIDI tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses General MIDI output automatically.
-You will have to specify a SoundFont in the MIDI tab for ScummVM to use FluidSynth. MIDI is like digital sheet music; it needs a library of sound samples known as a SoundFont to draw from in order to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
+You will have to specify a SoundFont in the MIDI tab for ScummVM to use FluidSynth. MIDI is like digital sheet music; it needs a library of sound samples known as a SoundFont to draw from to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
-Since the default output volume from FluidSynth can be fairly low, ScummVM will automatically set the gain to get a stronger signal. This can be further adjusted using the :ref:`MIDI gain <gain>` setting.
+The default output volume from FluidSynth can be fairly low, so ScummVM automatically sets the gain to get a stronger signal. Use the :ref:`MIDI gain <gain>` setting to further adjust this.
The processor requirements for FluidSynth are quite high; a fast CPU is recommended.
@@ -109,14 +109,14 @@ You don't need to enable **True Roland MT-32** in the MT-32 tab, ScummVM does th
.. tip::
- Some games work better with some MT-32 devices than others. As an example, Lure of the Temptress makes use of extra sound effects included with the CM-32L and won't sound right with an MT-32. Likewise, The Colonel's Bequest exploits some bugs in the early MT-32 modules, which means that later devices will play incorrect sound effects!
+ Some games work better with some MT-32 devices than others. As an example, Lure of the Temptress makes use of extra sound effects included with the CM-32L and won't sound right with an MT-32. Likewise, The Colonel's Bequest uses some bugs in the early MT-32 modules, which means that later devices will play incorrect sound effects!
`This Wikipedia article <https://en.wikipedia.org/wiki/List_of_MT-32-compatible_computer_games>`_ provides a comprehensive list of MT-32 compatible games, including which games work best with which device.
The processor requirements for the MT-32 emulator are quite high; a fast CPU is strongly recommended.
-Native MIDI support
+Built-in MIDI support
--------------------------
All MIDI ports show up in the **Preferred device** or **Music device** dropdown selector. If you have selected a MIDI port, you need to specify what type of MIDI device this is with the options in the :ref:`MT-32 <mt32>` tab.
@@ -125,7 +125,7 @@ All MIDI ports show up in the **Preferred device** or **Music device** dropdown
- Enable **Roland GS device** to tell ScummVM to use an MT-32 soundtrack on a GS device. This is not supported by all games.
- If no options are selected, ScummVM treats the device on the port as a General MIDI device.
-If 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.
+If you select an option that does not match the actual device, this might have unintended consequences. For example, if a game only has support for MT-32 and you have a General MIDI device selected as the **Preferred device** or **Music device**, ScummVM will convert the MT-32 MIDI data to GM-compatible MIDI data. While this might work fine for some games, it really depends on how the game has made use of the MT-32.
@@ -146,11 +146,11 @@ For an in-depth look at audio and MIDI device setup on a Windows computer, see t
Linux
******
-MIDI device setup may vary depending on your Linux distro.
+MIDI device setup might vary depending on your Linux distro.
-If you do not have a hardware MIDI device, there are two options: FluidSynth and TiMidity. FluidSynth is recommended as TiMidity may have some lag, depending on the system.
+If you do not have a hardware MIDI device, there are two options: FluidSynth and TiMidity. FluidSynth is recommended as TiMidity might have some lag, depending on the system.
-Here are a couple of helpful articles from the Ubuntu community documentation to get you started. These instructions should work for any Debian-based distro.
+Here are a couple of helpful articles from the Ubuntu community documentation to get you started.
`How to: Software Synthesizers <https://help.ubuntu.com/community/Midi/SoftwareSynthesisHowTo>`_
@@ -163,7 +163,7 @@ Here are a couple of helpful articles from the Ubuntu community documentation to
What is AdLib?
================
-AdLib devices do not use MIDI. They instead have a chip that produces sound via FM synthesis. While some games do store their audio data using a MIDI-derived format, this is converted by the game to work with the AdLib chip. ScummVM emulates a few different AdLib configurations, and selects the most appropriate for the game:
+AdLib devices do not use MIDI. They instead have a chip that produces sound through FM synthesis. While some games do store their audio data using a MIDI-derived format, this is converted by the game to work with the AdLib chip. ScummVM emulates a few different AdLib configurations, and selects the most appropriate for the game:
- The original AdLib and SoundBlaster card had one OPL2 chip.
- The SoundBlaster Pro 1 had two OPL2 chips
@@ -171,13 +171,13 @@ AdLib devices do not use MIDI. They instead have a chip that produces sound via
The AdLib emulator setting offers MAME, DOSBox and Nuked emulation, with MAME being the least accurate and using the least CPU power, and Nuked being the most accurate and also using the most CPU power - DOSBox is somewhere in between.
-There is also the option to select the OPL2LPT and OPL3LPT devices, which are external hardware devices with a real OPL chip, connected via the parallel port of a computer.
+There is also the option to select the OPL2LPT and OPL3LPT devices, which are external hardware devices with a real OPL chip, connected through the parallel port of a computer.
-AdLib does not require a SoundFont or ROMs, so for many games it may be the easiest to configure. However, if an MT-32 or GS emulator or device is available, ScummVM will prioritize this over AdLib.
+AdLib does not require a SoundFont or ROMs, so for many games it might be the easiest to configure. However, if an MT-32 or GS emulator or device is available, ScummVM will prioritize this over AdLib.
Mixed AdLib/MIDI mode
------------------------
-Some games contain sound effects that are exclusive to the AdLib soundtrack, or the AdLib soundtrack may provide better sound effects. For these games, you can combine MIDI music with AdLib sound effects by using the :ref:`mixed AdLib/MIDI mode <multi>`.
+Some games contain sound effects that are exclusive to the AdLib soundtrack, or the AdLib soundtrack might provide better sound effects. For these games, you can combine MIDI music with AdLib sound effects by using the :ref:`mixed AdLib/MIDI mode <multi>`.
.. note::
@@ -201,7 +201,7 @@ For games that use CD audio, the sounds were probably sampled at 44100Hz, so tha
ScummVM generates the samples when using AdLib, FM-Towns, PC Speaker or IBM PCjr emulated sound. 22050Hz will usually be fine for these options, although for Beneath a Steel Sky 44100Hz is recommended.
-ScummVM has to resample all sounds to the selected output frequency. It is recommended to choose an output frequency that is a multiple of the original frequency. Choosing an in-between number may not be supported by your sound card.
+ScummVM has to resample all sounds to the selected output frequency. It is recommended to choose an output frequency that is a multiple of the original frequency. Choosing an in-between number might not be supported by your sound card.
.. _buffer:
@@ -212,6 +212,6 @@ There is no option to control audio buffer size through the GUI, but the default
Appropriate values are normally between 512 and 8192, but the value must be one of: 256, 512, 1024, 2048, 4096, 8192, 16384, or 32768.
-Smaller values yield faster response time, but can lead to stuttering if your CPU isn't able to catch up with audio sampling when using the sound emulators. Large buffer sizes may lead to minor audio delays (high latency).
+Smaller values yield faster response time, but can lead to stuttering if your CPU isn't able to catch up with audio sampling when using the sound emulators. Large buffer sizes might lead to minor audio delays (high latency).
diff --git a/doc/docportal/advanced_topics/understand_graphics.rst b/doc/docportal/advanced_topics/understand_graphics.rst
index d5ca949b42..101e4171ec 100644
--- a/doc/docportal/advanced_topics/understand_graphics.rst
+++ b/doc/docportal/advanced_topics/understand_graphics.rst
@@ -110,7 +110,7 @@ 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.
+- Pixel-perfect scaling: scales the image to a multiple of the original game resolution as much as possible (for example, 2x, 3x, 4x), 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.
@@ -120,7 +120,7 @@ To switch between stretch modes, press :kbd:`Ctrl+Alt+s`.
Render mode
-------------
-For most games this setting will have no effect. For some of the older games that could be played on different systems and graphics cards, this control allows us to decide which system we want ScummVM to reproduce.
+For most games this setting will have no effect. For some of the older games that could be played on different systems and graphics cards, this control lets you decide which system you want ScummVM to reproduce.
Below are some of the common render modes, to illustrate how the render mode setting works.
diff --git a/doc/docportal/consoles/nintendo_3ds.rst b/doc/docportal/consoles/nintendo_3ds.rst
index 73c952780e..da74f08460 100644
--- a/doc/docportal/consoles/nintendo_3ds.rst
+++ b/doc/docportal/consoles/nintendo_3ds.rst
@@ -8,7 +8,7 @@ Install ScummVM
Prerequisites
****************
-- A Nintendo 3DS with a Homebrew Launcher or custom firmware. Enabling homebrew is outside the scope of this documentation.
+- A Nintendo 3DS with a Homebrew Launcher or custom firmware. How to enable homebrew is outside the scope of this documentation.
Download and install ScummVM
*********************************
@@ -28,14 +28,14 @@ CIA
Use any CIA installation software to install the ``scummvm.cia`` file.
-The CIA format requires a DSP binary dump saved on your SD card as ``/3ds/dspfirm.cdc``. This is not an optional step, since without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
+The CIA format requires a DSP binary dump saved on your SD card as ``/3ds/dspfirm.cdc``. This is not an optional step, because without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
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:`../use_scummvm/connect_cloud`.
+ScummVM for the Nintendo 3DS also has cloud functionality. See :doc:`../use_scummvm/connect_cloud`.
See :doc:`../use_scummvm/add_play_games` for more information about how to add games to ScummVM.
@@ -46,9 +46,7 @@ Controls
Default control mapping
****************************
-Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
-
-See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. csv-table::
:widths: 50 50
@@ -73,11 +71,12 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
Hover mode
************
-When using the touchscreen, you are simulating the movement of the mouse. You can click with taps, however you can't drag or hold down a mouse button unless you use the buttons mapped to the right/left mouse buttons.
+When using the touchscreen, hover mode simulates the movement of the mouse. You can click with taps, however you can't drag or hold down a mouse button unless you use the buttons mapped to the right/left mouse buttons.
Drag mode
**************
-Every time you touch and release the touchscreen, you are simulating the click and release of the mouse buttons. At the moment, this is only a left mouse button click.
+
+Simulates the click and release of the mouse buttons every time you touch and release the touchscreen. At the moment, this is only a left mouse button click.
Magnify mode
****************
@@ -114,6 +113,9 @@ Settings
For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
+3DS config menu
+****************
+
.. figure:: ../images/3ds/config.png
The 3DS config menu.
@@ -125,7 +127,7 @@ Stretch to fit
Stretches the image to fit the screen
Snap to edges
- The 3DS touch screen has difficulty reaching the very end of the screen. Enabling this options means that if you're within a few pixels of the edge, the cursor will snap to the edge.
+ The 3DS touch screen has difficulty reaching the very end of the screen. With this option enabled, if you're within a few pixels of the edge the cursor snaps to the edge.
Use Screen:
Sets whether ScummVM uses the **Top**, **Bottom** or **Both** screens.
@@ -133,6 +135,16 @@ Use Screen:
C-Pad Sensitivity
Sets the sensitivity of the Circle Pad.
+Audio
+******
+
+Supported audio file formats:
+
+- MP3
+- OGG
+- OGG
+- Uncompressed audio
+
Known issues
==============
diff --git a/doc/docportal/consoles/nintendo_switch.rst b/doc/docportal/consoles/nintendo_switch.rst
index f163abec39..ec8ceac258 100644
--- a/doc/docportal/consoles/nintendo_switch.rst
+++ b/doc/docportal/consoles/nintendo_switch.rst
@@ -9,14 +9,13 @@ Prerequisites
****************
- A homebrew-enabled Nintendo Switch console. How to enable homebrew is outside the scope of this documentation.
-- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
Download and install ScummVM
*******************************
-The Nintendo Switch package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
+The Nintendo Switch package is available for download on the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_.
-Download the ``.zip`` archive to a computer, and extract the files.
+Download the zip file to a computer, and extract the files.
Copy the extracted ``scummvm`` folder to your Nintendo Switch microSD card, into the ``/switch/`` folder.
@@ -26,19 +25,17 @@ 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 <../use_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:`../use_scummvm/add_play_games` page.
Controls
=================
-Default control mapping
+Default control map
*********************************
-These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
-
-See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |plus| raw:: html
@@ -87,47 +84,38 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
Short single finger tap,Left mouse button click
Short second finger tap while holding one finger,Right mouse button click
Single finger drag,"Move pointer indirectly with finger, pointer speed can be adjusted in control settings"
- `Two finger drag`_ ,Move pointer while left mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
- `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
+ `Two finger drag`_ ,Move pointer while left mouse button is held down (drag-and-drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
+ `Three finger drag`_ ,Move pointer while right mouse button is held down (drag-and-drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
Keyboard and mouse support
****************************
-Physical USB mice and keyboards work on the Switch and are supported by ScummVM.
-
-- All keyboards work.
-- Not all mice work. A mouse compatibility list is available on this `Google Sheet <https://docs.google.com/spreadsheets/d/1Drbo5-QuSX901MwtOytSMuqRGxeIkq2HELM806I9dj0/edit#gid=0>`_.
+Physical USB mice and keyboards work on the Switch and are supported by ScummVM. All keyboards work but not all mice work. A mouse compatibility list is available on this `Google Sheet <https://docs.google.com/spreadsheets/d/1Drbo5-QuSX901MwtOytSMuqRGxeIkq2HELM806I9dj0/edit#gid=0>`_.
Touch support
-***************
-
-For multi-touch gestures, the fingers have to be far enough apart from each other that the Switch will not erroneously recognize them as a single finger, otherwise the pointer will jump around.
+****************
-The touch control scheme can be switched in the global settings. Go to **Options > Control > Touchpad mouse mode**.
+For multi-touch gestures, the fingers have to be far enough apart from each other that the Switch does not recognize them as a single finger, otherwise the pointer jumps around.
- - When touchpad mouse mode is off (default), the touch controls are direct. The pointer always jumps to the finger.
+The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
+ - When touchpad mouse mode is off (default), the touch controls are direct. The pointer always jumps to where the finger touches the screen.
- When touchpad mouse mode is on, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
- The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
Two finger drag
^^^^^^^^^^^^^^^^^^^
-The two finger drag works in the following way: holding down two fingers for a while initiates a drag and drop feature, where the left mouse button is being held down.
+Hold down two fingers to initiate a drag-and-drop feature. The two finger drag simulates the left mouse button being held down.
- The first finger affects mouse motion during the drag, the second finger can be removed without affecting the drag.
- When the last finger is removed, the left mouse button is released and the drag is over.
- The second finger can be anywhere, it doesn't have to be close to the first finger, and it doesn't have to be put down simultaneously with the first finger.
-Typical usage of the two finger drag and drop in Full Throttle:
- - Hold down one finger over an object.
- - Hold down a second finger somewhere on the screen for a little bit to initiate a two finger drag. This brings up the action menu.
- - Let go of the second finger. The two finger drag continues since one finger is still down.
- - Select an action with the first finger, and let go of the first finger to end the drag.
Three finger drag
^^^^^^^^^^^^^^^^^^^^
-The three finger drag works in a similar way to the `Two finger drag`_, except that instead of holding down a single second finger, you hold down two extra fingers. Holding down the three fingers for a while initiates a drag and drop feature, where the right mouse button is being held down.
+Hold down the three fingers to initiate a drag-and-drop feature. The three finger drag simulates the right mouse button being held down.
Paths
=======
@@ -157,9 +145,9 @@ Supported devices:
Supported audio file formats:
-- ``.mp3``
-- ``.ogg``
-- ``.flac``
+- MP3
+- OGG
+- FLAC
- Uncompressed audio
Controls
@@ -167,6 +155,3 @@ Controls
See the `Touch support`_ section.
-Known issues
-==============
-
diff --git a/doc/docportal/consoles/playstation_3.rst b/doc/docportal/consoles/playstation_3.rst
index 54aeef72ed..c8d0e3f500 100644
--- a/doc/docportal/consoles/playstation_3.rst
+++ b/doc/docportal/consoles/playstation_3.rst
@@ -27,19 +27,17 @@ 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 <../use_scummvm/connect_cloud>`.
+To copy game files to the hard drive, use the USB drive, or use ScummVM's :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
See :doc:`../use_scummvm/add_play_games` for more information.
Controls
=================
-Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
+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.
-See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
-
-Default control mapping
+Default control map
*************************
.. |square| raw:: html
@@ -81,18 +79,23 @@ Paths
Saved games
*******************
-``/hdd0/game/SCUM12000/saves``
+```/hdd0/game/SCUM12000/USRDIR/saves/``
Configuration file
**************************
-
+``/hdd0/game/SCUM12000/USRDIR/scummvm.ini``
Settings
==========
For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
+Audio
+*********
+Supported audio file formats:
-Known issues
-==============
+- MP3
+- OGG
+- FLAC
+- Uncompressed audio
\ No newline at end of file
diff --git a/doc/docportal/consoles/playstation_portable.rst b/doc/docportal/consoles/playstation_portable.rst
index 148cb08b66..4b49f6dcb7 100644
--- a/doc/docportal/consoles/playstation_portable.rst
+++ b/doc/docportal/consoles/playstation_portable.rst
@@ -9,17 +9,16 @@ Prerequisites
****************
- A homebrew-enabled PSP. How to enable homebrew is outside the scope of this documentation.
-- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
+- A computer to download an extract the install files.
Download and install ScummVM
*******************************
+The PSP package is available for download ScummVM's `Downloads page <https://www.scummvm.org/downloads>`_.
-The PSP package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
+Download the zip file to a computer, and extract the files.
-Download the ``.zip`` archive to a computer, and extract the files.
-
-Connect the PSP to the computer by USB cable. Go to **Settings > USB Connection** on the PSP. Ensure the **USB Device** option is set to **Memory Stick**. The computer should automatically open the root folder of the PSP. Alternatively, if you have a Memory Stick adapter, copy the files directly to the Memory Stick.
+Connect the PSP to the computer by USB cable. Go to **Settings > USB Connection** on the PSP. Ensure the **USB Device** option is set to **Memory Stick**. The computer automatically opens the root folder of the PSP. Alternatively, if you have a Memory Stick adapter, copy the files directly to the Memory Stick.
Copy the extracted ``scummvm`` folder to your PSP, into the ``/PSP/GAME/`` folder.
@@ -35,12 +34,10 @@ For more information, see :doc:`../use_scummvm/add_play_games`.
Controls
=================
-Default control mapping
+Default control map
*********************************
-These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
-
-See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |square| raw:: html
@@ -76,9 +73,9 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
|circle|,Right Mouse Button
|square|,Period
|square| + R button,Spacebar
- SELECT,Show/Hide Virtual Keyboard. Hold down to move keyboard onscreen (with Directional buttons).
- SELECT + R button ,Show Image Viewer
- START,Global main menu
+ SELECT,Shows/Hides the virtual Keyboard. Hold down with Directional buttons to move the keyboard.
+ SELECT + R button ,Shows Image Viewer
+ START,Global Main Menu
START + R button,F5
.. csv-table::
@@ -86,11 +83,11 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
Virtual Keyboard Mode,
START,Enter. Also exits virtual keyboard mode
- SELECT,Exit the virtual keyboard mode
+ SELECT,Exits the virtual keyboard mode
R button,Input: lowercase/uppercase letters (press to toggle)
L button,Input: numbers/symbols (press to toggle)
- Directional buttons,"Select square of characters (up, down, left or right)"
- |triangle| |x| |circle| |square| and L/R buttons,Choose a specific character in the square. The four center characters are chosen by the button in the corresponding position. The 2 top characters are chosen by the L/R buttons.
+ Directional buttons,"Selects square of characters (up, down, left or right)"
+ |triangle| |x| |circle| |square| and L/R buttons,Chooses a specific character in the square. The four center characters are chosen by the button in the corresponding position. The 2 top characters are chosen by the L/R buttons.
Analog stick,Moves in a direction (left/right/up/down)
.. csv-table::
@@ -98,18 +95,18 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
Image Viewer,
Left/right directional buttons,Previous/next image
- Up/down directional buttons ,Zoom in/out
- Analog stick,Move around the image
- "L/R buttons + START",Exit image viewer
+ Up/down directional buttons ,Zooms in/out
+ Analog stick,Moves around the image
+ "L/R buttons + START",Exits image viewer
.. csv-table::
:header-rows: 1
1st Person Game Mode ,
- |square| + R button + L button,Enable 1st Person Mode
+ |square| + R button + L button,Enables 1st Person Mode
|square|,Modifier key (instead of R button)
- L/R button,Strafe left/right
- Directional buttons left/right,Turn left/right
+ L/R button,Strafes left/right
+ Directional buttons left/right,Turns left/right
|square| + Directional buttons,F1/F2/F3/F4
|square| + SELECT,Image Viewer
|square| + START,Esc
@@ -121,7 +118,14 @@ For more information, see the Settings section of the documentation. Only platfo
Audio
*******
-Games will generally run faster if audio files are in the ``.mp3`` file format.
+
+Supported audio file formats:
+
+- MP3
+- OGG
+- Uncompressed audio
+
+Games run faster if audio files are in the ``.mp3`` file format.
Paths
@@ -130,7 +134,7 @@ Paths
Saved games
************
-``ms0://scummvm_savegames/``
+``ms0:/scummvm_savegames/``
Configuration file
********************
@@ -140,4 +144,5 @@ Configuration file
Known issues
==============
-- Plugin files are not interchangeable between ScummVM versions. You must copy all the plugin files found in the ``PSP/GAME/scummvm/plugin/`` folder for every new version you install. If ScummVM crashes on startup, delete the existing plugin files in the plugin directory and copy the new ones again.
+- Plugin files are not interchangeable between ScummVM versions. You must copy all the plugin files found in the ``/PSP/GAME/scummvm/plugin/`` folder for every new version you install. If ScummVM crashes on startup, delete the existing plugin files in the plugin directory and copy the new ones again.
+- If the virtual keyboard does not show up on the screen, ensure the ``kbd.zip`` file is in the ``scummvm`` folder.
\ No newline at end of file
diff --git a/doc/docportal/consoles/ps_vita.rst b/doc/docportal/consoles/ps_vita.rst
index b38d52f6a9..8ad24fd58e 100644
--- a/doc/docportal/consoles/ps_vita.rst
+++ b/doc/docportal/consoles/ps_vita.rst
@@ -9,12 +9,11 @@ Prerequisites
*******************
- A homebrew-enabled PS Vita console with `Vitashell <https://github.com/TheOfficialFloW/VitaShell/releases/tag/v2.02>`_ installed. How to enable homebrew is outside the scope of this documentation.
-- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
Download and install ScummVM
******************************
-The PS Vita package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
+The PS Vita package is available for download on the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_.
Copy the ``.vpk`` to the PS Vita and install it using VitaShell.
@@ -24,18 +23,11 @@ Transfer game files
There are a few ways to transfer game files to the PS Vita.
-Using VitaShell:
-
- - Transfer over FTP
- - Transfer via USB
-
-If you're using SD2Vita:
-
- - Transfer the files directly to the microSD card.
+Use VitaShell to transfer the files by USB or FTP, or use SD2Vita to transfer the files directly to the microSD card.
-Folders containing game files can be copied into any folder.
+Folders containing game files can be copied anywhere on the SD card.
-ScummVM on the PS Vita supports :doc:`Cloud functionality <../use_scummvm/connect_cloud>`.
+ScummVM on the PS Vita supports :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
For more information on how to add and play games, see the :doc:`../use_scummvm/add_play_games` page.
@@ -43,12 +35,10 @@ For more information on how to add and play games, see the :doc:`../use_scummvm/
Controls
=================
-Default control mapping
+Default control map
*********************************
-These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
-
-See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |square| raw:: html
@@ -75,8 +65,8 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
Button,Action
Left stick,Mouse
Left stick + R button,Slow Mouse
- |x|,Left mouse button
- |circle|,Right mouse button
+ |x|,Left mouse click
+ |circle|,Right mouse click
Directional buttons,Keypad 'Cursor' Keys
Directional buttons + R button,Diagonal Keypad 'Cursor' Keys
L button,Game menu (F5)
@@ -94,23 +84,23 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
"Front Touchscreen Controls, always enabled",
Touch,Action
- Short single finger tap,Move pointer to finger position and left mouse button click
- Short second finger tap while holding one finger,Move pointer to first finger position and right mouse button click
- Single finger drag,Move pointer directly with finger
- `Two finger drag`_ ,Move pointer while left mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
- `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed.
+ One finger tap,Moves pointer to finger position and left mouse click
+ Two finger tap,Moves pointer to first finger position and right mouse click
+ Single finger drag,Moves pointer directly with finger
+ `Two finger drag`_ ,Moves pointer while left mouse button is held down (drag-and-drop).
+ `Three finger drag`_ ,Moves pointer while right mouse button is held down (drag-and-drop).
.. csv-table::
:widths: 50 50
:header-rows: 2
- "Back Touchpad Controls, enabled via settings",
+ "Back Touchpad Controls, enabled through settings",
Touch,Action
- Short single finger tap,Left mouse button click
- Short second finger tap while holding one finger,Right mouse button click
- Single finger drag,"Move pointer indirectly with finger, pointer speed can be adjusted in control settings"
- `Two finger drag`_,Move pointer while left mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
- `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed.
+ One finger tap,Left mouse button click
+ Two finger tap,Right mouse button click
+ Single finger drag,"Moves pointer indirectly with finger, pointer speed can be adjusted in control settings"
+ `Two finger drag`_,Moves pointer while left mouse button is held down (drag-and-drop).
+ `Three finger drag`_ ,Moves pointer while right mouse button is held down (drag-and-drop).
Keyboard and mouse support
****************************
@@ -119,9 +109,7 @@ Real bluetooth mice and keyboards work on the Vita and are supported by ScummVM.
.. note::
- Not all bluetooth keyboards or mice pair successfully with the Vita.
-
- We tested the Jelly Bean BT keyboard and mouse combo (ASIN:B06Y56BBYP) and with the standalone Jelly Comb Bluetooth Wireless Mouse (ASIN:B075HBDWCF).
+ Not all bluetooth keyboards or mice pair successfully with the Vita. The ScummVM team tested the Jelly Bean BT keyboard and mouse combo (ASIN:B06Y56BBYP) and with the standalone Jelly Comb Bluetooth Wireless Mouse (ASIN:B075HBDWCF).
Touch support
****************
@@ -150,25 +138,26 @@ The front touchscreen uses the direct mode by default, but this can be changed b
When set to true, the touch controls on the front touchscreen are indirect.
+Two finger tap
+^^^^^^^^^^^^^^^^^^^^
+
+For a two finger tap, hold one finger down and then tap with a second finger.
+
+
Two finger drag
^^^^^^^^^^^^^^^^^^^
-The two finger drag works in the following way: holding down two fingers for a while initiates a drag and drop feature, where the left mouse button is being held down.
+Hold down two fingers to initiate a drag-and-drop feature. The two finger drag simulates the left mouse button being held down.
- The first finger affects mouse motion during the drag, the second finger can be removed without affecting the drag.
- When the last finger is removed, the left mouse button is released and the drag is over.
- The second finger can be anywhere, it doesn't have to be close to the first finger, and it doesn't have to be put down simultaneously with the first finger.
-Typical usage of the two finger drag and drop in Full Throttle:
- - Hold down one finger over an object.
- - Hold down a second finger somewhere on the screen for a little bit to initiate a two finger drag. This brings up the action menu.
- - Let go of the second finger. The two finger drag continues since one finger is still down.
- - Select an action with the first finger, and let go of the first finger to end the drag.
-
Three finger drag
^^^^^^^^^^^^^^^^^^^^
-The three finger drag works in a similar way to the `Two finger drag`_, except that instead of holding down a single second finger, you hold down two extra fingers. Holding down the three fingers for a while initiates a drag and drop feature, where the right mouse button is being held down.
-
+
+Hold down the three fingers to initiate a drag-and-drop feature. The three finger drag simulates the right mouse button being held down.
+
Paths
============================
@@ -191,9 +180,9 @@ Audio
Supported audio file formats:
-- ``.mp3``
-- ``.ogg``
-- ``.flac``
+- MP3
+- OGG
+- FLAC
- Uncompressed audio
Controls
@@ -204,4 +193,4 @@ See the `Touch support`_ section.
Known Issues
===============
-MT-32 emulation is not available on the PS Vita.
\ No newline at end of file
+- MT-32 emulation is not available on the PS Vita.
\ No newline at end of file
diff --git a/doc/docportal/consoles/sega_dreamcast.rst b/doc/docportal/consoles/sega_dreamcast.rst
index a7196c3109..56005f9e54 100644
--- a/doc/docportal/consoles/sega_dreamcast.rst
+++ b/doc/docportal/consoles/sega_dreamcast.rst
@@ -35,11 +35,11 @@ Copy the downloaded ``SCUMMVM.BIN`` and ``IP.BIN`` files into the ``ScummVMDC``
The ``.PLG`` files in the plain files package are the plugins that are required to run the games. For the best performance, only include the plugins for games you want to play. For example, if you want to play LucasArts games, include ``SCUMM.PLG``.
-In the plain files package there are also ``.DAT`` files. These files may be listed as required Datafiles on the `Datafiles wiki page <https://wiki.scummvm.org/index.php/Datafiles>`_.
+In the plain files package there are also ``.DAT`` files. These files might be listed as required Datafiles on the `Datafiles wiki page <https://wiki.scummvm.org/index.php/Datafiles>`_.
-Copy the required ``.PLG`` and ``.DAT`` files into the root of the ScummVMDC directory.
+Copy the required ``.PLG`` and ``.DAT`` files into the root of the ``ScummVMDC`` directory.
-Next, make a new directory for each game. In this example, we will add all the required Day of the Tentacle data files into a subdirectory named ``DOTT``.
+Next, make a new directory for each game. In this example, all the required Day of the Tentacle data files have been copied into a subdirectory named ``DOTT``.
Our file structure now looks like this:
@@ -56,18 +56,18 @@ Our file structure now looks like this:
The next step is to create a bootable disc image from the ``ScummVMDC`` folder.
-Use Bootdreams to create either a ``.dci``, ``.nrg`` or ``.mds``/``.mdf`` disc image.
+Use Bootdreams to create either a Discjuggler, Nero or Alcohol120% disc image.
.. figure:: ../images/dreamcast/bootdreams.png
1. Choose the preferred disc image type by clicking on the corresponding icon at the top of the window.
-2. Choose the ``ScummVMDC`` folder as the **Selfboot foler**
+2. Choose the ``ScummVMDC`` folder as the **Selfboot folder**
3. Enter a title for the disc image in the **CD label** field.
4. Leave the **Disc format** as **Audio/Data**
5. Click **Process** to create the disc image.
-To burn the resulting image to disc, use any software capable of using those image formats, such as Nero Burning ROM for ``.nrg``, Alcohol120% for ``.mds``, and Padus DiscJuggler or ImgBurn for ``.cdi``.
+To burn the resulting image to disc, use any software capable of using those image formats, such as Nero Burning ROM for NRG, Alcohol120% for MDS, and Padus DiscJuggler or ImgBurn for CDI disc images.
.. tip::
@@ -76,26 +76,26 @@ To burn the resulting image to disc, use any software capable of using those ima
.. caution::
- Use the lowest possible burning speed for best results; the Dreamcast is an older system and as such can have problems reading discs burned at high speeds. If available, the 4x speed is ideal.
-
- Ensure that you use good quality discs from a reputable manufacturer. If possible, use archival grade discs.
+ Use the lowest possible burning speed for best results; the Dreamcast is an older system and as such can have problems reading discs burned at high speeds. If available, the 4x speed is ideal. Ensure that you use good quality discs from a reputable manufacturer. If possible, use archival grade discs.
Transfer game files
=======================
-Game files can be included on the same CD as the ScummVM binary file, or on a separate disc
+Game files can be included on the same CD as the ScummVM binary file, or on a separate disc.
The Dreamcast port does not use the normal ScummVM Launcher. It uses its own custom graphical user interface, which automatically scans the disc for games, and adds the games to a games list through ScummVM's built-in autodetection.
-ScummVM for the Dreamcast supports disc swapping from the GUI. It will rescan once a new disc is inserted and repopulate the games list.
+ScummVM for the Dreamcast supports disc swapping from the GUI. It rescans after a new disc is inserted and repopulates the games list.
Controls
=================
-The mouse cursor can be controlled with the standard Dreamcast controller.
-There is a virtual keyboard that can be brought up by pressing the left trigger button, that will emulate keyboard input.
-The Dreamcast mouse and keyboard peripherals are also supported.
+Default control map
+*********************
+
+These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+
.. csv-table::
:header-rows: 2
@@ -103,28 +103,30 @@ The Dreamcast mouse and keyboard peripherals are also supported.
Game Controller Mapping:,,
Button,Action,Notes
Joystick,Moves pointer,
- Directional pad,Moves pointer slowly,Also controls the on-screen keyboard
+ Directional pad,Moves pointer slowly, Also controls the on-screen keyboard
â’¶,Left Click,
â’·,Right Click,
â“Ž,Spacebar,Pause
Start,F5,Load and save
- Trigger L,Toggles the on-screen keyboard on/off,
+ Trigger L,Toggles the virtual keyboard on/off,
â“,5,For boxing in Indiana Jones and the Last Crusade
â“ + Directional pad,"1, 2, 3, 4, 6, 7, 8, 9",For boxing in Indiana Jones and the Last Crusade
+The mouse cursor is controlled with the standard Dreamcast controller. The Dreamcast mouse and keyboard peripherals are also supported.
+
Paths
=======
Saved games
*****************
-The Visual Memory Unit (VMU) is used for saving and loading games.
+The Visual Memory Unit (VMU) is used to save and load games.
Autosave is enabled on the Dreamcast, so each game will use some memory blocks (between 2 and 13) for the autosave in save slot 0.
-When a game is saved, the VMU beeps, and a prompt is displayed on the screen letting you know that the game has been saved.
+When a game is saved, the VMU beeps, and a prompt is displayed on the screen to let you know that the game has been saved.
-Games are saved and loaded through the native in-game menus.
+Games are saved and loaded through the built-in game menus.
Configuration file
*********************
diff --git a/doc/docportal/get_started/android.rst b/doc/docportal/get_started/android.rst
index 85f70be553..25e0c90aec 100644
--- a/doc/docportal/get_started/android.rst
+++ b/doc/docportal/get_started/android.rst
@@ -26,32 +26,32 @@ Go to the Google Play Store to download and install ScummVM.
APK package
************
-On your device, use a web browser app to navigate to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_. The recommended download section on the page should suggest the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
+On your device, use a web browser app to navigate to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_. The recommended download section on the page suggests the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
.. tip::
- To find the correct package for your device, find out whether the device has a 32 or 64-bit operating system, and which chipset the device has. An internet search using the device model number should allow you to find these details.
+ To find the correct package for your device, find out whether the device has a 32 or 64-bit operating system, and which chipset the device has. Do an internet search using the device model number to find these details.
-Click on the correct package to start the download. Once it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and once permission is granted, returns to the install.
+Click on the correct package to start the download. After it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and after permission is granted, returns to the install.
.. note::
- The downloaded APK package is treated as an app from an unknown source, since it doesn't originate in the Google Play store. To allow unknown apps:
+ The downloaded APK package is treated as an app from an unknown source, because it doesn't originate in the Google Play store. To allow unknown apps:
- - For Android 7 or earlier, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
- - For Android 8 or later, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
+ - For Android 7 or lower, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
+ - For Android 8 or higher, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
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:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
+ScummVM has built-in Cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
There are a few other options to transfer the game files:
- Copy the files directly onto the microSD card, if the device has one.
- - USB transfer from a computer. To complete file transfer 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.
+ - USB transfer from a computer. To complete file transfer by USB cable, tap the **Charging this device via USB notification** when the device is connected. Select **Use USB for** and then **File Transfer**. An Android File Transfer window opens.
- Download games such as freeware games or those from digital distributors directly to your device.
For more information on which files ScummVM requires, and how to add and play games, see :doc:`../use_scummvm/add_play_games`.
@@ -72,46 +72,37 @@ Controls can also be manually configured in the :doc:`Keymaps tab <../settings/k
Touch screen control, Action
One finger tap, Left mouse click
Two finger tap, Right mouse click
- Long hold one finger tap, Middle mouse click
+ One finger touch & hold, Middle mouse click
Long press system Back button, Opens Global Main Menu
Short press system Back button, "Skip, or Cancel/Quit in the Launcher"
Small keyboard icon (top right), Opens/closes Virtual keyboard
+Touch controls
+****************
+The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
+
+ - When touchpad mouse mode is off (default), the touch controls are direct. The pointer jumps to where the finger touches the screen.
+ - When touchpad mouse mode is on, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
+ - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
Two finger tap
-****************
+^^^^^^^^^^^^^^^^^
To do a two finger tap, hold one finger down and then tap with a second finger.
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
=======
diff --git a/doc/docportal/get_started/ios.rst b/doc/docportal/get_started/ios.rst
index e945ec0940..bcf65a9a5d 100644
--- a/doc/docportal/get_started/ios.rst
+++ b/doc/docportal/get_started/ios.rst
@@ -101,12 +101,12 @@ Open the ``scummvm.xcodeproj`` file from the Finder, or from the command line:
Build ScummVM
*****************
-Once Xcode is open, connect a device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then select the device you just connected. You will need to "Trust" the device for it to show up on the list of connected devices.
+When Xcode is open, connect a device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then select the device you just connected. You will need to "Trust" the device for it to show up on the list of connected devices.
.. figure:: ../images/ios/choose_device.gif
-The last step before building ScummVM is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** you should see a field labeled **Bundle Identifier**. Input a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
+The last step before building ScummVM is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** there is a field labeled **Bundle Identifier**. Enter a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
.. figure:: ../images/ios/identifier.gif
@@ -138,7 +138,7 @@ Install ScummVM
Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended ``.deb`` or ``.ipa`` package. When the device asks how to open the file, choose Filza.
-Ensure the package is saved somewhere in the ``/var/mobile/`` directory. It should default to ``/var/mobile/Documents/``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
+Ensure the package is saved somewhere in the ``/var/mobile/`` directory. It defaults to ``/var/mobile/Documents/``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
Restart your device for the install to complete.
@@ -147,11 +147,11 @@ 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:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
+ScummVM has built-in cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
.. note::
- ScummVM's cloud functionality does not currently support iCloud, however it is possible to upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder.
+ ScummVM's cloud functionality does not currently support iCloud, however you can upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder.
Another way to transfer files (for macOS Catalina and newer) to your device is by using the Finder while your device is connected to your Mac. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag the folder containing the game files into the **ScummVM** folder. For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
@@ -168,40 +168,52 @@ Controls
:header-rows: 2
Game Controller Mapping,
- Action,Touch screen control
- Left click,Single tap
- Right click,"Hold one finger on screen where you want to click, single tap another"
- Arrow keys,Use a three finger swipe in the direction of the arrow key you want. You can also use the arrow buttons in the bar above the keyboard. You may need to scroll across on smaller screens to see these.
- ESC,"Hold one finger on screen, double tap another, or use the Esc key in the bar above the keyboard."
- Tab,The Tab button in the bar above the keyboard.
- Return,The Return button in the bar above the keyboard.
- Global Main Menu,"Swipe two fingers down from top to bottom, or the tap the left-most button in the bar above the keyboard."
- Enable/disable keyboard,"The pinch gesture enables or disables the keyboard. If no external keyboard is connected, this shows and hides the onscreen keyboard. When an external keyboard is connected, the pinch gesture enables/disables inputs from the external keyboard."
- F 0-9 keys,The F-bar above the keyboard.
- Pause,Keyboard spacebar
- Toggle `Click and drag mode`_,Swipe two fingers up from bottom to top.
- Toggles between :ref:`direct` and :ref:`touchpad` ,Swipe two fingers from left to right.
+ Touch screen control, Action
+ One finger tap, Left mouse click
+ :ref:`twofinger`, Right mouse click
+ :ref:`twofingerdouble`,ESC
+ Two finger swipe (bottom to top), Toggles `Click and drag mode`_
+ Two finger swipe (left to right),Toggles between touch direct mode and touchpad mode.
+ Two finger swipe (top to bottom),Global Main Menu
+ Three finger swipe, Arrow keys
+
+ Pinch gesture, Enables/disables keyboard
+ Keyboard spacebar, Pause
+
+
+Touch controls
+^^^^^^^^^^^^^^^^^
+The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
-Click and drag mode
-^^^^^^^^^^^^^^^^^^^^
+ - When touchpad mouse mode is off, the touch controls are direct. The pointer jumps to where the finger touches the screen.
+ - When touchpad mouse mode is on, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
+ - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
- 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.
+.. _twofinger:
-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.
+Two finger tap
+******************
-.. _direct:
+For a two finger tap, hold one finger down and then tap with a second finger.
-Direct mode
-^^^^^^^^^^^^^
+.. _twofingerdouble:
-The mouse cursor is placed directly under where your finger touches the screen.
+Two finger double tap
+************************
-.. _touchpad:
+For a two finger double tap, hold one finger down and then double tap with a second finger.
-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.
+Click and drag mode
+*********************
+
+Simulates a left mouse click when you touch the screen. The mouse pointer drags to wherever you slide your finger, and releases where you lift your finger.
+
+If you press down a second finger in this mode, it releases the simulated left mouse button, and presses down the simulated right mouse button. The right mouse button is released when you lift your finger again.
+
+Keyboard
+**********
+If no external keyboard is connected, the pinch gesture shows and hides the onscreen keyboard. When an external keyboard is connected, the pinch gesture enables/disables inputs from the external keyboard.
Paths
=======
@@ -209,9 +221,9 @@ Paths
Saved games
^^^^^^^^^^^^^^^^^
-``/var/mobile/Library/ScummVM/Savegames/`` if the device is jailbroken, or ``Savegames/`` in the ScummVM folder for a non-jailbroken device. Access this folder via the Finder or iTunes.
+``/var/mobile/Library/ScummVM/Savegames/`` if the device is jailbroken, or ``Savegames/`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
Configuration file
^^^^^^^^^^^^^^^^^^^^^^^
-``/var/mobile/Library/ScummVM/Preferences`` if the device is jailbroken, or ``Preferences`` in the ScummVM folder for a non-jailbroken device. Access this folder via the Finder or iTunes.
\ No newline at end of file
+``/var/mobile/Library/ScummVM/Preferences`` if the device is jailbroken, or ``Preferences`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
\ No newline at end of file
diff --git a/doc/docportal/get_started/mac_linux_windows.rst b/doc/docportal/get_started/mac_linux_windows.rst
index 7124da46dc..bd0c1abc7f 100644
--- a/doc/docportal/get_started/mac_linux_windows.rst
+++ b/doc/docportal/get_started/mac_linux_windows.rst
@@ -3,18 +3,16 @@
Mac, Linux or Windows
========================
-All downloads are available from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_.
+macOS
+-------
-macOS/Mac OSX
-------------------
-
-Download the recommended Disk Image. Once the download has completed, double click the file to mount the Disk Image. A window will open with the ScummVM icon. Drag this icon into your Applications folder to install ScummVM.
+Download the recommended disk image file from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_. After the download has completed, double click the file to mount the disk image file. A window containing the ScummVM icon opens. Drag this icon into your Applications folder to install ScummVM.
To run ScummVM, click on the icon in the Applications folder.
.. note::
- macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. Since ScummVM is not available from the App Store, follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
+ macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. ScummVM is not available from the App Store, so follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
Linux
@@ -40,15 +38,15 @@ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through
Flathub
**********
-Flathub is another way to quickly install apps for Linux by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
+Flathub is another way to install apps for Linux, by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
-Once Flatpak is installed, enter the following on the command line to install ScummVM:
+When Flatpak is installed, enter the following on the command line to install ScummVM:
.. code:: bash
flatpak install flathub org.scummvm.ScummVM
-Some distributions have the option to install Flatpaks via the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog opens; choose the **Open with Software Install (default)** option, and then click **OK**.
+Some distributions have the option to install Flatpaks through the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog opens; choose the **Open with Software Install (default)** option, and then click **OK**.
To run ScummVM, enter the following on the command line:
@@ -69,9 +67,9 @@ ScummVM is found in the software repositories of many Linux distributions.
.. caution::
- The repositories may not contain the most up-to-date version of ScummVM.
+ The repositories might not contain the most up-to-date version of ScummVM.
-If you are unsure about how to install software packages from the software repository for your distribution, you may find `this help article <https://www.maketecheasier.com/install-software-in-various-linux-distros/>`_ useful.
+If you are unsure about how to install software packages from the software repository for your distribution, you might find `this help article <https://www.maketecheasier.com/install-software-in-various-linux-distros/>`_ useful.
To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
@@ -79,13 +77,13 @@ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through
Release binaries
*********************
-At this time, binary packages are only released for Debian and Ubuntu. Find and download the ScummVM version that corresponds to your operating system and architecture. To install a ``.deb`` package, either double click on the downloaded ``.deb`` file to use the graphical installer, or, if that's not available, use the command line.
+At this time, binary packages are only released for Debian and Ubuntu. On the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, find and download the ScummVM package that corresponds to your operating system and architecture. To install a DEB package, either double click on the downloaded DEB file to use the graphical installer, or, if that's not available, use the command line.
.. code:: bash
sudo apt install /path/to/downloaded/file.deb
-Replace ``/path/to/downloaded/file.deb`` with the actual path to the downloaded ``.deb`` package. The APT software manager will handle the installation.
+Replace ``/path/to/downloaded/file.deb`` with the actual path to the downloaded DEB package. The APT software manager handles the installation.
To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
@@ -98,13 +96,13 @@ There are two ways to install ScummVM onto a computer running Windows; download
Installer
************
-Download the Windows installer for your operating system, and double click the downloaded file. The installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
+Download the Windows installer for your operating system from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, and double click the downloaded file. The installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
To run ScummVM, either navigate to desktop and double click the ScummVM shortcut, or go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Apps > ScummVM**.
Manual
**********
-Download the Windows ``.zip`` file for your operating system (32bit or 64bit). To unzip the contents, right-click the folder and select **Extract All**.
+Download the Windows zip file for your operating system (32bit or 64bit). To extract the files, right-click the folder and select **Extract All**.
To run ScummVM from the extracted folder, find the ``scummvm.exe`` file and double click it.
diff --git a/doc/docportal/help/contact.rst b/doc/docportal/help/contact.rst
index 7df94adb8a..14d8ba0b44 100644
--- a/doc/docportal/help/contact.rst
+++ b/doc/docportal/help/contact.rst
@@ -1,10 +1,10 @@
==============
-Contact us!
+Contact us
==============
There are a few ways to become a part of the ScummVM community:
-Chatting on the `Discord Channel <https://discord.com/invite/5D8yTtF>`_ or the `IRC Channel <irc://irc.freenode.net/scummvm?key=scummvm>`_ | Posting on the `ScummVM Forum <https://forums.scummvm.org/>`_ | Or by `Reporting a Bug <https://bugs.scummvm.org/>`_
+Chat with us on the `Discord Channel <https://discord.com/invite/5D8yTtF>`_ or the `IRC Channel <irc://irc.freenode.net/scummvm?key=scummvm>`_ | Post on the `ScummVM Forum <https://forums.scummvm.org/>`_ | Or `Report a Bug <https://bugs.scummvm.org/>`_
We look forward to meeting you!
\ No newline at end of file
diff --git a/doc/docportal/help/faq.rst b/doc/docportal/help/faq.rst
index c86ecf0a72..dc3d3ec923 100644
--- a/doc/docportal/help/faq.rst
+++ b/doc/docportal/help/faq.rst
@@ -14,13 +14,13 @@ About
Is ScummVM an emulator?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-No. ScummVM replaces the original executable files that shipped with the game. This means that your games can run on many different platforms they were never designed to run on! For an in-depth look at how ScummVM works, see our `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
+No. ScummVM replaces the original executable files that shipped with the game. This means that your games can run on many different platforms they were never designed to run on! For an in-depth look at how ScummVM works, see the `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
Is ScummVM free?
^^^^^^^^^^^^^^^^^^^^
ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is freely available for you to do whatever you want with it. If you make modifications and redistribute your work, you must make your source code available.
-The ScummVM team would be delighted if you send them your modifications, so that the changes can be merged into the main source code. See the `Contributing guide <#>`_ on our wiki.
+The ScummVM team would be delighted if you send them your modifications, so that the changes can be merged into the main source code. See the `Developer Central <https://wiki.scummvm.org/index.php/Developer_Central>`_ wiki page.
How do I install ScummVM onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -28,9 +28,10 @@ See :ref:`firststeps`.
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:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
+For general guidance, see the :doc:`../use_scummvm/add_play_games` page. For specific information, find the page for your device on the sidebar.
+
+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?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -41,13 +42,14 @@ Games
Can I only play LucasArts SCUMM games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the `Supported games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ page on our wiki for a comprehensive list. There is a caveat; not all supported games are playable on all platforms. Sometimes this is because the game is simply too CPU intensive for the device, or there may be many other reasons. If a game is not available on a platform, you will not be able to add it to ScummVM.
+Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the `Supported games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ page on our wiki for a comprehensive list. There is a caveat; not all supported games are playable on all platforms. Sometimes this is because the game is simply too CPU intensive for the device, or there might be many other reasons. If a game is not available on a platform, you will not be able to add it to ScummVM.
.. _getgames:
Where do I get the games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See `Where to get the games <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ on our wiki.
+See the :doc:`../use_scummvm/add_play_games` page.
+
.. _installgames:
@@ -61,7 +63,7 @@ If you do not have any hard copy games, there are some digital options available
How do I know if I can play my game using ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The best place to check is the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
+The best place to check is the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website.
I have saved games from when I played the original game - can I use these with ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -69,11 +71,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:`../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.
+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`.
What are the in-game keyboard shortcuts?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A list of default shortcuts can be found on the :doc:`../use_scummvm/keyboard_shortcuts` page. Since version 2.2.0 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 you can create custom shortcuts on the :doc:`../settings/keymaps` tab.
Troubleshooting
===================
@@ -98,11 +100,11 @@ Games
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.
+1. Make sure your game is supported. Check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website, and the `Platform Overview <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ page on the wiki.
2. Check that you have all the required datafiles. See the :doc:`../use_scummvm/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`
+3. Ask for advice on the ScummVM forums or on DIscord. See the :doc:`contact` page.
4. If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
@@ -125,7 +127,7 @@ Sometimes it's worth checking the obvious.
1. Are your speakers on? Are your headphones properly connected?
2. Try playing an audio clip from another source to see if you have sound in general.
-3. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM should fall back on an audio setting that works, but if it doesn't, you may need to change the settings yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
+3. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM falls back on an audio setting that works, but if for some reason it doesn't, you might need to change the settings yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
Help! There's no sound on my iPhone/iPad!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -133,20 +135,20 @@ ScummVM will not play any sound if your device is in Silent Mode. If this is not
I have a "talkie" version of a LucasArts game but I can't hear the voices. What's the problem?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The original games shipped with an uncompressed ``MONSTER.SOU`` file - this is the voice file. If you have compressed this file to either a ``MONSTER.SO3`` (``.mp3``), ``MONSTER.SOG`` (``.ogg``), or ``MONSTER.SOF`` (``.flac``) format, make sure that the ScummVM you're using has support for those formats.
+The original games shipped with an uncompressed ``MONSTER.SOU`` file, which is the voice file. If you have compressed this file to either a ``MONSTER.SO3`` (MP3 file), ``MONSTER.SOG`` (OGG file), or ``MONSTER.SOF`` (FLAC file) format, make sure that the ScummVM you're using has support for those formats.
The audio is really glitchy. What can I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-There may be a few things at play here.
+There might be a few things at play here.
-- Try to increase the :ref:`audio buffer size <buffer>` in the :doc:`configuration file <../advanced_topics/configuration_file>`.
-- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU may not have the processing power to keep up. In this case, you may have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, as long as your platform supports it.
-- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU may not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
+- Try to increase the :ref:`audio buffer size <buffer>` in the configuration file.
+- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU might not have the processing power to keep up. In this case, you might have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, as long as your platform supports it.
+- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU might not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
- If you are using the :ref:`adlib` emulator, try selecting the least CPU-intensive option; MAME.
I have a CD version of a game, how do I get the sound to work without running the game from the CD?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See using :ref:`cdaudio`.
+See :ref:`cdaudio`.
Graphics
***********
diff --git a/doc/docportal/help/report_bugs.rst b/doc/docportal/help/report_bugs.rst
index 26b3e047d0..4914ae43a4 100644
--- a/doc/docportal/help/report_bugs.rst
+++ b/doc/docportal/help/report_bugs.rst
@@ -26,7 +26,7 @@ To help you report a bug, you can find error messages in the ScummVM log file. T
.. panels::
:column: col-lg-12 mb-2
- We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location may vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
+ We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location might vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
.. tabbed:: Windows
diff --git a/doc/docportal/other_platforms/amigaos_4.rst b/doc/docportal/other_platforms/amigaos_4.rst
index 6599b34ac4..590686b92c 100644
--- a/doc/docportal/other_platforms/amigaos_4.rst
+++ b/doc/docportal/other_platforms/amigaos_4.rst
@@ -31,7 +31,7 @@ Transfer game files
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.
+For games on PC or Mac formatted discs, use the original platform to access the data files, and then transfer these to Amiga. Alternatively, if you have external hardware such as a Catweazel floppy disc controller, you might be able to use this to access the files.
ScummVM for Amiga OS has Cloud and LAN functionality, to help manage the transfer of files. See :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
@@ -67,6 +67,6 @@ The CAMD driver allows the use of MIDI hardware. Select CAMD as the :ref:`Prefer
Known issues
==============
-Due to the Big Endian nature of Amiga OS, there can sometimes be graphics and sounds issues with games. Check out the Platform Overview `wiki page <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ for a list of compatible engines.
+Due to the big-endian nature of Amiga OS, there can sometimes be graphics and sounds issues with games. Check out the Platform Overview `wiki page <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ for a list of compatible engines.
If a game crashes and it's listed as compatible, report it as a :doc:`bug <../help/report_bugs>`.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/atari.rst b/doc/docportal/other_platforms/atari.rst
index 076373417a..8d2c37353b 100644
--- a/doc/docportal/other_platforms/atari.rst
+++ b/doc/docportal/other_platforms/atari.rst
@@ -9,17 +9,19 @@ Prerequisites
****************
- A powerful Atari system or clone; minimum CPU 68060.
-- FreeMiNT, TOS or MagiC.
+- FreeMiNT, TOS or MagiC operating system.
Download and install ScummVM
*********************************
-A binary package is provided for the m68000 CPU, one for the m68020 to m68060 range of CPUs, and one for the Coldfire (FireBee) CPU. All are available for download from the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_. To install ScummVM, extract the selected ScummVM archive into a folder on the hard disk.
+Binary packages are provided for the m68000 CPU, the m68020 to m68060 range of CPUs, and the Coldfire (FireBee) CPU. All are available for download from the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_. To install ScummVM, extract the selected ScummVM archive into a folder on the hard disk.
Run ``scummvm.gtp`` to start Scummvm. The ``scummvm.gtp`` command will take :doc:`command line options <../advanced_topics/command_line>` to set parameters for the ScummVM session.
To run ScummVM from a FreeMiNT Command Line Interface, make the program executable with the following command:
+.. code-block:: bash
+
chmod +x scummvm.gtp
For the best performance, run ScummVM under FreeMiNT, from the command line, and without the AES started.
@@ -32,9 +34,7 @@ Transfer files to the Atari as you normally would, such as through a network con
Controls
=================
-Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`.
-
-See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
Paths
@@ -58,16 +58,25 @@ For more information, see the Settings section of the documentation. Only platfo
Graphics
************
-For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. XBIOS works better than GEM, since GEM rendering seems to be slower. Note that this is not a ScummVM setting, but rather a system-wide setting.
+For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. XBIOS works better than GEM, because GEM rendering is slower. Note that this is not a ScummVM setting, but rather a system-wide setting.
+
+Audio
+*******
+
+Supported audio file formats:
+- MP3
+- OGG
+- FLAC
+- Uncompressed audio
Known issues
==============
-- There is no Cloud/LAN functionality.
+- There is no cloud/LAN functionality.
-- The native MIDI driver (STMIDI) does not work. This is due to an issue with SDL timers not functioning properly from the Atari version of SDL 1.2.
+- The built-in MIDI driver (STMIDI) does not work.
-- While support for ``.FLAC``, ``.OGG`` and ``.MP3`` audio formats is available in the Atari port of ScummVM, these decoding libraries are extremely CPU intensive and greatly slow down the user experience. ScummVM is best run with uncompressed audio, when available.
+- FLAC, OGG and MP3 decoding libraries are extremely CPU intensive and greatly slow down the user experience. ScummVM is best run with uncompressed audio, when available.
- While all supported engines are included in the Atari ScummVM release, not all games will run well due to the lack of resources. For example, the Curse of Monkey Island will run on a CT60-equipped Atari Falcon, but very poorly.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/risc_os.rst b/doc/docportal/other_platforms/risc_os.rst
index d9e52762c9..652013b7bf 100644
--- a/doc/docportal/other_platforms/risc_os.rst
+++ b/doc/docportal/other_platforms/risc_os.rst
@@ -16,14 +16,14 @@ Download and install ScummVM
Download the RISC OS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_.
-Use a tool such as SparkFS to extract the archive. It is important that the archive is not extracted on any other system, since this results in a loss of file type information. ScummVM requires this file type information to run properly.
+Use a tool such as SparkFS to extract the archive. It is important that the archive is not extracted on any other system, because this results in a loss of file type information. ScummVM requires the file type information to run properly.
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.
+Copy data files directly from the original discs on machines that have CD and/or floppy drives, or use a USB drive to transfer the files from another system.
See :doc:`../use_scummvm/add_play_games` for more information.
@@ -56,14 +56,14 @@ For more information about settings, see the Settings section of the documentati
.. _reporter:
-There is one additional configuration option, *enable_reporter*. When set to true in :doc:`../advanced_topics/configuration_file`, log messages are sent to the `!Reporter <http://www.avisoft.force9.co.uk/Reporter.html>`_ application, which can be useful to developers.
+There is one additional configuration option, *enable_reporter*. When set to true in :doc:`../advanced_topics/configuration_file`, log messages are sent to the `!Reporter <http://www.avisoft.force9.co.uk/Reporter.html>`_ application. This is useful mostly for developers.
Known issues
==============
-- Due to ongoing issues with executable size, releases are built without Cloud or LAN functionality.
+- ScummVM for RISC OS does not have cloud or LAN functionality.
- FluidSynth is not supported.
-- The releases are only compatible with RISC OS 5, and not RISC OS 3, 4, or 6.
+- ScummVM is not compatible with RISC OS 3, 4 or 6.
\ No newline at end of file
diff --git a/doc/docportal/release_notes/release_notes_2.2.0.rst b/doc/docportal/release_notes/release_notes_2.2.0.rst
index 6596dd64db..eb748ee8bc 100644
--- a/doc/docportal/release_notes/release_notes_2.2.0.rst
+++ b/doc/docportal/release_notes/release_notes_2.2.0.rst
@@ -5,7 +5,9 @@ Version 2.2.0 - "Interactive Fantasy"
New games
=============
- - Currently, more than 1600 games are detected and supported.
+
+Currently, more than 1600 games are detected and supported.
+
- Added support for Blazing Dragons.
- Added support for Griffon Legend.
- Added support for Interactive Fiction games based on the following engines:
@@ -123,8 +125,8 @@ SCUMM
- Fixed the rendering of the flashlight in MM NES to match the original version.
- Replaced the existing NES palette to a more accurate NTSC palette based on Mesen.
- Added a new GUI option to switch to an alternative NES palette based on the NES Classic.
- - Improved colors in Apple //gs Maniac Mansion.
- - Fixed crash when entering garage in Apple //gs Maniac Mansion.
+ - Improved colors in Apple IIGS Maniac Mansion.
+ - Fixed crash when entering garage in Apple IIGS Maniac Mansion.
- Added support from Classic Full Throttle from Remastered release.
Supernova
@@ -135,7 +137,7 @@ Supernova
Sky
********
- - Fixed syncing of music volume between native settings panel and ScummVM configuration.
+ - Fixed syncing of music volume between built-in settings panel and ScummVM configuration.
Sword1
********
diff --git a/doc/docportal/settings/audio.rst b/doc/docportal/settings/audio.rst
index 472313142f..bac3a72d07 100644
--- a/doc/docportal/settings/audio.rst
+++ b/doc/docportal/settings/audio.rst
@@ -52,7 +52,7 @@ AdLib Emulator
.. _speechmute:
Text and Speech
- For games with digitized speech, this setting allows the user to decide whether to play the game with speech only, subtitles only, or both.
+ 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*
diff --git a/doc/docportal/settings/cloud.rst b/doc/docportal/settings/cloud.rst
index 6bfe4ff5e6..2033a383e4 100644
--- a/doc/docportal/settings/cloud.rst
+++ b/doc/docportal/settings/cloud.rst
@@ -18,7 +18,7 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the Cl
Active storage
Choose from Dropbox, OneDrive, Google Drive, or Box.
-Once a Cloud service has been selected, further options are available:
+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.
diff --git a/doc/docportal/settings/control.rst b/doc/docportal/settings/control.rst
index d17db96ff8..02a1cc17fe 100644
--- a/doc/docportal/settings/control.rst
+++ b/doc/docportal/settings/control.rst
@@ -31,4 +31,4 @@ Show on-screen control
Toggles the small on-screen keyboard icon on and off.
Touchpad mouse mode
- Toggles between :ref:`direct` and :ref:`touchpad`.
\ No newline at end of file
+ Toggles between direct mode and touchpad mode.
\ No newline at end of file
diff --git a/doc/docportal/settings/engine.rst b/doc/docportal/settings/engine.rst
index 075aba8fed..4d8eff1075 100644
--- a/doc/docportal/settings/engine.rst
+++ b/doc/docportal/settings/engine.rst
@@ -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 **Edit Game**, and then select the **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 might 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>`_.
@@ -75,7 +75,7 @@ Use an alternative palette
.. _support:
Mouse support
- Enables mouse support. Allows use of the mouse for movement and in game menus.
+ Enables mouse support for movement and in game menus.
*mousesupport*
@@ -124,7 +124,7 @@ Shorty mode
.. _nodelay:
Frame limiter high performance mode
- Avoids use of ``delayMillis()`` function. This mode may result in high CPU usage.
+ Avoids use of ``delayMillis()`` function. This mode might result in high CPU usage.
*nodelaymillisfl*
@@ -251,7 +251,7 @@ Enable studio audience
.. _skipsupport:
Skip support
- Allows the user to skip text and cutscenes.
+ Lets the user skip text and cutscenes.
*skip_support*
@@ -367,7 +367,7 @@ Use original save/load screens
.. _skiphall:
Skip the Hall of Records storyboard scenes
- Allows the player to skip past the Hall of Records storyboard scenes.
+ Lets the player skip past the Hall of Records storyboard scenes.
*skiphallofrecordsscenes*
@@ -630,7 +630,7 @@ XEEN
.. _cost:
Show item costs in standard inventory mode
- Shows item costs in standard inventory mode, which allows the value of items to be compared.
+ Shows item costs in standard inventory mode, which lets the value of items be compared.
*ShowItemCosts*
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index f01e10e992..8154a70a3f 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -31,7 +31,7 @@ From the Launcher, highlight a game on the games list, then select **Edit Game**
.. _lang:
**Language**
- 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.
+ 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 example, selecting German will add an umlaut to German subtitles, and selecting Spanish will add the tilde to Spanish subtitles.
*language*
diff --git a/doc/docportal/settings/lan.rst b/doc/docportal/settings/lan.rst
index 8373aa44ae..6db43c3387 100644
--- a/doc/docportal/settings/lan.rst
+++ b/doc/docportal/settings/lan.rst
@@ -4,7 +4,7 @@ LAN
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.
+ScummVM can run a local network web server for browser-based file management, including uploading and downloading game files.
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
@@ -17,7 +17,7 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the LA
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
Run server
- Starts the web server. Once running, this displays the URL at which the web server can be accessed.
+ Starts the web server. When running, this displays the URL at which the web server can be accessed.
Stop server
Stops the web server.
diff --git a/doc/docportal/use_scummvm/add_play_games.rst b/doc/docportal/use_scummvm/add_play_games.rst
index 7d9d274b76..b7df280a38 100644
--- a/doc/docportal/use_scummvm/add_play_games.rst
+++ b/doc/docportal/use_scummvm/add_play_games.rst
@@ -50,9 +50,9 @@ For games on floppies or CDs:
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.
+- If the data files are supplied as a zip file, extract the files.
-For macOS or Linux users without access to a Windows machine, it is possible to get the game files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer on macOS or Linux. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.
+For macOS or Linux users without access to a Windows machine, you can get the game files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer on macOS or Linux. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.
@@ -74,13 +74,13 @@ ScummVM needs access to all the data files, so it will not be able to run direct
CD audio
**********
-Some games contain one or more separate audio tracks on CD. To use these with ScummVM, extract the audio tracks from the CD in ``.wav`` or ``.aiff`` format, and then convert them to either ``.mp3``, ``.flac`` or ``.ogg`` file formats.
+Some games contain one or more separate audio tracks on CD. To use these with ScummVM, extract the audio tracks from the CD in WAV or AIFF format, and then convert them to either MP3, FLAC or OGG file formats.
.. tip::
Software suggestion:
- `fre:ac <https://www.freac.org/>`_ is a multi-platform, open-source software, with the ability to both rip CDs and convert audio between ``.mp3``, ``.ogg``, ``.flac`` and ``.wav`` formats.
+ `fre:ac <https://www.freac.org/>`_ is a multi-platform, open-source software, with the ability to both rip CDs and convert audio between MP3, OGG, FLAC and WAV file formats.
Place the converted audio files in the same folder that contains the other game datafiles.
@@ -94,9 +94,9 @@ 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, `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 Windows, `HFS Explorer <http://www.catacombae.org/hfsexplorer/>`_ is a basic and free option, which gives you read-only access to HFS drives. Use the installer rather than the zip file, to ensure it is installed correctly.
-For Linux, hfsplus allows read-only access to HFS drives. To use hfsplus, use the command line:
+For Linux, hfsplus gives you read-only access to HFS drives. To use hfsplus, use the command line:
1. Install hfsplus using the software manager. On Debian-based distributions, use ``sudo apt install hfsplus``.
2. Find the game disc by running ``sudo fdisk -l`` and finding the one with type ``Apple HFS/HFS+``. In this example, this is ``/dev/fd0``.
@@ -124,9 +124,9 @@ Add games to the Launcher
.. note::
- The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the native system file browser, or its own file browser.
+ The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the system file browser, or its own file browser.
-5. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should work at the default settings. Click **Ok**.
+5. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything is OK at the default settings. Click **Ok**.
.. image:: ../images/Launcher/game_settings.png
:class: with-shadow
diff --git a/doc/docportal/use_scummvm/connect_cloud.rst b/doc/docportal/use_scummvm/connect_cloud.rst
index 91e8a077cc..4a617ecec0 100644
--- a/doc/docportal/use_scummvm/connect_cloud.rst
+++ b/doc/docportal/use_scummvm/connect_cloud.rst
@@ -8,7 +8,7 @@ To connect your chosen cloud storage service to ScummVM, select it from the **Ac
.. figure:: ../images/cloud_and_lan/cloud_storage.png
-Click on the link shown at **1.**, and log in to your cloud storage account. Once you have logged in, a 6-digit code will be displayed.
+Click on the link shown at **1.**, and sign in to your cloud storage account. After you sign in, a 6-digit code will be displayed.
.. figure:: ../images/cloud_and_lan/cloud_code.png
@@ -16,7 +16,7 @@ Copy the 6-digit code, click into the empty field next to **Paste**, and then cl
.. figure:: ../images/cloud_and_lan/cloud_connect.png
-Click **3. Connect**. Once the next page loads, click **Enable storage**.
+Click **3. Connect**. After the next page loads, click **Enable storage**.
.. figure:: ../images/cloud_and_lan/cloud_enable.png
diff --git a/doc/docportal/use_scummvm/save_load_games.rst b/doc/docportal/use_scummvm/save_load_games.rst
index b604bf478d..449b565b13 100644
--- a/doc/docportal/use_scummvm/save_load_games.rst
+++ b/doc/docportal/use_scummvm/save_load_games.rst
@@ -63,7 +63,7 @@ To load a saved state from within a game, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5
Location of saved game files
-------------------------------
-The save directory can be changed via the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_topics/configuration_file>`.
+The save directory can be changed with the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_topics/configuration_file>`.
Default saved game paths are shown below.
@@ -114,7 +114,7 @@ Default saved game paths are shown below.
:column: col-lg-12 mb-2
- 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.
+ We follow the XDG Base Directory Specification, so by default the saved games can be found at ``~/.local/share/scummvm/saves/``, but this location might vary depending on the value of the ``XDG_DATA_HOME`` environment variable.
``.local`` is a hidden directory. To view it use ``ls -a`` on the command line, or, if you are using a GUI file manager, press :kbd:`Ctrl + H`.
diff --git a/doc/docportal/use_scummvm/the_launcher.rst b/doc/docportal/use_scummvm/the_launcher.rst
index b455b6570b..89f22eee2f 100755
--- a/doc/docportal/use_scummvm/the_launcher.rst
+++ b/doc/docportal/use_scummvm/the_launcher.rst
@@ -18,10 +18,10 @@ The pane on the left is the games list, which lists all the games that have been
Quick search
=============
-Quick search allows you to filter the games list.
+Quick search lets you filter the games list.
The quick search input is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, click **X** next to the input field.
-There are many ways to filter games. For instance, you can type "Monkey Island" to quickly locate all "Monkey Island" games on the list, or you can type "German" to find German games.
+There are many ways to filter games. For example, you can type "Monkey Island" to locate all "Monkey Island" games on the list, or you can type "German" to find German games.
.. figure:: ../images/Launcher/quicksearch.png
Commit: 4206bc5035c2ad29a5b9bfc88f6f4ff1562e8aef
https://github.com/scummvm/scummvm/commit/4206bc5035c2ad29a5b9bfc88f6f4ff1562e8aef
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: changes logo and theming
- adds ScummVM logo
- adds external link icons
- changes navbar colors
- changes PDF output - removes blank pages
- new font
Changed paths:
A doc/docportal/logo.png
doc/docportal/_static/custom.css
doc/docportal/conf.py
diff --git a/doc/docportal/_static/custom.css b/doc/docportal/_static/custom.css
index f2995fe7d6..cc007e8ff2 100644
--- a/doc/docportal/_static/custom.css
+++ b/doc/docportal/_static/custom.css
@@ -20,3 +20,11 @@
}
}
+.wy-side-nav-search, .wy-nav-top {
+ background-color: #cc6600 !important;
+ }
+
+.caption-text, .icon-home {
+ color: #cc6600;
+}
+
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index 88aa779ff1..00d0a0ed76 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -55,21 +55,39 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
#
html_theme = "sphinx_rtd_theme"
-html_css_files = ["https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"]
+html_logo = 'logo.png'
+
+html_theme_options = {
+ 'logo_only': True,
+ 'style_external_links': True,
+}
-html_js_files = ["https://kit.fontawesome.com/b9732bf460.js"]
html_static_path = ['_static']
-def setup(app):
- app.add_css_file("custom.css")
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
+html_css_files = ["https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"]
+
+def setup(app):
+ app.add_css_file("custom.css")
master_doc = 'index'
html_sidebars = {'**': ['localtoc.html']}
-panels_add_fontawesome_latex = True
\ No newline at end of file
+panels_add_fontawesome_latex = True
+
+#Options for LaTex Output
+
+latex_elements = {
+ 'extraclassoptions': 'openany,oneside',
+ 'preamble':r'''
+ \usepackage{kpfonts}
+ \usepackage[defaultsans]{lato}
+ \usepackage{kpfonts}
+ ''',
+}
+
diff --git a/doc/docportal/logo.png b/doc/docportal/logo.png
new file mode 100644
index 0000000000..5d3085bf11
Binary files /dev/null and b/doc/docportal/logo.png differ
Commit: c50acc201445ebca4f14c936468152c057f91bb7
https://github.com/scummvm/scummvm/commit/c50acc201445ebca4f14c936468152c057f91bb7
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: changes pdf output fonts
Changed paths:
doc/docportal/conf.py
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index 00d0a0ed76..7a272f324b 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -84,10 +84,10 @@ panels_add_fontawesome_latex = True
latex_elements = {
'extraclassoptions': 'openany,oneside',
- 'preamble':r'''
- \usepackage{kpfonts}
- \usepackage[defaultsans]{lato}
- \usepackage{kpfonts}
+ 'fontpkg': r'''
+ \setmainfont{DejaVu Sans}
+ \setsansfont{DejaVu Sans}
+ \setmonofont{Dejavu Sans Mono}
''',
}
Commit: 23853634a62c780b8e2ada73c5a996089f2c7f01
https://github.com/scummvm/scummvm/commit/23853634a62c780b8e2ada73c5a996089f2c7f01
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: changes PDF output font
Changed paths:
doc/docportal/conf.py
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index 7a272f324b..7aa9423981 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -84,10 +84,15 @@ panels_add_fontawesome_latex = True
latex_elements = {
'extraclassoptions': 'openany,oneside',
- 'fontpkg': r'''
- \setmainfont{DejaVu Sans}
- \setsansfont{DejaVu Sans}
- \setmonofont{Dejavu Sans Mono}
+ 'fncychap': ' ',
+ 'preamble': r'''
+ \usepackage{lato}
+ \usepackage{Inconsolata}
''',
+ 'fontpkg': r'''
+ \setmainfont{Lato}
+ \setsansfont{Lato}
+ \setmonofont{Inconsolata}
+ ''',
}
Commit: 73a6cc4306ad7223a9029079ae1aea6065acf497
https://github.com/scummvm/scummvm/commit/73a6cc4306ad7223a9029079ae1aea6065acf497
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: changes PDF fonts
Changed paths:
doc/docportal/conf.py
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index 7aa9423981..ce3fb4240a 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -86,13 +86,10 @@ latex_elements = {
'extraclassoptions': 'openany,oneside',
'fncychap': ' ',
'preamble': r'''
+ \usepackage{lato}
\usepackage{lato}
\usepackage{Inconsolata}
''',
- 'fontpkg': r'''
- \setmainfont{Lato}
- \setsansfont{Lato}
- \setmonofont{Inconsolata}
- ''',
+
}
Commit: e123f389fac50be98edd82f44010c496e1c03945
https://github.com/scummvm/scummvm/commit/e123f389fac50be98edd82f44010c496e1c03945
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: fixes PDF font spelling
Changed paths:
doc/docportal/conf.py
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index ce3fb4240a..993367b6b5 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -88,7 +88,7 @@ latex_elements = {
'preamble': r'''
\usepackage{lato}
\usepackage{lato}
- \usepackage{Inconsolata}
+ \usepackage{inconsolata}
''',
}
Commit: 9b50c278a6deb1a45fc815a92877fb78863f2f3f
https://github.com/scummvm/scummvm/commit/9b50c278a6deb1a45fc815a92877fb78863f2f3f
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: changes PDF output
Changed paths:
doc/docportal/conf.py
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index 993367b6b5..6f1bf745ac 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -85,9 +85,10 @@ panels_add_fontawesome_latex = True
latex_elements = {
'extraclassoptions': 'openany,oneside',
'fncychap': ' ',
+ 'pointsize': '11pt',
'preamble': r'''
- \usepackage{lato}
- \usepackage{lato}
+ \usepackage{charter}
+ \usepackage[defaultsans]{lato}
\usepackage{inconsolata}
''',
Commit: 7d39826b26478ebe094a8df2ea7fa7b7aa60a1d8
https://github.com/scummvm/scummvm/commit/7d39826b26478ebe094a8df2ea7fa7b7aa60a1d8
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: multiple changes in response to review
Getting started/ports:
- As a trial, redesigned the site layout
- All install/control/path info is now contained in section "The basics"
- Duplicate information has not been removed - awaiting feedback
General changes:
- Lightened up the tone in some sections
- Made headings more descriptive
- Added reference to .ini keys on Settings pages
- Reformatted Launcher page
- Split adding/playing games into two pages
- Added favicon
- Changed formatting of inline code
Changed paths:
A doc/docportal/images/Launcher/launcher.png
A doc/docportal/images/Launcher/mass_add_confirm.png
A doc/docportal/images/Launcher/mass_add_success.png
A doc/docportal/images/cloud_and_lan/LAN.png
A doc/docportal/images/cloud_and_lan/LAN_server.png
A doc/docportal/images/cloud_and_lan/LAN_server_new.png
A doc/docportal/images/cloud_and_lan/LAN_server_upload.png
A doc/docportal/images/donate/GOG_button_small.png
A doc/docportal/images/donate/ppdonate.png
A doc/docportal/ports/amigaos_4.rst
A doc/docportal/ports/atari.rst
A doc/docportal/ports/nintendo_3ds.rst
A doc/docportal/ports/nintendo_switch.rst
A doc/docportal/ports/playstation_3.rst
A doc/docportal/ports/playstation_portable.rst
A doc/docportal/ports/ps_vita.rst
A doc/docportal/ports/risc_os.rst
A doc/docportal/ports/sega_dreamcast.rst
A doc/docportal/scummvm.ico
A doc/docportal/settings/how_to_settings.rst
A doc/docportal/trial/computer.rst
A doc/docportal/trial/console.rst
A doc/docportal/trial/phones.rst
A doc/docportal/use_scummvm/game_files.rst
R doc/docportal/consoles/nintendo_3ds.rst
R doc/docportal/consoles/nintendo_switch.rst
R doc/docportal/consoles/playstation_3.rst
R doc/docportal/consoles/playstation_portable.rst
R doc/docportal/consoles/ps_vita.rst
R doc/docportal/consoles/sega_dreamcast.rst
R doc/docportal/images/settings/LAN.png
R doc/docportal/images/settings/LAN_server.png
R doc/docportal/images/settings/LAN_server_new.png
R doc/docportal/images/settings/LAN_server_upload.png
R doc/docportal/other_platforms/amigaos_4.rst
R doc/docportal/other_platforms/atari.rst
R doc/docportal/other_platforms/risc_os.rst
R doc/docportal/use_scummvm/how_to_settings.rst
doc/docportal/_static/custom.css
doc/docportal/advanced_topics/command_line.rst
doc/docportal/advanced_topics/configuration_file.rst
doc/docportal/advanced_topics/understand_audio.rst
doc/docportal/advanced_topics/understand_graphics.rst
doc/docportal/conf.py
doc/docportal/get_started/android.rst
doc/docportal/help/contact.rst
doc/docportal/help/report_bugs.rst
doc/docportal/images/Launcher/mass_add.png
doc/docportal/images/Launcher/quicksearch.png
doc/docportal/index.rst
doc/docportal/settings/accessibility.rst
doc/docportal/settings/audio.rst
doc/docportal/settings/cloud.rst
doc/docportal/settings/control.rst
doc/docportal/settings/engine.rst
doc/docportal/settings/game.rst
doc/docportal/settings/graphics.rst
doc/docportal/settings/keymaps.rst
doc/docportal/settings/lan.rst
doc/docportal/settings/misc.rst
doc/docportal/settings/paths.rst
doc/docportal/use_scummvm/LAN.rst
doc/docportal/use_scummvm/add_play_games.rst
doc/docportal/use_scummvm/connect_cloud.rst
doc/docportal/use_scummvm/keyboard_shortcuts.rst
doc/docportal/use_scummvm/save_load_games.rst
doc/docportal/use_scummvm/the_launcher.rst
diff --git a/doc/docportal/_static/custom.css b/doc/docportal/_static/custom.css
index cc007e8ff2..f4b606779e 100644
--- a/doc/docportal/_static/custom.css
+++ b/doc/docportal/_static/custom.css
@@ -2,8 +2,6 @@
@media (min-width: 385px){
.wy-table-responsive table td {
- /* !important prevents the common CSS stylesheets from overriding
- this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}
@@ -20,6 +18,8 @@
}
}
+/* Change theme colors*/
+
.wy-side-nav-search, .wy-nav-top {
background-color: #cc6600 !important;
}
@@ -28,3 +28,16 @@
color: #cc6600;
}
+/* Change header size*/
+
+h4 {
+ font-size: 100% !important;
+}
+
+/* Change inline code formatting*/
+
+.rst-content code.literal {
+ padding: 5px !important;
+ white-space: normal;
+ color: #000000;
+}
\ No newline at end of file
diff --git a/doc/docportal/advanced_topics/command_line.rst b/doc/docportal/advanced_topics/command_line.rst
index aee80345cd..c2f9c9e2d9 100755
--- a/doc/docportal/advanced_topics/command_line.rst
+++ b/doc/docportal/advanced_topics/command_line.rst
@@ -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:\Program Files\ScummVM\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:\Program Files\ScummVM\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:\Program Files\ScummVM\scummvm.exe -f -n -pD:``resource``ft
.. tabbed:: Linux/Unix
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index c18e2e630d..3508486afc 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -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 the Launcher. See :doc:`../use_scummvm/how_to_settings`.
+Settings are also accessible directly from the Launcher. See :doc:`../settings/how_to_settings`.
Location
==========
@@ -17,7 +17,7 @@ The configuration file saves to different default locations, depending on the pl
.. panels::
:column: col-lg-12 mb-2
- ``~/Library/Preferences/ScummVM Preferences``, where ``~`` is your Home directory.
+ ``~/Library/Preferences/ScummVM Preferences``
.. note::
@@ -25,7 +25,7 @@ The configuration file saves to different default locations, depending on the pl
.. tip::
- To see the Library folder you will need to view hidden files by using the keyboard shortcut :kbd:`Cmd + Shift + .`
+ To see the Library folder, press :kbd:`Option` when clicking **Go** in the Finder menu.
.. tabbed:: Windows
@@ -36,7 +36,7 @@ The configuration file saves to different default locations, depending on the pl
95/98/ME
^^^^^^^^^^
- ``<windir>\scummvm.ini``, where ``<windir>`` is the Windows directory. Most commonly, this is ``C:\WINDOWS``.
+ ``C:\WINDOWS\scummvm.ini``
---
@@ -45,7 +45,7 @@ The configuration file saves to different default locations, depending on the pl
Windows NT4
^^^^^^^^^^^^
- ``<windir>\Profiles\username\Application Data\ScummVM\scummvm.ini``, where ``<windir>`` is the Windows directory. Most commonly, this is ``C:\WINDOWS``.
+ ``C:\WINDOWS\Profiles\username\Application Data\ScummVM\scummvm.ini``
---
:column: col-lg-12 mb-2
@@ -59,31 +59,21 @@ The configuration file saves to different default locations, depending on the pl
Window Vista/7/8/10
^^^^^^^^^^^^^^^^^^^^^^
- ``\Users\username\AppData\Roaming\ScummVM\scummvm.ini``
+ ``%APPDATA%\ScummVM\scummvm.ini``
- .. tip::
-
- The AppData folder is hidden. The steps to view hidden files and folders depends on the Windows version.
-
- For more information, see this `Windows support page <https://support.microsoft.com/en-us/help/14201/windows-show-hidden-files>`_.
-
-
- .. note::
-
- If an earlier version of ScummVM was installed under Windows, the configuration file remains in the previous default location of ``<windir>\scummvm.ini``
.. tabbed:: Linux/Unix
.. panels::
:column: col-lg-12 mb-2
- We follow the XDG Base Directory Specification, so by default the configuration file is found at ``/~.config/scummvm/scummvm.ini``, but its location might vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
+ ScummVM follows the XDG Base Directory Specification, so by default the configuration file is found at ``~/.config/scummvm/scummvm.ini``, but its location might vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
If ScummVM was installed using Snap, the configuration file 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, or, if you are using a GUI file manager, press :kbd:`Ctrl + H`.
+ ``.config`` is a hidden directory. To view it use ``ls -a`` on the command line.
@@ -142,10 +132,10 @@ Example of a configuration file
music_driver=windows
-Keywords
-===========
+Configuration keys
+=====================
-There are many recognized configuration keywords. In the table below, each keyword is linked to an explanatory description in the Settings pages.
+There are many recognized configuration keys. In the table below, each keyword is linked to an explanatory description in the Settings pages.
.. csv-table::
:widths: 35 15 25 25
diff --git a/doc/docportal/advanced_topics/understand_audio.rst b/doc/docportal/advanced_topics/understand_audio.rst
index d3e7622569..1052ee3c43 100644
--- a/doc/docportal/advanced_topics/understand_audio.rst
+++ b/doc/docportal/advanced_topics/understand_audio.rst
@@ -103,6 +103,10 @@ Some games which contain MIDI music data have tracks designed specifically for t
Place these ROMs in the game directory, in your extrapath, or in the directory where your ScummVM executable resides. ScummVM also looks for ``CM32L_PCM.ROM`` and ``CM32L_CONTROL.ROM``—the ROMs from the CM-32L device—and uses these instead of the MT32 ROMs if they are available.
+.. note::
+
+ The MT-32 ROMs are copyrighted, and are not provided by ScummVM. These must be taken from your own MT-32 module.
+
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.
diff --git a/doc/docportal/advanced_topics/understand_graphics.rst b/doc/docportal/advanced_topics/understand_graphics.rst
index 101e4171ec..0df33ce424 100644
--- a/doc/docportal/advanced_topics/understand_graphics.rst
+++ b/doc/docportal/advanced_topics/understand_graphics.rst
@@ -28,11 +28,11 @@ A comparison of graphics modes
.. figure:: /images/graphics/graphics_mode/2x.png
- **2x**: No filtering, factor 2x. Default for non 640x480 games.
+ **2x**: No filtering, scales the image by a factor of 2. Default for non 640x480 games.
.. figure:: ../images/graphics/graphics_mode/3x.png
- **3x**: No filtering, factor 3x.
+ **3x**: No filtering, scales the image by a factor of 3.
.. figure:: ../images/graphics/graphics_mode/2xsai.png
@@ -56,15 +56,15 @@ A comparison of graphics modes
.. figure:: ../images/graphics/graphics_mode/hq2x.png
- **HQ2x**: Very nice high quality filter, but slow. Factor 2x.
+ **HQ2x**: Very nice high quality filter, but slow. Uses lookup tables to create anti-aliased output. Factor 2x.
.. figure:: ../images/graphics/graphics_mode/hq3x.png
- **HQ3x**: Very nice high quality filter, but slow. Factor 3x.
+ **HQ3x**: Very nice high quality filter, but slow. Uses lookup tables to create anti-aliased output. Factor 3x.
.. figure:: ../images/graphics/graphics_mode/tv2x.png
- **TV2x**: Interlace filter, tries to emulate a TV. Factor 2x.
+ **TV2x**: Interlace filter. Introduces scan lines to emulate a TV. Factor 2x.
.. figure:: ../images/graphics/graphics_mode/dotmatrix.png
@@ -80,10 +80,12 @@ To switch between graphics modes, press :kbd:`Ctrl + Alt` and :kbd:`1` to :kbd:`
OpenGL mode
**************
-OpenGL graphics mode works a little differently to the other graphics modes. Instead of applying the aspect ratio and stretch mode settings one after the other (and after the graphics mode scaling has been applied), it does all the scaling and stretching in one step, going directly from the original game resolution to the final display resolution.
+OpenGL graphics mode works a little differently to the other graphics modes. Instead of applying the aspect ratio and stretch mode settings one after the other (and after the graphics mode scaling has been applied), it does all the scaling and stretching in one step, going directly from the original game resolution to the final display resolution. OpenGL mode uses hardware rendering, instead of software rendering.
Output is controlled by your window size (or screen resolution if in full screen) and the stretch mode selected, as well as the **Filter graphics** option.
+
+
.. _aspect:
Aspect ratio correction
@@ -153,4 +155,6 @@ 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.
+Nearest neighbor is a simple way to scale an image; each pixel becomes multiple pixels of the same color. While this preserves the sharper details in a pixel art image, it also creates "jagged" edges as the image is scaled up. Bilinear interpolation finds the average color between pixel color values and fills in missing pixel, which results in a "smoothed" image.
+
To toggle between bilinear interpolation and nearest neighbor, press :kbd:`Ctrl+Alt+f`.
\ No newline at end of file
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index 6f1bf745ac..8a29a185ae 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -65,6 +65,8 @@ html_theme_options = {
html_static_path = ['_static']
+html_extra_path = ['images/donate/ppdonate.png','images/donate/GOG_button_small.png']
+html_favicon = 'scummvm.ico'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
diff --git a/doc/docportal/get_started/android.rst b/doc/docportal/get_started/android.rst
index 25e0c90aec..7af59aba53 100644
--- a/doc/docportal/get_started/android.rst
+++ b/doc/docportal/get_started/android.rst
@@ -17,14 +17,14 @@ Install ScummVM
There are two ways to install ScummVM on an Android device; install it from the Google Play Store, or manually download and install the APK package from the ScummVM downloads page.
-Google Play Store
-*********************
+From the Google Play Store
+****************************
Go to the Google Play Store to download and install ScummVM.
-APK package
-************
+From the APK package
+***********************
On your device, use a web browser app to navigate to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_. The recommended download section on the page suggests the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
diff --git a/doc/docportal/help/contact.rst b/doc/docportal/help/contact.rst
index 14d8ba0b44..1296bbd6bd 100644
--- a/doc/docportal/help/contact.rst
+++ b/doc/docportal/help/contact.rst
@@ -5,6 +5,16 @@ Contact us
There are a few ways to become a part of the ScummVM community:
-Chat with us on the `Discord Channel <https://discord.com/invite/5D8yTtF>`_ or the `IRC Channel <irc://irc.freenode.net/scummvm?key=scummvm>`_ | Post on the `ScummVM Forum <https://forums.scummvm.org/>`_ | Or `Report a Bug <https://bugs.scummvm.org/>`_
+- Chat with us on `Discord <https://discord.com/invite/5D8yTtF>`_ or the `IRC Channel <irc://irc.freenode.net/scummvm?key=scummvm>`_ . It's a great place to hang out with developers and other ScummVM users.
+
+- Post on the `ScummVM Forum <https://forums.scummvm.org/>`_ . We have several forums; the `Help and Support forum <https://forums.scummvm.org/viewforum.php?f=2>`_ if you need help while using ScummVM, the `General discussion forum <https://forums.scummvm.org/viewforum.php?f=1>`_ for all general questions, and `The Junkyard <https://forums.scummvm.org/viewforum.php?f=8>`_ for almost everything else! We also have some platform-specific forums, in case you have a specific question. Make sure to read the `Forum Rules <https://forums.scummvm.org/viewtopic.php?t=17>`_ before posting.
+
+- There are three ScummVM mailing lists, which you can join `here <https://lists.scummvm.org/>`_.
+
+- If you find a bug, :doc:`report_bugs`.
+
+- Feature requests can be made to our `Feature request tracker <https://bugs.scummvm.org/report/11>`_.
+
+- If you have made modifications to the ScummVM source code and would like to see them merged into the main code, open a Pull Request on our `GitHub page <https://github.com/scummvm/scummvm/pulls>`_.
We look forward to meeting you!
\ No newline at end of file
diff --git a/doc/docportal/help/report_bugs.rst b/doc/docportal/help/report_bugs.rst
index 4914ae43a4..fc2deb94f6 100644
--- a/doc/docportal/help/report_bugs.rst
+++ b/doc/docportal/help/report_bugs.rst
@@ -5,6 +5,20 @@ Report a bug
To report a bug, go to the ScummVM `Issue Tracker <https://bugs.scummvm.org/>`_ and log in with your GitHub account.
+Please make sure the bug is reproducible, and still occurs in the latest git/Daily build version. Also check the `compatibility list <https://www.scummvm.org/compatibility/>`_ for that game, to ensure the issue is not already known. Please do not report bugs for games that are not listed as completeable on the `Supported Games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ wiki page, or on the compatibility list. We already know those games have bugs!
+
+Please include the following information in the bug report:
+
+- ScummVM version (test the latest git/Daily build)
+- Bug details, including instructions for how to reproduce the bug. If possible, include log files, screenshots, and any other relevant information.
+- Game language
+- Game version (for example, talkie or floppy)
+- Platform and Compiler (for example, Win32, Linux or FreeBSD)
+- An attached saved game, if possible.
+- If this bug only occurred recently, include the last version without the bug, and the first version with the bug. That way we can fix it quicker by looking at the changes made.
+
+Finally, please report each issue separately; do not file multiple issues on the same ticket. It is difficult to track the status of each individual bug when they aren't on their own tickets.
+
.. _logfile:
@@ -19,7 +33,7 @@ To help you report a bug, you can find error messages in the ScummVM log file. T
.. panels::
:column: col-lg-12 mb-2
- ``~/Library/Logs/scummvm.log``, where ``~`` is your Home directory.
+ ``~/Library/Logs/scummvm.log``
.. tabbed:: Linux
@@ -36,11 +50,6 @@ To help you report a bug, you can find error messages in the ScummVM log file. T
Window Vista/7/8/10
^^^^^^^^^^^^^^^^^^^^^^
- ``\Users\username\AppData\Roaming\ScummVM\scummvm.log``
-
- .. tip::
-
- The AppData folder is hidden. The steps to view hidden files and folders depends on the Windows version.
+ ``%APPDATA\ScummVM\scummvm.log``
- For more information, see the `Windows support page <https://support.microsoft.com/en-us/help/14201/windows-show-hidden-files>`_.
-
\ No newline at end of file
+
diff --git a/doc/docportal/images/Launcher/launcher.png b/doc/docportal/images/Launcher/launcher.png
new file mode 100644
index 0000000000..929791b3cc
Binary files /dev/null and b/doc/docportal/images/Launcher/launcher.png differ
diff --git a/doc/docportal/images/Launcher/mass_add.png b/doc/docportal/images/Launcher/mass_add.png
index 28e488a052..7d16482da6 100644
Binary files a/doc/docportal/images/Launcher/mass_add.png and b/doc/docportal/images/Launcher/mass_add.png differ
diff --git a/doc/docportal/images/Launcher/mass_add_confirm.png b/doc/docportal/images/Launcher/mass_add_confirm.png
new file mode 100644
index 0000000000..1c4687dbb9
Binary files /dev/null and b/doc/docportal/images/Launcher/mass_add_confirm.png differ
diff --git a/doc/docportal/images/Launcher/mass_add_success.png b/doc/docportal/images/Launcher/mass_add_success.png
new file mode 100644
index 0000000000..817355da46
Binary files /dev/null and b/doc/docportal/images/Launcher/mass_add_success.png differ
diff --git a/doc/docportal/images/Launcher/quicksearch.png b/doc/docportal/images/Launcher/quicksearch.png
index fc0f7bdf50..7db9507cf0 100644
Binary files a/doc/docportal/images/Launcher/quicksearch.png and b/doc/docportal/images/Launcher/quicksearch.png differ
diff --git a/doc/docportal/images/settings/LAN.png b/doc/docportal/images/cloud_and_lan/LAN.png
similarity index 100%
rename from doc/docportal/images/settings/LAN.png
rename to doc/docportal/images/cloud_and_lan/LAN.png
diff --git a/doc/docportal/images/settings/LAN_server.png b/doc/docportal/images/cloud_and_lan/LAN_server.png
similarity index 100%
rename from doc/docportal/images/settings/LAN_server.png
rename to doc/docportal/images/cloud_and_lan/LAN_server.png
diff --git a/doc/docportal/images/settings/LAN_server_new.png b/doc/docportal/images/cloud_and_lan/LAN_server_new.png
similarity index 100%
rename from doc/docportal/images/settings/LAN_server_new.png
rename to doc/docportal/images/cloud_and_lan/LAN_server_new.png
diff --git a/doc/docportal/images/cloud_and_lan/LAN_server_upload.png b/doc/docportal/images/cloud_and_lan/LAN_server_upload.png
new file mode 100644
index 0000000000..c348740405
Binary files /dev/null and b/doc/docportal/images/cloud_and_lan/LAN_server_upload.png differ
diff --git a/doc/docportal/images/donate/GOG_button_small.png b/doc/docportal/images/donate/GOG_button_small.png
new file mode 100644
index 0000000000..1f5d48e9b2
Binary files /dev/null and b/doc/docportal/images/donate/GOG_button_small.png differ
diff --git a/doc/docportal/images/donate/ppdonate.png b/doc/docportal/images/donate/ppdonate.png
new file mode 100644
index 0000000000..e4757bfef0
Binary files /dev/null and b/doc/docportal/images/donate/ppdonate.png differ
diff --git a/doc/docportal/images/settings/LAN_server_upload.png b/doc/docportal/images/settings/LAN_server_upload.png
deleted file mode 100644
index a75c4de243..0000000000
Binary files a/doc/docportal/images/settings/LAN_server_upload.png and /dev/null differ
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 72542b22eb..8f444f9657 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -1,26 +1,23 @@
+
.. toctree::
:glob:
- :caption: Quickstart guide
- :maxdepth: 2
+ :caption: The basics
:hidden:
- get_started/mac_linux_windows
- get_started/android
- get_started/ios
-
+ trial/*
.. toctree::
- :caption: How to use ScummVM
+ :caption: Using ScummVM
:glob:
:hidden:
use_scummvm/the_launcher
+ use_scummvm/game_files
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::
@@ -28,6 +25,7 @@
:glob:
:hidden:
+ settings/how_to_settings
settings/game
settings/engine
settings/graphics
@@ -51,95 +49,69 @@
advanced_topics/understand_audio
advanced_topics/understand_graphics
-
.. toctree::
+ :caption: Help
:glob:
- :caption: Consoles
- :maxdepth: 2
:hidden:
- consoles/*
+ help/report_bugs
+ help/contact
+ help/faq
-.. toctree::
- :glob:
- :caption: Other platforms
- :maxdepth: 2
- :hidden:
- other_platforms/*
.. toctree::
- :caption: Help
+ :caption: Release Notes
:glob:
:hidden:
- help/report_bugs
- help/contact
- help/faq
+ release_notes/*
+
.. toctree::
- :caption: Release Notes
+ :caption: Other platforms
:glob:
:hidden:
- release_notes/*
+ get_started/*
+ ports/*
====================
Welcome to ScummVM!
====================
-ScummVM is a program that allows you to run classic graphical point-and-click adventure games, provided you already have the game data files. ScummVM replaces the executable files shipped with the games, which means they can be played on systems they were never designed for!
+ScummVM allows you to play classic graphic point-and-click adventure games, text adventure games, and RPGs, as long as you already have the game data files. ScummVM replaces the executable files shipped with the games, which means you can now play your favorite games on all your favorite devices.
+
+So how did ScummVM get its name? Many of the famous LucasArts adventure games, such as Maniac Mansion and the Monkey Island series, were created using a utility called SCUMM (Script Creation Utility for Maniac Mansion). The 'VM' in ScummVM stands for Virtual Machine.
+
+While ScummVM was originally designed to run LucasArts' SCUMM games, over time support has been added for many other games: see the full list `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_. Noteworthy titles include Broken Sword, Myst and Blade Runner, although there are countless other hidden gems to explore.
-SCUMM (Script Creation Utility for Maniac Mansion) is a utility that was used to create many of the famous LucasArts adventure games, such as Maniac Mansion and Monkey Island. It is the namesake of ScummVM, with VM meaning Virtual Machine.
-While ScummVM was originally designed to run LucasArts' SCUMM games, over time support has been added for many other games.
.. _firststeps:
-First steps
+The basics
================
-We have guides available to show you how to get ScummVM up and running:
+We have guides to show you how to get ScummVM up and running on many different platforms:
.. panels::
- :container: container-fluid text-center mb-4
- :column: col-lg-12 mb-4
-
- Getting started
- ^^^^^^^^^^^^
-
- :doc:`get_started/mac_linux_windows`
-
- :doc:`get_started/ios`
+ :container: text-center mb-4
- :doc:`get_started/android`
+ :doc:`trial/computer`
---
- :column: col-lg-6
- Consoles
- ^^^^^^^^^^^^^^^^^^^
- :doc:`consoles/ps_vita`
-
- :doc:`consoles/playstation_portable`
-
- :doc:`consoles/nintendo_switch`
-
- :doc:`consoles/nintendo_3ds`
-
- :doc:`consoles/sega_dreamcast`
+ :doc:`trial/phones`
---
- :column: col-lg-6
- Other platforms
- ^^^^^^^^^^^^^^^
- :doc:`other_platforms/amigaos_4`
+ :doc:`trial/console`
- :doc:`other_platforms/risc_os`
+ ---
- :doc:`other_platforms/atari`
+ Other operating systems
@@ -152,14 +124,16 @@ So you have ScummVM installed, but now you need to know how to play some games!
.. panels::
:container: text-center mb-4
- Understand the interface
+ Understanding the interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- :doc:`use_scummvm/the_launcher`
+ :doc:`The Launcher <use_scummvm/the_launcher>`
---
- Play games
+ Playing games
^^^^^^^^^^^^^^
+ :doc:`use_scummvm/game_files`
+
:doc:`use_scummvm/add_play_games`
:doc:`use_scummvm/save_load_games`
@@ -168,17 +142,17 @@ So you have ScummVM installed, but now you need to know how to play some games!
---
- Use the features
- ^^^^^^^^^^^^^^^^^^
+ Exploring the features
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:doc:`use_scummvm/connect_cloud`
:doc:`use_scummvm/LAN`
---
- Change settings
+ Changing settings
^^^^^^^^^^^^^^^^^^^^^
- :doc:`use_scummvm/how_to_settings`
+ :doc:`settings/how_to_settings`
@@ -203,12 +177,12 @@ In this section, we also take a deep dive into understanding the graphics and au
---
- Understand the settings
+ Understanding the settings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- :doc:`advanced_topics/understand_audio`
+ :doc:`The audio settings <advanced_topics/understand_audio>`
- :doc:`advanced_topics/understand_graphics`
+ :doc:`The graphics settings <advanced_topics/understand_graphics>`
@@ -232,13 +206,34 @@ 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 happening with the latest release, check out our Release Notes section.
+We have a Release Notes section where you can see what's changed in both current and past releases.
The ScummVM Project
===================
-ScummVM is an open-source project.
-If you enjoy ScummVM, feel free to donate using the PayPal button on the `ScummVM homepage <https://www.scummvm.org>`__. This will help us buy the utilities to develop ScummVM faster and more efficiently.
+ScummVM is an open-source project created, maintained and constantly improved by a team of passionate volunteers from all around the world. If you enjoy using ScummVM and would like to support the team, you can use the PayPal Donate button below.
+
+.. raw:: html
+
+ <form id="donate-header" action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
+ <input type="hidden" name="cmd" value="_s-xclick">
+ <input type="hidden" name="hosted_button_id" value="U6E6SLL7E8MAS">
+ <input type="image" src="ppdonate.png" style="width: 126px; height: 50px; border: 0 none;" name="submit" alt="Support This Project">
+ </form>
+ <br>
+
+Another way to support us is to buy your games from GOG.com using the ScummVM Affiliate link.
+
+.. raw:: html
+
+ <a href="https://www.gog.com/?pp=22d200f8670dbdb3e253a90eee5098477c95c23d">
+ <img src="GOG_button_small.png" width="126" height="46" alt="GOG.com games">
+ </a>
+
+
+
+If you have software development or technical writing skills, we would love for you to join the ScummVM team! Check out `Developer Central <https://wiki.scummvm.org/index.php?title=Developer_Central>`_ on the ScummVM wiki for more information on contributing to ScummVM.
+
+
-If you 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.
\ No newline at end of file
diff --git a/doc/docportal/other_platforms/amigaos_4.rst b/doc/docportal/ports/amigaos_4.rst
similarity index 100%
rename from doc/docportal/other_platforms/amigaos_4.rst
rename to doc/docportal/ports/amigaos_4.rst
diff --git a/doc/docportal/other_platforms/atari.rst b/doc/docportal/ports/atari.rst
similarity index 100%
rename from doc/docportal/other_platforms/atari.rst
rename to doc/docportal/ports/atari.rst
diff --git a/doc/docportal/consoles/nintendo_3ds.rst b/doc/docportal/ports/nintendo_3ds.rst
similarity index 100%
rename from doc/docportal/consoles/nintendo_3ds.rst
rename to doc/docportal/ports/nintendo_3ds.rst
diff --git a/doc/docportal/consoles/nintendo_switch.rst b/doc/docportal/ports/nintendo_switch.rst
similarity index 100%
rename from doc/docportal/consoles/nintendo_switch.rst
rename to doc/docportal/ports/nintendo_switch.rst
diff --git a/doc/docportal/consoles/playstation_3.rst b/doc/docportal/ports/playstation_3.rst
similarity index 100%
rename from doc/docportal/consoles/playstation_3.rst
rename to doc/docportal/ports/playstation_3.rst
diff --git a/doc/docportal/consoles/playstation_portable.rst b/doc/docportal/ports/playstation_portable.rst
similarity index 97%
rename from doc/docportal/consoles/playstation_portable.rst
rename to doc/docportal/ports/playstation_portable.rst
index 4b49f6dcb7..71e2637254 100644
--- a/doc/docportal/consoles/playstation_portable.rst
+++ b/doc/docportal/ports/playstation_portable.rst
@@ -125,7 +125,9 @@ Supported audio file formats:
- OGG
- Uncompressed audio
-Games run faster if audio files are in the ``.mp3`` file format.
+.. tip::
+
+ Games run faster if audio files are in the ``.mp3`` file format.
Paths
diff --git a/doc/docportal/consoles/ps_vita.rst b/doc/docportal/ports/ps_vita.rst
similarity index 100%
rename from doc/docportal/consoles/ps_vita.rst
rename to doc/docportal/ports/ps_vita.rst
diff --git a/doc/docportal/other_platforms/risc_os.rst b/doc/docportal/ports/risc_os.rst
similarity index 100%
rename from doc/docportal/other_platforms/risc_os.rst
rename to doc/docportal/ports/risc_os.rst
diff --git a/doc/docportal/consoles/sega_dreamcast.rst b/doc/docportal/ports/sega_dreamcast.rst
similarity index 100%
rename from doc/docportal/consoles/sega_dreamcast.rst
rename to doc/docportal/ports/sega_dreamcast.rst
diff --git a/doc/docportal/scummvm.ico b/doc/docportal/scummvm.ico
new file mode 100644
index 0000000000..20052a170d
Binary files /dev/null and b/doc/docportal/scummvm.ico differ
diff --git a/doc/docportal/settings/accessibility.rst b/doc/docportal/settings/accessibility.rst
index 507cc5a664..287ea4f04a 100644
--- a/doc/docportal/settings/accessibility.rst
+++ b/doc/docportal/settings/accessibility.rst
@@ -12,6 +12,7 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the LA
The Accessibility tab in the global settings.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,,,,,,,,,,,,
diff --git a/doc/docportal/settings/audio.rst b/doc/docportal/settings/audio.rst
index bac3a72d07..c1c5eaf15e 100644
--- a/doc/docportal/settings/audio.rst
+++ b/doc/docportal/settings/audio.rst
@@ -16,6 +16,8 @@ Audio settings are found on four tabs:
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
@@ -72,7 +74,7 @@ Subtitle speed
The Volume tab
-----------------
-Use the Volume tab to set the relative volumes for various sounds.
+Use the Volume tab to set the relative volumes for various in-game sounds.
.. figure:: ../images/settings/volume_game.png
@@ -118,7 +120,7 @@ Mute All
The MIDI tab
------------------------------
-Use the MIDI tab to change the settings of General MIDI devices.
+Use the MIDI tab to change the settings of General MIDI (GM) devices.
.. figure:: ../images/settings/MIDI.png
@@ -130,7 +132,7 @@ Use the MIDI tab to change the settings of General MIDI devices.
.. _gm:
GM Device
- Specifies a preferred General MIDI (GM) device, which ScummVM uses if the **Preferred device** is set to **<default>** and General MIDI playback is required.
+ Specifies a preferred General MIDI device, which ScummVM uses if the **Preferred device** is set to **<default>** and General MIDI playback is required.
*gm_device*
@@ -279,7 +281,7 @@ Interpolation
The MT-32 tab
-----------------
-Use the MT-32 tab to change the settings of MT-32 devices.
+Use the MT-32 tab to change the settings of Roland MT-32 devices.
.. figure:: ../images/settings/MT32.png
diff --git a/doc/docportal/settings/cloud.rst b/doc/docportal/settings/cloud.rst
index 2033a383e4..e99b9b12d5 100644
--- a/doc/docportal/settings/cloud.rst
+++ b/doc/docportal/settings/cloud.rst
@@ -4,7 +4,7 @@ Cloud
Use the Cloud tab to manage connected cloud storage services.
-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.
+For a comprehensive look at how to use ScummVM's built-in cloud functionality, check out our :doc:`../use_scummvm/connect_cloud` guide.
From the Launcher, select **Options**, click the **>** scroll arrow until the Cloud tab is visible, and then select the **Cloud** tab.
@@ -13,6 +13,7 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the Cl
The Cloud tab in the global settings
+
,,,,,,,,,,,,,,,,,,,,,
Active storage
diff --git a/doc/docportal/settings/control.rst b/doc/docportal/settings/control.rst
index 02a1cc17fe..2dc2899fe1 100644
--- a/doc/docportal/settings/control.rst
+++ b/doc/docportal/settings/control.rst
@@ -2,7 +2,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.
+Use the Control tab to change settings for joysticks, game controllers, and touch screens. This tab is not always available.
From the Launcher, select **Options**, and then select the **Control** tab.
@@ -10,6 +10,7 @@ From the Launcher, select **Options**, and then select the **Control** tab.
The Control tab in the global settings
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,
diff --git a/doc/docportal/settings/engine.rst b/doc/docportal/settings/engine.rst
index 4d8eff1075..52c99b62f0 100644
--- a/doc/docportal/settings/engine.rst
+++ b/doc/docportal/settings/engine.rst
@@ -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 **Edit Game**, and then select the **Engine** tab. This tab might 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 is not available for all games.
To find out which engine powers your game, have a look at the ScummVM Supported Games `wiki page
<https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_.
@@ -15,6 +15,7 @@ Engines: ADL_ | AGI_ | BLADERUNNER_ | CGE_ | CINE_ | DRASCULA_ | DREAMWEB_ | HDB
The Engine tab in the game-specific settings
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,,,,,,
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index 8154a70a3f..29045621a1 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -11,7 +11,9 @@ From the Launcher, highlight a game on the games list, then select **Edit Game**
.. figure:: ../images/settings/game.png
The Game tab in the game-specific settings
-
+
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+
,,,,,,,
.. _gameid:
diff --git a/doc/docportal/settings/graphics.rst b/doc/docportal/settings/graphics.rst
index d39c7932c3..88e70c8f8c 100644
--- a/doc/docportal/settings/graphics.rst
+++ b/doc/docportal/settings/graphics.rst
@@ -18,6 +18,8 @@ For a comprehensive look at how to use these settings, check out our :doc:`../ad
The Graphics tab in the global settings
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+
,,,,,,,
.. _gfxmode:
diff --git a/doc/docportal/use_scummvm/how_to_settings.rst b/doc/docportal/settings/how_to_settings.rst
similarity index 92%
rename from doc/docportal/use_scummvm/how_to_settings.rst
rename to doc/docportal/settings/how_to_settings.rst
index b5891f6721..307405b8ea 100644
--- a/doc/docportal/use_scummvm/how_to_settings.rst
+++ b/doc/docportal/settings/how_to_settings.rst
@@ -1,5 +1,5 @@
=======================
-Change settings
+How to change settings
=======================
From the Launcher
@@ -17,4 +17,4 @@ Not all settings are available for all games; for example, where there is no MID
In the configuration file
==========================
-See the :doc:`configuration file <../advanced_topics/configuration_file>` page for more information on how to do this. Configuration keywords are listed in the Settings pages below the description of each setting, in italics.
\ No newline at end of file
+See the :doc:`configuration file <../advanced_topics/configuration_file>` page for more information on how to do this. Configuration keys are listed in the Settings pages, after the description of each setting, in italics.
\ No newline at end of file
diff --git a/doc/docportal/settings/keymaps.rst b/doc/docportal/settings/keymaps.rst
index 1bbf743209..63cb28be2b 100644
--- a/doc/docportal/settings/keymaps.rst
+++ b/doc/docportal/settings/keymaps.rst
@@ -2,7 +2,7 @@
Keymaps
===============
-Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or mouse or joystick buttons.
+Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or to mouse or joystick buttons.
**To change settings globally:**
@@ -20,6 +20,9 @@ Use the Keymaps tab to assign actions to keyboard keys or shortcuts, or mouse or
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.
diff --git a/doc/docportal/settings/lan.rst b/doc/docportal/settings/lan.rst
index 6db43c3387..bb98c74483 100644
--- a/doc/docportal/settings/lan.rst
+++ b/doc/docportal/settings/lan.rst
@@ -2,17 +2,18 @@
LAN
==============
-Use the LAN tab to control the web server.
+Use the LAN tab to control the Local Area Network (local web server).
-ScummVM can run a local network web server for browser-based file management, including uploading and downloading game files.
+For a comprehensive look at how to use ScummVM's built-in LAN functionality, check out our :doc:`../use_scummvm/LAN` guide.
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
-.. figure:: ../images/settings/LAN.png
+.. figure:: ../images/cloud_and_lan/LAN.png
The LAN tab in the global settings
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
diff --git a/doc/docportal/settings/misc.rst b/doc/docportal/settings/misc.rst
index 950f852203..e1d3f8797d 100644
--- a/doc/docportal/settings/misc.rst
+++ b/doc/docportal/settings/misc.rst
@@ -10,6 +10,7 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the Mi
The Misc tab in the global settings.
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
,,,,,,,,,,,,,,,
diff --git a/doc/docportal/settings/paths.rst b/doc/docportal/settings/paths.rst
index 36915c770e..759a8c8854 100644
--- a/doc/docportal/settings/paths.rst
+++ b/doc/docportal/settings/paths.rst
@@ -16,6 +16,8 @@ Use the Paths tab to tell ScummVM where to look for files.
The Paths tab in the global settings
+All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description.
+
,,,,,,,,,,,,,,,,,
.. _savepath:
diff --git a/doc/docportal/trial/computer.rst b/doc/docportal/trial/computer.rst
new file mode 100644
index 0000000000..709e5e30f6
--- /dev/null
+++ b/doc/docportal/trial/computer.rst
@@ -0,0 +1,167 @@
+========================
+Windows, macOS or Linux
+========================
+
+.. tabbed:: Windows
+
+ There are two ways to install ScummVM onto a computer running Windows; download and use the installer, or install manually.
+
+ .. dropdown:: Installing ScummVM using the installer
+ :open:
+
+ Download the Windows installer for your operating system from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, and double click the downloaded file. The installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
+
+ To run ScummVM, either navigate to desktop and double click the ScummVM shortcut, or go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Apps > ScummVM**.
+
+ .. dropdown:: Installing ScummVM manually
+
+ Download the Windows zip file for your operating system (32bit or 64bit). To extract the files, right-click the folder and select **Extract All**.
+
+ To run ScummVM from the extracted folder, find the ``scummvm.exe`` file and double click it.
+
+ .. dropdown:: Paths
+
+ **Configuration file**
+
+ 95/98/ME: ``C:\WINDOWS\scummvm.ini``
+
+ Windows NT4: ``C:\WINDOWS\Profiles\username\Application Data\ScummVM\scummvm.ini``
+
+ Windows 2000/XP: ``\Documents and Settings\username\Application Data\ScummVM\scummvm.ini``
+
+ Window Vista/7/8/10: ``%APPDATA%\ScummVM\scummvm.ini``
+
+ **Saved games**
+
+ 95/98/ME: ``C:\WINDOWS\Saved games\``
+
+ Windows NT4: ``C:\WINDOWS\Profiles\username\Application Data\ScummVM\Saved games\``
+
+ Windows 2000/XP: ``\Documents and Settings\username\Application Data\ScummVM\Saved games\``
+
+ Window Vista/7/8/10: ``%APPDATA%\ScummVM\Saved games\``
+
+
+.. tabbed:: macOS
+
+ .. dropdown:: Installing ScummVM using the disk image
+ :open:
+
+ Download the recommended disk image file from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_. After the download has completed, double click the file to mount the disk image file. A window containing the ScummVM icon opens. Drag this icon into your Applications folder to install ScummVM.
+
+ To run ScummVM, click on the icon in the Applications folder.
+
+ .. note::
+
+ macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. ScummVM is not available from the App Store, so follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
+
+ .. dropdown:: Paths
+
+ **Configuration file**
+
+ ``~/Library/Preferences/ScummVM Preferences``
+
+ .. note::
+
+ If an earlier version of ScummVM was installed on your system, the configuration file remains in the previous default location of ``~/.scummvmrc``.
+
+ .. tip::
+
+ To see the Library folder, press :kbd:`Option` when clicking **Go** in the Finder menu.
+
+ **Saved games**
+
+ ``~/Documents/ScummVM Savegames/``
+
+.. tabbed:: Linux
+
+
+ There are multiple ways to install ScummVM onto a computer running Linux: use the Snap Store, Flathub or the software repository, or install the release binary.
+
+ .. dropdown:: Installing ScummVM using the Snap Store
+ :open:
+
+ A Snap is an app that is bundled with its dependencies, which makes the install on any Linux operating system very easy. Snap comes pre-installed on Debian and Ubuntu-based distributions, but can be installed on any Linux distribution by following the instructions on the `Snapcraft website <https://snapcraft.io/>`_.
+
+ The ScummVM Snap comes with a selection of freeware games and demos pre-loaded.
+
+ Enter the following on the command line to install the ScummVM Snap:
+
+ .. code:: bash
+
+ sudo snap install scummvm
+
+ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
+
+ .. dropdown:: Installing ScummVM using Flathub
+
+ Flathub is another way to install apps for Linux, by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
+
+ When Flatpak is installed, enter the following on the command line to install ScummVM:
+
+ .. code:: bash
+
+ flatpak install flathub org.scummvm.ScummVM
+
+ Some distributions have the option to install Flatpaks through the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog opens; choose the **Open with Software Install (default)** option, and then click **OK**.
+
+ To run ScummVM, enter the following on the command line:
+
+ .. code:: bash
+
+ flatpak run org.scummvm.ScummVM
+
+ To pass :doc:`Command line arguments <../advanced_topics/command_line>`, add them after the Flatpak ``run`` command.
+
+ .. note::
+
+ The Flatpak version of ScummVM is sandboxed, meaning that any games need to be copied into the Documents folder to be accessible by ScummVM.
+
+
+ .. dropdown:: Installing ScummVM using the software repository
+
+ ScummVM is found in the software repositories of many Linux distributions.
+
+ .. caution::
+
+ The repositories might not contain the most up-to-date version of ScummVM.
+
+ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
+
+
+ .. dropdown:: Installing ScummVM using the release binaries
+
+ Binary packages are only released for Debian and Ubuntu. On the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, find and download the ScummVM package that corresponds to your operating system and architecture. To install a DEB package, either double click on the downloaded DEB file to use the graphical installer, or, if that's not available, use the command line.
+
+ .. code:: bash
+
+ sudo apt install /path/to/downloaded/file.deb
+
+ Replace ``/path/to/downloaded/file.deb`` with the actual path to the downloaded DEB package. The APT software manager handles the installation.
+
+ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
+
+ .. dropdown:: Paths
+
+ **Configuration file**
+
+
+ ScummVM follows the XDG Base Directory Specification, so by default the configuration file is found at ``~/.config/scummvm/scummvm.ini``, but its location might vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
+
+ If Snap was used to install ScummVM, 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.
+
+ **Saved games**
+
+ ScummVM follows the XDG Base Directory Specification, so by default the saved games can be found at ``~/.local/share/scummvm/saves/``, but this location might vary depending on the value of the ``XDG_DATA_HOME`` environment variable.
+
+ If Snap was used to install ScummVM, the saves can be found at ``~/snap/scummvm/current/.local/share/scummvm/saves/``.
+
+ .. note::
+
+ ``.local`` is a hidden directory. To view it use ``ls -a`` on the command line.
+
+
diff --git a/doc/docportal/trial/console.rst b/doc/docportal/trial/console.rst
new file mode 100644
index 0000000000..a4845cc1a5
--- /dev/null
+++ b/doc/docportal/trial/console.rst
@@ -0,0 +1,134 @@
+=============================
+Consoles
+=============================
+
+.. tabbed:: Nintendo 3DS
+
+ There are two ways to install ScummVM onto a Nintendo 3DS: using the 3DSX format, and using the CIA format.
+
+ **What you'll need:**
+
+ - A Nintendo 3DS with a Homebrew Launcher or custom firmware. How to enable homebrew is outside the scope of this documentation.
+ - The Nintendo 3DS package downloaded from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_, and extracted.
+
+
+ .. dropdown:: Installing ScummVM using the 3DSX format
+ :open:
+
+ Copy the extracted files to your SD card into the ``/3ds/scummvm`` directory.
+
+ Launch ScummVM using the Homebrew Launcher.
+
+
+ .. dropdown:: Installing ScummVM using the CIA format
+
+ Use any CIA installation software to install the ``scummvm.cia`` file.
+
+ The CIA format requires a DSP binary dump saved on your SD card as ``/3ds/dspfirm.cdc``. This is not an optional step, because without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
+
+ .. dropdown:: Transferring 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:`../use_scummvm/connect_cloud`.
+
+ See :doc:`../use_scummvm/add_play_games` for more information about how to add games to ScummVM.
+
+ .. dropdown:: Controls
+
+ Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+
+ .. csv-table::
+ :widths: 50 50
+ :header-rows: 1
+
+ Game Controller Mapping:,
+ Button,Action
+ Circle Pad,Moves the cursor
+ R + Circle Pad,Slow Mouse
+ â’¶,Left mouse button
+ â’·,Right mouse button
+ â“,Opens the virtual keyboard
+ â“Ž,ESC
+ Control Pad,Keypad cursor keys
+ L Button,Toggles magnify mode on/off
+ R Button,Toggles between hover/drag modes
+ START,Opens global main menu
+ SELECT,Opens 3DS config menu
+
+ .. _hover:
+
+ **Hover mode**
+
+
+ When using the touchscreen, hover mode simulates the movement of the mouse. You can click with taps, however you can't drag or hold down a mouse button unless you use the buttons mapped to the right/left mouse buttons.
+
+ **Drag mode**
+
+
+ Simulates the click and release of the mouse buttons every time you touch and release the touchscreen. At the moment, this is only a left mouse button click.
+
+ **Magnify mode**
+
+ Due to the low resolutions of the 3DS screens (400x240 for the top, and 320x240 for the bottom), games that run at a higher resolution will inevitably lose some visual detail from being scaled down. This can result in situations where essential information, such as text, is indiscernable.
+
+ Magnify mode increases the scale factor of the top screen back to 1, but the bottom screen remains unchanged. The touchscreen can then be used to change which part of the game display is being magnified. This can be done even in situations where the cursor is disabled, such as during full-motion video segments.
+
+ When activating magnify mode, touchscreen controls are automatically switched to :ref:`hover` mode to reduce the risk of the user accidentally inputting a click when changing the magnified area with the stylus. Clicking can still be done as in normal hover mode. Turning off magnify mode will revert controls back to what was used previously. It will also restore the top screen's previous scale factor.
+
+ Currently magnify mode can only be used when the following conditions are met:
+
+ - In the 3DS config menu, **Use Screen** is set to **Both**
+ - A game is played
+ - The horizontal and/or vertical resolution in-game is greater than that of the top screen
+
+ Magnify mode cannot be used in the Launcher menu.
+
+ .. dropdown:: Paths
+
+ **Configuration file**
+
+ ``sdmc:/3ds/scummvm/scummvm.ini``
+
+ **Saved games**
+
+ ``sdmc:/3ds/scummvm/saves/``
+
+ .. dropdown:: Settings
+
+ For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
+
+ **3DS config menu**
+
+
+ .. figure:: ../images/3ds/config.png
+
+ The 3DS config menu.
+
+ Show mouse cursor
+ Toggles a visible mouse cursor on/off.
+
+ Stretch to fit
+ Stretches the image to fit the screen
+
+ Snap to edges
+ The 3DS touch screen has difficulty reaching the very end of the screen. With this option enabled, if you're within a few pixels of the edge the cursor snaps to the edge.
+
+ Use Screen:
+ Sets whether ScummVM uses the **Top**, **Bottom** or **Both** screens.
+
+ C-Pad Sensitivity
+ Sets the sensitivity of the Circle Pad.
+
+ **Audio**
+
+ Supported audio file formats:
+
+ - MP3
+ - OGG
+ - OGG
+ - Uncompressed audio
+
+ .. dropdown:: Known issues
+
+ Some games are not playable due to the slow CPU speed on the 3DS. If there are any games that run really slowly, this is considered a hardware limitation, not a bug.
diff --git a/doc/docportal/trial/phones.rst b/doc/docportal/trial/phones.rst
new file mode 100644
index 0000000000..ad7e9b1a65
--- /dev/null
+++ b/doc/docportal/trial/phones.rst
@@ -0,0 +1,327 @@
+=========================
+Phones and tablets
+=========================
+
+.. tabbed:: Android
+
+ There are two ways to install ScummVM on an Android device; install it from the Google Play Store, or manually download and install the APK package from the ScummVM downloads page.
+
+ .. dropdown:: Installing ScummVM from the Google Play Store
+ :open:
+
+ Go to the Google Play Store to download and install ScummVM.
+
+ .. note::
+
+ ScummVM has been tested to work up to Android 10. Currently there are some file browsing limitations with Android 11. The ScummVM team are working to resolve these.
+
+ .. dropdown:: Downloading and manually installing the APK package
+
+ On your device, use a web browser app to navigate to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_. The recommended download section on the page suggests the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
+
+ .. tip::
+
+ To find the correct package for your device, find out whether the device has a 32 or 64-bit operating system, and which chipset the device has. Do an internet search using the device model number to find these details.
+
+ Click on the correct package to start the download. After it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and after permission is granted, returns to the install.
+
+ .. note::
+
+ The downloaded APK package is treated as an app from an unknown source, because it doesn't originate in the Google Play store. To allow unknown apps:
+
+ - For Android 7 or lower, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
+ - For Android 8 or higher, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
+
+
+ .. dropdown:: Transferring 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 lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
+
+ There are a few other options to transfer the game files:
+
+ - Copy the files directly onto the microSD card, if the device has one.
+ - USB transfer from a computer. To complete file transfer by USB cable, tap the **Charging this device via USB notification** when the device is connected. Select **Use USB for** and then **File Transfer**. An Android File Transfer window opens.
+ - Download games such as freeware games or those from digital distributors directly to your device.
+
+ For more information on which files ScummVM requires, see the :doc:`../use_scummvm/game_files` page. To learn how to add and play games, see the :doc:`../use_scummvm/add_play_games`.
+
+ .. dropdown:: Controls
+
+
+ Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
+
+ .. csv-table::
+ :header-rows: 1
+
+ Touch screen control, Action
+ One finger tap, Left mouse click
+ Two finger tap, Right mouse click
+ One finger touch & hold, Middle mouse click
+ 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
+
+ **Touch controls**
+
+ The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
+
+ - When touchpad mouse mode is off (default), the touch controls are direct. The pointer jumps to where the finger touches the screen.
+ - When touchpad mouse mode is on, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
+ - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
+
+ **Two finger tap**
+
+ To do a two finger tap, hold one finger down and then tap with a second finger.
+
+
+ **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.
+
+ .. dropdown:: 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.
+
+ **Accessing the internal app folder**
+
+ To access the internal app folder, use ScummVM's built-in LAN functionality:
+
+ 1. From the Launcher, select **Options** and then the **LAN** tab.
+ 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.
+
+
+ .. dropdown:: 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.
+
+.. tabbed:: iOS
+
+
+ There are two ways to install ScummVM onto an iOS device, and the method you use depends on whether or not the device is jailbroken.
+
+ .. dropdown:: Installing ScummVM onto a device without a jailbreak
+
+ To install ScummVM onto a device without a jailbreak requires you to build the app yourself, using the source code and an app called Xcode. While a rudimentary knowledge of the command line would be helpful, this is not required.
+
+ **What you'll need:**
+
+ - A Mac computer with Xcode installed. Xcode is a free App, available from the Mac App Store.
+ - An Apple Developer account. You can sign up for a free account on the `Apple Developer Member Center <https://developer.apple.com/membercenter/>`_ with your Apple ID.
+ - The ScummVM `iOS Libraries <https://www.scummvm.org/frs/build/scummvm-ios7-libs-v2.zip>`_ downloaded.
+
+ .. note::
+
+ If you have a free Apple developer account, each build will only be valid for 7 days, which means you will need to repeat these steps and rebuild ScummVM every week.
+
+
+ **Creating the Xcode project**
+
+
+ The first step is to download the repository containing the code required to build the app. The following steps require use of the command line. Go to **Applications > Utilities > Terminal** and copy and paste the following, then press :kbd:`return` :
+
+ .. code-block:: bash
+
+ git clone --depth 1 -b branch-2-2-0 https://github.com/scummvm/scummvm.git
+
+
+ If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time will also install the command line tools required.
+
+ The next step changes the present working directory and then generates the tools required to create the Xcode project.
+
+ .. code-block:: bash
+
+ cd scummvm/devtools/create_project/xcode
+ xcodebuild
+
+ The next command creates a new directory called ``build`` at the same level as the repository:
+
+ .. code-block:: bash
+
+ cd ../../../..
+ mkdir build
+ cd build
+
+ The present working directory will now be the new ``build`` directory. Extract the contents of the downloaded iOS libraries package into the build folder by using the following command:
+
+ .. code-block:: bash
+
+ unzip ~/Downloads/scummvm-ios7-libs-v2.zip
+
+ .. note::
+
+ In newer versions of macOS, the archive is extracted automatically. If this is the case, the ``unzip`` command will not work as expected. Instead, copy the contents of the ``scummvm-ios7-libs-v2`` folder into the ``build`` directory. It is simplest to do this in the Finder.
+
+
+ **Generating the Xcode project**
+
+ It's time to generate the Xcode project. Ensure the present working directory is still the ``build`` directory, and then run the following on the command line:
+
+ .. code::
+
+ ../scummvm/devtools/create_project/xcode/build/Release/create_project ../scummvm --xcode --enable-fluidsynth --disable-nasm --disable-opengl --disable-theora --disable-taskbar --disable-tts --disable-fribidi
+
+ The resulting directory structure should look like this:
+
+ .. code-block:: bash
+
+ Home
+ |--scummvm
+ '--build
+ |-- include
+ |-- lib
+ |-- engines
+ '-- scummvm.xcodeproj
+
+ .. tip::
+
+ To view the Home directory in the Finder, select **Go > Home** in the menu bar, or press :kbd:`command+shift+H`.
+
+ Open the ``scummvm.xcodeproj`` file from the Finder, or from the command line:
+
+ .. code-block:: bash
+
+ open scummvm.xcodeproj
+
+ **Building ScummVM**
+
+ When Xcode is open, connect a device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then select the device you just connected. You will need to "Trust" the device for it to show up on the list of connected devices.
+
+ .. figure:: ../images/ios/choose_device.gif
+
+
+ The last step before building ScummVM is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** there is a field labeled **Bundle Identifier**. Enter a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
+
+ .. figure:: ../images/ios/identifier.gif
+
+
+ Next to **General**, click on **Signing & Capabilities**. Under **Signing**, tick the **Automatically manage signing** box, and select your developer account from the **Team** dropdown menu.
+
+ .. figure:: ../images/ios/signing.gif
+
+
+
+ If you have not added your developer account to Xcode, do this now. Click **Add an Account** in the dropdown menu.
+
+ In the upper left-hand corner, press the play button to build ScummVM. When the build is finished, it launches on your connected device.
+
+ .. dropdown:: Installing ScummVM onto a jailbroken device
+
+ **What you'll need:**
+
+ - A jailbroken iOS device. How to jailbreak a device is outside the scope of this documentation.
+ - A file manager app such as Filza installed on the device.
+
+
+ **Installing ScummVM**
+
+ Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended ``.deb`` or ``.ipa`` package. When the device asks how to open the file, choose Filza.
+
+ Ensure the package is saved somewhere in the ``/var/mobile/`` directory. It defaults to ``/var/mobile/Documents/``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
+
+ Restart your device for the install to complete.
+
+ .. dropdown:: Transferring game files
+
+
+ There are multiple ways to transfer game files to your iOS device.
+
+ ScummVM has built-in cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
+
+ .. note::
+
+ ScummVM's cloud functionality does not currently support iCloud, however you can upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder.
+
+ Another way to transfer files (for macOS Catalina and newer) to your device is by using the Finder while your device is connected to your Mac. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag the folder containing the game files into the **ScummVM** folder. For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
+
+ .. image:: ../images/ios/ios_transfer_files.gif
+
+ For more information on which files ScummVM requires, and how to add and play games, see :doc:`../use_scummvm/add_play_games`.
+
+ .. dropdown:: Controls
+
+ .. csv-table::
+ :widths: 40 60
+ :header-rows: 2
+
+ Game Controller Mapping,
+ Touch screen control, Action
+ One finger tap, Left mouse click
+ Two finger tap, Right mouse click
+ Two finger double tap,ESC
+ Two finger swipe (bottom to top), Toggles :ref:`Click and drag mode <clickdrag>`.
+ Two finger swipe (left to right),Toggles between touch direct mode and touchpad mode.
+ Two finger swipe (top to bottom),Global Main Menu
+ Three finger swipe, Arrow keys
+
+ Pinch gesture, Enables/disables keyboard
+ Keyboard spacebar, Pause
+
+
+ **Touch controls**
+
+ The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
+
+ - When touchpad mouse mode is off, the touch controls are direct. The pointer jumps to where the finger touches the screen.
+ - When touchpad mouse mode is on, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
+ - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
+
+ .. _twofinger:
+
+ **Two finger tap**
+
+
+ For a two finger tap, hold one finger down and then tap with a second finger.
+
+ .. _twofingerdouble:
+
+ **Two finger double tap**
+
+
+ For a two finger double tap, hold one finger down and then double tap with a second finger.
+
+ .. _clickdrag:
+
+ **Click and drag mode**
+
+
+ Simulates a left mouse click when you touch the screen. The mouse pointer drags to wherever you slide your finger, and releases where you lift your finger.
+
+ If you press down a second finger in this mode, it releases the simulated left mouse button, and presses down the simulated right mouse button. The right mouse button is released when you lift your finger again.
+
+ **Keyboard**
+
+ If no external keyboard is connected, the pinch gesture shows and hides the onscreen keyboard. When an external keyboard is connected, the pinch gesture enables/disables inputs from the external keyboard.
+
+ .. dropdown:: Paths
+
+
+ **Saved games**
+
+ ``/var/mobile/Library/ScummVM/Savegames/`` if the device is jailbroken, or ``Savegames/`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
+
+ **Configuration file**
+
+ ``/var/mobile/Library/ScummVM/Preferences`` if the device is jailbroken, or ``Preferences`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
+
+
diff --git a/doc/docportal/use_scummvm/LAN.rst b/doc/docportal/use_scummvm/LAN.rst
index 9fb9e825cf..bde2bce442 100644
--- a/doc/docportal/use_scummvm/LAN.rst
+++ b/doc/docportal/use_scummvm/LAN.rst
@@ -1,11 +1,17 @@
-==============================
-Set up a local web server
-==============================
+==================================
+Using the local web server
+==================================
+
+ScummVM can run a local web server (LAN), to simplify the transfer of game files, saved games and configuration files between devices on the same network. This is a good option if you do not want to use the Cloud, or if ScummVM for your platform does not have cloud functionality.
+
+
+.. note::
+
+ LAN functionality is not supported on all platforms.
+
+This guide explains how to set up and run a local web server.
-ScummVM can run a local web server, to allow the transfer of files between devices on the same network.
-How to use the web server
-----------------------------
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
@@ -18,24 +24,24 @@ Click **Run server** to start the server.
To access the server, type the URL shown into the address bar of any web browser:
-.. figure:: ../images/settings/LAN_server.png
+.. figure:: ../images/cloud_and_lan/LAN_server.png
The server's browser interface.
-To download a file, click on the file. A system download dialog box opens.
+To download a file, click on the file to open the system download dialog.
To create a new directory, click **Create Directory**.
-.. figure:: ../images/settings/LAN_server_new.png
+.. figure:: ../images/cloud_and_lan/LAN_server_new.png
Create a new directory.
To upload files, click **Upload Files** and select files from the system file browser.
-.. figure:: ../images/settings/LAN_server_upload.png
+.. figure:: ../images/cloud_and_lan/LAN_server_upload.png
Upload files.
-To change which files are accessible on the web server, set the **/root/ Path** to the directory containing the files you wish to access. You can access anything inside that directory, but you cannot access its parent directory.
+To change which files are accessible on the web server, set the **/root/ Path** to the directory containing the files you wish to access. You can access anything inside that directory, but you cannot access its parent directory. On some platforms ScummVM automatically sets the **/root/ Path**, but on some other platforms you need to configure this manually before running the web server for the first time.
-To stop the web server, click **Stop server** to stop the server, or **Ok** to close the settings dialog.
+To stop the web server, click **Stop server** to stop the server, or click **Ok** to close the settings dialog.
diff --git a/doc/docportal/use_scummvm/add_play_games.rst b/doc/docportal/use_scummvm/add_play_games.rst
index b7df280a38..c0d0938b01 100644
--- a/doc/docportal/use_scummvm/add_play_games.rst
+++ b/doc/docportal/use_scummvm/add_play_games.rst
@@ -1,121 +1,38 @@
=================================
-Add and play games
+Adding and playing a game
=================================
The games
-----------------
+------------
One of the most frequently asked questions is, "Where do I get the games?!?". If you still have your old floppy discs or CDs lying around, and have a way to read them, then you can use the game files from those original discs.
-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 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.
-
-In some cases ScummVM still shows the copy protection screen. Enter any answer; chances are that it will work.
-
-
-The game files
-------------------------
-
-ScummVM needs access to the data files for each game. A comprehensive list of required data files for each game is found on the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page. ScummVM can run the game data files from any directory it has access to, including external media.
-
-.. note::
-
- For ease of use, you can create a dedicated games folder into which folder containing game files can be copied. The resulting directory structure will look somewhat like this::
-
- ScummVM Games
- |-- Day of the Tentacle
- | |-- MONSTER.SOU
- | |-- TENTACLE.000
- | `-- TENTACLE.001
- `-- Flight of the Amazon Queen
- |-- QUEEN.1
- `-- queen.tbl
-
-
- The exact layout of files and folders within the game folder is not important, as long as all the files are there.
-
-For games on floppies or CDs:
-
-- If the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above.
-- If the data files are not accessible, run the installer on the platform the game was designed for, to extract the game files.
-
-For games downloaded from digital distributors or from various `freeware sources <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games#Freeware_Games>`__:
-
-- Run the installer to extract the game files, or
-- If the data files are supplied as a zip file, extract the files.
-
-For macOS or Linux users without access to a Windows machine, you can get the game files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer on macOS or Linux. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.
-
-
+If you haven't had a floppy disc or even a CD in your possession for a while, there is a ScummVM `wiki page <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ dedicated to helping you find some games to play.
.. tip::
- 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
-*****************
-
-ScummVM needs access to all the data files, so it will not be able to run directly from a CD if the game has multiple discs. To add a multi-CD game, copy the required data files from the CD to a folder on your hard drive.
-
-- Where there are duplicate, identical files (same name, same file size) on more than one disc, only one copy of the file is required.
-- Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.
-
-.. _cdaudio:
+ ScummVM has an affiliate referrer programme with GOG.com, so if you are going to buy a game, please use this `GOG.com <https://www.gog.com/?pp=22d200f8670dbdb3e253a90eee5098477c95c23d">`_ link to help the project!
-CD audio
-**********
-
-Some games contain one or more separate audio tracks on CD. To use these with ScummVM, extract the audio tracks from the CD in WAV or AIFF format, and then convert them to either MP3, FLAC or OGG file formats.
-
-.. tip::
-
- Software suggestion:
-
- `fre:ac <https://www.freac.org/>`_ is a multi-platform, open-source software, with the ability to both rip CDs and convert audio between MP3, OGG, FLAC and WAV file formats.
-
-Place the converted audio files in the same folder that contains the other game datafiles.
-
-
-.. _macgames:
-
-Macintosh games
-******************
-
-All LucasArts SCUMM games also exist in versions for the Macintosh. Most of the newer games shipped with only a single data file; ScummVM can use this file like it does any other data file. Some discs shipped with hidden files. To view hidden files in macOS, press :kbd:`Cmd+Shift+.` in a Finder window.
-
-Mac uses a different file system to other systems (HFS+), so to access the CD or floppy disc on a Windows or Linux system you will need additional software to view and copy the files.
-
-For Windows, `HFS Explorer <http://www.catacombae.org/hfsexplorer/>`_ is a basic and free option, which gives you read-only access to HFS drives. Use the installer rather than the zip file, to ensure it is installed correctly.
-
-For Linux, hfsplus gives you read-only access to HFS drives. To use hfsplus, use the command line:
-
- 1. Install hfsplus using the software manager. On Debian-based distributions, use ``sudo apt install hfsplus``.
- 2. Find the game disc by running ``sudo fdisk -l`` and finding the one with type ``Apple HFS/HFS+``. In this example, this is ``/dev/fd0``.
- 3. Create a mount point, for example: ``sudo mkdir /media/macgamedrive``
- 4. Mount the device to that moint point: ``sudo mount -t hfsplus /dev/fd0 /media/macgamedrive``
- 5. Access the device at ``/media/macgamedrive``.
+Make sure to check out the `compatibility list <https://www.scummvm.org/compatibility/>`_ on the ScummVM website, and the `Supported Games page <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ and `Platform Overview page <https://wiki.scummvm.org/index.php/Platforms/Overview>`_ on the ScummVM wiki before you buy a game, to ensure it can run with ScummVM.
.. _add and play games:
-Add games to the Launcher
+Adding games to the Launcher
---------------------------------
+The following steps explain how to add a game to ScummVM, and assume you have access to the data files for each game. If you're not sure how to access the game data files, see the :doc:`game_files` page.
+
+
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**.
+2. In the Launcher window, click **Add Game**. This opens a file browser; either the system file browser or the ScummVM file browser.
.. image:: ../images/Launcher/add_game.png
- :class: with-shadow
+To add multiple games at once, click the expander arrow next to **Add Game**, and select **Mass Add**.
+
+.. image:: ../images/Launcher/mass_add.png
3. Use the file browser to locate the folder containing the game data files. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Click **Choose** to select the folder.
@@ -126,16 +43,36 @@ Add games to the Launcher
The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the system file browser, or its own file browser.
-5. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything is OK at the default settings. Click **Ok**.
+3a. If you are using **Mass Add**, select **Yes** to run the mass game detector. A dialog opens to advise which games were added to the games list.
+
+.. image:: ../images/Launcher/mass_add_confirm.png
+
+.. image:: ../images/Launcher/mass_add_success.png
+
+4. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should be OK at the default settings. Any settings changed here override the global settings. Click **Ok**.
.. image:: ../images/Launcher/game_settings.png
:class: with-shadow
-6. Games are now ready to play! To play, highlight a game in the games list and click **Start**.
+.. note::
+
+ The **Edit Game** dialog does not open when **Mass Add** is used.
+
+5. Games are now ready to play! To play, highlight a game in the games list and click **Start**, or double-click the game in the games list.
.. 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_topics/command_line>`_ page.
+A note about copyright
+------------------------
+
+ScummVM has a strict anti-piracy stance and the team wil not tolerate discussions around pirated games in any part of the project, including on the Forum or on Discord.
+Copy protection screen
+************************
+
+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. Enter any answer; chances are that it will work.
diff --git a/doc/docportal/use_scummvm/connect_cloud.rst b/doc/docportal/use_scummvm/connect_cloud.rst
index 4a617ecec0..760ea43fa1 100644
--- a/doc/docportal/use_scummvm/connect_cloud.rst
+++ b/doc/docportal/use_scummvm/connect_cloud.rst
@@ -1,18 +1,35 @@
===============================
-Connect a cloud service
+Connecting a cloud service
===============================
+
+Connecting ScummVM to a cloud storage service provides an easy way of sharing game files and saved games between multiple devices. ScummVM currently supports Dropbox, OneDrive, Google Drive and Box, although only one service can be connected at any one time.
+
+.. note::
+
+ Cloud functionality is not supported on all platforms.
+
+This guide explains how to connect a cloud service to ScummVM.
+
From the Launcher, select **Options**, click the **>** scroll arrow until the Cloud tab is visible, and then select the **Cloud** tab.
-To connect your chosen cloud storage service to ScummVM, select it from the **Active storage** dropdown.
+Select your preferred cloud storage service from the **Active storage** dropdown.
.. figure:: ../images/cloud_and_lan/cloud_storage.png
-Click on the link shown at **1.**, and sign in to your cloud storage account. After you sign in, a 6-digit code will be displayed.
+Click on the link shown at **1.**, and sign in to your cloud storage account. A 6-digit code is displayed after you sign in.
.. figure:: ../images/cloud_and_lan/cloud_code.png
-Copy the 6-digit code, click into the empty field next to **Paste**, and then click **Paste**.
+.. warning::
+
+ Do not share this 6-digit code with anyone before you connect your cloud storage account.
+
+For devices without a web browser, navigate to the following ScummVM links on a computer or any other device with a web browser:
+
+`Dropbox <https://cloud.scummvm.org/dropbox>`_ | `OneDrive <https://cloud.scummvm.org/onedrive>`_ | `Google Drive <https://cloud.scummvm.org/gdrive>`_ | `Box <https://cloud.scummvm.org/box>`_
+
+Copy the 6-digit code, click into the empty field next to **Paste**, and then click **Paste**. Alternatively, for devices without a web browser, manually enter the 6-digit code.
.. figure:: ../images/cloud_and_lan/cloud_connect.png
diff --git a/doc/docportal/use_scummvm/game_files.rst b/doc/docportal/use_scummvm/game_files.rst
new file mode 100644
index 0000000000..c7144b6b1d
--- /dev/null
+++ b/doc/docportal/use_scummvm/game_files.rst
@@ -0,0 +1,86 @@
+
+===========================
+Accessing game files
+===========================
+
+The game files
+------------------
+
+ScummVM needs access to the data files for each game. A comprehensive list of required data files for each game is found on the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page. ScummVM can run the game data files from any directory it has access to, including external media.
+
+.. note::
+
+ For ease of use, you can create a dedicated games folder into which folder containing game files can be copied. The resulting directory structure will look somewhat like this::
+
+ ScummVM Games
+ |-- Day of the Tentacle
+ | |-- MONSTER.SOU
+ | |-- TENTACLE.000
+ | `-- TENTACLE.001
+ `-- Flight of the Amazon Queen
+ |-- QUEEN.1
+ `-- queen.tbl
+
+
+
+For games on floppies or CDs:
+
+- If the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above.
+- If the data files are not accessible, run the installer on the platform the game was designed for, to extract the game files.
+
+For games downloaded from digital distributors or from various `freeware sources <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games#Freeware_Games>`__:
+
+- Run the installer to extract the data files, or
+- If the data files are supplied as a zip file, extract the files.
+
+For macOS or Linux users without access to a Windows machine, you can get the data files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer on macOS or Linux. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.
+
+
+
+.. 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:`../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
+*****************
+
+ScummVM needs access to all the data files, so it will not be able to run directly from a CD if the game has multiple discs. To add a multi-CD game, copy the required data files from the CD to a folder on your hard drive. For a comprehensive list of required files, see the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page.
+
+As a general guideline:
+
+- Where there are duplicate, identical files (same name, same file size) on more than one disc, only one copy of the file is required.
+- Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.
+
+.. _cdaudio:
+
+CD audio
+**********
+
+Some games contain one or more separate audio tracks on CD. To use these with ScummVM, extract the audio tracks from the CD in WAV or AIFF format, and then convert them to either MP3, FLAC or OGG file formats. Place the converted audio files in the same folder that contains the other game datafiles.
+
+.. tip::
+
+ `fre:ac <https://www.freac.org/>`_ is a multi-platform, open-source software, with the ability to both rip CDs and convert audio between MP3, OGG, FLAC and WAV file formats.
+
+
+.. _macgames:
+
+Macintosh games
+******************
+
+All LucasArts SCUMM games also exist in versions for the Macintosh. Most of the newer games shipped with only a single data file; ScummVM can use this file like it does any other data file. Some discs shipped with hidden files. To view hidden files in macOS, press :kbd:`Cmd+Shift+.` in a Finder window.
+
+Mac uses a different file system to other systems (HFS+), so to access the CD or floppy disc on a Windows or Linux system you need additional software to view and copy the files.
+
+For Windows, `HFS Explorer <http://www.catacombae.org/hfsexplorer/>`_ is a basic and free option, which gives you read-only access to HFS drives. Use the installer rather than the zip file, to ensure it is installed correctly.
+
+For Linux, hfsplus gives you read-only access to HFS drives. To use hfsplus, use the command line:
+
+ 1. Install hfsplus using the software manager. On Debian-based distributions, use ``sudo apt install hfsplus``.
+ 2. Find the game disc by running ``sudo fdisk -l`` and finding the one with type ``Apple HFS/HFS+``. In this example, this is ``/dev/fd0``.
+ 3. Create a mount point, for example: ``sudo mkdir /media/macgamedrive``
+ 4. Mount the device to that moint point: ``sudo mount -t hfsplus /dev/fd0 /media/macgamedrive``
+ 5. Access the device at ``/media/macgamedrive``.
+
+
diff --git a/doc/docportal/use_scummvm/keyboard_shortcuts.rst b/doc/docportal/use_scummvm/keyboard_shortcuts.rst
index 55bde42357..e5d5ba7603 100755
--- a/doc/docportal/use_scummvm/keyboard_shortcuts.rst
+++ b/doc/docportal/use_scummvm/keyboard_shortcuts.rst
@@ -4,13 +4,11 @@ Keyboard shortcuts
ScummVM supports various in-game keyboard and mouse shortcuts, and since version 2.2.0 these can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`, or in the :doc:`configuration file <../advanced_topics/configuration_file>`.
-For game-specific shortcuts, see the `wiki entry <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ for the game you are playing.
+For game-specific controls, see the `wiki entry <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ for the game you are playing.
+Default shortcuts are shown in the table.
-Default keyboard shortcuts
-============================
-
.. csv-table::
:widths: 30 70
:header-rows: 1
diff --git a/doc/docportal/use_scummvm/save_load_games.rst b/doc/docportal/use_scummvm/save_load_games.rst
index 449b565b13..8a15609b22 100644
--- a/doc/docportal/use_scummvm/save_load_games.rst
+++ b/doc/docportal/use_scummvm/save_load_games.rst
@@ -1,67 +1,49 @@
===============================
-Save and load games
+Saving and loading a game
===============================
-Save a game
+This guide explains how to save and load a game from the Global Main Menu, or load a game directly from the Launcher.
+
+.. note::
+
+ Some games use their own load or save entry points within the game, or use their own menu instead of the GMM.
+
+Saving a game
==============
-Press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac) to access the Global Main Menu. Select **Save**.
+When you're playing a game and you're ready to save, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac) to access the Global Main Menu. Select **Save**.
.. figure:: ../images/Launcher/gmm_save.png
- The Global Main Menu, or GMM.
+ The Global Main Menu (GMM).
There are two views: list view and tile view. Click the list and tile icons at the bottom left of the window to toggle between the two.
+In tile view, click on the **New Save** tile. Enter a description for the game, then click **OK**.
+
.. figure:: ../images/Launcher/save_game_tile.png
- Save a game, tile view.
+ Saving a game, tile view.
.. figure:: ../images/Launcher/save_game_tile_desc.png
Save game decription, tile view.
+In list view, click on a slot to save the game to that slot. Enter a description for the game, then click **Save**.
+
.. figure:: ../images/Launcher/save_game_list.png
- Save a game, list view.
+ Saving a game, list view.
+
Autosave
------------
-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
-===============
-
-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.
-
-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.
-
-To load a saved game, highlight the saved state and click **Load**.
-
-To delete a saved game, highlight the saved state and click **Delete**.
-
-.. figure:: ../images/Launcher/load_game_list.png
-
- Load a game, list view.
-
-In tile view, each tile shows a screenshot of the saved state, as well as the description and save slot number. Click on the tile to load that saved state.
-
-
-.. figure:: ../images/Launcher/load_game_tile.png
-
- Load a game, tile view.
-
-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:
+ScummVM automatically saves your 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>`.
Location of saved game files
--------------------------------
+===============================
The save directory can be changed with the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_topics/configuration_file>`.
@@ -98,14 +80,7 @@ Default saved game paths are shown below.
Window Vista/7/8/10
^^^^^^^^^^^^^^^^^^^^^^
- ``\Users\username\AppData\Roaming\ScummVM\Saved games\``
-
- .. tip::
-
- The AppData folder is hidden. The steps to view hidden files and folders depends on the Windows version.
-
- For more information, see the `Windows support page <https://support.microsoft.com/en-us/help/14201/windows-show-hidden-files>`_.
-
+ ``%APPDATA%\ScummVM\Saved games``
.. tabbed:: Linux/Unix
@@ -114,9 +89,9 @@ Default saved game paths are shown below.
:column: col-lg-12 mb-2
- We follow the XDG Base Directory Specification, so by default the saved games can be found at ``~/.local/share/scummvm/saves/``, but this location might vary depending on the value of the ``XDG_DATA_HOME`` environment variable.
+ ScummVM follows the XDG Base Directory Specification, so by default the saved games can be found at ``~/.local/share/scummvm/saves/``, but this location might vary depending on the value of the ``XDG_DATA_HOME`` environment variable.
- ``.local`` is a hidden directory. To view it use ``ls -a`` on the command line, or, if you are using a GUI file manager, press :kbd:`Ctrl + H`.
+ ``.local`` is a hidden directory. To view it use ``ls -a`` on the command line.
If ScummVM was installed using Snap, the saves can be found at ``~/snap/scummvm/current/.local/share/scummvm/saves/``
@@ -129,3 +104,31 @@ Default saved game paths are shown below.
See the relevant Platform page for details.
+
+
+Loading a game
+===============
+
+If you want to load your saved game without having to start the game first, select the **Load** button directly from the Launcher. To load a saved game while you're playing a game, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac) to access the Global Main Menu, then select **Load**.
+
+There are two views: list view and tile view. Click the list and tile icons at the bottom left of the window to toggle between the two.
+
+In list view, the pane on the left shows a list of your saved games. Click on a saved game to highlight it. In the pane on the right you can see timestamps, screenshots and playtime for that saved game.
+
+Once you have highlighted the game you want to play, click **Load**.
+
+To delete a saved game, highlight the saved game and click **Delete**.
+
+.. figure:: ../images/Launcher/load_game_list.png
+
+ Loading a game, list view.
+
+In tile view, each tile shows a screenshot of the saved state, as well as a description and a save slot number. Click on the tile to load that saved game.
+
+.. figure:: ../images/Launcher/load_game_tile.png
+
+ Loading a game, tile view.
+
+
+.. _savelocation:
+
diff --git a/doc/docportal/use_scummvm/the_launcher.rst b/doc/docportal/use_scummvm/the_launcher.rst
index 89f22eee2f..13df2dbb52 100755
--- a/doc/docportal/use_scummvm/the_launcher.rst
+++ b/doc/docportal/use_scummvm/the_launcher.rst
@@ -1,128 +1,136 @@
-==============
+===================================
+Understanding the interface
+===================================
+
The Launcher
-==============
+===============
The main ScummVM window is called the Launcher. The Launcher opens whenever you start ScummVM, unless you launch a game directly from the command line.
-.. figure:: ../images/Launcher/the_launcher.png
+.. figure:: ../images/Launcher/launcher.png
- The Launcher.
+ The Launcher, with labels for each GUI element.
The games list
-===============
+********************
The pane on the left is the games list, which lists all the games that have been added to ScummVM. The games list usually offers some additional information about each game, such as original platform and language. To highlight any game on the list, type the first letter(s) of its title, or click on it.
-Quick search
-=============
+The search box
+********************
-Quick search lets you filter the games list.
-The quick search input is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, click **X** next to the input field.
+The search box lets you filter the games list. It is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, click **X**.
There are many ways to filter games. For example, you can type "Monkey Island" to locate all "Monkey Island" games on the list, or you can type "German" to find German games.
-.. figure:: ../images/Launcher/quicksearch.png
-
- The quick search function.
-
The buttons
-============
+************************
To the right of the games list there are a number of buttons. Their functions are as follows:
Start
------
+^^^^^^^^
Launches the highlighted game.
Load
-----
+^^^^^^^
Opens the load game window, from which you can run a previously saved state without having to start the game first.
See the :doc:`save_load_games` page.
Add Game
----------
+^^^^^^^^^^
Opens a file browser. To add a game, select a folder containing game files.
See the :doc:`add_play_games` page.
Edit Game
-----------
+^^^^^^^^^^^^
Opens the game settings window. This window also opens whenever a game is added to the games list in the Launcher.
-Use this window to configure settings specific to a game. These settings override the global settings. For more information, see the :doc:`../use_scummvm/how_to_settings` page.
+Use this window to configure settings specific to a game. These settings override the global settings. For more information, see the :doc:`../settings/how_to_settings` page.
Remove Game
------------
+^^^^^^^^^^^^^
-Removes the highlighted game from the list.
+Removes the highlighted game from the list. This does not remove any saved games, so if you add a game to the games list again, you are able to resume where you left off.
Options
--------
+^^^^^^^^^^^
-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
+Opens the global settings window. Use this window to define global game settings, as well as change a number of the ScummVM Launcher settings. For more information, see the :doc:`../settings/how_to_settings` page.
About
------
+^^^^^^^^^^
Shows credits and miscellaneous information about ScummVM.
Quit
--------
+^^^^^^^
Closes the Launcher and quits the ScummVM application.
The Global Main Menu
=====================
+You can access the ScummVM Global Main Menu, also known as the GMM, while you are playing a game. To open the GMM, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac).
+
.. figure:: ../images/Launcher/gmm.png
The Global Main Menu, or GMM.
-The Global Main Menu (GMM) is available while playing any game. Press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5` on a Mac). The GMM provides the following options:
+
+The buttons
+*****************
+
+In the Global Main Menu there are a number of buttons. Their functions are as follows:
Resume
---------
+^^^^^^^^^^
Closes the GMM and resumes the game.
Load
---------
+^^^^^^
Opens the load game window, to load a saved game state.
Save
-------
+^^^^^^
Opens the save game window, to save a game state.
Options
-----------
+^^^^^^^^
Opens a dialog which provides gameplay options, such as sound volume, subtitle and keymap settings.
About
---------
+^^^^^^^^^^^
Displays the ScummVM **About** dialog. This is also available from the Launcher.
Help
-------
+^^^^^^
Displays a list of keyboard shortcuts for the game.
Return to Launcher
----------------------
+^^^^^^^^^^^^^^^^^^^^^
-Quits the game and returns to The Launcher. This is not available for all games.
+Quits the game and returns to the Launcher.
+
+.. note::
+
+ This is not available for all games.
Quit
---------
-Quits the game and ScummVM, and returns to the Operating System.
+^^^^^^^
+Quits the game and ScummVM, and returns to the operating system. Any unsaved game progress is lost.
Commit: 9804f4e23be580feb2704734ca5ea438dad77147
https://github.com/scummvm/scummvm/commit/9804f4e23be580feb2704734ca5ea438dad77147
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: changes layout of site
- rearranges pages into "User Manual" and "Other platforms" sections
- refines "Other platforms" pages - clearer headings/structure
- updates graphics page + adds borders to images
- rewritten iOS build instructions for clarity
Changed paths:
A doc/docportal/other_platforms/amigaos_4.rst
A doc/docportal/other_platforms/android.rst
A doc/docportal/other_platforms/atari.rst
A doc/docportal/other_platforms/ios.rst
A doc/docportal/other_platforms/nintendo_3ds.rst
A doc/docportal/other_platforms/nintendo_switch.rst
A doc/docportal/other_platforms/playstation_3.rst
A doc/docportal/other_platforms/playstation_portable.rst
A doc/docportal/other_platforms/ps_vita.rst
A doc/docportal/other_platforms/risc_os.rst
A doc/docportal/other_platforms/sega_dreamcast.rst
A doc/docportal/use_scummvm/how_to_settings.rst
A doc/docportal/use_scummvm/install_computer.rst
R doc/docportal/get_started/android.rst
R doc/docportal/get_started/ios.rst
R doc/docportal/get_started/mac_linux_windows.rst
R doc/docportal/ports/amigaos_4.rst
R doc/docportal/ports/atari.rst
R doc/docportal/ports/nintendo_3ds.rst
R doc/docportal/ports/nintendo_switch.rst
R doc/docportal/ports/playstation_3.rst
R doc/docportal/ports/playstation_portable.rst
R doc/docportal/ports/ps_vita.rst
R doc/docportal/ports/risc_os.rst
R doc/docportal/ports/sega_dreamcast.rst
R doc/docportal/settings/how_to_settings.rst
R doc/docportal/trial/computer.rst
R doc/docportal/trial/console.rst
R doc/docportal/trial/phones.rst
doc/docportal/_static/custom.css
doc/docportal/advanced_topics/configuration_file.rst
doc/docportal/advanced_topics/understand_graphics.rst
doc/docportal/images/graphics/graphics_mode/1x.png
doc/docportal/images/graphics/graphics_mode/2x.png
doc/docportal/images/graphics/graphics_mode/2xsai.png
doc/docportal/images/graphics/graphics_mode/3x.png
doc/docportal/images/graphics/graphics_mode/advmame2x.png
doc/docportal/images/graphics/graphics_mode/advmame3x.png
doc/docportal/images/graphics/graphics_mode/dotmatrix.png
doc/docportal/images/graphics/graphics_mode/hq2x.png
doc/docportal/images/graphics/graphics_mode/hq3x.png
doc/docportal/images/graphics/graphics_mode/super2xsai.png
doc/docportal/images/graphics/graphics_mode/supereagle.png
doc/docportal/images/graphics/graphics_mode/tv2x.png
doc/docportal/index.rst
doc/docportal/use_scummvm/the_launcher.rst
diff --git a/doc/docportal/_static/custom.css b/doc/docportal/_static/custom.css
index f4b606779e..420905a8dd 100644
--- a/doc/docportal/_static/custom.css
+++ b/doc/docportal/_static/custom.css
@@ -28,7 +28,7 @@
color: #cc6600;
}
-/* Change header size*/
+/* Change H4 header size*/
h4 {
font-size: 100% !important;
@@ -40,4 +40,20 @@ h4 {
padding: 5px !important;
white-space: normal;
color: #000000;
+}
+
+/* Change color of tabs*/
+
+.tabbed-set>input:checked+label {
+ border-color: #cc6600 !important;
+ color: #cc6600 !important;
+}
+
+.tabbed-set>label {
+ color: #ffbb77 !important;
+}
+
+.tabbed-content {
+ box-shadow: 0 -.0625rem #ffd3a8,0 .0625rem #ffd3a8 !important;
+
}
\ No newline at end of file
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index 3508486afc..bc93b47a84 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -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 the Launcher. See :doc:`../settings/how_to_settings`.
+Settings are also accessible directly from the Launcher. See :doc:`../use_scummvm/how_to_settings`.
Location
==========
@@ -88,7 +88,7 @@ The configuration file saves to different default locations, depending on the pl
Using the configuration file
==================================
-Global settings are listed under the ``[scummvm]`` heading. Global :doc:`keymaps settings <../settings/keymaps>` are listed under the ``[keymapper]`` heading. Game-specific settings, including keymaps, are listed under the heading for that game, for example ``[queen]`` for Flight of the Amazon Queen. Use the configuration keywords_ to change settings.
+Global settings are listed under the ``[scummvm]`` heading. Global :doc:`keymaps settings <../settings/keymaps>` are listed under the ``[keymapper]`` heading. Game-specific settings, including keymaps, are listed under the heading for that game, for example ``[queen]`` for Flight of the Amazon Queen. Use the configuration keys to change settings.
Example of a configuration file
diff --git a/doc/docportal/advanced_topics/understand_graphics.rst b/doc/docportal/advanced_topics/understand_graphics.rst
index 0df33ce424..ab15af069a 100644
--- a/doc/docportal/advanced_topics/understand_graphics.rst
+++ b/doc/docportal/advanced_topics/understand_graphics.rst
@@ -19,6 +19,8 @@ The original game graphics are upscaled using different graphical filters, which
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.
+There is always a speed penalty when using any form of filtering.
+
A comparison of graphics modes
*************************************
@@ -71,9 +73,9 @@ A comparison of graphics modes
**DotMatrix**: Dot matrix effect. Factor 2x.
-Not all engines support all, or even any, of the graphics modes.
-
-There is always a speed penalty when using any form of anti-aliasing/linear filtering.
+.. note::
+
+ Not all platforms support all the graphics modes.
To switch between graphics modes, press :kbd:`Ctrl + Alt` and :kbd:`1` to :kbd:`8`.
@@ -93,6 +95,8 @@ Aspect ratio correction
Older games were designed to be run at 320x200 pixels, but on systems where each pixel was rectangular instead of square. This means that on modern systems these games look wider and flatter than they are supposed to. Aspect ratio correction duplicates lines of pixels to correct this.
+For a game with an original resolution of 320x200, aspect ratio correction results in a resolution of 320x240.
+
.. figure:: ../images/graphics/aspect_ratio/no_aspect_ratio.png
No aspect ratio correction applied.
@@ -112,7 +116,10 @@ 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 fills the remaining empty space with black borders.
+- Pixel-perfect scaling: scales the image to the highest multiple of the game resolution that fits the window, or that fits the screen if in fullscreen mode. Any empty space is filled with black bars.
+
+ - For example, a game with an original resolution of 320x200 with aspect ratio correction applied (320x240) and a 3x graphics mode, will be stretched to a multiple of 900x720 pixels: 1800x1440, 2700x2160 and so on.
+
- 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.
diff --git a/doc/docportal/get_started/mac_linux_windows.rst b/doc/docportal/get_started/mac_linux_windows.rst
deleted file mode 100644
index bd0c1abc7f..0000000000
--- a/doc/docportal/get_started/mac_linux_windows.rst
+++ /dev/null
@@ -1,108 +0,0 @@
-
-========================
-Mac, Linux or Windows
-========================
-
-macOS
--------
-
-Download the recommended disk image file from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_. After the download has completed, double click the file to mount the disk image file. A window containing the ScummVM icon opens. Drag this icon into your Applications folder to install ScummVM.
-
-To run ScummVM, click on the icon in the Applications folder.
-
-.. note::
-
- macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. ScummVM is not available from the App Store, so follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
-
-
-Linux
---------
-
-There are multiple ways to install ScummVM onto a computer running Linux; use the Snap Store, Flathub or the software repository, or install the release binary.
-
-The Snap Store
-*********************
-
-A Snap is an app that is bundled with its dependencies, which makes the install on any Linux operating system very easy. Snap comes pre-installed on Debian and Ubuntu-based distributions, but can be installed on any Linux distribution by following the instructions on the `Snapcraft website <https://snapcraft.io/>`_.
-
-The ScummVM Snap comes with a selection of freeware games and demos pre-loaded.
-
-Enter the following on the command line to install the ScummVM Snap:
-
-.. code:: bash
-
- sudo snap install scummvm
-
-To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking :menuselection:`Menu --> Games --> ScummVM`.
-
-Flathub
-**********
-
-Flathub is another way to install apps for Linux, by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
-
-When Flatpak is installed, enter the following on the command line to install ScummVM:
-
-.. code:: bash
-
- flatpak install flathub org.scummvm.ScummVM
-
-Some distributions have the option to install Flatpaks through the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog opens; choose the **Open with Software Install (default)** option, and then click **OK**.
-
-To run ScummVM, enter the following on the command line:
-
-.. code:: bash
-
- flatpak run org.scummvm.ScummVM
-
-To pass :doc:`Command line arguments <../advanced_topics/command_line>`, add them after the Flatpak ``run`` command.
-
-.. note::
-
- The Flatpak version of ScummVM is sandboxed, meaning that any games need to be copied into the Documents folder to be accessible by ScummVM.
-
-Software Repository
-*********************************
-
-ScummVM is found in the software repositories of many Linux distributions.
-
-.. caution::
-
- The repositories might not contain the most up-to-date version of ScummVM.
-
-If you are unsure about how to install software packages from the software repository for your distribution, you might find `this help article <https://www.maketecheasier.com/install-software-in-various-linux-distros/>`_ useful.
-
-To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
-
-
-Release binaries
-*********************
-
-At this time, binary packages are only released for Debian and Ubuntu. On the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, find and download the ScummVM package that corresponds to your operating system and architecture. To install a DEB package, either double click on the downloaded DEB file to use the graphical installer, or, if that's not available, use the command line.
-
-.. code:: bash
-
- sudo apt install /path/to/downloaded/file.deb
-
-Replace ``/path/to/downloaded/file.deb`` with the actual path to the downloaded DEB package. The APT software manager handles the installation.
-
-To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
-
-
-Windows
----------
-
-There are two ways to install ScummVM onto a computer running Windows; download and use the installer, or install manually.
-
-Installer
-************
-
-Download the Windows installer for your operating system from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, and double click the downloaded file. The installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
-
-To run ScummVM, either navigate to desktop and double click the ScummVM shortcut, or go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Apps > ScummVM**.
-
-Manual
-**********
-
-Download the Windows zip file for your operating system (32bit or 64bit). To extract the files, right-click the folder and select **Extract All**.
-
-To run ScummVM from the extracted folder, find the ``scummvm.exe`` file and double click it.
diff --git a/doc/docportal/images/graphics/graphics_mode/1x.png b/doc/docportal/images/graphics/graphics_mode/1x.png
index d30afdd9fc..7ccd597f8f 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/1x.png and b/doc/docportal/images/graphics/graphics_mode/1x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/2x.png b/doc/docportal/images/graphics/graphics_mode/2x.png
index e9121ba08c..d15e535752 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/2x.png and b/doc/docportal/images/graphics/graphics_mode/2x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/2xsai.png b/doc/docportal/images/graphics/graphics_mode/2xsai.png
index 024b9d3910..519fa65321 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/2xsai.png and b/doc/docportal/images/graphics/graphics_mode/2xsai.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/3x.png b/doc/docportal/images/graphics/graphics_mode/3x.png
index bcee73ba5a..16a12e64a8 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/3x.png and b/doc/docportal/images/graphics/graphics_mode/3x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/advmame2x.png b/doc/docportal/images/graphics/graphics_mode/advmame2x.png
index 11769c4963..4e6cec1f23 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/advmame2x.png and b/doc/docportal/images/graphics/graphics_mode/advmame2x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/advmame3x.png b/doc/docportal/images/graphics/graphics_mode/advmame3x.png
index d8ec958df3..7cec5253fa 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/advmame3x.png and b/doc/docportal/images/graphics/graphics_mode/advmame3x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/dotmatrix.png b/doc/docportal/images/graphics/graphics_mode/dotmatrix.png
index 47cd6704ac..6add7bade0 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/dotmatrix.png and b/doc/docportal/images/graphics/graphics_mode/dotmatrix.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/hq2x.png b/doc/docportal/images/graphics/graphics_mode/hq2x.png
index f2ac5a9438..887791565a 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/hq2x.png and b/doc/docportal/images/graphics/graphics_mode/hq2x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/hq3x.png b/doc/docportal/images/graphics/graphics_mode/hq3x.png
index 98e819dc48..41707959b4 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/hq3x.png and b/doc/docportal/images/graphics/graphics_mode/hq3x.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/super2xsai.png b/doc/docportal/images/graphics/graphics_mode/super2xsai.png
index 2b97f56047..e62f4065c3 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/super2xsai.png and b/doc/docportal/images/graphics/graphics_mode/super2xsai.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/supereagle.png b/doc/docportal/images/graphics/graphics_mode/supereagle.png
index 31f69f9e5e..dc1c3c08a3 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/supereagle.png and b/doc/docportal/images/graphics/graphics_mode/supereagle.png differ
diff --git a/doc/docportal/images/graphics/graphics_mode/tv2x.png b/doc/docportal/images/graphics/graphics_mode/tv2x.png
index 9bdbb49c47..610c850ad8 100644
Binary files a/doc/docportal/images/graphics/graphics_mode/tv2x.png and b/doc/docportal/images/graphics/graphics_mode/tv2x.png differ
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 8f444f9657..5756207130 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -4,28 +4,29 @@
:caption: The basics
:hidden:
- trial/*
-
-.. toctree::
- :caption: Using ScummVM
- :glob:
- :hidden:
-
+ use_scummvm/install_computer
use_scummvm/the_launcher
use_scummvm/game_files
use_scummvm/add_play_games
use_scummvm/save_load_games
+ use_scummvm/keyboard_shortcuts
+ use_scummvm/how_to_settings
use_scummvm/connect_cloud
use_scummvm/LAN
- use_scummvm/keyboard_shortcuts
+
+.. toctree::
+ :caption: Other platforms
+ :glob:
+ :hidden:
+
+ other_platforms/*
.. toctree::
- :caption: Settings
+ :caption: The settings
:glob:
:hidden:
- settings/how_to_settings
settings/game
settings/engine
settings/graphics
@@ -68,13 +69,7 @@
release_notes/*
-.. toctree::
- :caption: Other platforms
- :glob:
- :hidden:
- get_started/*
- ports/*
====================
@@ -91,70 +86,53 @@ While ScummVM was originally designed to run LucasArts' SCUMM games, over time s
.. _firststeps:
-The basics
+Start here!
================
-We have guides to show you how to get ScummVM up and running on many different platforms:
+We have a user manual section covering all the basics:
.. panels::
:container: text-center mb-4
- :doc:`trial/computer`
-
- ---
-
- :doc:`trial/phones`
-
- ---
+ Installation
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ :doc:`Installing ScummVM on a computer <use_scummvm/install_computer>`
- :doc:`trial/console`
+ :doc:`use_scummvm/the_launcher`
---
-
- Other operating systems
-
-
-
-How do I use ScummVM?
-=========================
-
-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
-
- Understanding the interface
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- :doc:`The Launcher <use_scummvm/the_launcher>`
-
- ---
-
Playing games
- ^^^^^^^^^^^^^^
+ ^^^^^^^^^^^^^^^
:doc:`use_scummvm/game_files`
-
+
:doc:`use_scummvm/add_play_games`
:doc:`use_scummvm/save_load_games`
+ ---
+
+
+ Controls and settings
+ ^^^^^^^^^^^^^^^^^^^^^^^
:doc:`use_scummvm/keyboard_shortcuts`
+ :doc:`use_scummvm/how_to_settings`
+
---
+
+ Useful features
+ ^^^^^^^^^^^^^^^^
- Exploring the features
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:doc:`use_scummvm/connect_cloud`
:doc:`use_scummvm/LAN`
- ---
- Changing settings
- ^^^^^^^^^^^^^^^^^^^^^
- :doc:`settings/how_to_settings`
+
+
diff --git a/doc/docportal/ports/amigaos_4.rst b/doc/docportal/other_platforms/amigaos_4.rst
similarity index 86%
rename from doc/docportal/ports/amigaos_4.rst
rename to doc/docportal/other_platforms/amigaos_4.rst
index 590686b92c..9af99405b7 100644
--- a/doc/docportal/ports/amigaos_4.rst
+++ b/doc/docportal/other_platforms/amigaos_4.rst
@@ -2,16 +2,15 @@
AmigaOS 4
=============================
-Install ScummVM
-===================
+This page contains all the information you need to get ScummVM up and running on AmigaOS 4.
-Prerequisites
-****************
+What you'll need
+===================
- A system running Amiga OS 4
-Download and install ScummVM
-*********************************
+Installing ScummVM
+=====================================
ScummVM is available for download from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_ or the `OS4 Depot <http://www.os4depot.net>`_.
@@ -26,10 +25,10 @@ Run the extracted ``ScummVM_Install`` script. This installer guides you through
To automatically keep ScummVM up to date through AmiUpdate, run the ``Autoinstall`` script.
-Transfer game files
-=======================
+Transferring game files
+=========================
-See :doc:`../use_scummvm/add_play_games` for more information.
+See :doc:`../use_scummvm/game_files` for more information.
For games on PC or Mac formatted discs, use the original platform to access the data files, and then transfer these to Amiga. Alternatively, if you have external hardware such as a Catweazel floppy disc controller, you might be able to use this to access the files.
diff --git a/doc/docportal/get_started/android.rst b/doc/docportal/other_platforms/android.rst
similarity index 92%
rename from doc/docportal/get_started/android.rst
rename to doc/docportal/other_platforms/android.rst
index 7af59aba53..b6dac4dcb0 100644
--- a/doc/docportal/get_started/android.rst
+++ b/doc/docportal/other_platforms/android.rst
@@ -3,7 +3,9 @@
Android
===============
-Prerequisites
+This page contains all the information you need to get ScummVM up and running on an Android device.
+
+What you'll need
================
- An Android device running Android 4.1 (Jelly Bean) or newer.
@@ -12,19 +14,19 @@ Prerequisites
ScummVM has been tested to work up to Android 10. Currently there are some file browsing limitations with Android 11. The ScummVM team are working to resolve these.
-Install ScummVM
+Installing ScummVM
====================================
There are two ways to install ScummVM on an Android device; install it from the Google Play Store, or manually download and install the APK package from the ScummVM downloads page.
-From the Google Play Store
-****************************
+Installing from the Google Play Store
+***************************************
-Go to the Google Play Store to download and install ScummVM.
+The latest supported version of ScummVM is on the Google Play Store; search for ScummVM on the Google Play Store and select **Install**.
-From the APK package
-***********************
+Manually installing the APK package
+*************************************
On your device, use a web browser app to navigate to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_. The recommended download section on the page suggests the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
@@ -41,7 +43,7 @@ Click on the correct package to start the download. After it has downloaded, go
- For Android 7 or lower, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
- For Android 8 or higher, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
-Transfer game files
+Transferring game files
========================================
Transfer all the required game data files to your device, into a folder accessible by the ScummVM app.
@@ -118,8 +120,8 @@ Configuration file
The configuration file is in the internal app folder, and this path cannot be changed.
-Access the internal app folder
-********************************
+Accessing the internal app folder
+************************************
To access the internal app folder, use ScummVM's built-in LAN functionality:
diff --git a/doc/docportal/ports/atari.rst b/doc/docportal/other_platforms/atari.rst
similarity index 79%
rename from doc/docportal/ports/atari.rst
rename to doc/docportal/other_platforms/atari.rst
index 8d2c37353b..84d005c9c2 100644
--- a/doc/docportal/ports/atari.rst
+++ b/doc/docportal/other_platforms/atari.rst
@@ -2,17 +2,16 @@
Atari/FreeMiNT
=============================
-Install ScummVM
-===================
+This page contains all the information you need to get ScummVM up and running on an Atari system.
-Prerequisites
-****************
+What you'll need
+=================
-- A powerful Atari system or clone; minimum CPU 68060.
+- A powerful Atari system or clone; recommended minimum CPU 68060.
- FreeMiNT, TOS or MagiC operating system.
-Download and install ScummVM
-*********************************
+Installing ScummVM
+=====================================
Binary packages are provided for the m68000 CPU, the m68020 to m68060 range of CPUs, and the Coldfire (FireBee) CPU. All are available for download from the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_. To install ScummVM, extract the selected ScummVM archive into a folder on the hard disk.
@@ -26,8 +25,8 @@ To run ScummVM from a FreeMiNT Command Line Interface, make the program executab
For the best performance, run ScummVM under FreeMiNT, from the command line, and without the AES started.
-Transfer game files
-=======================
+Transferring game files
+=========================
Transfer files to the Atari as you normally would, such as through a network connection or by optical disc.
@@ -58,7 +57,11 @@ For more information, see the Settings section of the documentation. Only platfo
Graphics
************
-For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. XBIOS works better than GEM, because GEM rendering is slower. Note that this is not a ScummVM setting, but rather a system-wide setting.
+For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. This is not a ScummVM setting, but rather a system-wide setting.
+
+.. tip::
+
+ XBIOS works better than GEM, because GEM rendering is generally slower.
Audio
*******
@@ -75,7 +78,7 @@ Known issues
- There is no cloud/LAN functionality.
-- The built-in MIDI driver (STMIDI) does not work.
+- The Atari built-in MIDI driver (STMIDI) does not work.
- FLAC, OGG and MP3 decoding libraries are extremely CPU intensive and greatly slow down the user experience. ScummVM is best run with uncompressed audio, when available.
diff --git a/doc/docportal/get_started/ios.rst b/doc/docportal/other_platforms/ios.rst
similarity index 74%
rename from doc/docportal/get_started/ios.rst
rename to doc/docportal/other_platforms/ios.rst
index bcf65a9a5d..f7bd488a69 100644
--- a/doc/docportal/get_started/ios.rst
+++ b/doc/docportal/other_platforms/ios.rst
@@ -3,74 +3,76 @@
iOS
==============
-Install ScummVM
+This page contains all the information you need to get ScummVM up and running on an iOS device.
+
+
+Installing ScummVM
=====================
-There are two methods to install ScummVM onto an iOS device, and the method use depends on whether or not the device is jailbroken.
+There are two ways to install ScummVM on an iOS device, and the method you use depends on whether or not the device has custom firmware installed.
-No Jailbreak
-^^^^^^^^^^^^^^^^
+Devices without custom firmware
+************************************
-This method is a little complex, however it is currently the only way to install ScummVM onto an iOS device that is not jailbroken. While a rudimentary knowledge of the command line would be useful, the following instructions, if followed carefully, can be completed by anyone.
+To installing ScummVM on an iOS device without custom firmware you need to build the app from the source code, and then install it on your device. While a basic knowledge of the command line would be useful, the following instructions, if followed carefully, can be completed by anyone.
-Prerequisites
-****************
+What you'll need
+^^^^^^^^^^^^^^^^^^^^
- A Mac computer with Xcode installed. Xcode is a free App, available from the Mac App Store.
- An Apple Developer account. You can sign up for a free account on the `Apple Developer Member Center <https://developer.apple.com/membercenter/>`_ with your Apple ID.
-- The ScummVM `iOS Libraries <https://www.scummvm.org/frs/build/scummvm-ios7-libs-v2.zip>`_ downloaded.
+- The ScummVM `iOS Libraries <https://www.scummvm.org/frs/build/scummvm-ios7-libs-v2.zip>`_ downloaded, and the zip file extracted.
.. note::
If you have a free Apple developer account, each build will only be valid for 7 days, which means you will need to repeat these steps and rebuild ScummVM every week.
-Create the Xcode project
-***************************
+Step 1: Setting up the Xcode project
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The first step is to download the repository containing the code required to build the app. The next steps require use of the command line. Go to **Applications > Utilities > Terminal** and copy and paste the following, then press :kbd:`return` :
+The first step is to download the repository containing the code required to build the app. The next steps require use of the command line. Go to **Applications > Utilities > Terminal** and copy and paste the following, then press :kbd:`return`. This downloads (clones) the source code into your Home directory, into a folder called ``scummvm``:
.. code-block:: bash
- git clone https://github.com/scummvm/scummvm.git
+ git clone --depth 1 -b branch-2-2-0 https://github.com/scummvm/scummvm.git
-.. note::
- The default branch of the ScummVM repository will be the master branch. To build a specific version of ScummVM, checkout the appropriate branch. For example, to build version 2.2.0, use the following command:
+.. tip::
- .. code-block::
+ To view the Home directory in the Finder, select **Go > Home** in the menu bar, or press :kbd:`command+shift+H`.
- git checkout branch-2-2-0
+If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time also installs the command line tools required.
-If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time will also install the command line tools required.
+Create a new directory called ``build`` at the same level as the repository you just cloned, using either the Finder, or the command line as follows:
-The next step changes the present working directory and then generates the tools required to create the Xcode project.
+.. code-block::
-.. code-block:: bash
+ mkdir build
- cd scummvm/devtools/create_project/xcode
- xcodebuild
+Copy the contents of the ``scummvm-ios7-libs-v2`` folder you extracted earlier into the ``build`` directory, using either the Finder, or the command line as follows:
-The next command creates a new directory called ``build`` at the same level as the repository:
+.. code-block::
-.. code-block:: bash
+ cp -r ~/Downloads/scummvm-ios7-libs-v2/* ~/build/
- cd ../../../..
- mkdir build
- cd build
+If your downloaded iOS library folder is not in the Downloads folder as it is in the preceding example, change the path to where the folder actually is.
-The present working directory will now be the new ``build`` directory. Extract the contents of the downloaded iOS libraries package into the build folder by using the following command:
+Now let's change the present working directory and then set up the tools required to create the Xcode project:
.. code-block:: bash
- unzip ~/Downloads/scummvm-ios7-libs-v2.zip
+ cd scummvm/devtools/create_project/xcode
+ xcodebuild
+
-.. note::
+Step 2: Generating the Xcode project
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- In newer versions of macOS, the archive is extracted automatically. If this is the case, the ``unzip`` command will not work as expected. Instead, copy the contents of the ``scummvm-ios7-libs-v2`` folder into the ``build`` directory. It is simplest to do this in the Finder.
+Change your present working directory to the ``build`` directory:
+.. code-block::
-Generate the Xcode project
-*****************************
+ cd ~/build
-It's time to generate the Xcode project. Ensure the present working directory is still the ``build`` directory, and then run the following on the command line:
+It's time to generate the Xcode project. Run the following on the command line:
.. code::
@@ -88,9 +90,6 @@ The resulting directory structure looks like this:
|-- engines
'-- scummvm.xcodeproj
-.. tip::
-
- To view the Home directory in the Finder, select **Go > Home** in the menu bar, or press :kbd:`command+shift+H`.
Open the ``scummvm.xcodeproj`` file from the Finder, or from the command line:
@@ -98,8 +97,8 @@ Open the ``scummvm.xcodeproj`` file from the Finder, or from the command line:
open scummvm.xcodeproj
-Build ScummVM
-*****************
+Step 3: Building the ScummVM app
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When Xcode is open, connect a device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then select the device you just connected. You will need to "Trust" the device for it to show up on the list of connected devices.
@@ -122,19 +121,18 @@ If you have not added your developer account to Xcode, do this now. Click **Add
In the upper left-hand corner, press the play button to build ScummVM. When the build is finished, it launches on your connected device.
-Jailbreak
-^^^^^^^^^^^^
-
+Devices with custom firmware
+*******************************
-Prerequisites
-***************
+What you'll need
+^^^^^^^^^^^^^^^^^^^
-- A jailbroken iOS device. How to jailbreak a device is outside the scope of this documentation.
+- An iOS device with custom firmware installed (jailbroken). How to jailbreak a device is outside the scope of this documentation.
- A file manager app such as Filza installed on the device.
-Install ScummVM
-*******************
+Downloading and installing ScummVM
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended ``.deb`` or ``.ipa`` package. When the device asks how to open the file, choose Filza.
@@ -142,7 +140,7 @@ Ensure the package is saved somewhere in the ``/var/mobile/`` directory. It defa
Restart your device for the install to complete.
-Transfer game files
+Transferring game files
========================
There are multiple ways to transfer game files to your iOS device.
@@ -182,7 +180,7 @@ Controls
Touch controls
-^^^^^^^^^^^^^^^^^
+*******************
The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
- When touchpad mouse mode is off, the touch controls are direct. The pointer jumps to where the finger touches the screen.
@@ -192,38 +190,38 @@ The touch control scheme can be switched in the global settings. From the Launch
.. _twofinger:
Two finger tap
-******************
+^^^^^^^^^^^^^^^^^^^^^
For a two finger tap, hold one finger down and then tap with a second finger.
.. _twofingerdouble:
Two finger double tap
-************************
+^^^^^^^^^^^^^^^^^^^^^^^
For a two finger double tap, hold one finger down and then double tap with a second finger.
Click and drag mode
-*********************
+^^^^^^^^^^^^^^^^^^^^^^^
Simulates a left mouse click when you touch the screen. The mouse pointer drags to wherever you slide your finger, and releases where you lift your finger.
If you press down a second finger in this mode, it releases the simulated left mouse button, and presses down the simulated right mouse button. The right mouse button is released when you lift your finger again.
Keyboard
-**********
+^^^^^^^^^^^^^^^^^^^^
If no external keyboard is connected, the pinch gesture shows and hides the onscreen keyboard. When an external keyboard is connected, the pinch gesture enables/disables inputs from the external keyboard.
Paths
=======
Saved games
-^^^^^^^^^^^^^^^^^
+**************
``/var/mobile/Library/ScummVM/Savegames/`` if the device is jailbroken, or ``Savegames/`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
Configuration file
-^^^^^^^^^^^^^^^^^^^^^^^
+*********************
``/var/mobile/Library/ScummVM/Preferences`` if the device is jailbroken, or ``Preferences`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
\ No newline at end of file
diff --git a/doc/docportal/ports/nintendo_3ds.rst b/doc/docportal/other_platforms/nintendo_3ds.rst
similarity index 86%
rename from doc/docportal/ports/nintendo_3ds.rst
rename to doc/docportal/other_platforms/nintendo_3ds.rst
index da74f08460..46bd8685ec 100644
--- a/doc/docportal/ports/nintendo_3ds.rst
+++ b/doc/docportal/other_platforms/nintendo_3ds.rst
@@ -2,42 +2,41 @@
Nintendo 3DS
=============================
-Install ScummVM
-===================
+This page contains all the information you need to get ScummVM up and running on a Nintendo 3DS.
-Prerequisites
-****************
+What you'll need
+===================
- A Nintendo 3DS with a Homebrew Launcher or custom firmware. How to enable homebrew is outside the scope of this documentation.
-Download and install ScummVM
-*********************************
+Installing ScummVM
+======================================
Download the Nintendo 3DS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Extract the archive.
There are two ways to install ScummVM: using the 3DSX format, or the CIA format.
-3DSX
-^^^^^^
+Using the 3DSX format
+***********************
Copy the extracted files to your SD card into the ``/3ds/scummvm`` directory.
Launch ScummVM using the Homebrew Launcher.
-CIA
-^^^^^
+Using the CIA format
+***********************
Use any CIA installation software to install the ``scummvm.cia`` file.
The CIA format requires a DSP binary dump saved on your SD card as ``/3ds/dspfirm.cdc``. This is not an optional step, because without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
-Transfer game files
-=======================
+Transferring 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:`../use_scummvm/connect_cloud`.
-See :doc:`../use_scummvm/add_play_games` for more information about how to add games to ScummVM.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
@@ -86,11 +85,11 @@ Magnify mode increases the scale factor of the top screen back to 1, but the bot
When activating magnify mode, touchscreen controls are automatically switched to :ref:`hover` mode to reduce the risk of the user accidentally inputting a click when changing the magnified area with the stylus. Clicking can still be done as in normal hover mode. Turning off magnify mode will revert controls back to what was used previously. It will also restore the top screen's previous scale factor.
-Currently magnify mode can only be used when the following conditions are met:
+Magnify mode can only be used when the following conditions are met:
-- In the 3DS config menu, **Use Screen** is set to **Both**
-- A game is played
-- The horizontal and/or vertical resolution in-game is greater than that of the top screen
+- In the 3DS config menu, the **Use Screen** option is set to **Both**.
+- The horizontal and/or vertical in-game resolution is greater than that of the top screen.
+- You're playing a game.
Magnify mode cannot be used in the Launcher menu.
@@ -113,8 +112,8 @@ Settings
For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
-3DS config menu
-****************
+The 3DS config menu
+*********************
.. figure:: ../images/3ds/config.png
diff --git a/doc/docportal/ports/nintendo_switch.rst b/doc/docportal/other_platforms/nintendo_switch.rst
similarity index 96%
rename from doc/docportal/ports/nintendo_switch.rst
rename to doc/docportal/other_platforms/nintendo_switch.rst
index ec8ceac258..69ff5f1332 100644
--- a/doc/docportal/ports/nintendo_switch.rst
+++ b/doc/docportal/other_platforms/nintendo_switch.rst
@@ -2,16 +2,15 @@
Nintendo Switch
=============================
-Install ScummVM
-===================
+This page contains all the information you need to get ScummVM up and running on a Nintendo Switch.
-Prerequisites
-****************
+What you'll need
+===================
- A homebrew-enabled Nintendo Switch console. How to enable homebrew is outside the scope of this documentation.
-Download and install ScummVM
-*******************************
+Installing ScummVM
+=======================================
The Nintendo Switch package is available for download on the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_.
@@ -20,7 +19,7 @@ Download the zip file to a computer, and extract the files.
Copy the extracted ``scummvm`` folder to your Nintendo Switch microSD card, into the ``/switch/`` folder.
-Transfer game files
+Transferring game files
=======================
Copy the folders containing game files into the ``/switch/scummvm/`` folder on the microSD card.
diff --git a/doc/docportal/ports/playstation_3.rst b/doc/docportal/other_platforms/playstation_3.rst
similarity index 94%
rename from doc/docportal/ports/playstation_3.rst
rename to doc/docportal/other_platforms/playstation_3.rst
index c8d0e3f500..4c4e92fbbc 100644
--- a/doc/docportal/ports/playstation_3.rst
+++ b/doc/docportal/other_platforms/playstation_3.rst
@@ -2,18 +2,17 @@
PlayStation 3
=============================
-Install ScummVM
-===================
+This page contains all the information you need to get ScummVM up and running on a PlayStation 3.
-Prerequisites
-****************
+What you'll need
+===================
- A Homebrew enabled Playstation 3 console. How to enable homebrew is outside the scope of this documentation.
- A USB drive
- A computer
-Download and install ScummVM
-*********************************
+Installing ScummVM
+=====================================
Download the Playstation 3 package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Copy the ``.pkg`` file to a USB drive.
@@ -22,7 +21,7 @@ Plug the USB drive into the PS3. Go to the XMB, then go to **Games > Install Pa
To launch ScummVM, go to the XMB, then go to **Games > PlayStation 3 > ScummVM**.
-Transfer game files
+Transferring game files
=======================
Games can be launched from either a USB drive, or from the internal hard drive. The hard drive has better performance.
diff --git a/doc/docportal/ports/playstation_portable.rst b/doc/docportal/other_platforms/playstation_portable.rst
similarity index 95%
rename from doc/docportal/ports/playstation_portable.rst
rename to doc/docportal/other_platforms/playstation_portable.rst
index 71e2637254..c26f2e2cf4 100644
--- a/doc/docportal/ports/playstation_portable.rst
+++ b/doc/docportal/other_platforms/playstation_portable.rst
@@ -2,17 +2,16 @@
PlayStation Portable
=====================
-Install ScummVM
-===================
+This page contains all the information you need to get ScummVM up and running on a PSP.
-Prerequisites
-****************
+What you'll need
+===================
- A homebrew-enabled PSP. How to enable homebrew is outside the scope of this documentation.
- A computer to download an extract the install files.
-Download and install ScummVM
-*******************************
+Installing ScummVM
+=======================================
The PSP package is available for download ScummVM's `Downloads page <https://www.scummvm.org/downloads>`_.
@@ -24,7 +23,7 @@ Copy the extracted ``scummvm`` folder to your PSP, into the ``/PSP/GAME/`` folde
Go to **Game > Memory Stick** and choose **ScummVM** to launch ScummVM!
-Transfer game files
+Transferring game files
==========================
Transfer game files onto the PSP as described in the installation section above. They can be copied to any folder; location doesn't matter.
diff --git a/doc/docportal/ports/ps_vita.rst b/doc/docportal/other_platforms/ps_vita.rst
similarity index 96%
rename from doc/docportal/ports/ps_vita.rst
rename to doc/docportal/other_platforms/ps_vita.rst
index 8ad24fd58e..8daad11cb2 100644
--- a/doc/docportal/ports/ps_vita.rst
+++ b/doc/docportal/other_platforms/ps_vita.rst
@@ -2,23 +2,22 @@
PlayStation Vita
=====================
-Install ScummVM
-=======================
+This page contains all the information you need to get ScummVM up and running on a PS Vita.
-Prerequisites
-*******************
+What you'll need
+=======================
- A homebrew-enabled PS Vita console with `Vitashell <https://github.com/TheOfficialFloW/VitaShell/releases/tag/v2.02>`_ installed. How to enable homebrew is outside the scope of this documentation.
-Download and install ScummVM
-******************************
+Installing ScummVM
+======================================
The PS Vita package is available for download on the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_.
Copy the ``.vpk`` to the PS Vita and install it using VitaShell.
-Transfer game files
+Transferring game files
=======================
There are a few ways to transfer game files to the PS Vita.
@@ -116,6 +115,9 @@ Touch support
For multi-touch gestures, the fingers have to be far enough apart from each other that the Vita will not recognize them as a single finger, otherwise the pointer will jump around.
+Touchpad mouse mode
+^^^^^^^^^^^^^^^^^^^^^^^
+
The touch control scheme can be switched in the global settings. Go to **Options > Control**:
- When **Touchpad mouse mode** is off:
diff --git a/doc/docportal/ports/risc_os.rst b/doc/docportal/other_platforms/risc_os.rst
similarity index 91%
rename from doc/docportal/ports/risc_os.rst
rename to doc/docportal/other_platforms/risc_os.rst
index 652013b7bf..ede8a96b2c 100644
--- a/doc/docportal/ports/risc_os.rst
+++ b/doc/docportal/other_platforms/risc_os.rst
@@ -2,17 +2,16 @@
RISC OS
=============================
-Install ScummVM
-===================
+This page contains all the information you need to get ScummVM up and running on the RISC operating system.
-Prerequisites
-****************
+WHat you'll need
+===================
- A system running RISC OS 5
- The `SharedUnixLibrary <https://www.riscos.info/index.php/SharedUnixLibrary>`_, `DRenderer <https://www.riscos.info/packages/LibraryDetails.html#DRendererarm>`_ and `Iconv <https://www.netsurf-browser.org/projects/iconv/>`_ modules installed. SharedUnixLibrary and DRenderer can be installed using `Packman <https://www.riscos.info/index.php/PackMan>`_.
-Download and install ScummVM
-*********************************
+Installing ScummVM
+======================================
Download the RISC OS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_.
@@ -20,7 +19,7 @@ Use a tool such as SparkFS to extract the archive. It is important that the arch
-Transfer game files
+Transferring game files
=======================
Copy data files directly from the original discs on machines that have CD and/or floppy drives, or use a USB drive to transfer the files from another system.
diff --git a/doc/docportal/ports/sega_dreamcast.rst b/doc/docportal/other_platforms/sega_dreamcast.rst
similarity index 92%
rename from doc/docportal/ports/sega_dreamcast.rst
rename to doc/docportal/other_platforms/sega_dreamcast.rst
index 56005f9e54..04c84b0a0c 100644
--- a/doc/docportal/ports/sega_dreamcast.rst
+++ b/doc/docportal/other_platforms/sega_dreamcast.rst
@@ -2,11 +2,10 @@
Sega Dreamcast
=============================
-Run ScummVM
-================
+This page contains all the information you need to get ScummVM up and running on a Sega Dreamcast.
-Prerequisites
-****************************
+What you'll need
+=================
- A CD-R disc (80min/700mb).
- A CD-RW drive.
@@ -14,8 +13,8 @@ Prerequisites
- Software to create a bootable disc image, such as `BootDreams <https://dcemulation.org/index.php?title=BootDreams>`_
- CD burning software such as Nero Burning ROM, ImgBurn or Alcohol120%.
-Download the package
-*************************
+Running ScummVM
+==================================
There are two ways to get ScummVM running on the Dreamcast:
1. Download the ready-to-go Nero Image and Demos package and burn the extracted ``.nrg`` image to a CD-R using Nero Burning ROM.
@@ -23,12 +22,12 @@ There are two ways to get ScummVM running on the Dreamcast:
Both packages are available from the ScummVM `Downloads page <https://www.scummvm.org/downloads/>`_
-Create a disc from the Dreamcast Nero Image and Demos package
+Creating a disc from the Dreamcast Nero Image and Demos package
********************************************************************
Use Nero Burning ROM to burn the ``.nrg`` file contained in the package to a CD-R disc.
-Create a disc from the Dreamcast plain files package
-******************************************************
+Creating a disc from the Dreamcast plain files package
+********************************************************
Create a directory on your computer. In this example, the directory is called ``ScummVMDC``.
Copy the downloaded ``SCUMMVM.BIN`` and ``IP.BIN`` files into the ``ScummVMDC`` directory. These are the main boot and engine files required for ScummVM to run.
@@ -78,8 +77,8 @@ To burn the resulting image to disc, use any software capable of using those ima
Use the lowest possible burning speed for best results; the Dreamcast is an older system and as such can have problems reading discs burned at high speeds. If available, the 4x speed is ideal. Ensure that you use good quality discs from a reputable manufacturer. If possible, use archival grade discs.
-Transfer game files
-=======================
+Transferring game files
+========================
Game files can be included on the same CD as the ScummVM binary file, or on a separate disc.
@@ -90,13 +89,9 @@ ScummVM for the Dreamcast supports disc swapping from the GUI. It rescans after
Controls
=================
-
Default control map
*********************
-These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
-
-
.. csv-table::
:header-rows: 2
diff --git a/doc/docportal/trial/console.rst b/doc/docportal/trial/console.rst
deleted file mode 100644
index a4845cc1a5..0000000000
--- a/doc/docportal/trial/console.rst
+++ /dev/null
@@ -1,134 +0,0 @@
-=============================
-Consoles
-=============================
-
-.. tabbed:: Nintendo 3DS
-
- There are two ways to install ScummVM onto a Nintendo 3DS: using the 3DSX format, and using the CIA format.
-
- **What you'll need:**
-
- - A Nintendo 3DS with a Homebrew Launcher or custom firmware. How to enable homebrew is outside the scope of this documentation.
- - The Nintendo 3DS package downloaded from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_, and extracted.
-
-
- .. dropdown:: Installing ScummVM using the 3DSX format
- :open:
-
- Copy the extracted files to your SD card into the ``/3ds/scummvm`` directory.
-
- Launch ScummVM using the Homebrew Launcher.
-
-
- .. dropdown:: Installing ScummVM using the CIA format
-
- Use any CIA installation software to install the ``scummvm.cia`` file.
-
- The CIA format requires a DSP binary dump saved on your SD card as ``/3ds/dspfirm.cdc``. This is not an optional step, because without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
-
- .. dropdown:: Transferring 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:`../use_scummvm/connect_cloud`.
-
- See :doc:`../use_scummvm/add_play_games` for more information about how to add games to ScummVM.
-
- .. dropdown:: Controls
-
- Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
-
- .. csv-table::
- :widths: 50 50
- :header-rows: 1
-
- Game Controller Mapping:,
- Button,Action
- Circle Pad,Moves the cursor
- R + Circle Pad,Slow Mouse
- â’¶,Left mouse button
- â’·,Right mouse button
- â“,Opens the virtual keyboard
- â“Ž,ESC
- Control Pad,Keypad cursor keys
- L Button,Toggles magnify mode on/off
- R Button,Toggles between hover/drag modes
- START,Opens global main menu
- SELECT,Opens 3DS config menu
-
- .. _hover:
-
- **Hover mode**
-
-
- When using the touchscreen, hover mode simulates the movement of the mouse. You can click with taps, however you can't drag or hold down a mouse button unless you use the buttons mapped to the right/left mouse buttons.
-
- **Drag mode**
-
-
- Simulates the click and release of the mouse buttons every time you touch and release the touchscreen. At the moment, this is only a left mouse button click.
-
- **Magnify mode**
-
- Due to the low resolutions of the 3DS screens (400x240 for the top, and 320x240 for the bottom), games that run at a higher resolution will inevitably lose some visual detail from being scaled down. This can result in situations where essential information, such as text, is indiscernable.
-
- Magnify mode increases the scale factor of the top screen back to 1, but the bottom screen remains unchanged. The touchscreen can then be used to change which part of the game display is being magnified. This can be done even in situations where the cursor is disabled, such as during full-motion video segments.
-
- When activating magnify mode, touchscreen controls are automatically switched to :ref:`hover` mode to reduce the risk of the user accidentally inputting a click when changing the magnified area with the stylus. Clicking can still be done as in normal hover mode. Turning off magnify mode will revert controls back to what was used previously. It will also restore the top screen's previous scale factor.
-
- Currently magnify mode can only be used when the following conditions are met:
-
- - In the 3DS config menu, **Use Screen** is set to **Both**
- - A game is played
- - The horizontal and/or vertical resolution in-game is greater than that of the top screen
-
- Magnify mode cannot be used in the Launcher menu.
-
- .. dropdown:: Paths
-
- **Configuration file**
-
- ``sdmc:/3ds/scummvm/scummvm.ini``
-
- **Saved games**
-
- ``sdmc:/3ds/scummvm/saves/``
-
- .. dropdown:: Settings
-
- For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
-
- **3DS config menu**
-
-
- .. figure:: ../images/3ds/config.png
-
- The 3DS config menu.
-
- Show mouse cursor
- Toggles a visible mouse cursor on/off.
-
- Stretch to fit
- Stretches the image to fit the screen
-
- Snap to edges
- The 3DS touch screen has difficulty reaching the very end of the screen. With this option enabled, if you're within a few pixels of the edge the cursor snaps to the edge.
-
- Use Screen:
- Sets whether ScummVM uses the **Top**, **Bottom** or **Both** screens.
-
- C-Pad Sensitivity
- Sets the sensitivity of the Circle Pad.
-
- **Audio**
-
- Supported audio file formats:
-
- - MP3
- - OGG
- - OGG
- - Uncompressed audio
-
- .. dropdown:: Known issues
-
- Some games are not playable due to the slow CPU speed on the 3DS. If there are any games that run really slowly, this is considered a hardware limitation, not a bug.
diff --git a/doc/docportal/trial/phones.rst b/doc/docportal/trial/phones.rst
deleted file mode 100644
index ad7e9b1a65..0000000000
--- a/doc/docportal/trial/phones.rst
+++ /dev/null
@@ -1,327 +0,0 @@
-=========================
-Phones and tablets
-=========================
-
-.. tabbed:: Android
-
- There are two ways to install ScummVM on an Android device; install it from the Google Play Store, or manually download and install the APK package from the ScummVM downloads page.
-
- .. dropdown:: Installing ScummVM from the Google Play Store
- :open:
-
- Go to the Google Play Store to download and install ScummVM.
-
- .. note::
-
- ScummVM has been tested to work up to Android 10. Currently there are some file browsing limitations with Android 11. The ScummVM team are working to resolve these.
-
- .. dropdown:: Downloading and manually installing the APK package
-
- On your device, use a web browser app to navigate to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_. The recommended download section on the page suggests the correct ``.apk`` package, however if it does not, scroll down to select the correct package.
-
- .. tip::
-
- To find the correct package for your device, find out whether the device has a 32 or 64-bit operating system, and which chipset the device has. Do an internet search using the device model number to find these details.
-
- Click on the correct package to start the download. After it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and after permission is granted, returns to the install.
-
- .. note::
-
- The downloaded APK package is treated as an app from an unknown source, because it doesn't originate in the Google Play store. To allow unknown apps:
-
- - For Android 7 or lower, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
- - For Android 8 or higher, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
-
-
- .. dropdown:: Transferring 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 lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
-
- There are a few other options to transfer the game files:
-
- - Copy the files directly onto the microSD card, if the device has one.
- - USB transfer from a computer. To complete file transfer by USB cable, tap the **Charging this device via USB notification** when the device is connected. Select **Use USB for** and then **File Transfer**. An Android File Transfer window opens.
- - Download games such as freeware games or those from digital distributors directly to your device.
-
- For more information on which files ScummVM requires, see the :doc:`../use_scummvm/game_files` page. To learn how to add and play games, see the :doc:`../use_scummvm/add_play_games`.
-
- .. dropdown:: Controls
-
-
- Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
-
- .. csv-table::
- :header-rows: 1
-
- Touch screen control, Action
- One finger tap, Left mouse click
- Two finger tap, Right mouse click
- One finger touch & hold, Middle mouse click
- 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
-
- **Touch controls**
-
- The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
-
- - When touchpad mouse mode is off (default), the touch controls are direct. The pointer jumps to where the finger touches the screen.
- - When touchpad mouse mode is on, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
- - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
-
- **Two finger tap**
-
- To do a two finger tap, hold one finger down and then tap with a second finger.
-
-
- **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.
-
- .. dropdown:: 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.
-
- **Accessing the internal app folder**
-
- To access the internal app folder, use ScummVM's built-in LAN functionality:
-
- 1. From the Launcher, select **Options** and then the **LAN** tab.
- 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.
-
-
- .. dropdown:: 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.
-
-.. tabbed:: iOS
-
-
- There are two ways to install ScummVM onto an iOS device, and the method you use depends on whether or not the device is jailbroken.
-
- .. dropdown:: Installing ScummVM onto a device without a jailbreak
-
- To install ScummVM onto a device without a jailbreak requires you to build the app yourself, using the source code and an app called Xcode. While a rudimentary knowledge of the command line would be helpful, this is not required.
-
- **What you'll need:**
-
- - A Mac computer with Xcode installed. Xcode is a free App, available from the Mac App Store.
- - An Apple Developer account. You can sign up for a free account on the `Apple Developer Member Center <https://developer.apple.com/membercenter/>`_ with your Apple ID.
- - The ScummVM `iOS Libraries <https://www.scummvm.org/frs/build/scummvm-ios7-libs-v2.zip>`_ downloaded.
-
- .. note::
-
- If you have a free Apple developer account, each build will only be valid for 7 days, which means you will need to repeat these steps and rebuild ScummVM every week.
-
-
- **Creating the Xcode project**
-
-
- The first step is to download the repository containing the code required to build the app. The following steps require use of the command line. Go to **Applications > Utilities > Terminal** and copy and paste the following, then press :kbd:`return` :
-
- .. code-block:: bash
-
- git clone --depth 1 -b branch-2-2-0 https://github.com/scummvm/scummvm.git
-
-
- If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time will also install the command line tools required.
-
- The next step changes the present working directory and then generates the tools required to create the Xcode project.
-
- .. code-block:: bash
-
- cd scummvm/devtools/create_project/xcode
- xcodebuild
-
- The next command creates a new directory called ``build`` at the same level as the repository:
-
- .. code-block:: bash
-
- cd ../../../..
- mkdir build
- cd build
-
- The present working directory will now be the new ``build`` directory. Extract the contents of the downloaded iOS libraries package into the build folder by using the following command:
-
- .. code-block:: bash
-
- unzip ~/Downloads/scummvm-ios7-libs-v2.zip
-
- .. note::
-
- In newer versions of macOS, the archive is extracted automatically. If this is the case, the ``unzip`` command will not work as expected. Instead, copy the contents of the ``scummvm-ios7-libs-v2`` folder into the ``build`` directory. It is simplest to do this in the Finder.
-
-
- **Generating the Xcode project**
-
- It's time to generate the Xcode project. Ensure the present working directory is still the ``build`` directory, and then run the following on the command line:
-
- .. code::
-
- ../scummvm/devtools/create_project/xcode/build/Release/create_project ../scummvm --xcode --enable-fluidsynth --disable-nasm --disable-opengl --disable-theora --disable-taskbar --disable-tts --disable-fribidi
-
- The resulting directory structure should look like this:
-
- .. code-block:: bash
-
- Home
- |--scummvm
- '--build
- |-- include
- |-- lib
- |-- engines
- '-- scummvm.xcodeproj
-
- .. tip::
-
- To view the Home directory in the Finder, select **Go > Home** in the menu bar, or press :kbd:`command+shift+H`.
-
- Open the ``scummvm.xcodeproj`` file from the Finder, or from the command line:
-
- .. code-block:: bash
-
- open scummvm.xcodeproj
-
- **Building ScummVM**
-
- When Xcode is open, connect a device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then select the device you just connected. You will need to "Trust" the device for it to show up on the list of connected devices.
-
- .. figure:: ../images/ios/choose_device.gif
-
-
- The last step before building ScummVM is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** there is a field labeled **Bundle Identifier**. Enter a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
-
- .. figure:: ../images/ios/identifier.gif
-
-
- Next to **General**, click on **Signing & Capabilities**. Under **Signing**, tick the **Automatically manage signing** box, and select your developer account from the **Team** dropdown menu.
-
- .. figure:: ../images/ios/signing.gif
-
-
-
- If you have not added your developer account to Xcode, do this now. Click **Add an Account** in the dropdown menu.
-
- In the upper left-hand corner, press the play button to build ScummVM. When the build is finished, it launches on your connected device.
-
- .. dropdown:: Installing ScummVM onto a jailbroken device
-
- **What you'll need:**
-
- - A jailbroken iOS device. How to jailbreak a device is outside the scope of this documentation.
- - A file manager app such as Filza installed on the device.
-
-
- **Installing ScummVM**
-
- Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended ``.deb`` or ``.ipa`` package. When the device asks how to open the file, choose Filza.
-
- Ensure the package is saved somewhere in the ``/var/mobile/`` directory. It defaults to ``/var/mobile/Documents/``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
-
- Restart your device for the install to complete.
-
- .. dropdown:: Transferring game files
-
-
- There are multiple ways to transfer game files to your iOS device.
-
- ScummVM has built-in cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
-
- .. note::
-
- ScummVM's cloud functionality does not currently support iCloud, however you can upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder.
-
- Another way to transfer files (for macOS Catalina and newer) to your device is by using the Finder while your device is connected to your Mac. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag the folder containing the game files into the **ScummVM** folder. For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
-
- .. image:: ../images/ios/ios_transfer_files.gif
-
- For more information on which files ScummVM requires, and how to add and play games, see :doc:`../use_scummvm/add_play_games`.
-
- .. dropdown:: Controls
-
- .. csv-table::
- :widths: 40 60
- :header-rows: 2
-
- Game Controller Mapping,
- Touch screen control, Action
- One finger tap, Left mouse click
- Two finger tap, Right mouse click
- Two finger double tap,ESC
- Two finger swipe (bottom to top), Toggles :ref:`Click and drag mode <clickdrag>`.
- Two finger swipe (left to right),Toggles between touch direct mode and touchpad mode.
- Two finger swipe (top to bottom),Global Main Menu
- Three finger swipe, Arrow keys
-
- Pinch gesture, Enables/disables keyboard
- Keyboard spacebar, Pause
-
-
- **Touch controls**
-
- The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
-
- - When touchpad mouse mode is off, the touch controls are direct. The pointer jumps to where the finger touches the screen.
- - When touchpad mouse mode is on, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
- - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
-
- .. _twofinger:
-
- **Two finger tap**
-
-
- For a two finger tap, hold one finger down and then tap with a second finger.
-
- .. _twofingerdouble:
-
- **Two finger double tap**
-
-
- For a two finger double tap, hold one finger down and then double tap with a second finger.
-
- .. _clickdrag:
-
- **Click and drag mode**
-
-
- Simulates a left mouse click when you touch the screen. The mouse pointer drags to wherever you slide your finger, and releases where you lift your finger.
-
- If you press down a second finger in this mode, it releases the simulated left mouse button, and presses down the simulated right mouse button. The right mouse button is released when you lift your finger again.
-
- **Keyboard**
-
- If no external keyboard is connected, the pinch gesture shows and hides the onscreen keyboard. When an external keyboard is connected, the pinch gesture enables/disables inputs from the external keyboard.
-
- .. dropdown:: Paths
-
-
- **Saved games**
-
- ``/var/mobile/Library/ScummVM/Savegames/`` if the device is jailbroken, or ``Savegames/`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
-
- **Configuration file**
-
- ``/var/mobile/Library/ScummVM/Preferences`` if the device is jailbroken, or ``Preferences`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
-
-
diff --git a/doc/docportal/settings/how_to_settings.rst b/doc/docportal/use_scummvm/how_to_settings.rst
similarity index 96%
rename from doc/docportal/settings/how_to_settings.rst
rename to doc/docportal/use_scummvm/how_to_settings.rst
index 307405b8ea..13cd1d35f1 100644
--- a/doc/docportal/settings/how_to_settings.rst
+++ b/doc/docportal/use_scummvm/how_to_settings.rst
@@ -1,5 +1,5 @@
=======================
-How to change settings
+Changing settings
=======================
From the Launcher
diff --git a/doc/docportal/trial/computer.rst b/doc/docportal/use_scummvm/install_computer.rst
similarity index 64%
rename from doc/docportal/trial/computer.rst
rename to doc/docportal/use_scummvm/install_computer.rst
index 709e5e30f6..badc095bc8 100644
--- a/doc/docportal/trial/computer.rst
+++ b/doc/docportal/use_scummvm/install_computer.rst
@@ -1,6 +1,7 @@
-========================
-Windows, macOS or Linux
-========================
+
+=====================================
+Installing ScummVM
+=====================================
.. tabbed:: Windows
@@ -19,29 +20,6 @@ Windows, macOS or Linux
To run ScummVM from the extracted folder, find the ``scummvm.exe`` file and double click it.
- .. dropdown:: Paths
-
- **Configuration file**
-
- 95/98/ME: ``C:\WINDOWS\scummvm.ini``
-
- Windows NT4: ``C:\WINDOWS\Profiles\username\Application Data\ScummVM\scummvm.ini``
-
- Windows 2000/XP: ``\Documents and Settings\username\Application Data\ScummVM\scummvm.ini``
-
- Window Vista/7/8/10: ``%APPDATA%\ScummVM\scummvm.ini``
-
- **Saved games**
-
- 95/98/ME: ``C:\WINDOWS\Saved games\``
-
- Windows NT4: ``C:\WINDOWS\Profiles\username\Application Data\ScummVM\Saved games\``
-
- Windows 2000/XP: ``\Documents and Settings\username\Application Data\ScummVM\Saved games\``
-
- Window Vista/7/8/10: ``%APPDATA%\ScummVM\Saved games\``
-
-
.. tabbed:: macOS
.. dropdown:: Installing ScummVM using the disk image
@@ -55,28 +33,10 @@ Windows, macOS or Linux
macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. ScummVM is not available from the App Store, so follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
- .. dropdown:: Paths
-
- **Configuration file**
-
- ``~/Library/Preferences/ScummVM Preferences``
-
- .. note::
-
- If an earlier version of ScummVM was installed on your system, the configuration file remains in the previous default location of ``~/.scummvmrc``.
-
- .. tip::
-
- To see the Library folder, press :kbd:`Option` when clicking **Go** in the Finder menu.
-
- **Saved games**
-
- ``~/Documents/ScummVM Savegames/``
-
.. tabbed:: Linux
- There are multiple ways to install ScummVM onto a computer running Linux: use the Snap Store, Flathub or the software repository, or install the release binary.
+ There are multiple ways to install ScummVM onto a computer running Linux: use the Snap Store, Flathub or the software repository, or install the release binary.
.. dropdown:: Installing ScummVM using the Snap Store
:open:
@@ -103,7 +63,7 @@ Windows, macOS or Linux
flatpak install flathub org.scummvm.ScummVM
- Some distributions have the option to install Flatpaks through the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog opens; choose the **Open with Software Install (default)** option, and then click **OK**.
+ Some distributions have the option to install Flatpaks through the graphical desktop interface. Navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ , click the **INSTALL** button and then follow the install process.
To run ScummVM, enter the following on the command line:
@@ -141,27 +101,3 @@ Windows, macOS or Linux
To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
- .. dropdown:: Paths
-
- **Configuration file**
-
-
- ScummVM follows the XDG Base Directory Specification, so by default the configuration file is found at ``~/.config/scummvm/scummvm.ini``, but its location might vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
-
- If Snap was used to install ScummVM, 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.
-
- **Saved games**
-
- ScummVM follows the XDG Base Directory Specification, so by default the saved games can be found at ``~/.local/share/scummvm/saves/``, but this location might vary depending on the value of the ``XDG_DATA_HOME`` environment variable.
-
- If Snap was used to install ScummVM, the saves can be found at ``~/snap/scummvm/current/.local/share/scummvm/saves/``.
-
- .. note::
-
- ``.local`` is a hidden directory. To view it use ``ls -a`` on the command line.
-
-
diff --git a/doc/docportal/use_scummvm/the_launcher.rst b/doc/docportal/use_scummvm/the_launcher.rst
index 13df2dbb52..4c317ddae8 100755
--- a/doc/docportal/use_scummvm/the_launcher.rst
+++ b/doc/docportal/use_scummvm/the_launcher.rst
@@ -53,7 +53,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:`../settings/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
@@ -65,7 +65,7 @@ Removes the highlighted game from the list. This does not remove any saved games
Options
^^^^^^^^^^^
-Opens the global settings window. Use this window to define global game settings, as well as change a number of the ScummVM Launcher settings. For more information, see the :doc:`../settings/how_to_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
^^^^^^^^^^
Commit: b80d05563fba3e4b2fec3651eb504b3effe500e3
https://github.com/scummvm/scummvm/commit/b80d05563fba3e4b2fec3651eb504b3effe500e3
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds missing cmd line/config file keys
Changed paths:
doc/docportal/advanced_topics/command_line.rst
doc/docportal/advanced_topics/configuration_file.rst
diff --git a/doc/docportal/advanced_topics/command_line.rst b/doc/docportal/advanced_topics/command_line.rst
index c2f9c9e2d9..5f1481d2f5 100755
--- a/doc/docportal/advanced_topics/command_line.rst
+++ b/doc/docportal/advanced_topics/command_line.rst
@@ -17,56 +17,56 @@ Usage
To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any of the options documented below, and/or the path to the game you wish to start. If a game has already been added to the games list in the Launcher, you can pass the game id instead of the path to the game.
-.. tabbed:: macOS
+.. tabbed:: Windows
.. panels::
:column: col-lg-12
- The following examples assume the path to the ScummVM app is ``Applications/ScummVM.app``.
-
- If you are unsure of the path to the app, drag the ScummVM app icon into the Terminal window. This prints the path to the ScummVM app.
-
- To run ScummVM from the command line, add ``/Contents/MacOS/scummvm`` to that path.
+ The following examples assume that the path to ScummVM is ``C:\Program Files\ScummVM\scummvm.exe``.
^^^^
To run Monkey Island, fullscreen (``-f``):
- .. code::
-
- /Applications/ScummVM.app/Contents/MacOS/scummvm -f monkey
+ .. code-block::
+ C:\Program Files\ScummVM\scummvm.exe -f monkey
+
+
To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
- .. code::
+ .. code-block::
- /Applications/ScummVM.app/Contents/MacOS/scummvm -f -n -p/cdrom/resource/ft
+ C:\Program Files\ScummVM\scummvm.exe -f -n -pD:``resource``ft
-.. tabbed:: Windows
+.. tabbed:: macOS
.. panels::
:column: col-lg-12
- The following examples assume that the path to ScummVM is ``C:\Program Files\ScummVM\scummvm.exe``.
+ The following examples assume the path to the ScummVM app is ``Applications/ScummVM.app``.
+
+ If you are unsure of the path to the app, drag the ScummVM app icon into the Terminal window. This prints the path to the ScummVM app.
+
+ To run ScummVM from the command line, add ``/Contents/MacOS/scummvm`` to that path.
^^^^
To run Monkey Island, fullscreen (``-f``):
- .. code-block::
+ .. code::
+
+ /Applications/ScummVM.app/Contents/MacOS/scummvm -f monkey
- C:\Program Files\ScummVM\scummvm.exe -f monkey
-
-
To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
- .. code-block::
+ .. code::
- C:\Program Files\ScummVM\scummvm.exe -f -n -pD:``resource``ft
+ /Applications/ScummVM.app/Contents/MacOS/scummvm -f -n -p/cdrom/resource/ft
-.. tabbed:: Linux/Unix
+.. tabbed:: Linux
.. panels::
:column: col-lg-12
@@ -103,7 +103,7 @@ Option parameters are shown below in capitals, and need to be replaced with real
Short options are listed where they are available.
.. csv-table::
- :widths: 30 10 60
+ :widths: 35 10 55
:header-rows: 1
Option,Short,Description
@@ -116,6 +116,7 @@ Short options are listed where they are available.
``--boot-param=NUM``,``-b``,"Pass number to the boot script (`boot param <https://wiki.scummvm.org/index.php/Boot_Params>`_)."
``--cdrom=DRIVE``,,"Sets the CD drive to play CD audio from. This can be a drive, path, or numeric index (default: 0)"
``--config=FILE``,``-c``,"Uses alternate configuration file"
+ ``--console``,,"Enables the console window (default: enabled). Win32 and Symbian32 only."
``--copy-protection``,,"Enables copy protection"
``--debug-channels-only``,,"Shows only the specified debug channels"
``--debugflags=FLAGS``,,"Enables engine specific debug flags"
@@ -123,6 +124,7 @@ Short options are listed where they are available.
``--demo-mode``,,"Starts demo mode of Maniac Mansion or The 7th Guest"
``--detect``,,"Displays a list of games with their game id from the current or specified directory. This does not add the game to the games list. Use ``--path=PATH`` before ``--detect`` to specify a directory."
``--dimuse-tempo=NUM``,,"Sets internal Digital iMuse tempo (10 - 100) per second (default: 10)"
+ ``--engine-speed=NUM``,,"Sets frames per second limit (0 - 100) for Grim Fandango or Escape from Monkey Island (default: 60)."
``--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>`"
@@ -136,8 +138,9 @@ Short options are listed where they are available.
``--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-targets``,``-t``,"Displays list of configured targets and exits"
``--list-themes``,,"Displays list of all usable GUI themes"
+ ``--logfile=PATH``,-l,"Uses alternate path for log file (SDL backend only)."
``--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>`"
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index bc93b47a84..fe9064db68 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -3,7 +3,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.
+The configuration file provides a way to edit both global and game-specific settings. It is a text file containing configuration keys and parameters.
Settings are also accessible directly from the Launcher. See :doc:`../use_scummvm/how_to_settings`.
@@ -12,21 +12,6 @@ Location
The configuration file saves to different default locations, depending on the platform.
-.. tabbed:: macOS
-
- .. panels::
- :column: col-lg-12 mb-2
-
- ``~/Library/Preferences/ScummVM Preferences``
-
- .. note::
-
- If an earlier version of ScummVM was installed on your system, the configuration file remains in the previous default location of ``~/.scummvmrc``.
-
- .. tip::
-
- To see the Library folder, press :kbd:`Option` when clicking **Go** in the Finder menu.
-
.. tabbed:: Windows
@@ -61,8 +46,23 @@ The configuration file saves to different default locations, depending on the pl
^^^^^^^^^^^^^^^^^^^^^^
``%APPDATA%\ScummVM\scummvm.ini``
+.. tabbed:: macOS
-.. tabbed:: Linux/Unix
+ .. panels::
+ :column: col-lg-12 mb-2
+
+ ``~/Library/Preferences/ScummVM Preferences``
+
+ .. note::
+
+ If an earlier version of ScummVM was installed on your system, the configuration file remains in the previous default location of ``~/.scummvmrc``.
+
+ .. tip::
+
+ To see the Library folder, press :kbd:`Option` when clicking **Go** in the Finder menu.
+
+
+.. tabbed:: Linux
.. panels::
:column: col-lg-12 mb-2
@@ -77,13 +77,6 @@ The configuration file saves to different default locations, depending on the pl
-.. tabbed:: Other
-
- .. panels::
- :column: col-lg-12 mb-2
-
- See the relevant Platform page for details.
-
Using the configuration file
==================================
@@ -138,16 +131,17 @@ Configuration keys
There are many recognized configuration keys. In the table below, each keyword is linked to an explanatory description in the Settings pages.
.. csv-table::
- :widths: 35 15 25 25
+ :widths: 37 13 25 25
:header-rows: 1
Keyword,Type,Default,Description/Options
- alsa_port,number,,
+ alsa_port,integer,,Specifies which ALSA port ScummVM uses when using the ALSA music driver (Linux).
":ref:`alt_intro <altintro>`",boolean,false,
":ref:`altamigapalette <altamiga>`",boolean,false,
":ref:`apple2gs_speedmenu <2gs>`",boolean,false,
":ref:`aspect_ratio <ratio>`",boolean,false,
- ":ref:`audio_buffer_size <buffer>`",number,"Calculated","
+ ":ref:`audio_buffer_size <buffer>`",integer,"Calculated based on output sampling frequency to keep audio latency below 45ms.","Overrides the size of the audio buffer. Allowed values:
+
- 256
- 512
- 1024
@@ -156,20 +150,22 @@ There are many recognized configuration keys. In the table below, each keyword i
- 8192
- 16384
- 32768"
- ":ref:`autosave_period <autosave>`", integer, 300s
- auto_savenames,boolean,false
+ ":ref:`autosave_period <autosave>`", integer, 300,
+ auto_savenames,boolean,false, Automatically generates names for saved games
":ref:`bilinear_filtering <bilinear>`",boolean,false,
- `boot_param <https://wiki.scummvm.org/index.php/Boot_Params>`_,number,none,
+ `boot_param <https://wiki.scummvm.org/index.php/Boot_Params>`_,integer,none,
":ref:`bright_palette <bright>`",boolean,true,
- cdrom,number,,
+ cdrom,integer,0, "Sets which CD drive to play CD audio from (as a numeric index). If a negative number is set, ScummVM does not access the CD drive."
":ref:`color <color>`",boolean,,
":ref:`commandpromptwindow <cmd>`",boolean,false,
- confirm_exit,boolean,,
- console,boolean,true,
- controller_map_db,string,,
- copy_protection,boolean,false,
- demo_mode,boolean,false,
+ confirm_exit,boolean,false, ScummVM requests confirmation before quitting (SDL backend only)
+ console,boolean,true, Enables the console window for Win32/Symbian32.
+ controller_map_db,string,"``gamecontrollerdb.txt`` is loaded from the specified extrapath", "Specifies the custom controller mapping file to load to complete the default database (SDL backend only)."
+ copy_protection,boolean,false, Enables copy protection
+ demo_mode,boolean,false, Starts demo mode of Maniac Mansion or the 7th Guest
":ref:`description <description>`",string,,
+ desired_screen_aspect_ratio,string,auto,
+ dimuse_tempo,integer,10,"Sets internal Digital iMuse tempo per second; 0 - 100"
":ref:`disable_dithering <dither>`",boolean,false,
":ref:`disable_stamina_drain <stamina>`",boolean,false,
":ref:`DurableArmor <durable>`",boolean,false,
@@ -185,15 +181,17 @@ There are many recognized configuration keys. In the table below, each keyword i
":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"
+ enable_unsupported_game_warning,boolean,true, Shows a warning when adding a game that is unsupported.
+ extra,string, ,"Shows additional information about a game, such as version"
+ ":ref:`extrapath <extra>`",string,None,
":ref:`fade_style <fade>`",boolean,true,
":ref:`filtering <filtering>`",boolean,false,
":ref:`floating_cursors <floating>`",boolean,false,
":ref:`fluidsynth_chorus_activate <chact>`",boolean,true,
- ":ref:`fluidsynth_chorus_depth <chdepth>`",number,80,"- 0 - 210"
- ":ref:`fluidsynth_chorus_level <chlevel>`",number,100,"- 0 - 100"
+ ":ref:`fluidsynth_chorus_depth <chdepth>`",integer,80,"- 0 - 210"
+ ":ref:`fluidsynth_chorus_level <chlevel>`",integer,100,"- 0 - 100"
":ref:`fluidsynth_chorus_nr <chnr>`",integer,3,"- 0 - 99"
- ":ref:`fluidsynth_chorus_speed <chspeed>`",number,30,"- 10 - 500"
+ ":ref:`fluidsynth_chorus_speed <chspeed>`",integer,30,"- 10 - 500"
":ref:`fluidsynth_chorus_waveform <chwave>`",string,Sine,"
- sine
- triangle"
@@ -203,16 +201,16 @@ There are many recognized configuration keys. In the table below, each keyword i
- 7th
- linear."
":ref:`fluidsynth_reverb_activate <revact>`",boolean,true,
- ":ref:`fluidsynth_reverb_damping <revdamp>`",number,0,"- 0 - 1"
- ":ref:`fluidsynth_reverb_level <revlevel>`",number,90,"- 0 - 100"
- ":ref:`fluidsynth_reverb_roomsize <revroom>`",number,20,"- 0 - 100"
- ":ref:`fluidsynth_reverb_width <revwidth>`",number,1,"- 0 - 100"
+ ":ref:`fluidsynth_reverb_damping <revdamp>`",integer,0,"- 0 - 1"
+ ":ref:`fluidsynth_reverb_level <revlevel>`",integer,90,"- 0 - 100"
+ ":ref:`fluidsynth_reverb_roomsize <revroom>`",integer,20,"- 0 - 100"
+ ":ref:`fluidsynth_reverb_width <revwidth>`",integer,1,"- 0 - 100"
":ref:`frames_per_secondfl <fpsfl>`",boolean,false,
:ref:`frontpanel_touchpad_mode <frontpanel>`,boolean, false
":ref:`fullscreen <fullscreen>`",boolean,false,
":ref:`gameid <gameid>`",string,,
- gamepath,string,,
- ":ref:`gfx_mode <gfxmode>`",string,2x,"
+ gamepath,string,,Specifies the path to the game
+ ":ref:`gfx_mode <gfxmode>`",string,normal (1x),"
- 1x
- 2x
- 3x
@@ -235,16 +233,22 @@ There are many recognized configuration keys. In the table below, each keyword i
- timidity"
":ref:`GraphicsDithering <gdither>`",boolean,true,
":ref:`gui_browser_native <guibrowser>`", boolean, true
+ gui_browser_show_hidden,boolean,false, Shows hidden files/folders in the ScummVM file browser.
+ gui_list_max_scan_entries,integer,-1, "Specifies the threshold for scanning directories in the Launcher. If the number of game entires exceeds the specified number, then scanning is skipped."
+ gui_saveload_chooser,string,grid,"- list
+ - grid"
+ gui_saveload_last_pos,string,0,
+ ":ref:`gui_use_game_language <guilanguage>`",boolean, ,
":ref:`helium_mode <helium>`",boolean,false,
":ref:`help_style <help>`",boolean,false,
":ref:`herculesfont <herc>`",boolean,false,
":ref:`hpbargraphs <hp>`",boolean,true,
":ref:`hypercheat <hyper>`",boolean,false,
- iconpath,string,,
+ iconpath,string,, "Specifies the path to icons to use as overlay for the ScummVM icon in the Windows taskbar or the macOS Dock when running a game. The icon files should be named after the gameid and be an ico file on Windows, or a png file on macOS."
":ref:`improved <improved>`",boolean,true,
":ref:`InvObjectsAnimated <objanimated>`",boolean,true,
":ref:`joystick_deadzone <deadzone>`",integer, 3
- joystick_num,number,,
+ joystick_num,integer,0,Enables joystick input and selects which joystick to use. The default is the first joystick.
":ref:`kbdmouse_speed <mousespeed>`", integer, 10
":ref:`keymap_engine-default_DOWN <down>`",string,JOY_DOWN
":ref:`keymap_engine-default_LCLK <LCLK>`",string,MOUSE_LEFT JOY_A
@@ -292,12 +296,12 @@ There are many recognized configuration keys. In the table below, each keyword i
":ref:`keymap_sdl-graphics_STCH <STCH>`",string,C+A+s
":ref:`language <lang>`",string,,
":ref:`local_server_port <serverport>`",integer,12345,
- ":ref:`midi_gain <gain>`",number,,"- 0 - 1000"
+ ":ref:`midi_gain <gain>`",integer,,"- 0 - 1000"
":ref:`mm_nes_classic_palette <classic>`",boolean,false,
":ref:`monotext <mono>`",boolean,true,
":ref:`mousebtswap <btswap>`",boolean,false,
":ref:`mousesupport <support>`",boolean,true,
- ":ref:`mt32_device <mt32>`",string,,"
+ ":ref:`mt32_device <mt32>`",string,auto,"
- auto
- alsa
- seq
@@ -334,7 +338,8 @@ There are many recognized configuration keys. In the table below, each keyword i
- pc98
- segacd
"
- ":ref:`music_volume <music>`",number,,"- 0-256 "
+ music_mute,boolean,false, Mutes the game music.
+ ":ref:`music_volume <music>`",integer,192,"- 0-256 "
":ref:`mute <mute>`",boolean,false,
":ref:`native_fb01 <fb01>`",boolean,false,
":ref:`native_mt32 <nativemt32>`",boolean,false,
@@ -342,6 +347,7 @@ There are many recognized configuration keys. In the table below, each keyword i
":ref:`nodelaymillisfl <nodelay>`",boolean,false,
":ref:`ntsc <ntsc>`",boolean,,
":ref:`object_labels <labels>`",boolean,true,
+ opl2lpt_parport,,null,
":ref:`opl_driver <opl>`",string,,"
- auto
- mame
@@ -351,7 +357,7 @@ There are many recognized configuration keys. In the table below, each keyword i
- op2lpt
- op3lpt "
":ref:`originalsaveload <osl>`",boolean,false,
- ":ref:`output_rate <outputrate>`",number,,"
+ ":ref:`output_rate <outputrate>`",integer,,"
Sensible values are:
- 11025
@@ -360,7 +366,7 @@ There are many recognized configuration keys. In the table below, each keyword i
":ref:`platform <platform>`",string,,
":ref:`portaits_on <portraits>`",boolean,true,
":ref:`prefer_digitalsfx <dsfx>`",boolean,true,
- ":ref:`render_mode <render>`",string,,"
+ ":ref:`render_mode <render>`",string,default,"
- hercGreen
- hercAmber
- cga
@@ -375,10 +381,12 @@ There are many recognized configuration keys. In the table below, each keyword i
- macintosh "
":ref:`rootpath <rootpath>`",string,,
":ref:`savepath <savepath>`",string,,
- save_slot,number,,
+ save_slot,integer,autosave, Specifies the saved game slot to load
":ref:`scalemakingofvideos <scale>`",boolean,false,
":ref:`scanlines <scan>`",boolean,false,
- screenshotpath,string,,
+ screenshotpath,string,,Specifies where screenshots are saved
+ sfx_mute,boolean,false, Mutes the game sound effects.
+ ":ref:`sfx_volume <sfx>`",integer,192,
":ref:`shorty <shorty>`",boolean,false,
":ref:`show_fps <fps>`",boolean,false,
":ref:`ShowItemCosts <cost>`",boolean,false,
@@ -388,6 +396,7 @@ There are many recognized configuration keys. In the table below, each keyword i
":ref:`skiphallofrecordsscenes <skiphall>`",boolean,false,
":ref:`smooth_scrolling <smooth>`",boolean,true,
":ref:`speech_mute <speechmute>`",boolean,false,
+ ":ref:`speech_volume <speechvol>`",integer,192,
":ref:`stretch_mode <stretchmode>`",string,,"
- center
- pixel-perfect
@@ -396,8 +405,10 @@ There are many recognized configuration keys. In the table below, each keyword i
- fit_force_aspect "
":ref:`studio_audience <studio>`",boolean,true,
":ref:`subtitles <speechmute>`",boolean,false,
- ":ref:`talkspeed <talkspeed>`",number,60,"- 0 - 255 "
- tempo,number,100,"- 50-200"
+ ":ref:`talkspeed <talkspeed>`",integer,60,"- 0 - 255 "
+ tempo,integer,100,"Sets the music tempo, in percent, for SCUMM games.
+
+ - 50-200"
":ref:`TextWindowAnimated <windowanimated>`",boolean,true,
":ref:`themepath <themepath>`",string,none,
":ref:`transparent_windows <transparentwindows>`",boolean,true,
@@ -405,7 +416,7 @@ There are many recognized configuration keys. In the table below, each keyword i
":ref:`tts_enabled <ttsenabled>`",boolean,false,
":ref:`tts_narrator <ttsnarrator>`",boolean,false,
use_cdaudio,boolean,true,
- versioninfo,string,,
+ versioninfo,string,,Shows the ScummVM version that created the configuration file.
":ref:`window_style <style>`",boolean,true,
":ref:`windows_cursors <wincursors>`",boolean,false,
Commit: 6c20b03eb191647c81f36da0c98011cf5c37573e
https://github.com/scummvm/scummvm/commit/6c20b03eb191647c81f36da0c98011cf5c37573e
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: refines templates - settings/platform pages
Changed paths:
A doc/docportal/contribute/platform_template.rst
A doc/docportal/contribute/settings_template.rst
R doc/docportal/contribute/tech_writers.md
diff --git a/doc/docportal/contribute/platform_template.rst b/doc/docportal/contribute/platform_template.rst
new file mode 100644
index 0000000000..b28c5a7116
--- /dev/null
+++ b/doc/docportal/contribute/platform_template.rst
@@ -0,0 +1,75 @@
+=============================
+Title
+=============================
+
+What you'll need
+===================
+
+- Bullet points listing all prerequisites.
+
+Install ScummVM
+===============================
+
+Detailed download and install instructions.
+
+Transferring game files
+=========================
+
+Detailed instructions for getting game files onto the device.
+
+"See :doc:`../use_scummvm/game_files` for more information about game file requirements."
+
+Controls
+=================
+
+"Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`."
+
+"See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts."
+
+Default control mapping
+*************************
+
+Use a CSV-list table. Set widths to equal 100%. Choose how many header rows you have.
+
+It's easiest to use Google Sheets or Excel to export a spreadsheet as a CSV file.
+
+.. csv-table::
+ :widths: 30 30 40
+ :header-rows: 1
+
+ Button, Action, Description
+ Left stick, Move pointer,
+
+
+
+[Other control information] - Optional
+*****************************************
+
+Paths
+=======
+
+Saved games
+*******************
+
+``path/to/savedgames``
+
+Configuration file
+**************************
+``path/to/configurationfile``
+
+
+Settings
+==========
+
+"For more information, see the Settings section of the documentation. Only platform-specific differences are listed here."
+
+[Applicable tab] e.g. Audio
+*******************************
+
+
+
+
+Known issues
+==============
+
+Anything specific to this port that is a known issue.
\ No newline at end of file
diff --git a/doc/docportal/contribute/settings_template.rst b/doc/docportal/contribute/settings_template.rst
new file mode 100644
index 0000000000..6debc48a39
--- /dev/null
+++ b/doc/docportal/contribute/settings_template.rst
@@ -0,0 +1,35 @@
+=====================
+Name of settings tab
+=====================
+
+Short description of what is on the tab, and why you would use settings on this tab.
+
+"**To change settings globally:**
+
+ From the Launcher, select **Options**. The **xxxx** tab is the first tab shown.
+
+**To change settings for a specific game:**
+
+ Highlight the game in the games list, select **Edit Game** then select the **xxxx** tab."
+
+.. figure:: ../images/settings/screenshotoftab.png
+
+ The xxxx tab in the global settings
+
+"All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description."
+
+,,,,,,,,,,,,,,
+
+.. _refforconfigurationfile:
+
+Option label
+ Description of option.
+
+ *config_file_key*
+
+.. _refforconfigurationfile:
+
+Option label
+ Description of option.
+
+ *config_file_key*
\ No newline at end of file
diff --git a/doc/docportal/contribute/tech_writers.md b/doc/docportal/contribute/tech_writers.md
deleted file mode 100644
index c368a1a453..0000000000
--- a/doc/docportal/contribute/tech_writers.md
+++ /dev/null
@@ -1,57 +0,0 @@
-# Contribution guide for technical writers
-The user documentation is located at [docs.scummvm.org](https://docs.scummvm.org/en/latest/) . It is written in reStructuredText or markdown, built using Sphinx, and deployed by Read the Docs. The recommonmark extension is used to enable parsing of markdown files. The [sphinx-panels](https://sphinx-panels.readthedocs.io/en/latest/) extension is used to provide Bootstrap functionality by using custom rST directives. All documentation is written to conform to the Google developer documentation [style guide](https://developers.google.com/style).
-
-There are two ways to contribute to documentation; working online directly on Github, or by forking and cloning the scummvm repository to work locally.
-
-## Small changes to existing documentation
-
-This may include correcting a mistake, or fixing spelling or grammar.
-
-The easiest way to make a change is to use the **Edit this page on GitHub** link on the applicable page to edit documentation online, on GitHub. This method does not require you to fork the repository, but do bear in mind that you won’t be able to upload images while working in this way.
-
-Once you are happy with your changes, create a pull request (PR). The ScummVM team will review the pull request, and if there are no issues, it will be merged into the existing code.
-
-## Large changes, new or existing documentation
-
-This may include documenting a new feature, documenting a new or existing port, or writing a guide.
-
-### Set up your environment
-
-* Install Python3:
- * Linux: Comes with Python3 installed.
- * macOS: See [this tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-local-programming-environment-on-macos) .
- * Windows: See [this tutorial](https://phoenixnap.com/kb/how-to-install-python-3-windows).
-* Install pip3:
- * 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), 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.
-
-### Create and edit documentation
-
-Documentation files are found in `scummvm/doc/docportal/`
-Images, screenshots and GIFs are found in `scummvm/doc/docportal/images/`.
-
-There are many options for editing and creating documents. A particularly good one is [VS Code](https://code.visualstudio.com), which features extensions to help you write in reStructuredText/markdown, as well as featuring Git integration.
-
-Here is a [handy guide](https://rest-sphinx-memo.readthedocs.io/en/latest/intro.html) to reStructuredText as it is used by Sphinx.
-
-If you are creating a new Platform or Settings page, use the template provided in the docportal directory: `platform_template.rst` or `settings_template.rst`. This is to ensure our documentation remains consistent and predictable for the end user.
-
-### Preview your documentation
-
-To build a preview of the documentation, open a new Terminal window, and change your working directory until you are in the `docportal` directory. Use the `make html` command. The output HTML files will be in the `scummvm/doc/docportal/_build/html/` directory. Open the `index.html` file in a browser to view the index page of the site.
-
-Note:
-Do not commit the `_build` folder to your branch. The documentation is built by Read the Docs before deployment, so the local build is not required.
-
-### Commit your work
-
-Follow the ScummVM [commit guidelines](https://wiki.scummvm.org/index.php/Commit_Guidelines) when you [make a commit](https://github.com/git-guides/git-commit) .
-
-### Create a Pull Request
-
-For documentation related to the CURRENT release, create a pull request against the branch for the current version. For example, to make a change or add documentation applicable to ScummVM version 2.2.0, open a pull request against `branch-2-2-0`. For documentation related to the NEXT release, open a pull request against the `master` branch.
Commit: 028a11c2d04d61459e55e62e870d7ded642db461
https://github.com/scummvm/scummvm/commit/028a11c2d04d61459e55e62e870d7ded642db461
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: tidies up FAQ
Changed paths:
doc/docportal/help/faq.rst
diff --git a/doc/docportal/help/faq.rst b/doc/docportal/help/faq.rst
index dc3d3ec923..5168ab17df 100644
--- a/doc/docportal/help/faq.rst
+++ b/doc/docportal/help/faq.rst
@@ -14,13 +14,13 @@ About
Is ScummVM an emulator?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-No. ScummVM replaces the original executable files that shipped with the game. This means that your games can run on many different platforms they were never designed to run on! For an in-depth look at how ScummVM works, see the `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
+No! ScummVM actually replaces the original executable file that shipped with the game. This means that your games can run on platforms they were never designed for! For an in-depth look at how ScummVM works, see the `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
Is ScummVM free?
^^^^^^^^^^^^^^^^^^^^
-ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is freely available for you to do whatever you want with it. If you make modifications and redistribute your work, you must make your source code available.
+ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is available for you to do whatever you want with it, but if you make modifications and redistribute your work, you must make your source code available.
-The ScummVM team would be delighted if you send them your modifications, so that the changes can be merged into the main source code. See the `Developer Central <https://wiki.scummvm.org/index.php/Developer_Central>`_ wiki page.
+The ScummVM team would be delighted if you send them your modifications, so that the changes you've made can be merged into the main source code. See the `Developer Central <https://wiki.scummvm.org/index.php/Developer_Central>`_ wiki page for contributing guidelines.
How do I install ScummVM onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -29,41 +29,41 @@ See :ref:`firststeps`.
How do I get game files onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-For general guidance, see the :doc:`../use_scummvm/add_play_games` page. For specific information, find the page for your device on the sidebar.
+For general guidance, see the :doc:`../use_scummvm/game_files` page. For platform-specific information, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
-ScummVM 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`.
+ScummVM has cloud and LAN functionality to simplify the file transfer process. For more information, see :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
On what platform(s) will ScummVM run?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See our `Platforms list <https://wiki.scummvm.org/index.php/Platforms>`_ wiki page.
+See our `Platforms <https://wiki.scummvm.org/index.php/Platforms>`_ wiki page for a full list. We have guides available for many of the supported platforms, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
Games
********
Can I only play LucasArts SCUMM games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the `Supported games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ page on our wiki for a comprehensive list. There is a caveat; not all supported games are playable on all platforms. Sometimes this is because the game is simply too CPU intensive for the device, or there might be many other reasons. If a game is not available on a platform, you will not be able to add it to ScummVM.
+Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the full list of supported games `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_. There is a caveat; not all supported games are playable on all platforms. Often this is because the game is simply too CPU intensive for the device, or because of some other hardware or software limitation. If a game is not available on a platform, you will not be able to add it to ScummVM.
.. _getgames:
Where do I get the games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See the :doc:`../use_scummvm/add_play_games` page.
+See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Where_to_get_the_games>`_ wiki page.
.. _installgames:
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:`../use_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. For a complete guide, see :doc:`../use_scummvm/game_files`.
Do I need the original game discs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If you do not have any hard copy games, there are some digital options available, including some games that have been released as freeware. See :ref:`getgames`.
+Ideally yes, however we know that a lot of people don't! If you do not have any hard copy games, there are some digital options available, including some games that have been released as freeware. See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Where_to_get_the_games>`_ wiki page.
How do I know if I can play my game using ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The best place to check is the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website.
+The best place to check is the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website. You can also have a look at the full list of supported games `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_.
I have saved games from when I played the original game - can I use these with ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -71,11 +71,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:`../use_scummvm/the_launcher`, they cannot be started directly from the game files. See :doc:`../use_scummvm/add_play_games`.
+Games must be added to and started from :doc:`the ScummVM Launcher <../use_scummvm/the_launcher>`; they cannot be started directly from the game files. See :doc:`../use_scummvm/add_play_games`.
What are the in-game keyboard shortcuts?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A list of default shortcuts can be found on the :doc:`../use_scummvm/keyboard_shortcuts` page. Since version 2.2.0 you can create custom shortcuts on the :doc:`../settings/keymaps` tab.
+A list of default shortcuts can be found on the :doc:`../use_scummvm/keyboard_shortcuts` page. Since version 2.2.0 you can also create custom shortcuts on the :doc:`../settings/keymaps` tab.
Troubleshooting
===================
@@ -102,15 +102,15 @@ Help! My game won't run!
1. Make sure your game is supported. Check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website, and the `Platform Overview <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ page on the wiki.
-2. Check that you have all the required datafiles. See the :doc:`../use_scummvm/add_play_games` page for more information.
+2. Check that you have all the required datafiles. See the :doc:`../use_scummvm/game_files` page.
-3. Ask for advice on the ScummVM forums or on DIscord. See the :doc:`contact` page.
+3. Ask for advice on the ScummVM forums or on Discord. See the :doc:`contact` page.
4. If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
I installed my game but ScummVM can't find it... What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Installing the game does not necessarily provide ScummVM with the files it needs. In most cases you will need to copy the files from the disc into a folder ScummVM can access. See :ref:`installgames`.
+Installing the game does not necessarily provide ScummVM with the files it needs. In most cases you will need to copy the files from the disc into a folder ScummVM can access. See :doc:`../use_scummvm/game_files`.
Why are the subtitles in my non-English game messed up?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -131,20 +131,20 @@ Sometimes it's worth checking the obvious.
Help! There's no sound on my iPhone/iPad!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-ScummVM will not play any sound if your device is in Silent Mode. If this is not the problem, see :ref:`nosound`.
+ScummVM will not play any sound if your device is in Silent Mode. If this is not the problem, see :ref:`nosound`.
I have a "talkie" version of a LucasArts game but I can't hear the voices. What's the problem?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The original games shipped with an uncompressed ``MONSTER.SOU`` file, which is the voice file. If you have compressed this file to either a ``MONSTER.SO3`` (MP3 file), ``MONSTER.SOG`` (OGG file), or ``MONSTER.SOF`` (FLAC file) format, make sure that the ScummVM you're using has support for those formats.
+The original games shipped with an uncompressed voice file (``MONSTER.SOU``). If you have compressed this file to an mp3 file (``MONSTER.SO3``), an Ogg Vorbis file (``MONSTER.SOG``), or a FLAC file (``MONSTER.SOF``), make sure that the ScummVM you're using has support for those formats.
The audio is really glitchy. What can I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-There might be a few things at play here.
+There are a few things you can try:
- Try to increase the :ref:`audio buffer size <buffer>` in the configuration file.
-- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU might not have the processing power to keep up. In this case, you might have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, as long as your platform supports it.
+- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU might not have the processing power to keep up. In this case, you might have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, provided your platform supports it.
- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU might not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
-- If you are using the :ref:`adlib` emulator, try selecting the least CPU-intensive option; MAME.
+- If you are using the :ref:`AdLib <adlib>` emulator, try selecting the least CPU-intensive option; MAME.
I have a CD version of a game, how do I get the sound to work without running the game from the CD?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -155,7 +155,7 @@ Graphics
There are so many options... How do I know what to pick?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Start by checking out our :doc:`../advanced_topics/understand_graphics` page. It has comprehensive information on how it all works.
+Start by checking out our :doc:`../advanced_topics/understand_graphics` page. It has comprehensive information on how all this stuff works.
Can I just make the image larger (for example, 1 pixel becomes 4 pixels) without any smoothing or antialiasing?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Commit: d42a2241be1d2612f9dc92fb63a2bd6b3539c7f0
https://github.com/scummvm/scummvm/commit/d42a2241be1d2612f9dc92fb63a2bd6b3539c7f0
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds ref to new game files page
Changed paths:
A doc/docportal/other_platforms/playstation_vita.rst
R doc/docportal/other_platforms/ps_vita.rst
doc/docportal/other_platforms/amigaos_4.rst
doc/docportal/other_platforms/android.rst
doc/docportal/other_platforms/atari.rst
doc/docportal/other_platforms/ios.rst
doc/docportal/other_platforms/nintendo_switch.rst
doc/docportal/other_platforms/playstation_3.rst
doc/docportal/other_platforms/playstation_portable.rst
doc/docportal/other_platforms/risc_os.rst
doc/docportal/other_platforms/sega_dreamcast.rst
diff --git a/doc/docportal/other_platforms/amigaos_4.rst b/doc/docportal/other_platforms/amigaos_4.rst
index 9af99405b7..ef40fa2ef7 100644
--- a/doc/docportal/other_platforms/amigaos_4.rst
+++ b/doc/docportal/other_platforms/amigaos_4.rst
@@ -28,12 +28,12 @@ To automatically keep ScummVM up to date through AmiUpdate, run the ``Autoinstal
Transferring game files
=========================
-See :doc:`../use_scummvm/game_files` for more information.
-
For games on PC or Mac formatted discs, use the original platform to access the data files, and then transfer these to Amiga. Alternatively, if you have external hardware such as a Catweazel floppy disc controller, you might be able to use this to access the files.
ScummVM for Amiga OS has Cloud and LAN functionality, to help manage the transfer of files. See :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
+
Controls
=================
diff --git a/doc/docportal/other_platforms/android.rst b/doc/docportal/other_platforms/android.rst
index b6dac4dcb0..59539eb8c6 100644
--- a/doc/docportal/other_platforms/android.rst
+++ b/doc/docportal/other_platforms/android.rst
@@ -56,7 +56,7 @@ There are a few other options to transfer the game files:
- USB transfer from a computer. To complete file transfer by USB cable, tap the **Charging this device via USB notification** when the device is connected. Select **Use USB for** and then **File Transfer**. An Android File Transfer window opens.
- Download games such as freeware games or those from digital distributors directly to your device.
-For more information on which files ScummVM requires, and how to add and play games, see :doc:`../use_scummvm/add_play_games`.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
diff --git a/doc/docportal/other_platforms/atari.rst b/doc/docportal/other_platforms/atari.rst
index 84d005c9c2..db89bd1281 100644
--- a/doc/docportal/other_platforms/atari.rst
+++ b/doc/docportal/other_platforms/atari.rst
@@ -30,6 +30,8 @@ Transferring game files
Transfer files to the Atari as you normally would, such as through a network connection or by optical disc.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
+
Controls
=================
diff --git a/doc/docportal/other_platforms/ios.rst b/doc/docportal/other_platforms/ios.rst
index f7bd488a69..cd8024201f 100644
--- a/doc/docportal/other_platforms/ios.rst
+++ b/doc/docportal/other_platforms/ios.rst
@@ -156,7 +156,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:`../use_scummvm/add_play_games`.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
============
diff --git a/doc/docportal/other_platforms/nintendo_switch.rst b/doc/docportal/other_platforms/nintendo_switch.rst
index 69ff5f1332..0316da5ae4 100644
--- a/doc/docportal/other_platforms/nintendo_switch.rst
+++ b/doc/docportal/other_platforms/nintendo_switch.rst
@@ -26,7 +26,7 @@ Copy the folders containing game files into the ``/switch/scummvm/`` folder on t
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:`../use_scummvm/add_play_games` page.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
diff --git a/doc/docportal/other_platforms/playstation_3.rst b/doc/docportal/other_platforms/playstation_3.rst
index 4c4e92fbbc..8cd9d81659 100644
--- a/doc/docportal/other_platforms/playstation_3.rst
+++ b/doc/docportal/other_platforms/playstation_3.rst
@@ -28,7 +28,7 @@ Games can be launched from either a USB drive, or from the internal hard drive.
To copy game files to the hard drive, use the USB drive, or use ScummVM's :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
-See :doc:`../use_scummvm/add_play_games` for more information.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
diff --git a/doc/docportal/other_platforms/playstation_portable.rst b/doc/docportal/other_platforms/playstation_portable.rst
index c26f2e2cf4..47e571ad72 100644
--- a/doc/docportal/other_platforms/playstation_portable.rst
+++ b/doc/docportal/other_platforms/playstation_portable.rst
@@ -28,7 +28,7 @@ Transferring game files
Transfer game files onto the PSP as described in the installation section above. They can be copied to any folder; location doesn't matter.
-For more information, see :doc:`../use_scummvm/add_play_games`.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
diff --git a/doc/docportal/other_platforms/ps_vita.rst b/doc/docportal/other_platforms/playstation_vita.rst
similarity index 98%
rename from doc/docportal/other_platforms/ps_vita.rst
rename to doc/docportal/other_platforms/playstation_vita.rst
index 8daad11cb2..6dc7bde8a7 100644
--- a/doc/docportal/other_platforms/ps_vita.rst
+++ b/doc/docportal/other_platforms/playstation_vita.rst
@@ -28,7 +28,7 @@ Folders containing game files can be copied anywhere on the SD card.
ScummVM on the PS Vita supports :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
-For more information on how to add and play games, see the :doc:`../use_scummvm/add_play_games` page.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
diff --git a/doc/docportal/other_platforms/risc_os.rst b/doc/docportal/other_platforms/risc_os.rst
index ede8a96b2c..0d2246d4fb 100644
--- a/doc/docportal/other_platforms/risc_os.rst
+++ b/doc/docportal/other_platforms/risc_os.rst
@@ -4,7 +4,7 @@ RISC OS
This page contains all the information you need to get ScummVM up and running on the RISC operating system.
-WHat you'll need
+What you'll need
===================
- A system running RISC OS 5
@@ -24,7 +24,7 @@ Transferring game files
Copy data files directly from the original discs on machines that have CD and/or floppy drives, or use a USB drive to transfer the files from another system.
-See :doc:`../use_scummvm/add_play_games` for more information.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
diff --git a/doc/docportal/other_platforms/sega_dreamcast.rst b/doc/docportal/other_platforms/sega_dreamcast.rst
index 04c84b0a0c..9aee4a2636 100644
--- a/doc/docportal/other_platforms/sega_dreamcast.rst
+++ b/doc/docportal/other_platforms/sega_dreamcast.rst
@@ -86,6 +86,8 @@ The Dreamcast port does not use the normal ScummVM Launcher. It uses its own cus
ScummVM for the Dreamcast supports disc swapping from the GUI. It rescans after a new disc is inserted and repopulates the games list.
+See :doc:`../use_scummvm/game_files` for more information about game file requirements.
+
Controls
=================
Commit: e20ec44f80f49f52df5a60c3a62cc3a86f7f2c99
https://github.com/scummvm/scummvm/commit/e20ec44f80f49f52df5a60c3a62cc3a86f7f2c99
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds config file ref
Changed paths:
doc/docportal/settings/misc.rst
diff --git a/doc/docportal/settings/misc.rst b/doc/docportal/settings/misc.rst
index e1d3f8797d..b836f25d45 100644
--- a/doc/docportal/settings/misc.rst
+++ b/doc/docportal/settings/misc.rst
@@ -33,11 +33,14 @@ Autosave
*autosave_period*
+
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.
Commit: 547201b29441e7c99e78f6b3c3913e34f2c7a7cb
https://github.com/scummvm/scummvm/commit/547201b29441e7c99e78f6b3c3913e34f2c7a7cb
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: changes title of install page
Changed paths:
doc/docportal/use_scummvm/install_computer.rst
diff --git a/doc/docportal/use_scummvm/install_computer.rst b/doc/docportal/use_scummvm/install_computer.rst
index badc095bc8..d4f623ccfd 100644
--- a/doc/docportal/use_scummvm/install_computer.rst
+++ b/doc/docportal/use_scummvm/install_computer.rst
@@ -1,11 +1,11 @@
=====================================
-Installing ScummVM
+Installing ScummVM on a computer
=====================================
.. tabbed:: Windows
- There are two ways to install ScummVM onto a computer running Windows; download and use the installer, or install manually.
+ There are two ways to install ScummVM on a computer running Windows; download and use the installer, or install manually.
.. dropdown:: Installing ScummVM using the installer
:open:
@@ -36,7 +36,7 @@ Installing ScummVM
.. tabbed:: Linux
- There are multiple ways to install ScummVM onto a computer running Linux: use the Snap Store, Flathub or the software repository, or install the release binary.
+ There are multiple ways to install ScummVM on a computer running Linux: use the Snap Store, Flathub or the software repository, or install the release binary.
.. dropdown:: Installing ScummVM using the Snap Store
:open:
Commit: c1f6c2f638eed99c54d07e9555a45c2f5b0e874a
https://github.com/scummvm/scummvm/commit/c1f6c2f638eed99c54d07e9555a45c2f5b0e874a
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: excludes 'contribute' folder from build
Changed paths:
doc/docportal/conf.py
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index 8a29a185ae..3639b9d291 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -45,7 +45,7 @@ templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'contribute/*.rst']
# -- Options for HTML output -------------------------------------------------
Commit: be131fdde66816f39e5de937c36c791422cd5a3c
https://github.com/scummvm/scummvm/commit/be131fdde66816f39e5de937c36c791422cd5a3c
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: updates landing page with other platforms
Changed paths:
doc/docportal/index.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 5756207130..b57671d9c5 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -89,7 +89,7 @@ While ScummVM was originally designed to run LucasArts' SCUMM games, over time s
Start here!
================
-We have a user manual section covering all the basics:
+We have a user manual section covering **THE BASICS**:
.. panels::
:container: text-center mb-4
@@ -129,8 +129,50 @@ We have a user manual section covering all the basics:
:doc:`use_scummvm/LAN`
+We also have guides on how to get ScummVM running on a wide range of **OTHER PLATFORMS**:
+.. panels::
+ :container: text-center mb-4
+
+ Handheld consoles
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ :doc:`other_platforms/nintendo_3ds`
+
+ :doc:`other_platforms/nintendo_switch`
+
+ :doc:`other_platforms/playstation_portable`
+
+ :doc:`other_platforms/playstation_vita`
+
+ ---
+
+ Other consoles
+ ^^^^^^^^^^^^^^^^
+
+ :doc:`other_platforms/playstation_3`
+
+ :doc:`other_platforms/sega_dreamcast`
+
+ ---
+
+ Phones and tablets
+ ^^^^^^^^^^^^^^^
+ :doc:`other_platforms/ios`
+
+ :doc:`other_platforms/android`
+
+ ---
+
+ Other operating systems
+ ^^^^^^^^^^^^^^^^^^^^^^^
+ :doc:`other_platforms/amigaos_4`
+
+ :doc:`other_platforms/atari`
+
+ :doc:`other_platforms/risc_os`
+
+
@@ -184,7 +226,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?
======================================
-We have a Release Notes section where you can see what's changed in both current and past releases.
+We have a **RELEASE NOTES** section on the sidebar; here you can see what's changed in both current and past releases.
The ScummVM Project
Commit: 81cb95b514b7551b2d9065d38ad10570595a068a
https://github.com/scummvm/scummvm/commit/81cb95b514b7551b2d9065d38ad10570595a068a
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: changes location of templates
Changed paths:
R doc/docportal/port_template.rst
diff --git a/doc/docportal/port_template.rst b/doc/docportal/port_template.rst
deleted file mode 100644
index 68bf0c2935..0000000000
--- a/doc/docportal/port_template.rst
+++ /dev/null
@@ -1,76 +0,0 @@
-=============================
-Title
-=============================
-
-Install ScummVM
-===================
-
-Prerequisites
-****************
-
-- Bullet points listing all prerequisites.
-
-Download and install ScummVM
-*********************************
-
-Detailed install instructions.
-
-Transfer game files
-=======================
-
-Detailed instructions for getting game files onto the device.
-
-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.
-
-Default control mapping
-*************************
-
-Use a CSV-list table. Set widths to equal 100%. Choose how many header rows you have.
-
-It's easiest to use Google Sheets or Excel to export a spreadsheet as a CSV file.
-
-.. csv-table::
- :widths: 30 30 40
- :header-rows: 1
-
- Button, Action, Description
- Left stick, Move pointer,
-
-
-
-[Other control information] - Optional
-*****************************************
-
-Paths
-=======
-
-Saved games
-*******************
-
-``path/to/savedgames``
-
-Configuration file
-**************************
-``path/to/configurationfile``
-
-
-Settings
-==========
-
-For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
-
-[Applicable tab] e.g. Audio
-*******************************
-
-
-
-
-Known issues
-==============
-
-Anything specific to this port that is a known issue.
\ No newline at end of file
Commit: 4177a80927d1e5524dfc7af2f0e431c343a4c82c
https://github.com/scummvm/scummvm/commit/4177a80927d1e5524dfc7af2f0e431c343a4c82c
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: clarifies config key table
Changed paths:
doc/docportal/advanced_topics/configuration_file.rst
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index fe9064db68..fdc274998f 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -128,13 +128,13 @@ Example of a configuration file
Configuration keys
=====================
-There are many recognized configuration keys. In the table below, each keyword is linked to an explanatory description in the Settings pages.
+There are many recognized configuration keys. In the table below, each key is either linked to an explanatory description in the Settings pages, or has further information in the **Decription/Options** column.
.. csv-table::
:widths: 37 13 25 25
:header-rows: 1
- Keyword,Type,Default,Description/Options
+ Key,Type,Default,Description/Options
alsa_port,integer,,Specifies which ALSA port ScummVM uses when using the ALSA music driver (Linux).
":ref:`alt_intro <altintro>`",boolean,false,
":ref:`altamigapalette <altamiga>`",boolean,false,
Commit: f5123047ca95025628b6117e04fca684f397110c
https://github.com/scummvm/scummvm/commit/f5123047ca95025628b6117e04fca684f397110c
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: adds info to iOS page - trusting built app
Changed paths:
doc/docportal/other_platforms/ios.rst
diff --git a/doc/docportal/other_platforms/ios.rst b/doc/docportal/other_platforms/ios.rst
index cd8024201f..59d483a144 100644
--- a/doc/docportal/other_platforms/ios.rst
+++ b/doc/docportal/other_platforms/ios.rst
@@ -120,6 +120,8 @@ If you have not added your developer account to Xcode, do this now. Click **Add
In the upper left-hand corner, press the play button to build ScummVM. When the build is finished, it launches on your connected device.
+If ScummVM does not launch and you get an error message advising that the app failed to launch due to an invalid code signature, inadequate entitlements or because its profile has not been explicitly trusted by the user, you need to trust the apps that you have built. On your iOS device, go to **Settings > General > Device Management > Developer App > Trust "Apple Development:yourAppleIDhere" > Trust**.
+
Devices with custom firmware
*******************************
Commit: 16312141bbd462acb422e292040f74558c7d4533
https://github.com/scummvm/scummvm/commit/16312141bbd462acb422e292040f74558c7d4533
Author: cadihowley (cadihowley at gmail.com)
Date: 2020-11-30T17:41:26-05:00
Commit Message:
DOCS: fixes multiple small things
- changes colour of unselected tabs
- clarifies language option
- changes hierarchy of headings on game files page
- renames game files page
- fixes windows path
- corrects save game path info on Path page
- renames Other Platforms to Platform Guides
- standardises Understanding Audio/Graphics pages
Changed paths:
A doc/docportal/images/Launcher/choose_version.png
doc/docportal/_static/custom.css
doc/docportal/advanced_topics/configuration_file.rst
doc/docportal/advanced_topics/understand_audio.rst
doc/docportal/advanced_topics/understand_graphics.rst
doc/docportal/help/report_bugs.rst
doc/docportal/index.rst
doc/docportal/settings/game.rst
doc/docportal/settings/paths.rst
doc/docportal/use_scummvm/add_play_games.rst
doc/docportal/use_scummvm/game_files.rst
doc/docportal/use_scummvm/install_computer.rst
doc/docportal/use_scummvm/save_load_games.rst
doc/docportal/use_scummvm/the_launcher.rst
diff --git a/doc/docportal/_static/custom.css b/doc/docportal/_static/custom.css
index 420905a8dd..3752c7d755 100644
--- a/doc/docportal/_static/custom.css
+++ b/doc/docportal/_static/custom.css
@@ -50,7 +50,7 @@ h4 {
}
.tabbed-set>label {
- color: #ffbb77 !important;
+ color: #fd962e !important;
}
.tabbed-content {
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index fdc274998f..28b0c7e756 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -69,7 +69,7 @@ The configuration file saves to different default locations, depending on the pl
ScummVM follows the XDG Base Directory Specification, so by default the configuration file is found at ``~/.config/scummvm/scummvm.ini``, but its location might vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
- If ScummVM was installed using Snap, the configuration file can be found at ``~/snap/scummvm/current/.config/scummvm/scummvm.ini``
+ If ScummVM was installed using Snap, the configuration file is found at ``~/snap/scummvm/current/.config/scummvm/scummvm.ini``
.. note::
@@ -244,7 +244,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`herculesfont <herc>`",boolean,false,
":ref:`hpbargraphs <hp>`",boolean,true,
":ref:`hypercheat <hyper>`",boolean,false,
- iconpath,string,, "Specifies the path to icons to use as overlay for the ScummVM icon in the Windows taskbar or the macOS Dock when running a game. The icon files should be named after the gameid and be an ico file on Windows, or a png file on macOS."
+ iconpath,string,, "Specifies the path to icons to use as overlay for the ScummVM icon in the Windows taskbar or the macOS Dock when running a game. The icon files should be named after the :ref:`gameid <gameid>`, and be an ICO file on Windows, or a PNG file on macOS."
":ref:`improved <improved>`",boolean,true,
":ref:`InvObjectsAnimated <objanimated>`",boolean,true,
":ref:`joystick_deadzone <deadzone>`",integer, 3
@@ -415,7 +415,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`transparentdialogboxes <transparentdialog>`",boolean,false,
":ref:`tts_enabled <ttsenabled>`",boolean,false,
":ref:`tts_narrator <ttsnarrator>`",boolean,false,
- use_cdaudio,boolean,true,
+ use_cdaudio,boolean,true, "If true, ScummVM uses audio from the game CD."
versioninfo,string,,Shows the ScummVM version that created the configuration file.
":ref:`window_style <style>`",boolean,true,
":ref:`windows_cursors <wincursors>`",boolean,false,
diff --git a/doc/docportal/advanced_topics/understand_audio.rst b/doc/docportal/advanced_topics/understand_audio.rst
index 1052ee3c43..c890622f04 100644
--- a/doc/docportal/advanced_topics/understand_audio.rst
+++ b/doc/docportal/advanced_topics/understand_audio.rst
@@ -1,12 +1,12 @@
======================================================
-Understand the audio settings
+Understanding the audio settings
======================================================
-This guide is designed to expand on the information contained on the :doc:`audio settings <../settings/audio>` page.
+This guide expands on the information contained on the :doc:`audio settings <../settings/audio>` page.
-How do the settings work together?
-=====================================
+How do the audio settings work together?
+==========================================
The **Preferred device** in the global settings Audio tab, or the **Music device** in the game-specific settings Audio tab, specifies the device that ScummVM uses to output audio. This device can be an emulated sound device or a software synthesizer, or an actual hardware device such as a soundcard or a hardware MIDI synthesizer. When set to **<default>**, ScummVM will automatically choose the most appropriate option for the played game.
diff --git a/doc/docportal/advanced_topics/understand_graphics.rst b/doc/docportal/advanced_topics/understand_graphics.rst
index ab15af069a..2f09b9fc79 100644
--- a/doc/docportal/advanced_topics/understand_graphics.rst
+++ b/doc/docportal/advanced_topics/understand_graphics.rst
@@ -1,8 +1,8 @@
=====================================
-Understand the graphics settings
+Understanding the graphics settings
=====================================
-This guide is designed to expand on the information contained on the :doc:`graphics settings <../settings/graphics>` page.
+This guide expands on the information contained on the :doc:`graphics settings <../settings/graphics>` page.
How do the graphics settings work together?
----------------------------------------------
@@ -103,7 +103,7 @@ For a game with an original resolution of 320x200, aspect ratio correction resul
.. figure:: ../images/graphics/aspect_ratio/aspect_ratio.png
- Aspect ratio correction applied. Notice the moon is actually round now.
+ Aspect ratio correction applied. The moon is actually round, as it should be!
To toggle aspect ratio on and off, press :kbd:`Ctrl+Alt+a`.
diff --git a/doc/docportal/help/report_bugs.rst b/doc/docportal/help/report_bugs.rst
index fc2deb94f6..ab57eff2d2 100644
--- a/doc/docportal/help/report_bugs.rst
+++ b/doc/docportal/help/report_bugs.rst
@@ -50,6 +50,6 @@ To help you report a bug, you can find error messages in the ScummVM log file. T
Window Vista/7/8/10
^^^^^^^^^^^^^^^^^^^^^^
- ``%APPDATA\ScummVM\scummvm.log``
+ ``%APPDATA%\ScummVM\scummvm.log``
diff --git a/doc/docportal/images/Launcher/choose_version.png b/doc/docportal/images/Launcher/choose_version.png
new file mode 100644
index 0000000000..23e8a78757
Binary files /dev/null and b/doc/docportal/images/Launcher/choose_version.png differ
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index b57671d9c5..90dada2dfc 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -15,7 +15,7 @@
use_scummvm/LAN
.. toctree::
- :caption: Other platforms
+ :caption: Platform guides
:glob:
:hidden:
@@ -128,8 +128,9 @@ We have a user manual section covering **THE BASICS**:
:doc:`use_scummvm/LAN`
+.. _platformspecific:
-We also have guides on how to get ScummVM running on a wide range of **OTHER PLATFORMS**:
+We also have guides on how to get ScummVM running on a wide range of other platforms:
.. panels::
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index 29045621a1..29cdcb8887 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -33,7 +33,7 @@ All settings can also be changed in the :doc:`../advanced_topics/configuration_f
.. _lang:
**Language**
- 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 example, selecting German will add an umlaut to German subtitles, and selecting Spanish will add the tilde to Spanish subtitles.
+ For games that were released with support for multiple languages, this options changes the language of the game. For games that have a single language hardcoded, this option does not change the language of the game, it only affects the subtitles. Select the correct language to ensure that subtitles display correctly, especially for non-English games.
*language*
diff --git a/doc/docportal/settings/paths.rst b/doc/docportal/settings/paths.rst
index 759a8c8854..aebc5d7e65 100644
--- a/doc/docportal/settings/paths.rst
+++ b/doc/docportal/settings/paths.rst
@@ -23,7 +23,7 @@ All settings can also be changed in the :doc:`../advanced_topics/configuration_f
.. _savepath:
Save Path
- 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.
+ 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*
diff --git a/doc/docportal/use_scummvm/add_play_games.rst b/doc/docportal/use_scummvm/add_play_games.rst
index c0d0938b01..1d0848acd8 100644
--- a/doc/docportal/use_scummvm/add_play_games.rst
+++ b/doc/docportal/use_scummvm/add_play_games.rst
@@ -3,8 +3,8 @@
Adding and playing a game
=================================
-The games
-------------
+Where to get the games
+=============================
One of the most frequently asked questions is, "Where do I get the games?!?". If you still have your old floppy discs or CDs lying around, and have a way to read them, then you can use the game files from those original discs.
@@ -19,7 +19,7 @@ Make sure to check out the `compatibility list <https://www.scummvm.org/compatib
.. _add and play games:
Adding games to the Launcher
----------------------------------
+==============================
The following steps explain how to add a game to ScummVM, and assume you have access to the data files for each game. If you're not sure how to access the game data files, see the :doc:`game_files` page.
@@ -34,7 +34,7 @@ To add multiple games at once, click the expander arrow next to **Add Game**, an
.. image:: ../images/Launcher/mass_add.png
-3. Use the file browser to locate the folder containing the game data files. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Click **Choose** to select the folder.
+3. Use the file browser to locate the folder containing the game data files. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Highlight the folder by clicking on it, and then click **Choose**
.. image:: ../images/Launcher/choose_game_directory.png
:class: with-shadow
@@ -43,13 +43,24 @@ To add multiple games at once, click the expander arrow next to **Add Game**, an
The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the system file browser, or its own file browser.
-3a. If you are using **Mass Add**, select **Yes** to run the mass game detector. A dialog opens to advise which games were added to the games list.
+If you are using **Mass Add**, select **Yes** to run the mass game detector. A dialog opens to advise which games were added to the games list.
.. image:: ../images/Launcher/mass_add_confirm.png
.. image:: ../images/Launcher/mass_add_success.png
-4. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should be OK at the default settings. Any settings changed here override the global settings. Click **Ok**.
+
+Sometimes, ScummVM detects multiple versions of a single game. In this case, highlight the correct version and click **Choose** to continue.
+
+.. figure:: ../images/Launcher/choose_version.png
+
+.. caution::
+
+ If you are using **Mass Add**, ScummVM adds all versions of a game.
+
+If you are adding an unknown version of a game, ScummVM is not able to add the game to the games list. An error message appears to warn you that the game has not been added.
+
+4. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should be OK at the default settings. Any settings changed here override the global settings. Click **Ok**.
.. image:: ../images/Launcher/game_settings.png
:class: with-shadow
@@ -58,7 +69,7 @@ To add multiple games at once, click the expander arrow next to **Add Game**, an
The **Edit Game** dialog does not open when **Mass Add** is used.
-5. Games are now ready to play! To play, highlight a game in the games list and click **Start**, or double-click the game in the games list.
+6. Games are now ready to play! To play, highlight a game in the games list and click **Start**, or double-click the game in the games list.
.. image:: ../images/Launcher/start_game.png
:class: with-shadow
@@ -66,7 +77,7 @@ To add multiple games at once, click the expander arrow next to **Add Game**, an
Games can also be launched directly from the command line. For more information, see the `Command line options <../advanced_topics/command_line>`_ page.
A note about copyright
-------------------------
+==============================
ScummVM has a strict anti-piracy stance and the team wil not tolerate discussions around pirated games in any part of the project, including on the Forum or on Discord.
diff --git a/doc/docportal/use_scummvm/game_files.rst b/doc/docportal/use_scummvm/game_files.rst
index c7144b6b1d..e6039f74ba 100644
--- a/doc/docportal/use_scummvm/game_files.rst
+++ b/doc/docportal/use_scummvm/game_files.rst
@@ -1,11 +1,8 @@
===========================
-Accessing game files
+Handling game files
===========================
-The game files
-------------------
-
ScummVM needs access to the data files for each game. A comprehensive list of required data files for each game is found on the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page. ScummVM can run the game data files from any directory it has access to, including external media.
.. note::
@@ -23,41 +20,35 @@ ScummVM needs access to the data files for each game. A comprehensive list of re
-For games on floppies or CDs:
-
-- If the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above.
-- If the data files are not accessible, run the installer on the platform the game was designed for, to extract the game files.
-
-For games downloaded from digital distributors or from various `freeware sources <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games#Freeware_Games>`__:
+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.
-- Run the installer to extract the data files, or
-- If the data files are supplied as a zip file, extract the files.
-
-For macOS or Linux users without access to a Windows machine, you can get the data files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer on macOS or Linux. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.
+For games downloaded from digital distributors or from various `freeware sources <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games#Freeware_Games>`__ run the installer to extract the data files, or if the data files are supplied as a zip file, extract the files.
+For macOS or Linux users without access to a Windows machine, you can get the data files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.
.. 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:`../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.
+ 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 also 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
-*****************
+===================
ScummVM needs access to all the data files, so it will not be able to run directly from a CD if the game has multiple discs. To add a multi-CD game, copy the required data files from the CD to a folder on your hard drive. For a comprehensive list of required files, see the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page.
-As a general guideline:
-
-- Where there are duplicate, identical files (same name, same file size) on more than one disc, only one copy of the file is required.
-- Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.
+As a general guideline, where there are duplicate, identical files (same name, same file size) on more than one disc, only one copy of the file is required. Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.
.. _cdaudio:
CD audio
-**********
+============
+
+In most cases, ScummVM can use CD audio directly from the game CD. If you don't always want to insert the game CD to use the CD audio, you can extract the audio tracks from the CD and save them locally:
-Some games contain one or more separate audio tracks on CD. To use these with ScummVM, extract the audio tracks from the CD in WAV or AIFF format, and then convert them to either MP3, FLAC or OGG file formats. Place the converted audio files in the same folder that contains the other game datafiles.
+1. Extract the CD audio tracks in WAV or AIFF format.
+2. Convert the tracks to either MP3, FLAC or OGG file formats.
+3. Place the converted audio files in the same folder that contains the other game datafiles.
.. tip::
@@ -67,7 +58,7 @@ Some games contain one or more separate audio tracks on CD. To use these with Sc
.. _macgames:
Macintosh games
-******************
+==================
All LucasArts SCUMM games also exist in versions for the Macintosh. Most of the newer games shipped with only a single data file; ScummVM can use this file like it does any other data file. Some discs shipped with hidden files. To view hidden files in macOS, press :kbd:`Cmd+Shift+.` in a Finder window.
diff --git a/doc/docportal/use_scummvm/install_computer.rst b/doc/docportal/use_scummvm/install_computer.rst
index d4f623ccfd..49d0a544a7 100644
--- a/doc/docportal/use_scummvm/install_computer.rst
+++ b/doc/docportal/use_scummvm/install_computer.rst
@@ -1,11 +1,13 @@
=====================================
-Installing ScummVM on a computer
+Installing ScummVM
=====================================
+This page explains how to install ScummVM on a computer. For all other platforms, see the relevant :ref:`platform guide <platformspecific>`.
+
.. tabbed:: Windows
- There are two ways to install ScummVM on a computer running Windows; download and use the installer, or install manually.
+ There are two ways to install ScummVM on Windows: use the installer, or install manually.
.. dropdown:: Installing ScummVM using the installer
:open:
@@ -36,7 +38,7 @@ Installing ScummVM on a computer
.. tabbed:: Linux
- There are multiple ways to install ScummVM on a computer running Linux: use the Snap Store, Flathub or the software repository, or install the release binary.
+ There are multiple ways to install ScummVM on Linux: use the Snap Store, Flathub or the software repository, or manually install the release binary.
.. dropdown:: Installing ScummVM using the Snap Store
:open:
diff --git a/doc/docportal/use_scummvm/save_load_games.rst b/doc/docportal/use_scummvm/save_load_games.rst
index 8a15609b22..5a71fd521b 100644
--- a/doc/docportal/use_scummvm/save_load_games.rst
+++ b/doc/docportal/use_scummvm/save_load_games.rst
@@ -3,7 +3,7 @@
Saving and loading a game
===============================
-This guide explains how to save and load a game from the Global Main Menu, or load a game directly from the Launcher.
+This page explains how to save and load a game from the Global Main Menu, or load a game directly from the Launcher.
.. note::
@@ -49,15 +49,6 @@ The save directory can be changed with the savepath setting in the :doc:`Paths t
Default saved game paths are shown below.
-.. tabbed:: macOS
-
- .. panels::
- :column: col-lg-12 mb-2
-
- macOS/Mac OSX
- ^^^^^^^^^^
- ``~/Documents/ScummVM Savegames/``, where ``~`` is your Home directory.
-
.. tabbed:: Windows
.. panels::
@@ -66,8 +57,8 @@ Default saved game paths are shown below.
Windows NT4
^^^^^^^^^^^^
- ``<windir>\Profiles\username\Application Data\ScummVM\Saved games\`` where ``<windir>`` refers to the Windows directory. Most commonly, this is ``C:\WINDOWS``.
-
+ ``C:\WINDOWS\Profiles\username\Application Data\ScummVM\Saved games\``
+
---
:column: col-lg-12 mb-2
@@ -81,7 +72,15 @@ Default saved game paths are shown below.
Window Vista/7/8/10
^^^^^^^^^^^^^^^^^^^^^^
``%APPDATA%\ScummVM\Saved games``
-
+
+
+.. tabbed:: macOS
+
+ .. panels::
+ :column: col-lg-12 mb-2
+
+ ``~/Documents/ScummVM Savegames/``
+
.. tabbed:: Linux/Unix
@@ -97,14 +96,6 @@ Default saved game paths are shown below.
-.. tabbed:: Other
-
- .. panels::
- :column: col-lg-12 mb-2
-
- See the relevant Platform page for details.
-
-
Loading a game
===============
diff --git a/doc/docportal/use_scummvm/the_launcher.rst b/doc/docportal/use_scummvm/the_launcher.rst
index 4c317ddae8..612fe5f795 100755
--- a/doc/docportal/use_scummvm/the_launcher.rst
+++ b/doc/docportal/use_scummvm/the_launcher.rst
@@ -37,7 +37,7 @@ Launches the highlighted game.
Load
^^^^^^^
-Opens the load game window, from which you can run a previously saved state without having to start the game first.
+Opens the load game window, from which you can go to a saved game without having to start the game first.
See the :doc:`save_load_games` page.
@@ -98,17 +98,17 @@ Closes the GMM and resumes the game.
Load
^^^^^^
-Opens the load game window, to load a saved game state.
+Opens the load game window. From here, you can load a saved game.
Save
^^^^^^
-Opens the save game window, to save a game state.
+Opens the save game window. From here, you can save a game.
Options
^^^^^^^^
-Opens a dialog which provides gameplay options, such as sound volume, subtitle and keymap settings.
+Opens a dialog which provides some gameplay options, such as sound volume, subtitle and keymap settings.
About
More information about the Scummvm-git-logs
mailing list