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.
- 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.
Token Note Hover 4.0.0 and above supports both API Hooks and Direct System Support to enable the hovered-over tooltip display.
The Token Note Hover API provides a hook to display custom content. This allows systems and modules to inject content into the tooltip.
tokenNoteHover.createContent(
actor,
displayImages,
contentMap)- 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.
- 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
Notesfield 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>`
});
Many systems are directly supported by Token Note Hover module. FoundryVTT v13 only is supported.
- Alien RPG
- Blades in the Dark
- Cairn
- Call of Cthulhu 7th edition
- Custom System Builder
- Cypher System
- D&D 5E
- Daggerheart
- Das Schwarze Auge / The Dark Eye (5th Edition)
- Delta Green
- Dragonbane - Drakar och Demoner
- Draw Steel
- Dungeon Crawl Classics
- Forbidden Lands
- GURPS 4th Edition Game Aid (Unofficial)
- Ironsworn/Starforged
- Level Up: Advanced 5th Edition
- Mutant Year Zero
- Old-School Essentials
- Pathfinder 1st Edition
- Pathfinder 2e
- Powered by the Apocalypse
- RuneQuest Glorantha
- Savage Worlds Adventure Edition
- Shadowdark
- Simple Worldbuilding System
- Starfinder 1st Edition
- Tormenta20
- Twodsix - Cepheus & Traveller
- Universal Tabletop System
- Warhammer 40,000 Roleplay: Wrath & Glory
- Warhammer Fantasy Roleplay 4th Edition
- World of Darkness 20th edition
- World of Darkness 5e
- 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.
- 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
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.jsonTo 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- Zoom/Pan Options for
Zoom Around Cursorsetting.- 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.
| Actor Type | Note Location |
|---|---|
| Character | Description |
| Colony | Description |
| Creature | Notes |
| Planet | Description |
| Spacecraft | Description |
| Synthetic | Description |
| Territory | Description |
| Vehicles | Description |
| Actor Type | Note Location |
|---|---|
| Clock | Ticked Segments / Total Segments |
| Character | Notes |
| Crew | Notes |
| NPC | Notes |
| Actor Type | Note Location |
|---|---|
| Player Character | Background / Description / Notes |
| Non-Player Character | Role / Description / Notes |
| Actor Type | Note Location |
|---|---|
| Character | Backstory |
| Container | Description |
| Creature | Notes |
| NPC | Notes |
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 |
| Actor Type | Note Location |
|---|---|
| Community | Notes |
| Companion | Notes |
| Marker | Notes |
| NPC/Creature | Notes |
| PC | Notes & GM Notes |
| Vehicle | Notes |
| Actor Type | Note Location |
|---|---|
| Player Character | Biography |
| Non-player Character | Biography Public |
| Group | Description |
| Vehicle | Description |
| Encounter | Description |
| Actor Type | Note Location |
|---|---|
| Adversary | Notes |
| Character | Biography - Background |
| Companion | Partner |
| Environment | Notes |
Das Schwarze Auge / The Dark Eye (5th Edition)
| Actor Type | Note Location |
|---|---|
| Character | Notes |
| Creature | Description |
| Non-Player Character | Notes |
| Actor Type | Note Location |
|---|---|
| Agent | Notes |
| NPC | Notes |
| Unnatural | Notes |
| Vehicle | Notes |
Dragonbane - Drakar och Demoner
| Actor Type | Note Location |
|---|---|
| Player Character | Notes |
| Monster | Description |
| Non-Player Character | Description |
| Actor Type | Note Location |
|---|---|
| Character | Biography & Director Notes |
| NPC | Biography & Director Notes |
| Actor Type | Note Location |
|---|---|
| Player | Notes |
| NPC | Notes |
| Party | Notes |
| Actor Type | Note Location |
|---|---|
| Character | Notes |
| Monster | Notes |
| Party | Notes |
| Stronghold | Notes |
GURPS 4th Edition Game Aid (Unofficial)
| Actor Type | Note Location |
|---|---|
| Character | Notes |
| Enemy | Notes |
| Actor Type | Note Location |
|---|---|
| Character | Notes |
| Shared Sheet | Notes |
| NPC | Text entry area |
| Starship | Notes |
| Location | Text entry area |
Level Up: Advanced 5th Edition
| Actor Type | Note Location |
|---|---|
| Player Character | Notes |
| Non-Player Character | Notes & Private Notes (GM only) |
| Actor Type | Note Location |
|---|---|
| Animal | Info |
| Ark | Info |
| Human | Info |
| Mutant | Info |
| NPC | Info |
| Robot | Info |
| Spaceship | Info |
| Vehicle | Info |
| Actor Type | Note Location |
|---|---|
| Character | Notes |
| Monster | Notes |
| Actor Type | Note Location |
|---|---|
| Player Character | Notes |
| Haunt | Notes |
| Trap | Notes |
| Non-Player Character | Notes |
| Vehicle | Notes |
| 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 |
| Actor Type | Note Location |
|---|---|
| Character | Biography |
| NPC | Bio |
| Actor Type | Note Location |
|---|---|
| Actor | Allies & Notes |
Savage Worlds Adventure Edition
| Actor Type | Note Location |
|---|---|
| Player Character | About - Notes |
| Non-Player Character | Description |
| Group | Description |
| Vehicle | Description |
| Actor Type | Note Location |
|---|---|
| Player | Character Notes |
| NPC | Description |
| Actor Type | Note Location |
|---|---|
| Actor | Description |
| 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 |
| Actor Type | Note Location |
|---|---|
| Ameaça | Diário |
| Base | Descrição |
| Perigo Complexo | Objetivo |
| Personagem do Mestre | Diário |
| Personagem de Jogador | Biografia |
| Actor Type | Note Location |
|---|---|
| Traveller | Character Notes |
| Animal | Animal Notes |
| Robot | Robot Notes |
| Ship | Ship Notes |
| Space Object | Notes |
| Vehicle | Cargo Notes |
| Actor Type | Note Location |
|---|---|
| Chess Piece | Piece |
| Game Token | Resource |
Warhammer 40,000 Roleplay: Wrath & Glory
| Actor Type | Note Location |
|---|---|
| Agent | Notes |
| Threat | Notes |
| Vehicle | Notes |
Warhammer Fantasy Roleplay 4th Edition
| 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
| Actor Type | Note Location |
|---|---|
| All Actors | Appearance |
World of Darkness 5e (Archive)
| 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 |
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.
- If the hover does not work or causes the sidebar to move unexpectedly try the following:
- In the
Configure Settings, uncheck theHover Enabledbox, reload the screen, then re-check theHover Enabledbox. - Try uninstalling and re-installing the module.
- In the
- 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 Settingsdialog, enable theCoresetting checkbox forLeft-Click to Release Objectsto de-select objects easily.
Module by David Hudson and licensed for use under the GNU GPL license v3.
This project is based on Pin Cushion by 4535992.
- Syrious - Level Up: Advanced 5th Edition system and code refactoring.
- DanButcher45 - Cairn system.
- bithr - API code.
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