module

Token Variant Art

Endorsements
0
Installs
1.43%
Comments
0
Latest version1.12.2
Minimum Core0.7.7
Compatible Core0.8.9
Last updated1 week ago
Created5 months ago
Authors
Languages English
Systems Dnd5e
Project source Project URL
Report bugs Bug tracker URL

Token Variant Art

This module provides a pop-up window upon token creation which displays all the available variants of the token art it could find in the customizable list of directories.

art_select.mp4

 

The search is done using the Actor's name, and will ignore special characters, case, or spaces in the files

e.g.

  • 'Mage' will match: 09_mage.png, red-MAGE-64.png, mage-s_fire.jpg
  • 'Half-Red Dragon Veteran' will match: HalfRedDragonVeteran.png, hAlF_rEd_dRAgon-VETERAN.png

 

The only requirement is that the full name of the Actor is present in the file name. So the following would not match:

  • 'Mage' will NOT match: mag03.png, 09_ma_abc_ge.png

  • 'Half-Red Dragon Veteran' will NOT match RedDragon.png, HalfRedDragon.png

 

The Art Select screen can also be opened up from the Actor Sheet by right-clicking on the portrait or Token Configuration window's Image tab. A new button is added right next to the File Picker:

Art Select button

 

 

Settings

Variant art search paths

The directories that will be scanned for art can be set here. All of the sub-directories will be searched as well so feel free to organise your art as you wish.

Search Paths

The root of these paths is assumed to be Foundry VTT's local Data folder. The same folder where you would find your worlds, systems, and modules.

 

By default 'Token Variants' will attempt to search Caeora's Maps, Tokens, and Assets asset folder if installed.

 

To specify a path for a configured AWS S3 bucket you can use the following format: s3:{bucket-name}:{path}

 

For your ForgeVTT asset foler the format is this: https://assets.forge-vtt.com/{userId}/path/to/token/art

 

Filter Settings

"Filter Settings"

There are 3 types of searches. Portrait, Token, and General (Token+Portrait). Each of these searches can be configured with filters to exclude files that include or exclude certain text, or match some regular expression.

 

Token HUD Settings

A SubMenu with the following settings:

 

Enable Token HUD Button

Enables extra button in the Token HUD which brings up all of the found art in a small preview to the right:

"Keyword Search"

This art can be shared with players by right-clicking on the images, which makes them available in the Token HUD side menu without the need to enable the Enable Token HUD button for everyone setting. Shared artwork is indicated by a green arrow.

 

By default the side menu uses the token's name as the search criteria. However a custom search can be performed by right-clicking on the new Token HUD button while the side menu is open:

"Token Hud Search"

 

Display as image?

Controls whether the art in the preview is rendered as images or file names.

Opacity of token preview

Controls the opacity of the tokens in the preview before being hovered over.

 

Enable Token HUD button for everyone

If checked will allow all players to access the new Token HUD button.

 

Disable Caching

By default the module will search the directories defined in 'Variant art search paths' only when the world is loaded or when the module settings have changed. If new art is added while the world is still open it will not be found by the module. 'Disable Caching' will force the search to be performed every time a new actor is created at a significant cost to speed at which the art is displayed to the user.

 

Disable Automatic Popups

If checked will prevent automatic popups from being triggered upon Actor creation. The popup can still be brought up if Ctrl key is held while dragging the Token/Actor.

 

Filter by Monster (SRD)

Can be disabled if you want variant art to be retrieved for actors with names not found in Monster (SRD) list.

 

Search by Keyword

When enabled the art search will be done using both the Actor/Token full name as well as individual words within the name:

"Keyword Search"

Excluded Keywords

Words within this list will be excluded from the keywords search:

"Excluded Keywords"

 

Actor Directory Popup key

Controls the key used to trigger a popup when dragging an actor from the Actor Directory.

 

Display separate pop-ups for Portrait and Token art

When enabled the Art Select pop-up will be shown twice upon actor/token creation. Once for the portrait, and then again for the token art.

 

Match name to folder

When enabled all searches will be done both on the file names as well as the file paths:

e.g. 'Dragon' will match "token_art/dragons/red/avatar.png" as well as "tokens/monsters/RedDragon.png"

 

Subscribe
Notify of
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x