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
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
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.
Screenshot
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>`
});
Screenshot
Modules and Systems Using the API
Directly Supported Systems
Many systems are directly supported by Token Note Hover module. FoundryVTT v13 only is supported.
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.
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
Other Recommended Modules
Screenshots and Note Locations
Alien RPG
Alien RPG
Screenshot
Actor Type
Note Location
Character Description
Colony Description
Creature Notes
Planet Description
Spacecraft Description
Synthetic Description
Territory Description
Vehicles Description
Blades in the Dark
Blades in the Dark
Screenshot
Actor Type
Note Location
Clock Ticked Segments / Total Segments
Character Notes
Crew Notes
NPC Notes
Cairn
Cairn
Screenshot
Actor Type
Note Location
Player Character Background / Description / Notes
Non-Player Character Role / Description / Notes
Call of Cthulhu 7th edition
Call of Cthulhu 7th edition
Screenshot
Actor Type
Note Location
Character Backstory
Container Description
Creature Notes
NPC Notes
Custom System Builder
Custom System Builder
Screenshot
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:
Actor Type
Note Settings
Character Notes
Private Notes
Cypher System
Cypher System
Screenshot
Actor Type
Note Location
Community Notes
Companion Notes
Marker Notes
NPC/Creature Notes
PC Notes & GM Notes
Vehicle Notes
Dungeons & Dragons Fifth Edition
Dungeons & Dragons Fifth Edition
Screenshot
Actor Type
Note Location
Player Character Biography
Non-player Character Biography Public
Group Description
Vehicle Description
Encounter Description
Daggerheart
Daggerheart
Screenshot
Actor Type
Note Location
Adversary Notes
Character Biography - Background
Companion Partner
Environment Notes
Das Schwarze Auge / The Dark Eye (5th Edition)
Das Schwarze Auge / The Dark Eye (5th Edition)
Screenshot
Actor Type
Note Location
Character Notes
Creature Description
Non-Player Character Notes
Delta Green
Delta Green
Screenshot
Actor Type
Note Location
Agent Notes
NPC Notes
Unnatural Notes
Vehicle Notes
Dragonbane - Drakar och Demoner
Dragonbane - Drakar och Demoner
Screenshot
Actor Type
Note Location
Player Character Notes
Monster Description
Non-Player Character Description
Draw Steel
Draw Steel
Screenshot
Actor Type
Note Location
Hero Biography & Director Notes
NPC Biography & Director Notes
Object Biography & Director Notes
Retainer Biography & Director Notes
Party Party Members & Party Details
Dungeon Crawl Classics
Dungeon Crawl Classics
Screenshot
Actor Type
Note Location
Player Notes
NPC Notes
Party Notes
Forbidden Lands
Forbidden Lands
Screenshot
Actor Type
Note Location
Character Notes
Monster Notes
Party Notes
Stronghold Notes
GURPS 4th Edition Game Aid (Unofficial)
GURPS 4th Edition Game Aid (Unofficial)
Screenshot
Actor Type
Note Location
Character Notes
Enemy Notes
Ironsworn/Starforged
Ironsworn/Starforged
Screenshot
Actor Type
Note Location
Character Notes
Shared Sheet Notes
NPC Text entry area
Starship Notes
Location Text entry area
Level Up: Advanced 5th Edition
Level Up: Advanced 5th Edition
Screenshot
Actor Type
Note Location
Player Character Notes
Non-Player Character Notes & Private Notes (GM only)
Mutant Year Zero
Mutant Year Zero
Screenshot
Actor Type
Note Location
Animal Info
Ark Info
Human Info
Mutant Info
NPC Info
Robot Info
Spaceship Info
Vehicle Info
Old-School Essentials
Old-School Essentials
Screenshot
Actor Type
Note Location
Character Notes
Monster Notes
Pathfinder 1st Edition
Pathfinder 1
Screenshot
Actor Type
Note Location
Player Character Notes
Haunt Notes
Trap Notes
Non-Player Character Notes
Vehicle Notes
Pathfinder 2e
Pathfinder 2e
Screenshot
Actor Type
Note Location
Player Character Biography Appearance
Non-player Character Notes Description
Army Description
Familiar Creature Type
Hazard Description
Loot Text entry area
Party List of party members
Vehicle Description
Powered by the Apocalypse
Powered by the Apocalpypse
Screenshot
Actor Type
Note Location
Character Biography
NPC Bio
RuneQuest Glorantha
RuneQuest Glorantha
Screenshot
Actor Type
Note Location
Actor Allies & Notes
Savage Worlds Adventure Edition
Savage Worlds Adventure Edition
Screenshot
Actor Type
Note Location
Player Character About - Notes
Non-Player Character Description
Group Description
Vehicle Description
Shadowdark
Shadowdark RPG
Screenshot
Actor Type
Note Location
Player Character Notes
NPC Description
Simple Worldbuilding System
Simple Worldbuilding System
Screenshot
Actor Type
Note Location
Actor Description
Star Wars FFG system
Star Wars FFG system for Foundry VTT
Screenshot
Actor Type
Note Location
Character Biography
Homestead Biography
Minion Biography
Nemesis Biography
Rival Biography
Vehicle Biography
Starfinder 1st Edition
Starfinder 1st Edition
Screenshot
Actor Type
Note Location
Player Character Biography & GM Notes
Drone Biography & GM Notes
Hazard Notes
Non-Player Character Biography & GM Notes
Old-Style NPC Biography & GM Notes
Starship Notes
Vehicle Notes
Tormenta20
Tormenta20
Screenshot
Actor Type
Note Location
Ameaça Diário
Base Descrição
Perigo Complexo Objetivo
Personagem do Mestre Diário
Personagem de Jogador Biografia
Twodsix - Cepheus & Traveller
Twodsix - Cepheus & Traveller
Screenshot
Actor Type
Note Location
Traveller Character Notes
Animal Animal Notes
Robot Robot Notes
Ship Ship Notes
Space Object Notes
Vehicle Cargo Notes
Universal Tabletop System
Universal Tabletop System
Screenshot
Actor Type
Note Location
Chess Piece Piece
Game Token Resource
Warhammer 40,000 Roleplay: Wrath & Glory
Warhammer 40,000 Roleplay: Wrath & Glory
Screenshot
Actor Type
Note Location
Agent Notes
Threat Notes
Vehicle Notes
Warhammer Fantasy Roleplay 4th Edition
Warhammer Fantasy Roleplay 4th Edition
Screenshot
Actor Type
Note Location
Player Character Notes - Biography & GM Notes
Non-Player Character Notes - Biography & GM Notes
Creature Notes - Biography & GM Notes
Vehicle Description - Description & GM Notes
World of Darkness 20th edition
World of Darkness 20th edition
Screenshot
Actor Type
Note Location
All Actors Appearance
World of Darkness 5e
World of Darkness 5e (Archive)
World of Darkness 5e
Screenshot
Actor Type
Note Location
Ghoul Notes - Public Notes & Private Notes
Group Notes - Public Notes & Storyteller Notes
Hunter Notes - Public Notes & Private Notes
Mortal Notes - Public Notes & Private Notes
Story Character Notes - Public Notes & Private Notes
Vampire Notes - Public Notes & Private Notes
Werewolf Notes - Public Notes & Private Notes
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, reload the screen, then re-check the Hover Enabled box.
Try uninstalling and re-installing the module.
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.
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
FoundryVTT Modules and Other Resources
Please check out my other modules and resources for Ironsworn, Ironsworn: Starforged and other systems.
