diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst index a4f31732848..92817b995bc 100755 --- a/doc/docportal/advanced_topics/configuration_file.rst +++ b/doc/docportal/advanced_topics/configuration_file.rst @@ -246,11 +246,7 @@ There are many recognized configuration keys. In the table below, each key is ei ":ref:`herculesfont `",boolean,false, ":ref:`hpbargraphs `",boolean,true, ":ref:`hypercheat `",boolean,false, - iconspath,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 file must be an ICO file for Windows, or a PNG file for macOS. It must follow one of these naming conventions, where xxx is the file extension: - - - gameid.xxx - - :ref:`ID `.xxx - - engineid-gameid.xxx" + ":ref:`iconspath `",string,, ":ref:`improved `",boolean,true, ":ref:`InvObjectsAnimated `",boolean,true, ":ref:`joystick_deadzone `",integer, 3 diff --git a/doc/docportal/images/taskbar/game_icon.png b/doc/docportal/images/taskbar/game_icon.png new file mode 100644 index 00000000000..cf20c66dfe7 Binary files /dev/null and b/doc/docportal/images/taskbar/game_icon.png differ diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst index 5bd913940c9..cb6b475026b 100644 --- a/doc/docportal/index.rst +++ b/doc/docportal/index.rst @@ -10,6 +10,7 @@ use_scummvm/add_play_games use_scummvm/save_load_games use_scummvm/keyboard_shortcuts + use_scummvm/taskbar_integration use_scummvm/how_to_settings use_scummvm/connect_cloud use_scummvm/LAN diff --git a/doc/docportal/use_scummvm/taskbar_integration.rst b/doc/docportal/use_scummvm/taskbar_integration.rst new file mode 100644 index 00000000000..74a63905d53 --- /dev/null +++ b/doc/docportal/use_scummvm/taskbar_integration.rst @@ -0,0 +1,46 @@ +=========================== +Taskbar integration +=========================== + +The taskbar integration has several features: + +- Adds an overlay icon in the taskbar/dock when running a game (Windows and macOS) +- Updates a list of recently played games that can be started from the taskbar/dock (Windows and macOS). +- Shows a progress bar when doing a mass add of games, and shows the number of games found at the end (Windows, macOS and Linux). +- Shows an error state in the taskbar if an error occurs when running a game (Windows only). + +.. _iconspath: + +Setting up the icon overlay +================================ + +Icons for many games can be found on our `Github repository `__. + +Place the icons in a folder, and either change the *iconspath* in the :doc:`configuration file <../advanced_topics/configuration_file>` to point to this folder, or add the folder to the :ref:`Extra Path ` on the Paths settings tab. + +The icon files must be ICO files for Windows, or PNG files for macOS. They must follow one of these naming conventions, where xxx is the file extension: + + - gameid.xxx + - :ref:`ID `.xxx + - engineid-gameid.xxx + +To find the gameid and the engineid, open the :doc:`configuration file <../advanced_topics/configuration_file>`. The gameid is the name of the game in square brackets. The game entry will be similar to this: + +.. code:: + + [lure] + description=Lure of the Temptress (VGA/DOS/English) + iconspath=/Users/user/games/icons + path=/Users/user/games/lure + engineid=lure + +.. figure:: ../images/taskbar/game_icon.png + + macOS dock with a custom icon overlay for Beneath a Steel Sky. + +Launching recently played games +======================================= + +To start a recently played game, right click on the ScummVM icon in the taskbar or dock, and select the game you want to play. + +