Tabletop roleplaying games often require note-taking for specific objects in a scene, or landmarks on a map. Foundry Virtual Tabletop supports the use of placing journal entries on the map to serve as map notes. This page details the process of creating and working with Map Notes (a.k.a. Journal Notes) to notate scenes in Foundry Virtual Tabletop.
A Map Note is first made by creating its respective Journal Entry in the directory. The Journal Entry can be dragged from the sidebar onto the scene to create the Map Note. Finally, a dialog window should appear, allowing you to configure the note before it is placed. A Map Note can be configured again by double right-clicking it. The details of each configuration option are listed below:
- Journal Entry:
- The Journal Entry assigned to the Map Note. Double clicking the Map Note will bring up the Journal Entry.
- Text Label:
- The label the Map Note will display when moused over. If left empty, the label will default to the name of the Journal Entry.
- The coordinates for the Map Note on the scene. It is worth noting The Map Note can still be dragged and relocated after placing, making these fields more suitable for fine-tuning the placement of pins.
- Entry Icon:
- The display icon for the Map Note.
- Icon Size:
- The size of the Map Note's icon on the Scene. This is equal to the length of one side of the icon, in pixels.
- Icon Tint:
- The tint color of the Entry Icon. Empty by default.
- Font Family:
- The font which will be used to display the text of this note. Signika by default.
- Font Size:
- The font size of the Text Label entered.
- Text Color:
- The color of the Text Label. A text stroke will automatically be added in contrast to the color chosen to ensure visibility.
- Text Anchor Point:
- The placement of the Text Label relative to the Map Note itself.
The visibility of Map Notes are determined by its corresponding Journal Entry - if a player has "Limited" permissions to the Journal Entry, they will be able to view the Map Note. If a Map Note has no Journal Entry associated with it, the note will be visible to all users currently viewing the scene. Note that if a player only has Limited permission to a Journal Entry, they will still be able to see the position of the Map Note pin and it's assigned tooltip, but not any details of the Journal Entry itself.
If you right click on a Journal Entry in the sidebar, you can conveniently "Jump to Pin" to pan the canvas to it's placed Note location.
Map Notes are not always seen straight away - depending on the user's settings, they may only appear while the Journal Notes button is selected in the scene control toolbar. If you wish to see available map notes on the scene at all times, simply click on the Journal Notes button (bookmark icon) in the scene control toolbar, and click "Toggle Notes Display" (magnifying glass icon). Once enabled, notes will always be visible. This setting is per user - each player is able to turn on and off Map Note visibility.
A Map Note can be deleted from a Scene by a Gamemaster by mousing over the note and pressing the Delete key. Alternatively, all Map Notes on the current scene can be deleted by clicking the Map Notes button (bookmark icon) in the scene control toolbar, and clicking "Clear Notes" (trash can icon).
Remember that deleting a placeable object like a Map Note will not delete the Journal Entry that it refers to.
To interact with Map Note objects programmatically, you will primarily use the following API concepts: