Skip to content

Custom Icons

Material Foundry edited this page May 24, 2023 · 3 revisions

While many actions can automatically assign icons to the Stream Deck buttons, you might want to customize them. There are multiple ways to change the default icons:

Icon Override (preferred)

Each action has an 'Icon Override' option. By filling in the path to the preferred icon, you tell the module to use that icon. Changing the icon this way still allows the module to add a border (for example as a selection indicator), overlay data (such as a HP box) or set the background color. Leaving this field blank will let the module use the default icon.

Uploading Icons & Finding the Path

  1. Open the built-in image browser using, for example, one of these methods:
    1. Open a character sheet and double click the actor icon
    2. Open the token configuration for any token, go to the 'Appearance' tab and click the 'Browse Files' button to the right of 'Image Path'
    3. Open the scene configuration for any scene and click the 'Browse Files' button to the right of 'Background Image' or 'Foreground Image'
  2. Browse to the file location
  3. (Optionally) Upload a new file at the bottom using the 'Choose file' button
  4. Select the image you want the path to
  5. The path can be found at the bottom in the 'Selected' field, copy this into the 'Icon Override' field in the Stream Deck application

In the Stream Deck App

You can set the icon for a button by pressing the downward arrow on the icon box in the left part of the property inspector, or by right clicking the icon box. You'll have the option to set the icon from a file, creating a new icon (which redirects you to the Stream Deck Key Creator, or setting it back to the default icon. If you choose to change the icon this way, the module loses any control over it. This means that it cannot add a (selection) border, overlay any data or change the background color.

Changing the Default Icons

Various actions have default icons assigned to them (such as the 'Playlist'action, when set to 'Stop All'). Besides changing the icon on a button-by-button basis, as described above, you can change the default icon. The icons are stored in the module folder on your Foundry server:
[path to foundry data folder]/Data/modules/MaterialDeck/img
These can be replaced by your own icons, simply make sure the format and name are the same.
Using this method, not all default icons can be changed, since some of them are retrieved from Foundry, such as icons for conditions.

How to get icons

You can basically source the icons from everywhere using. It's preferable if you use a format that allows for transpirancy, such as png or webp, but you can also use jpg and svg.

You can grab icons from Foundry (on Windows):
C:/Program Files/FoundryVTT/resources/app/public/icons

From your game system (example for dnd5e):
[path to foundry data folder]/Data/systems/dnd5e/icons

From icon packs:
https://www.thoughtasylum.com/2020/01/12/stream-deck-icons/
https://nerdordie.com/resources/free-stream-deck-icon-pack/
https://streamsentials.com/stream-deck-icons/
https://visualsbyimpulse.com/store/champion-streamdeck-icons

How to create icons

You can of course create icons using paint or photoshop, but there are also some icon creator sites/apps:
https://www.elgato.com/en/gaming/keycreator
https://www.thoughtasylum.com/2020/12/24/stream-deck-icon-generator/ (MacOS only)
Or using paint, photoshop, etc.