[Scummvm-git-logs] scummvm master -> 6b65e27484238bb11d1fdd06d25962cc82fa423d
sev-
noreply at scummvm.org
Fri Oct 6 20:25:09 UTC 2023
This automated email contains information about 13 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
64f40b8959 GUI: updates content of help dialog
a74c827076 BACKENDS: ADNROID: Updates content of help tab
b7c8ae32ce DOCS: creates "Adding Games" section for Android
5df0851284 BACKENDS: ANDROID: updates contents of help dialog
239a2dd010 DOCS: Updates Android screenshots
5fb01f0a6b DOCS: amends Android docs to align with GUI help
ca2fa723e3 BASE: updates SAF popup to align with GUI help
7e41bec7f0 BACKENDS: ANDROID: minor edit to Help tab contents
d723f75797 DOCS: moves .yaml config to fix readthedocs builds
85ba85df69 DOCS: updates config file to fix doc builds
f3d2d90b37 DOCS: corrects readthedocs config file
a6bf0df585 DOCS: updates readthedocs config file
6b65e27484 DOCS: fixes readthedocs config file paths
Commit: 64f40b8959e8202ffb0b7df4229f4fe067dac92e
https://github.com/scummvm/scummvm/commit/64f40b8959e8202ffb0b7df4229f4fe067dac92e
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
GUI: updates content of help dialog
Changed paths:
gui/helpdialog.cpp
diff --git a/gui/helpdialog.cpp b/gui/helpdialog.cpp
index 6f2efb9dbcc..7beb61ed6b6 100644
--- a/gui/helpdialog.cpp
+++ b/gui/helpdialog.cpp
@@ -54,23 +54,18 @@ HelpDialog::HelpDialog()
Common::U32String helpText1 = _(
"## Where to get the games\n"
"\n"
-"Many games supported by ScummVM can still be bought from companies at the links on "
-"[our Wiki](https://wiki.scummvm.org/index.php?title=Where_to_get_the_games).\n"
+"Visit [our Wiki](https://wiki.scummvm.org/index.php?title=Where_to_get_the_games) for a list of games and where to purchase them.\n"
"\n"
-"Several games have been released for free legal download by their respective copyright "
-"holders. You can download them from [our website](https://scummvm.org/games).\n"
+"Alternatively, download a selection of [freeware games](https://scummvm.org/games) and [demos](https://www.scummvm.org/demos/) from our website \n"
"\n"
-"Also, we maintain a comprehensive [list of downloadable demos](https://www.scummvm.org/demos/).\n"
+"For other (out of print) games, try Amazon, eBay, Game Trading Zone or other auction "
+"sites. Beware of faulty games and illegal game copies.\n"
"\n"
-"For other (out of print) games try Amazon, eBay, Game Trading Zone or other auction "
-"sites but beware of faulty games (e.g., scratched discs) and illegal game copies "
-"(e.g., from Butterfly Media).\n"
-"\n"
-"The ScummVM team does not recommend any individual supplier of games and these lists are "
-"for reference purposes only. However, the ScummVM project does get a cut from every purchase on "
+"The ScummVM team does not recommend any individual supplier of games,"
+"however the project does get a cut from every purchase on "
"[GOG.com](https://www.gog.com/?pp=22d200f8670dbdb3e253a90eee5098477c95c23d) and "
"[ZOOM-Platform](https://www.zoom-platform.com/?affiliate=c049516c-9c4c-42d6-8649-92ed870e8b53) "
-"through one of the links with the added affiliate referrer though.\n"
+"through affiliate referral links.\n"
);
new RichTextWidget(tab, 10, 10, _w - 10, tabHeight - buttonHeight - 10, helpText1);
Commit: a74c8270764c9fbf9364c7bc883e98290e0d968a
https://github.com/scummvm/scummvm/commit/a74c8270764c9fbf9364c7bc883e98290e0d968a
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
BACKENDS: ADNROID: Updates content of help tab
Changed paths:
backends/platform/android/android.cpp
diff --git a/backends/platform/android/android.cpp b/backends/platform/android/android.cpp
index 2cbeb1515d3..7aa40aecf82 100644
--- a/backends/platform/android/android.cpp
+++ b/backends/platform/android/android.cpp
@@ -1039,7 +1039,7 @@ _s(
" * Gamepad emulation, the touch controls don't move any mouse. The fingers must be placed on lower left and right of the screen and respectively emulate a directional pad and action buttons.\n"
" * The pointer speed setting in the **Controls tab** affects how far the pointer moves in response to a finger movement.\n"
"\n"
-"The touch mode can be switched at anytime by tapping on the controller icon, next to the menu icon at the top right of the screen.\n"
+"The touch mode can be switched at any time by tapping on the controller icon, next to the menu icon at the top right of the screen.\n"
"\n"
"To display or hide the small controller icon, from the Launcher select **Options** and then the **Backend** tab. Tick the **Show on-screen control** box to enable the controller icon.\n"
"\n"
@@ -1063,67 +1063,25 @@ _s(
"\n"
"## Virtual keyboard\n"
"\n"
-"To open the virtual keyboard, long press on the small controller icon at the top right of the screen, or tap on any editable text field. To hide the virtual keyboard, tap the small controller icon (which became a keyboard one) again, or tap outside the text field.\n"
+"To open the virtual keyboard, long press on the small controller icon at the top right of the screen, or tap on any editable text field. To hide the virtual keyboard, tap the small controller icon, which now looks like a keyboard, or tap outside the text field.\n"
"\n"
),
_s("Adding Games"),
"android-help.zip",
_s(
-"## Adding SAF paths to ScummVM directory list\n"
-"\n"
-"Starting with version 2.7.0 of ScummVM for Android, significant changes were made to the file access system to allow support for modern versions of the Android Operating System.\n"
-"\n"
-"If you find that your existing added games or custom paths no longer work, please edit those paths and this time use the SAF system to browse to the desired locations.\n"
-"\n"
-"To do that:\n"
-"\n"
-" 1. For each game whose data is not found, go to the \"Paths\" tab in the \"Game Options\" and change the \"Game path\"\n"
-"\n"
-" 2. Inside the ScummVM file browser, use \"Go Up\" until you reach the \"root\" folder where you will see the \"<Add a new folder>\" option.\n"
-"\n"
-" ![File browser](browser-root.png \"Android browser\")\n"
-"\n"
-" File Browser root with <Add a new folder> item\n"
-"\n"
-" 3. Choose that, then browse and select the \"parent\" folder for your games subfolders, e.g. \"SD Card > ScummVMgames\". Click on \"Use this folder\".\n"
-"\n"
-" ![OS file browser root](fs-root.png \"OS file browser root\")\n"
-"\n"
-" OS file browser root\n"
-"\n"
-" ![OS selectable folder](fs-folder.png \"OS selectable folder\")\n"
-"\n"
-" OS file browser selectable folder with \"Use this folder\" button\n"
-"\n"
-" ![OS access permission dialog](fs-permission.png \"OS access permission\")\n"
-"\n"
-" OS file browser ask to grant ScummVM directory access permission\n"
-"\n"
-" 4. Then, a new folder \"ScummVMgames\" will appear on the \"root\" folder of the ScummVM browser.\n"
-"\n"
-" ![SAF folder added](browser-folder-in-list.png \"SAF folder added\")\n"
-"\n"
-" File browser with added SAF folder in root\n"
-"\n"
-" 5. Browse through this folder to your game data.\n"
-"\n"
-"Steps 2 and 3 need to be done only once for all of your games.\n"
-"\n"
-"\n"
-"## Removing SAF path authorizations\n"
-"\n"
-"In case you would like to revoke any of the granted SAF authorizations, there is an option for this in the \"Global Options > Backend\" tab as shown on the screenshot below:\n"
+
+"1. Select **Add Game...** from the launcher. \n"
"\n"
-"![\"Remove folder authorizations...\" button](gui-remove-permissions.png \"'Remove folder authorizations...' button\")\n"
+"2. Inside the ScummVM file browser, select **Go Up** until you reach the root folder which has the **<Add a new folder>** option. \n"
"\n"
-" GUI tab with \"Remove folder authorizations...\" button\n"
+"3. Select **<Add a new folder>**, browse your device, and select the parent folder for your games subfolders. For example, **SD Card > ScummVMgames**. Select **Use this folder**. \n"
"\n"
-"![List of authorizations to revoked](gui-remove-list.png \"List of authorizations to revoke\")\n"
+"4. In the ScummVM file browser, double-tap to browse through the subfolders of your added folder. Add a game by selecting the subfolder containing the game files. \n"
"\n"
-" GUI dialog with list of authorizations to revoke\n"
+"Step 2 and 3 are done only once. To add more games, repeat Steps 1 and 4. /n"
"\n"
-"In case you revoke authorization to a path, still used for specific games/titles, please follow the procedure of fixing them outlined in the previous subheading.\n"
+"See our [Android documentation](https://docs.scummvm.org/en/latest/other_platforms/android.html) for comprehensive instructions, including screenshots.\n"
),
0 // End of list
Commit: b7c8ae32cebf9b609e6397685b2245b0b3c8c478
https://github.com/scummvm/scummvm/commit/b7c8ae32cebf9b609e6397685b2245b0b3c8c478
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
DOCS: creates "Adding Games" section for Android
Changed paths:
doc/docportal/other_platforms/android.rst
diff --git a/doc/docportal/other_platforms/android.rst b/doc/docportal/other_platforms/android.rst
index 48978e1266a..a04efb69729 100644
--- a/doc/docportal/other_platforms/android.rst
+++ b/doc/docportal/other_platforms/android.rst
@@ -46,8 +46,6 @@ Click on the correct package to start the download. After it has downloaded, go
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:
@@ -59,61 +57,61 @@ There are a few other options to transfer the game files:
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
-Adding SAF paths to ScummVM directory list
-==========================================
-Starting with version 2.7.0 of ScummVM for Android, significant changes were made to the file access system to allow support for modern versions of the Android Operating System.
-If you find that your existing added games or custom paths no longer work, please edit those paths and this time use the SAF system to browse to the desired locations.
-To do that:
+Adding games
+================
-1. For each game whose data is not found, go to the "Paths" tab in the "Game Options" and change the "Game path"
+1. Select **Add Game...** from the launcher.
-2. Inside the ScummVM file browser, use "Go Up" until you reach the "root" folder where you will see the "<Add a new folder>" option.
+2. Inside the ScummVM file browser, select **Go Up** until you reach the root folder which has the **<Add a new folder>** option.
.. figure:: ../images/android/browser-root.png
- File Browser root with <Add a new folder> item
+ Root folder with <Add a new folder> option
-3. Choose that, then browse and select the "parent" folder for your games subfolders, e.g. "SD Card > ScummVMgames". Click on "Use this folder".
+3. Select **<Add a new folder>**, browse your device, and select the parent folder for your games subfolders. For example, **SD Card > ScummVMgames**. Select **Use this folder**.
.. figure:: ../images/android/fs-root.png
:width: 300 px
- OS file browser root
+ Android file browser root
.. figure:: ../images/android/fs-folder.png
:width: 300 px
- OS file browser selectable folder with "Use this folder" button
+ Android file browser selectable folder with **Use this folder** button
+
+4. Select **ALLOW** to grant ScummVM access to the content of the folder.
.. figure:: ../images/android/fs-permission.png
:width: 300 px
- OS file browser ask to grant ScummVM directory access permission
+ Android file browser request to grant ScummVM directory access permission
-4. Then, a new folder "ScummVMgames" will appear on the "root" folder of the ScummVM browser.
+5. In the ScummVM file browser, double-tap to on the added folder to browse through the subfolders. Add a game by selecting the subfolder containing the game files.
-.. figure:: ../images/android/browser-folder-in-list.png
+Step 2, 3 and 4 are done only once. To add more games, repeat Steps 1 and 5.
- File browser with added SAF folder in root
+.. _addSAFpath:
-5. Browse through this folder to your game data.
+ .. note::
+ Starting with version 2.7.0 of ScummVM for Android, significant changes were made to the file access system to allow support for modern versions of the Android Operating System.
-Steps 2 and 3 need to be done only once for all of your games.
+ If existing added games or custom paths no longer work, go to **Game Options > Paths**, select the path to update, then follow steps 2 through 5 above.
+Removing permissions
+************************
-Removing SAF path authorizations
-=============================
-In case you would like to revoke any of the granted SAF authorizations, there is an option for this in the "Global Options > Backend" tab as shown on the screenshot below:
+To remove any folder permissions granted to ScummVM, go to the **Global Options > Backend** tab.
.. figure:: ../images/android/gui-remove-permissions.png
- GUI tab with "Remove folder authorizations..." button
+ Backend tab with "Remove folder authorizations..." button
.. figure:: ../images/android/gui-remove-list.png
- GUI dialog with list of authorizations to revoke
+ Dialog with list of permissions to remove
-In case you revoke authorization to a path, still used for specific games/titles, please follow the procedure of fixing them outlined in the previous subheading.
+If any permissions are removed in error, see :ref:`this note <addSAFpath>` for instructions to reinstate them.
Controls
@@ -209,14 +207,14 @@ 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**.
+3. Use the file browser to **Go up** to the root of the ScummVM file browser.
+4. Select the **ScummVM data (Internal)** folder, and tap **Choose**.
5. Run the server to access the ``scummvm.ini`` configuration file.
For more information, see the :doc:`../use_scummvm/LAN` page.
Commit: 5df085128490fb4d6309de82a76e6928090ecdec
https://github.com/scummvm/scummvm/commit/5df085128490fb4d6309de82a76e6928090ecdec
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
BACKENDS: ANDROID: updates contents of help dialog
Changed paths:
backends/platform/android/android.cpp
dists/android/android-help.zip
diff --git a/backends/platform/android/android.cpp b/backends/platform/android/android.cpp
index 7aa40aecf82..2b2024153b2 100644
--- a/backends/platform/android/android.cpp
+++ b/backends/platform/android/android.cpp
@@ -1026,62 +1026,94 @@ void *OSystem_Android::getOpenGLProcAddress(const char *name) const {
#endif
static const char * const helpTabs[] = {
-_s("Controls"),
-"",
+
+_s("Touch Controls"),
+"android-help.zip",
_s(
-"## Touch controls\n"
+"## Touch control modes\n"
+"The touch control mode can be changed by tapping or clicking on the controller icon in the upper right corner"
+"\n"
+"### Direct mouse \n"
+"\n"
+"The touch controls are direct. The pointer jumps to where the finger touches the screen (default for menus).\n"
+"\n"
+" ![Direct mouse mode](mouse.png \"Direct mouse mode\")\n"
+"\n"
+"### Touchpad emulation \n"
+"\n"
+"The touch controls are indirect, like on a laptop touchpad.\n"
+"\n"
+" ![Touchpad mode](touchpad.png \"Touchpad mode\")\n"
+"\n"
+"### Gamepad emulation \n"
+"\n"
+"Fingers must be placed on lower left and right of the screen to emulate a directional pad and action buttons.\n"
+"\n"
+" ![Gamepad mode](gamepad.png \"Gamepad mode\")\n"
"\n"
-"The touch control scheme can be configured in the global settings. From the Launcher, go to **Options > Backend > Choose the preferred touch mode**.\n"
-"It's possible to configure the touch mode for three situations (ScummVM menus, 2D games and 3D games) and choose one of the three possible modes:\n"
+"To select the preferred touch mode for menus, 2D games, and 3D games, go to **Global Options > Backend > Choose the preferred touch mode**.\n"
"\n"
-" * Direct mouse, the touch controls are direct. The pointer jumps to where the finger touches the screen (default for menus).\n"
-" * Touchpad emulation, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.\n"
-" * Gamepad emulation, the touch controls don't move any mouse. The fingers must be placed on lower left and right of the screen and respectively emulate a directional pad and action buttons.\n"
-" * The pointer speed setting in the **Controls tab** affects how far the pointer moves in response to a finger movement.\n"
+"## Touch actions \n"
"\n"
-"The touch mode can be switched at any time by tapping on the controller icon, next to the menu icon at the top right of the screen.\n"
+"### Two finger scroll \n"
"\n"
-"To display or hide the small controller icon, from the Launcher select **Options** and then the **Backend** tab. Tick the **Show on-screen control** box to enable the controller icon.\n"
+"To scroll, slide two fingers up or down the screen"
"\n"
-"## Two finger tap\n"
+"### Two finger tap\n"
"\n"
"To do a two finger tap, hold one finger down and then tap with a second finger.\n"
"\n"
-"## Three finger tap\n"
+"### Three finger tap\n"
"\n"
"To do a three finger tap, start with holding down one finger and progressively touch down the other two fingers, one at a time, while still holding down the previous fingers. Imagine you are impatiently tapping your fingers on a surface, but then slow down that movement so it is rhythmic, but not too slow.\n"
"\n"
-"## Immersive Sticky fullscreen mode\n"
+"### Immersive Sticky fullscreen mode\n"
"\n"
-"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.\n"
+"Swipe from the edge to reveal the system bars. They remain semi-transparent and disappear after a few seconds unless you interact with them.\n"
"\n"
-"## Global Main Menu\n"
+"### Global Main Menu\n"
"\n"
-"To open the Global Main Menu, tap on the small menu icon at the top right of the screen.\n"
+"To open the Global Main Menu, tap on the menu icon at the top right of the screen.\n"
"\n"
-"To display or hide the small menu icon, from the Launcher select **Options** and then the **Backend** tab. Tick the **Show on-screen control** box to enable the menu icon.\n"
+" ![Menu icon](menu.png \"Menu icon\")\n"
"\n"
"## Virtual keyboard\n"
"\n"
-"To open the virtual keyboard, long press on the small controller icon at the top right of the screen, or tap on any editable text field. To hide the virtual keyboard, tap the small controller icon, which now looks like a keyboard, or tap outside the text field.\n"
+"To open the virtual keyboard, long press on the controller icon at the top right of the screen, or tap on any editable text field. To hide the virtual keyboard, tap the controller icon again, or tap outside the text field.\n"
+"\n"
+"\n"
+" ![Keybpard icon](keyboard.png \"Keyboard icon\")\n"
"\n"
),
_s("Adding Games"),
"android-help.zip",
_s(
-
+"## Adding Games \n"
+"\n"
"1. Select **Add Game...** from the launcher. \n"
"\n"
"2. Inside the ScummVM file browser, select **Go Up** until you reach the root folder which has the **<Add a new folder>** option. \n"
"\n"
-"3. Select **<Add a new folder>**, browse your device, and select the parent folder for your games subfolders. For example, **SD Card > ScummVMgames**. Select **Use this folder**. \n"
+" ![ScummVM file browser root](browser-root.png \"ScummVM file browser root\")\n"
+"\n"
+"3. Double-tap **<Add a new folder>**. In your device's file browser, navigate to the folder containing all your game folders. For example, **SD Card > ScummVMgames**. \n"
+"\n"
+"4. Select **Use this folder**. \n"
+"\n"
+" ![OS selectable folder](fs-folder.png \"OS selectable folder\")\n"
+"\n"
+"5. Select **Allow** to give ScummVM permission to access the folder. \n"
+"\n"
+" ![OS access permission dialog](fs-permission.png \"OS access permission\")\n"
+"\n"
+"6. In the ScummVM file browser, double-tap to browse through your added folder. Add a game by selecting the sub-folder containing the game files. \n"
"\n"
-"4. In the ScummVM file browser, double-tap to browse through the subfolders of your added folder. Add a game by selecting the subfolder containing the game files. \n"
+" ![SAF folder added](browser-folder-in-list.png \"SAF folder added\")\n"
"\n"
-"Step 2 and 3 are done only once. To add more games, repeat Steps 1 and 4. /n"
+"Step 2 and 3 are done only once. To add more games, repeat Steps 1 and 6. \n"
"\n"
-"See our [Android documentation](https://docs.scummvm.org/en/latest/other_platforms/android.html) for comprehensive instructions, including screenshots.\n"
+"See our [Android documentation](https://docs.scummvm.org/en/latest/other_platforms/android.html) for more information.\n"
),
0 // End of list
diff --git a/dists/android/android-help.zip b/dists/android/android-help.zip
index 458df11e852..c127ab97871 100644
Binary files a/dists/android/android-help.zip and b/dists/android/android-help.zip differ
Commit: 239a2dd010d327fb34b13607221c9cfaf451cee7
https://github.com/scummvm/scummvm/commit/239a2dd010d327fb34b13607221c9cfaf451cee7
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
DOCS: Updates Android screenshots
Changed paths:
doc/docportal/images/android/browser-folder-in-list.png
doc/docportal/images/android/browser-root.png
doc/docportal/images/android/fs-folder.png
doc/docportal/images/android/fs-permission.png
doc/docportal/images/android/fs-root.png
diff --git a/doc/docportal/images/android/browser-folder-in-list.png b/doc/docportal/images/android/browser-folder-in-list.png
index 53b20bb1413..a11e2cd3a73 100644
Binary files a/doc/docportal/images/android/browser-folder-in-list.png and b/doc/docportal/images/android/browser-folder-in-list.png differ
diff --git a/doc/docportal/images/android/browser-root.png b/doc/docportal/images/android/browser-root.png
index 50a08261aae..6d19b0a2c16 100644
Binary files a/doc/docportal/images/android/browser-root.png and b/doc/docportal/images/android/browser-root.png differ
diff --git a/doc/docportal/images/android/fs-folder.png b/doc/docportal/images/android/fs-folder.png
index c10236c39b3..21cbbd94860 100644
Binary files a/doc/docportal/images/android/fs-folder.png and b/doc/docportal/images/android/fs-folder.png differ
diff --git a/doc/docportal/images/android/fs-permission.png b/doc/docportal/images/android/fs-permission.png
index 55ca855a2a6..21955d9ec08 100644
Binary files a/doc/docportal/images/android/fs-permission.png and b/doc/docportal/images/android/fs-permission.png differ
diff --git a/doc/docportal/images/android/fs-root.png b/doc/docportal/images/android/fs-root.png
index 86d75fd802c..cebee848aed 100644
Binary files a/doc/docportal/images/android/fs-root.png and b/doc/docportal/images/android/fs-root.png differ
Commit: 5fb01f0a6bdf9a8cea1f08a73df4d7d9f2508a31
https://github.com/scummvm/scummvm/commit/5fb01f0a6bdf9a8cea1f08a73df4d7d9f2508a31
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
DOCS: amends Android docs to align with GUI help
Changed paths:
doc/docportal/other_platforms/android.rst
diff --git a/doc/docportal/other_platforms/android.rst b/doc/docportal/other_platforms/android.rst
index a04efb69729..8ac1cf0dc6e 100644
--- a/doc/docportal/other_platforms/android.rst
+++ b/doc/docportal/other_platforms/android.rst
@@ -68,35 +68,32 @@ Adding games
Root folder with <Add a new folder> option
-3. Select **<Add a new folder>**, browse your device, and select the parent folder for your games subfolders. For example, **SD Card > ScummVMgames**. Select **Use this folder**.
+3. Double-tap **<Add a new folder>**. In your device's file browser, navigate to the folder containing all your game folders. For example, **SD Card > ScummVMgames**
.. figure:: ../images/android/fs-root.png
- :width: 300 px
Android file browser root
.. figure:: ../images/android/fs-folder.png
- :width: 300 px
Android file browser selectable folder with **Use this folder** button
-
-4. Select **ALLOW** to grant ScummVM access to the content of the folder.
+4. Select **Use this folder**.
+5. Select **ALLOW** to give ScummVM permission to access the folder.
.. figure:: ../images/android/fs-permission.png
- :width: 300 px
Android file browser request to grant ScummVM directory access permission
-5. In the ScummVM file browser, double-tap to on the added folder to browse through the subfolders. Add a game by selecting the subfolder containing the game files.
+6. In the ScummVM file browser, double-tap to browse through your added folder. Add a game by selecting the sub-folder containing the game files, then tap **Choose**.
-Step 2, 3 and 4 are done only once. To add more games, repeat Steps 1 and 5.
+To add more games, repeat Steps 1 and 6.
.. _addSAFpath:
.. note::
Starting with version 2.7.0 of ScummVM for Android, significant changes were made to the file access system to allow support for modern versions of the Android Operating System.
- If existing added games or custom paths no longer work, go to **Game Options > Paths**, select the path to update, then follow steps 2 through 5 above.
+ If existing added games or custom paths no longer work, go to **Game Options > Paths**, select the path to update, then follow steps 2 through 6 above.
Removing permissions
************************
Commit: ca2fa723e32e1cd4feb1320853b1227665168a90
https://github.com/scummvm/scummvm/commit/ca2fa723e32e1cd4feb1320853b1227665168a90
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
BASE: updates SAF popup to align with GUI help
Changed paths:
base/main.cpp
diff --git a/base/main.cpp b/base/main.cpp
index d891e8db322..c7aca3ee4c8 100644
--- a/base/main.cpp
+++ b/base/main.cpp
@@ -647,25 +647,24 @@ extern "C" int scummvm_main(int argc, const char * const argv[]) {
if (!ConfMan.getGameDomains().empty()) {
GUI::MessageDialog alert(_(
// I18N: <Add a new folder> must match the translation done in backends/fs/android/android-saf-fs.h
- "In this new version of ScummVM Android, significant changes were made to "
+ "In this new version of ScummVM for Android, significant changes were made to "
"the file access system to allow support for modern versions of the Android "
"Operating System.\n"
"If you find that your existing added games or custom paths no longer work, "
- "please edit those paths and this time use the SAF system to browse to the "
- "desired locations.\n"
- "To do that:\n"
+ "please edit those paths:"
"\n"
- " 1. For each game whose data is not found, go to the \"Paths\" tab in "
- "the \"Game Options\" and change the \"Game path\"\n"
- " 2. Inside the ScummVM file browser, use \"Go Up\" until you reach "
- "the \"root\" folder where you will see the \"<Add a new folder>\" option.\n"
- " 3. Choose that, then browse and select the \"parent\" folder for your "
- "games subfolders, e.g. \"SD Card > myGames\". Click on \"Use this folder\".\n"
- " 4. Then, a new folder \"myGames\" will appear on the \"root\" folder "
- "of the ScummVM browser.\n"
- " 5. Browse through this folder to your game data.\n"
+ " 1. From the Launcher, go to **Game Options > Paths**."
+ " Select **Game Path** or **Extra Path**, as appropriate. \n"
+ " 2. Inside the ScummVM file browser, select **Go Up** until you reach the root folder"
+ "which has the **<Add a new folder>** option.\n"
+ " 3. Double-tap **<Add a new folder>**. In your device's file browser, navigate to the folder"
+ "containing all your game folders. For example, **SD Card > ScummVMgames** \n"
+ " 4. Select **Use this folder**. \n"
+ " 5. Select **Allow** to give ScummVM permission to access the folder. \n"
+ " 6. In the ScummVM file browser, double-tap to browse through your added folder."
+ "Select the folder containing the game's files, then tap **Choose**. \n"
"\n"
- "Steps 2 and 3 need to be done only once for all of your games."
+ "Repeat steps 1 and 6 for each game."
), _("Ok"),
// I18N: A button caption to dismiss amessage and read it later
_("Read Later"), Graphics::kTextAlignLeft);
@@ -675,18 +674,22 @@ extern "C" int scummvm_main(int argc, const char * const argv[]) {
} else {
GUI::MessageDialog alert(_(
// I18N: <Add a new folder> must match the translation done in backends/fs/android/android-saf-fs.h
- "In this new version of ScummVM Android, significant changes were made to "
+ "In this new version of ScummVM for Android, significant changes were made to "
"the file access system to allow support for modern versions of the Android "
"Operating System.\n"
- "Thus, you need to set up SAF in order to be able to add the games.\n"
+ "To add a game:\n"
"\n"
- " 1. Inside the ScummVM file browser, use \"Go Up\" until you reach "
- "the \"root\" folder where you will see the \"<Add a new folder>\" option.\n"
- " 2. Choose that, then browse and select the \"parent\" folder for your "
- "games subfolders, e.g. \"SD Card > myGames\". Click on \"Use this folder\".\n"
- " 3. Then, a new folder \"myGames\" will appear on the \"root\" folder "
- "of the ScummVM browser.\n"
- " 4. Browse through this folder to your game data."
+ " 1. Select **Add Game...** from the launcher. \n"
+ " 2. Inside the ScummVM file browser, select **Go Up** until you reach the root folder"
+ "which has the **<Add a new folder>** option.\n"
+ " 3. Double-tap **<Add a new folder>**. In your device's file browser, navigate to the folder"
+ "containing all your game folders. For example, **SD Card > ScummVMgames** \n"
+ " 4. Select **Use this folder**. \n"
+ " 5. Select **Allow** to give ScummVM permission to access the folder. \n"
+ " 6. In the ScummVM file browser, double-tap to browse through your added folder."
+ "Select the sub-folder containing the game's files, then tap **Choose**."
+ "\n"
+ "Repeat steps 1 and 6 for each game."
), _("Ok"),
// I18N: A button caption to dismiss a message and read it later
_("Read Later"), Graphics::kTextAlignLeft);
Commit: 7e41bec7f0c79bfef6f770acc2303980ed24e097
https://github.com/scummvm/scummvm/commit/7e41bec7f0c79bfef6f770acc2303980ed24e097
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
BACKENDS: ANDROID: minor edit to Help tab contents
Changed paths:
backends/platform/android/android.cpp
diff --git a/backends/platform/android/android.cpp b/backends/platform/android/android.cpp
index 2b2024153b2..049921fb167 100644
--- a/backends/platform/android/android.cpp
+++ b/backends/platform/android/android.cpp
@@ -1103,11 +1103,11 @@ _s(
"\n"
" ![OS selectable folder](fs-folder.png \"OS selectable folder\")\n"
"\n"
-"5. Select **Allow** to give ScummVM permission to access the folder. \n"
+"5. Select **ALLOW** to give ScummVM permission to access the folder. \n"
"\n"
" ![OS access permission dialog](fs-permission.png \"OS access permission\")\n"
"\n"
-"6. In the ScummVM file browser, double-tap to browse through your added folder. Add a game by selecting the sub-folder containing the game files. \n"
+"6. In the ScummVM file browser, double-tap to browse through your added folder. Add a game by selecting the sub-folder containing the game files, then tap **Choose**. \n"
"\n"
" ![SAF folder added](browser-folder-in-list.png \"SAF folder added\")\n"
"\n"
Commit: d723f75797ee616805cb95007e80eaef553f16f1
https://github.com/scummvm/scummvm/commit/d723f75797ee616805cb95007e80eaef553f16f1
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
DOCS: moves .yaml config to fix readthedocs builds
Changed paths:
A .readthedocs.yaml
R doc/docportal/.readthedocs.yaml
diff --git a/doc/docportal/.readthedocs.yaml b/.readthedocs.yaml
similarity index 100%
rename from doc/docportal/.readthedocs.yaml
rename to .readthedocs.yaml
Commit: 85ba85df69e7ea3906583199778a0ca98b2b5c8d
https://github.com/scummvm/scummvm/commit/85ba85df69e7ea3906583199778a0ca98b2b5c8d
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
DOCS: updates config file to fix doc builds
Changed paths:
A doc/docportal/.readthedocs.yaml
diff --git a/doc/docportal/.readthedocs.yaml b/doc/docportal/.readthedocs.yaml
new file mode 100644
index 00000000000..8c8ad338774
--- /dev/null
+++ b/doc/docportal/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: 2
+
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.10.8"
+
+sphinx:
+ configuration: docportal/conf.py
+
+python:
+ install:
+ - requirements: docportal/requirements.txt
\ No newline at end of file
Commit: f3d2d90b376da8b0f91d276409b5e21071547551
https://github.com/scummvm/scummvm/commit/f3d2d90b376da8b0f91d276409b5e21071547551
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
DOCS: corrects readthedocs config file
Changed paths:
R doc/docportal/.readthedocs.yaml
.readthedocs.yaml
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 1ddf2735dab..8c8ad338774 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,6 +1,7 @@
version: 2
build:
+ os: ubuntu-22.04
tools:
python: "3.10.8"
diff --git a/doc/docportal/.readthedocs.yaml b/doc/docportal/.readthedocs.yaml
deleted file mode 100644
index 8c8ad338774..00000000000
--- a/doc/docportal/.readthedocs.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-version: 2
-
-build:
- os: ubuntu-22.04
- tools:
- python: "3.10.8"
-
-sphinx:
- configuration: docportal/conf.py
-
-python:
- install:
- - requirements: docportal/requirements.txt
\ No newline at end of file
Commit: a6bf0df585b2c6c63d842cae50d4900a8caa1501
https://github.com/scummvm/scummvm/commit/a6bf0df585b2c6c63d842cae50d4900a8caa1501
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
DOCS: updates readthedocs config file
- sets python version to 3.10
Changed paths:
.readthedocs.yaml
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 8c8ad338774..56e867463a1 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -3,7 +3,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
- python: "3.10.8"
+ python: "3.10"
sphinx:
configuration: docportal/conf.py
Commit: 6b65e27484238bb11d1fdd06d25962cc82fa423d
https://github.com/scummvm/scummvm/commit/6b65e27484238bb11d1fdd06d25962cc82fa423d
Author: CadiH (cadihowley at gmail.com)
Date: 2023-10-06T22:24:55+02:00
Commit Message:
DOCS: fixes readthedocs config file paths
Changed paths:
.readthedocs.yaml
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 56e867463a1..bf3fd666694 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -6,8 +6,8 @@ build:
python: "3.10"
sphinx:
- configuration: docportal/conf.py
+ configuration: doc/docportal/conf.py
python:
install:
- - requirements: docportal/requirements.txt
\ No newline at end of file
+ - requirements: doc/docportal/requirements.txt
\ No newline at end of file
More information about the Scummvm-git-logs
mailing list