Skip to content

Latest commit

 

History

History
74 lines (67 loc) · 4.28 KB

README.md

File metadata and controls

74 lines (67 loc) · 4.28 KB
Raw

Foundry VTT Forge Installs The Latest Version Downloads

Image-Hover (https://foundryvtt.com/packages/image-hover/)

  • Author: Eriku#2108 (Discord)
  • Version: 3.0.1
  • Foundry VTT Compatibility:
    • Foundry v10 - Latest release.
    • Foundry v9 - 2.0.6.
    • Before Foundry v9 - 1.1.8.
  • System Compatibility: All systems.

Installation

To install, search for Image Hover in the module list or follow these instructions:

  1. Inside Foundry, select the Game Modules tab in the Configuration and Setup menu.
  2. Click the Install Module button and enter the following URL:
    https://github.com/Eriku33/Foundry-VTT-Image-Hover/releases/latest/download/module.json.

Description

A module built on top of the Foundry Virtual Tabletop API that allows users to hover over actor tokens and see the character art. User must be on the token layer to see the character art, if no character art exists (default icon), token art is used instead.
Image hover also supports animated file types that Foundry allows.

image-hover-animation-example

Settings

preview

Required actor permission

Setting for game masters to configure the required actor ownership to see character art.
Default: None - All users can hover over any token and see art.

Art on hover

Choose the type of artwork shown for tokens when hovered.
Default: Character art

Character art - Character art when possible.
Token art - Token art only.
Token art if wildcard - Token art if actor is wildcard(random image), otherwise character art.
Token art if unlinked - Character art for linked tokens only, otherwise token art.

Show all users art duration (Game master only)

The time (milliseconds) art is shown to all users when the "show all users art" key bind is pressed when hovering over a token.
User must be on the same scene and have Image Hover enabled.
The required actor permissions and hide art for specific token will be ignored.
Default: 6000 (6 seconds).

Enable/Disable Image Hover

Each user can disable the module.
Default: Enabled

Position of Image

Each user can relocate the character art to a different corner of the screen (Bottom left/right , Top left/right and Centre)
Default: Bottom Left

Image to monitor width

Each user can configure the size of the image based on the width of their monitor.
Default: 7 - Image will take up 1⁄7th of your screen.

Mouse hover time requirement

Each user can add a hover time (milliseconds) requirement before image shows up.
Default: 0.

Set a keybind to show all users art (Game master only)

Game masters can set a key bind to show all other users artwork.
Users must be on the same scene and have Image Hover enabled.
The duration that this art appears can be changed in the game masters module settings.

Set a keybind requirement while hovering a token

If a keybind is set in Game settings -> Configure controls,
that key will be required to be pressed while hovering over a token to see the art (Mouse hover time requirement will be set to 0).
If no keybind is set, art will be shown on token hover.

Token Configuration Settings

image-hover-settings-example

Hide image hover art (Game master only)

If Hide Image Hover Art checkbox is checked, art will not be shown to anyone on hover for that token.
Default: Unchecked

Specific image on hover (Game master only)

Use the file picker to select a specific image/video to show when users hover over the token.
Defaults to image set on Art on Hover setting.
Delete the text to remove image and revert to default.
Default: Unset (path/image.png)