DOCS: adds taskbar integration page

This commit is contained in:
cadihowley
2021-04-25 11:17:28 +12:00
committed by Cadi
parent 08fa2de581
commit 562deba7de
4 changed files with 48 additions and 5 deletions
@@ -246,11 +246,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,
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 <id>`.xxx
- engineid-gameid.xxx"
":ref:`iconspath <iconspath>`",string,,
":ref:`improved <improved>`",boolean,true,
":ref:`InvObjectsAnimated <objanimated>`",boolean,true,
":ref:`joystick_deadzone <deadzone>`",integer, 3
Binary file not shown.

After

Width:  |  Height:  |  Size: 159 KiB

+1
View File
@@ -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
@@ -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 <https://github.com/scummvm/scummvm-icons>`__.
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 <extra>` 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 <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.