[Scummvm-git-logs] scummvm master -> 000ef7a2a8905f5cbfbd2bde466e9c1007ec6705
sev-
noreply at scummvm.org
Mon Jul 6 08:07:36 UTC 2026
This automated email contains information about 2 new commits which have been
pushed to the 'scummvm' repo located at https://api.github.com/repos/scummvm/scummvm .
Summary:
9152bb6376 DOCS: Update Understanding the interface webpage
000ef7a2a8 DOCS: Update game file and launcher webpages
Commit: 9152bb6376a163b2717d4b90c317b5dbea38c20b
https://github.com/scummvm/scummvm/commit/9152bb6376a163b2717d4b90c317b5dbea38c20b
Author: Kartik Saxena (kartiksaxena2005 at gmail.com)
Date: 2026-07-06T10:07:30+02:00
Commit Message:
DOCS: Update Understanding the interface webpage
Changed paths:
A doc/docportal/images/Launcher/Game_Help_Window.png
A doc/docportal/images/Launcher/Help_built-in_reference_window.png
doc/docportal/images/Launcher/gmm.png
doc/docportal/images/Launcher/launcher_grid.png
doc/docportal/images/Launcher/launcher_list.png
doc/docportal/images/Launcher/launcher_list_group.png
doc/docportal/images/Launcher/launcher_popup.png
doc/docportal/use_scummvm/the_launcher.rst
diff --git a/doc/docportal/images/Launcher/Game_Help_Window.png b/doc/docportal/images/Launcher/Game_Help_Window.png
new file mode 100644
index 00000000000..fa5bf3a1ba7
Binary files /dev/null and b/doc/docportal/images/Launcher/Game_Help_Window.png differ
diff --git a/doc/docportal/images/Launcher/Help_built-in_reference_window.png b/doc/docportal/images/Launcher/Help_built-in_reference_window.png
new file mode 100644
index 00000000000..9719008faa6
Binary files /dev/null and b/doc/docportal/images/Launcher/Help_built-in_reference_window.png differ
diff --git a/doc/docportal/images/Launcher/gmm.png b/doc/docportal/images/Launcher/gmm.png
index cd8b479f95d..26a31516a55 100755
Binary files a/doc/docportal/images/Launcher/gmm.png and b/doc/docportal/images/Launcher/gmm.png differ
diff --git a/doc/docportal/images/Launcher/launcher_grid.png b/doc/docportal/images/Launcher/launcher_grid.png
index 10d7694c93d..eac6357e235 100755
Binary files a/doc/docportal/images/Launcher/launcher_grid.png and b/doc/docportal/images/Launcher/launcher_grid.png differ
diff --git a/doc/docportal/images/Launcher/launcher_list.png b/doc/docportal/images/Launcher/launcher_list.png
index 7d1af40b84b..79ca4f7b211 100755
Binary files a/doc/docportal/images/Launcher/launcher_list.png and b/doc/docportal/images/Launcher/launcher_list.png differ
diff --git a/doc/docportal/images/Launcher/launcher_list_group.png b/doc/docportal/images/Launcher/launcher_list_group.png
index 748039213a8..979482fbb86 100755
Binary files a/doc/docportal/images/Launcher/launcher_list_group.png and b/doc/docportal/images/Launcher/launcher_list_group.png differ
diff --git a/doc/docportal/images/Launcher/launcher_popup.png b/doc/docportal/images/Launcher/launcher_popup.png
index b6add32f0ae..8708db9a12b 100755
Binary files a/doc/docportal/images/Launcher/launcher_popup.png and b/doc/docportal/images/Launcher/launcher_popup.png differ
diff --git a/doc/docportal/use_scummvm/the_launcher.rst b/doc/docportal/use_scummvm/the_launcher.rst
index 8e90352be2c..e33d55a29ec 100755
--- a/doc/docportal/use_scummvm/the_launcher.rst
+++ b/doc/docportal/use_scummvm/the_launcher.rst
@@ -21,7 +21,7 @@ The games list
The pane on the left, when the Launcher is in list view, shows the games list, which shows 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.
-In grid view, all game icons are in the pane below the buttons, and show the game artwork. See :ref:`Update Icons <updateicons>` for information on how to update these. Use the **Icons per row** slider at the bottom of the page to change the size of the icons. Click on a game to select it. Click on the play icon in the pop-up menu to start the game, the gear icon to open the Game Options menu, or the export icon to load a saved game.
+In grid view, all game icons are in the pane above the buttons, and show the game artwork. See :ref:`Update Icons <updateicons>` for information on how to update these. Use the **Icons per row** slider at the bottom of the page to change the size of the icons. Click on a game to select it. Click on the play icon in the pop-up menu to start the game, the gear icon to open the Game Options menu, or the export icon to load a saved game.
.. figure:: ../images/Launcher/launcher_popup.png
@@ -42,7 +42,7 @@ The grouping menu
.. _group:
-To the right of the search box is the grouping menu. Use this menu to group games in alphabetical order, or by engine, series, publisher, language or platform. Hide or show groups of games by clicking on the black arrow to the left of each group heading.
+To the right of the search box is the grouping menu. Use this menu to group games in alphabetical order, or by engine, series, publisher, language, platform or year. Hide or show groups of games by clicking on the black arrow to the left of each group heading.
.. figure:: ../images/Launcher/launcher_list_group.png
@@ -52,7 +52,7 @@ To the right of the search box is the grouping menu. Use this menu to group game
The buttons
************************
-To the right of the games list in list view, or above the games list in grid view, there are a number of buttons. Their functions are as follows:
+To the right of the games list in list view, or below the games list in grid view, there are a number of buttons. Their functions are as follows:
Start (list view only)
^^^^^^^^^^^^^^^^^^^^^^^
@@ -91,6 +91,22 @@ Global 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.
+Help
+^^^^
+Clicking this button (or the **?** icon in the top left corner) opens a built-in reference window containing several tabs to assist users directly within the Launcher.
+
+.. figure:: ../images/Launcher/help_built-in_reference_window.png
+
+ The Built-in reference window after clicking Help or ? on Windows.
+
+* **General:** Provides a brief overview of what ScummVM is and provides links to resources for legally obtaining supported games.
+* **Cloud:** Displays step-by-step visual instructions for connecting ScummVM to cloud storage services.
+* **Keyboard:** Lists a comprehensive table of default keyboard shortcuts for controlling the engine, display, and audio.
+
+.. note::
+
+ Depending on your platform, there could be additional tabs with platform-specific support information.
+
About
^^^^^^^^^^
Shows credits and miscellaneous information about ScummVM.
@@ -134,16 +150,23 @@ Options
Opens a dialog which provides some gameplay options, such as sound volume, subtitle and keymap settings.
+Game Help
+^^^^^^^^^
-About
-^^^^^^^^^^^
+Display game-specific help if any, usually the keyboard shortcuts. Note that this is not available for all games; refer to the :doc:`../settings/keymaps` tab for keyboard shortcuts.
-Displays the ScummVM **About** dialog. This is also available from the Launcher.
+.. figure:: ../images/Launcher/game_help_window.png
+
+ The Game Help pop-up Window.
Help
-^^^^^^
+^^^^
+Opens a built-in reference window. This functions exactly like the Help button in the main Launcher.
-Displays a list of keyboard shortcuts for the game. Note that this is not available for all games; refer to the :doc:`../settings/keymaps` tab for keyboard shortcuts.
+About
+^^^^^^^^^^^
+
+Displays the ScummVM **About** dialog. This is also available from the Launcher.
Return to Launcher
^^^^^^^^^^^^^^^^^^^^^
Commit: 000ef7a2a8905f5cbfbd2bde466e9c1007ec6705
https://github.com/scummvm/scummvm/commit/000ef7a2a8905f5cbfbd2bde466e9c1007ec6705
Author: Kartik Saxena (kartiksaxena2005 at gmail.com)
Date: 2026-07-06T10:07:30+02:00
Commit Message:
DOCS: Update game file and launcher webpages
Updated the following documentation pages:
- Handling game files
- Handling Macintosh game files
- Adding and playing a game
Changed paths:
A doc/docportal/images/Launcher/multi_select.png
doc/docportal/images/Launcher/add_game.png
doc/docportal/images/Launcher/choose_game_directory.png
doc/docportal/images/Launcher/choose_version.png
doc/docportal/images/Launcher/game_settings.png
doc/docportal/images/Launcher/mass_add.png
doc/docportal/images/Launcher/mass_add_confirm.png
doc/docportal/images/Launcher/mass_add_success.png
doc/docportal/images/Launcher/start_game.png
doc/docportal/use_scummvm/add_play_games.rst
doc/docportal/use_scummvm/game_files.rst
doc/docportal/use_scummvm/mac_game_files.rst
diff --git a/doc/docportal/images/Launcher/add_game.png b/doc/docportal/images/Launcher/add_game.png
index 56189ad6a20..bbb8d53a9d6 100755
Binary files a/doc/docportal/images/Launcher/add_game.png and b/doc/docportal/images/Launcher/add_game.png differ
diff --git a/doc/docportal/images/Launcher/choose_game_directory.png b/doc/docportal/images/Launcher/choose_game_directory.png
index 4187a3e9850..bc1c3fd7ee5 100755
Binary files a/doc/docportal/images/Launcher/choose_game_directory.png and b/doc/docportal/images/Launcher/choose_game_directory.png differ
diff --git a/doc/docportal/images/Launcher/choose_version.png b/doc/docportal/images/Launcher/choose_version.png
index 23e8a787570..f3cb4977159 100644
Binary files a/doc/docportal/images/Launcher/choose_version.png and b/doc/docportal/images/Launcher/choose_version.png differ
diff --git a/doc/docportal/images/Launcher/game_settings.png b/doc/docportal/images/Launcher/game_settings.png
index 4e6f15e91b6..7d267137c79 100755
Binary files a/doc/docportal/images/Launcher/game_settings.png and b/doc/docportal/images/Launcher/game_settings.png differ
diff --git a/doc/docportal/images/Launcher/mass_add.png b/doc/docportal/images/Launcher/mass_add.png
index 23f834a5e09..27827d83b13 100755
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
index fea201e1169..cda2397a49b 100755
Binary files a/doc/docportal/images/Launcher/mass_add_confirm.png 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
index 4054e06ecff..4fdb11fb618 100755
Binary files a/doc/docportal/images/Launcher/mass_add_success.png and b/doc/docportal/images/Launcher/mass_add_success.png differ
diff --git a/doc/docportal/images/Launcher/multi_select.png b/doc/docportal/images/Launcher/multi_select.png
new file mode 100644
index 00000000000..b694c498a8e
Binary files /dev/null and b/doc/docportal/images/Launcher/multi_select.png differ
diff --git a/doc/docportal/images/Launcher/start_game.png b/doc/docportal/images/Launcher/start_game.png
index 371d0678a7e..79e18558fc9 100755
Binary files a/doc/docportal/images/Launcher/start_game.png and b/doc/docportal/images/Launcher/start_game.png differ
diff --git a/doc/docportal/use_scummvm/add_play_games.rst b/doc/docportal/use_scummvm/add_play_games.rst
index 82c5f4129b6..06b6a22ed78 100644
--- a/doc/docportal/use_scummvm/add_play_games.rst
+++ b/doc/docportal/use_scummvm/add_play_games.rst
@@ -28,54 +28,56 @@ The following steps explain how to add a game to ScummVM, and assume you have ac
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
+ .. figure:: ../images/Launcher/add_game.png
-To add multiple games at once, click the expander arrow next to **Add Game**, and select **Mass Add**.
+ To add multiple games at once, click the expander arrow next to **Add Game**, and select **Mass Add**.
-.. image:: ../images/Launcher/mass_add.png
+ .. figure:: ../images/Launcher/mass_add.png
3. Use the file browser to locate the folder containing the game data files. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Highlight the folder by clicking on it, and then click **Choose**
-.. image:: ../images/Launcher/choose_game_directory.png
- :class: with-shadow
+ .. figure:: ../images/Launcher/choose_game_directory.png
-.. note::
+ .. note::
- The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the system file browser, or its own file browser.
+ The **Use native system file browser** option in the :doc:`GUI <../settings/gui>` tab of the global settings controls whether ScummVM uses the system file browser, or its own file browser.
-If you are using **Mass Add**, select **Yes** to run the mass game detector. A dialog opens to advise which games were added to the games list.
+ 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
+ .. figure:: ../images/Launcher/mass_add_confirm.png
-.. image:: ../images/Launcher/mass_add_success.png
+ .. figure:: ../images/Launcher/mass_add_success.png
-Sometimes, ScummVM detects multiple versions of a single game. In this case, highlight the correct version and click **Choose** to continue.
+ Sometimes, ScummVM detects multiple versions of a single game. In this case, highlight the correct version and click **Choose** to continue.
-.. figure:: ../images/Launcher/choose_version.png
+ .. figure:: ../images/Launcher/choose_version.png
-.. caution::
+ .. caution::
- If you are using **Mass Add**, ScummVM adds all versions of a game.
+ If you are using **Mass Add**, ScummVM adds all versions of a game.
-If you are adding an unknown version of a game, ScummVM is not able to add the game to the games list. An error message appears to warn you that the game has not been added.
+ If you are 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 **Game Options** window 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
+ .. figure:: ../images/Launcher/game_settings.png
-.. note::
+ .. note::
- The **Game Options** window does not open when **Mass Add** is used.
+ The **Game Options** window does not open when **Mass Add** is used.
5. Games are now ready to play! To play, either double-click on the game in the games list, or highlight the game by clicking on it, and then click **Start**. In grid view, either double-click on a game to start it, or select the game and click the play icon in the pop-up window.
-.. image:: ../images/Launcher/start_game.png
- :class: with-shadow
+ .. figure:: ../images/Launcher/start_game.png
-Games can also be launched directly from the command line. For more information, see the `Command line options <../advanced_topics/command_line>`_ page.
+Games can also be launched directly from the command line. For more information, see the :doc:`Command line interface <../advanced_topics/command_line>` page.
+.. tip::
+ You can now use standard multiselect commands (like holding ``Ctrl`` or ``Shift`` while clicking) to select multiple games in the launcher list at once. This is especially useful if you want to use the **Remove Game** button to quickly clear several games from your list simultaneously!
+
+ .. figure:: ../images/Launcher/multi_select.png
+
A note about copyright
==============================
diff --git a/doc/docportal/use_scummvm/game_files.rst b/doc/docportal/use_scummvm/game_files.rst
index 3f3e2c2d30a..467143d2e4f 100644
--- a/doc/docportal/use_scummvm/game_files.rst
+++ b/doc/docportal/use_scummvm/game_files.rst
@@ -7,7 +7,7 @@ ScummVM needs access to the data files for each game. A list of required data fi
.. 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::
+ For ease of use, you can create a dedicated games folder into which the folders containing game files can be copied. The resulting directory structure will look somewhat like this::
ScummVM Games
|-- Day of the Tentacle
@@ -20,11 +20,17 @@ ScummVM needs access to the data files for each game. A list of required data fi
-For games on floppies or CDs, if the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above. If the data files are not accessible, run the installer on the platform the game was designed for, to extract the game files.
+For games on floppies or CDs, if the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above.
-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.
+**Working with installers and archives**
-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.
+For many modern engines, ScummVM can now load game data directly from the original installer files or tape images (such as ZX Spectrum TAP/TZX files) without requiring manual extraction.
+
+If your specific game engine does not support this yet, or the data files are otherwise inaccessible, you will need to extract them:
+
+* Run the installer on the platform the game was designed for.
+* 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, 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::
diff --git a/doc/docportal/use_scummvm/mac_game_files.rst b/doc/docportal/use_scummvm/mac_game_files.rst
index 5a7a04a43e3..c8125ae14a7 100644
--- a/doc/docportal/use_scummvm/mac_game_files.rst
+++ b/doc/docportal/use_scummvm/mac_game_files.rst
@@ -30,7 +30,7 @@ Filenames in Japanese games are encoded in a way that is unique to Apple. The re
Macintosh also allowed special characters to be used that are disallowed in filenames on other platforms.
-ScummVM runs on a wide variety of platforms and not all those platforms can store Japanese filenames or other special characters, such as non-ascii characters. ScummVM uses `punycode <https://en.wikipedia.org/wiki/Punycode>`_ to handle file names that would otherwise not be supported. Punycode converts all non-ascii characters to a special format. If the original file name had special characters, the new file name will start with ``xn--``,for example, ``xn--Icon-ja6e``.
+ScummVM runs on a wide variety of platforms and not all those platforms can store Japanese filenames or other special characters, such as non-ascii characters. ScummVM uses `punycode <https://en.wikipedia.org/wiki/Punycode>`_ to handle file names that would otherwise not be supported. Punycode converts all non-ascii characters to a special format. If the original file name had special characters, the new file name will start with ``xn--``, for example, ``xn--Icon-ja6e``.
Files that contain prohibited characters are always puny-encoded.
@@ -77,7 +77,7 @@ Creating the ISO image
Unmount the disk if needed:
- By default disks are mounted when they are inserted, and they need to be unmounted so that you can create the ISO file.
- - HFS is no longer supported on macOS 10.15 and above, therefore those disk cannot be mounted and do not need to be unmounted.
+ - HFS is no longer supported on macOS 10.15 and above, therefore those disks cannot be mounted and do not need to be unmounted.
.. code-block::
@@ -260,7 +260,7 @@ This mode is specific to macOS. It will traverse a directory, find all the resou
Options:
-* ``--punyencode``: encodes all filename characters as punycode, select this when your platform doesn't support UTF-8 filenames
+* ``--punycode``: encodes all filename characters as punycode, select this when your platform doesn't support UTF-8 filenames
.. note::
@@ -314,7 +314,7 @@ There are other ways to access HFS and HFS+ media on Windows, macOS, and Linux.
1. Install hfsutils using the software manager. On Debian-based distributions, use ``sudo apt install hfsutils``.
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. Mount the HFS volume by running ``hmount /dev/fd0``
- 4. List the files and directories on the HFS media using ``hls``, change the working directory on the HFS media using ``hcd`` and copy files using ``hcopy``. The ``hcopy`` commands take options to indicate if the files should be converted to macbinary (``-m``) or copied as a raw file (``-r``). For example ``hcopy -m "PP Disk 1:PP Data:JMP PP Resources" "pegasus/JMP PP Resources"``.
+ 4. List the files and directories on the HFS media using ``hls``, change the working directory on the HFS media using ``hcd`` and copy files using ``hcopy``. The ``hcopy`` command takes options to indicate if the files should be converted to macbinary (``-m``) or copied as a raw file (``-r``). For example ``hcopy -m "PP Disk 1:PP Data:JMP PP Resources" "pegasus/JMP PP Resources"``.
5. Unmount the HFS media with ``humount /dev/fd0``
More information about the Scummvm-git-logs
mailing list