Mel-Minimap
Mel-Minimap is a Foundry Virtual Tabletop module that displays the complete active Scene in a compact overview window. The minimap preserves the original map aspect ratio, shows relevant Tokens and Map Notes, and marks the portion of the Scene currently visible on the main canvas.

Features
Scene overview
- Displays the complete background of the active Scene or viewed Level.
- Preserves the original image aspect ratio. The map is never stretched.
- Uses a normal scale of 10% of the source image dimensions.
- Keeps the shorter map edge at least 300 pixels where possible.
- Scales very large maps down proportionally so the outer window does not exceed 350 × 350 pixels.
- Gives the map the maximum possible size when an extreme aspect ratio prevents both size limits from being met.
- Fits the map automatically in the fixed-size mode. Manual resizing is disabled in that mode.
- Displays the configured grid and a translucent white frame around the current main-canvas viewport.
- Can be moved or minimized like any other Foundry
ApplicationV2window. - Can be detached into a separate browser window using Foundry's native
Detachaction. - In fixed-size mode, a detached minimap keeps the automatically calculated size from the moment of detachment and cannot be resized through Foundry's application resize control.
- In fixed-size mode, re-attaching restores the size captured before detachment and then reapplies automatic map fitting in the main Foundry window.
- Optional dynamic sizing allows the minimap to be resized while attached or detached; the map always keeps its original aspect ratio.
- Clicking the minimap centers the main canvas on the selected position without changing the minimap's size or aspect ratio.
Tokens
Visible Tokens are displayed as compact markers using Foundry disposition colors:
- Party for friendly Tokens
- Neutral for neutral Tokens
- Opposition for hostile Tokens
- Self for the controlled Token or the Token belonging to the current user's character
The user's own Token is highlighted with a white marker and blue outline. Hovering over a Token displays its name and localized disposition in the top-left information area, subject to Foundry's Token name-display mode and the user's permissions.
Map Notes
Map Notes use their configured Foundry icon and iconSize, scaled proportionally to the complete Scene. The feature is controlled by the client setting Show Map Notes, which is disabled by default.
When the pointer hovers over a Map Note, its custom Note text or linked Journal title is shown in the top-left information area. Pressing V opens the linked Journal Entry and, when configured, its linked Journal Entry Page.
Actor Sheets and artwork
Vopens the Actor Sheet for a hovered Token when the current user has at least Observer permission for that Actor.Ctrl+1opens a player's hovered visible Token texture locally; Actor permission and Token name visibility are not required.- For the GM,
Ctrl+1retains the original Actor-artwork behavior, including the Actor artwork and Actor title. Ctrl+2retains the original GM-only Actor-artwork sharing behavior.- Player artwork windows use the neutral localized title Token Artwork and do not expose the Actor or Token name in the window title.
Configuration
TMel-Minimap settings are world settings. The GM configures them in Foundry's module settings, and the same values apply to every connected player. Players cannot override these settings with browser-local values. On the first update from an earlier release, the current GM values are migrated to the world settings:
-
Open minimap when the world starts: Opens the minimap automatically after the World is ready. Enabled by default.
-
Show map background: Displays the active Scene background in the minimap. Enabled by default.
-
Show Map Notes: Displays visible Map Note markers and enables Map Note hover actions. Disabled by default.
-
Enable dynamic minimap size: Enables manual resizing in the attached and detached windows. The automatic 10% scale, 300-pixel minimum where possible, and 350-pixel maximum remain the initial sizing defaults. Enabled by default.
Changing Show Map Notes, Show map background, or Enable dynamic minimap size updates open minimaps for all connected users. Changing Open minimap when the world starts synchronizes the current minimap visibility and is also used at the next world startup.
Usage
Minimap controls
| Action | Result |
|---|---|
| Scene Controls button | Opens or closes the minimap |
Ctrl+M |
Opens or closes the minimap |
| Click inside the map | Centers the main canvas on that position |
| Move the pointer over a Token | Shows the Token name and disposition |
| Move the pointer over a Map Note | Shows the Note text or linked Journal title |
Keyboard shortcuts for hovered objects
| Shortcut | Hovered Token | Hovered Map Note |
|---|---|---|
V |
Opens the Actor Sheet when permitted | Opens the linked Journal Entry or Journal Entry Page when permitted |
Ctrl+1 |
Opens the visible Token texture locally; GM uses Actor artwork | No action |
Ctrl+2 |
A GM shares the Actor's artwork with all connected players | No action |
The shortcut only applies while the pointer is over the minimap. If the current user does not have the required permission, the shortcut is ignored.
The artwork shortcuts also support Ctrl+Num1 and Ctrl+Num2 by default. For players, Ctrl+1 requires a visible, non-hidden Token with configured Token artwork, but does not require Actor ownership or a displayed Token name. The GM retains the original Actor-artwork behavior. All default bindings can be reassigned in Foundry's Controls configuration.
When Enable dynamic minimap size is active, resize the window using Foundry's resize handle while attached or the available window resize controls while detached. The canvas scales uniformly and letterboxes unused space when the window shape differs from the map.
Visibility and Fog of War
Mel-Minimap follows Foundry's current Scene visibility state for non-GM users:
- Unexplored or currently invisible areas are masked.
- Tokens inside masked areas are not displayed.
- Hidden or otherwise invisible Tokens are not displayed to players.
- Non-global Map Notes in unexplored or currently invisible areas are not displayed to players.
- Global Map Notes follow Foundry's global visibility behavior.
- GMs can see content that is hidden from players; hidden Token markers use reduced opacity.
- If the Scene's Token Vision setting is disabled, players see the complete map regardless of Exploration Mode.
The Fog of War mask is sampled across the map for performance. Lighting, weather, animated effects, and video animation are not reproduced as a separate full Scene render.
Localization
Mel-Minimap supports the following five languages:
- de - Deutsch
- en - English
- es - Español
- fr - Français
- nl - Nederlands
Documentation
Full documentation under: https://github.com/melnari/mel-minimap/blob/main/README.md
AI-assisted development and maintainership
Parts of this module were created with AI assistance. The maintainer reviews, tests, maintains, develops, and supports the code and is responsible for its quality, compatibility, licensing, and continued development.

