Token Note Hover

Features and Notes

The Token Note Hover module displays the note of a hovered-over token in a tooltip. Links, images and scrolling in the tooltip are supported.

The tooltip will not display if the note is empty or while the token is being dragged.

FoundryVTT Compatibility

• Token Note Hover 3.0.0 and above only run on FoundryVTT v13 and above.
• Token Note Hover 2.1.17 and below only run on FoundryVTT v12.

System Support

Token Note Hover 4.0.0 and above supports both API Hooks and Direct System Support to enable the hovered-over tooltip display.

Token Note Hover API

The Token Note Hover API provides a hook to display custom content. This allows systems and modules to inject content into the tooltip.

Hook tokenNoteHover.createContent

tokenNoteHover.createContent(
        actor,
        displayImages,
        contentMap)

Hook Parameters

• actor: the actor whose token is being hovered over
• displayImages: if images should be displayed
• contentMap: a map containing the HTML content to be displayed in the hovered note.

Example of Using the API to Display a Hovered Note

• Create a world using the Symbaroum system.
• Install and enable the Token Note Hover and World Scripter modules.
• In the World Scripter configuration dialog, paste the following code.

Hooks.on('tokenNoteHover.createContent', (actor, imageDisplay, contentMap) => { contentMap.content = `<p>${actor.system.notes}</p>` });

• Create some tokens, place them on a scene and add some text to the Notes field on their character sheet.
• A tooltip will display when the token is hovered over.

• Similar code can be added to any system to enable this functionality.
• Enriched HTML and other modules can be used for tooltip content. This example uses the GM Notes module with a link to an Foundry item.

Hooks.on('tokenNoteHover.createContent', (actor, imageDisplay, contentMap) => { 
    if( game.user.isGM && actor.flags['gm-notes']?.notes ) contentMap.content = contentMap.content+`<p>${actor.flags['gm-notes']?.notes}</p>` 
});

Modules and Systems Using the API

• GM Notes

Directly Supported Systems

Many systems are directly supported by Token Note Hover module. FoundryVTT v13 and above are supported.

• 3.5e for Foundry VTT
• Alien RPG
• Blades in the Dark
• Cairn
• Call of Cthulhu 7th edition
• Cosmere Roleplaying Game
• Custom System Builder
• Cypher System
• Daggerheart
• Das Schwarze Auge / The Dark Eye (5th Edition)
• Delta Green
• Dragonbane - Drakar och Demoner
• Draw Steel
• Dungeon Crawl Classics
• Dungeons & Dragons Fifth Edition
• Fallout: The Roleplaying Game
• Forbidden Lands
• GURPS 4th Edition Game Aid (Unofficial)
• Ironsworn/Starforged
• LANCER
• Level Up: Advanced 5th Edition
• Mutant Year Zero
• Old-School Essentials
• The One Ring 2nd Edition
• Pathfinder 1st Edition
• Pathfinder 2e
• Powered by the Apocalypse
• RuneQuest Glorantha
• Sandbox
• Savage Worlds Adventure Edition
• Shadowdark
• Shadowrun 5th Edition
• Simple Worldbuilding System
• Star Wars FFG system for Foundry VTT
• Starfinder 1st Edition
• Tormenta20
• Twodsix - Cepheus & Traveller
• Universal Tabletop System
• Warhammer 40,000 Roleplay: Imperium Maledictum
• Warhammer 40,000 Roleplay: Wrath & Glory
• Warhammer Fantasy Roleplay 4th Edition
• World of Darkness 20th edition
• World of Darkness 5e

Customization options

• Tooltip themes.
• Placement, display delay, display window size and font size customization.
• Note can appear adjacent to the token or in a corner of the screen.
• Enable/Disable notes for PCs and NPCs.
• Show/hide note images for tooltip display.
• Can require minimum token ownership level on notes for display.
• Display token title in tooltip.
• Hide/Display private notes.
• Show notes only when configured HotKey is pressed.

All settings, except for token ownership required are client-side only so each player can enable the features they need.

Contact

• Ironsworn/Starforged Discord Server - FoundryVTT Channel (jendave)
• FoundryVTT Discord Server - Module Discussion Channel (jendave)
• VOID Affiliate Network Discord Server - Game Hacks Channel (jendave)
• GitHub Repository
• Itch.io

Module Installation

To install the latest version of this module, search for Token Note Hover in the Add-On Modules tab of of the Foundry VTT game setup screen. Then click on Install.

Or use this URL and click on Install:

https://github.com/jendave/token-note-hover/releases/latest/download/module.json

To install the v12 version of this module, use this URL and click on Install:

https://github.com/jendave/token-note-hover/releases/download/2.1.17/module.json

Support

For questions, feature requests or bug reports, please open an issue.

Pull requests are welcome. Please include a reason for the request or create an issue before starting one.

Troubleshooting and Tips

• If the hover does not work or causes the sidebar to move unexpectedly try the following:
  • In the Configure Settings, uncheck the Hover Enabled box, save the settings, reload the screen, then re-check the Hover Enabled box.
  • Try uninstalling and re-installing the module.
• If the hovered note appears in the upper left corner unexpectedly:
  • Open Configure Settings, select Token Note Hover and re-save the settings.
• The Token Note will not display if the token is selected or showing a HUD.
  • This ensures the note does not display when the token is being used to show other attributes.
  • In the Configure Settings dialog, enable the Core setting checkbox for Left-Click to Release Objects to de-select objects easily.

Other Recommended Modules

• Zoom/Pan Options for Zoom Around Cursor setting.
  • Note that this and Lock View conflict with each other.
• Lock View to prevent zooming from affecting the tooltip placement.
  • Note that this and Zoom/Pan Options conflict with each other.
• Force Client Settings for forcing chosen settings for clients to the defaults provided by the GM.

Screenshots and Note Locations

3.5e for Foundry VTT

3.5e for Foundry VTT

Alien RPG

Alien RPG

Blades in the Dark

Blades in the Dark

Cairn

Cairn

Call of Cthulhu 7th edition

Call of Cthulhu 7th edition

Cosmere Roleplaying Game

Cosmere Roleplaying Game

Custom System Builder

Custom System Builder

Create a Template with these fields:

• Label: Notes
  • Component Type: Rich Text Area
  • Component key: notes
• Label: Private Notes
  • Component Type: Rich Text Area
  • Component key: privateNotes

Then in a Character Actor, use the Template with the following fields:

Cypher System

Cypher System

Daggerheart

Daggerheart

Das Schwarze Auge / The Dark Eye (5th Edition)

Das Schwarze Auge / The Dark Eye (5th Edition)

Delta Green

Delta Green

Dragonbane - Drakar och Demoner

Dragonbane - Drakar och Demoner

Draw Steel

Draw Steel

Dungeon Crawl Classics

Dungeon Crawl Classics

Dungeons & Dragons Fifth Edition

Dungeons & Dragons Fifth Edition

Fallout: The Roleplaying Game

Fallout: The Roleplaying Game

Forbidden Lands

Forbidden Lands

GURPS 4th Edition Game Aid (Unofficial)

GURPS 4th Edition Game Aid (Unofficial)

Ironsworn/Starforged

Ironsworn/Starforged

LANCER

LANCER

Level Up: Advanced 5th Edition

Level Up: Advanced 5th Edition

Mutant Year Zero

Mutant Year Zero

Old-School Essentials

Old-School Essentials

The One Ring 2nd Edition

The One Ring 2nd Edition

Pathfinder 1st Edition

Pathfinder 1

Pathfinder 2e

Pathfinder 2e

Powered by the Apocalypse

Powered by the Apocalpypse

RuneQuest Glorantha

RuneQuest Glorantha

Sandbox

Sandbox

Savage Worlds Adventure Edition

Savage Worlds Adventure Edition

Shadowdark

Shadowdark RPG

Shadowrun 5th Edition

Shadowrun 5th Edition

Simple Worldbuilding System

Simple Worldbuilding System

Star Wars FFG system

Star Wars FFG system for Foundry VTT

Starfinder 1st Edition

Starfinder 1st Edition

Tormenta20

Tormenta20

Twodsix - Cepheus & Traveller

Twodsix - Cepheus & Traveller

Universal Tabletop System

Universal Tabletop System

Warhammer 40,000 Roleplay: Imperium Maledictum

Warhammer 40,000 Roleplay: Imperium Maledictum

Warhammer 40,000 Roleplay: Wrath & Glory

Warhammer 40,000 Roleplay: Wrath & Glory

Warhammer Fantasy Roleplay 4th Edition

Warhammer Fantasy Roleplay 4th Edition

World of Darkness 20th edition

World of Darkness 20th edition

World of Darkness 5e

World of Darkness 5e (Archive)

World of Darkness 5e

Credits

Module by David Hudson and licensed for use under the GNU GPL license v3.

This project is based on Pin Cushion by 4535992.

Contributors

• Syrious - Level Up: Advanced 5th Edition system and code refactoring.
• DanButcher45 - Cairn system.
• bithr - API code.

FoundryVTT Modules and Other Resources

Please check out my other modules and resources for Ironsworn, Ironsworn: Starforged and other systems.

FoundryVTT Modules

• Starforged Custom Compendiums
• Starsmith Compendiums for Ironsworn: Starforged
• Ironsmith Expanded Oracles for Ironsworn
• Augmented Reality Cyberpunk City Kit
• Token Note Hover
• Token Action HUD Ironsworn
• VOID 1680 AM for FoundryVTT
• Ancient Wonders
• Rise & Shiningstar - An Adventure for Ironsworn: Starforged
• Roll Table Importer
• Ironsworn Impacts

Itch.io Resources

• The City on the Breeze - Cyberpunk-inspired Oracle arrays
• I’ll Be Home for Life Day! - Star Wars Life Day Oracle
• Critical Success Oracles
• I Owe My Soul to the Company Planet Oracles
• Creature Rank Generator