MapTool User Interface

From RPTools Wiki
Jump to navigation Jump to search

Languages:  English  • Deutsch

BEGINNER
THIS IS A BEGINNER ARTICLE

This is reference documentation of MapTool's user interface (UI) features including descriptions of all the menus and panels. It is intended for beginning and intermediate MapTool users who want to quickly learn about a particular feature or explore MapTool's UI features in more detail.

If you are just getting started with MapTool, it is recommended to read the Introduction to Mapping, or visit the Main Page to browse for beginner articles.

Overview of the MapTool Application Window

The minimum MapTool interface with no optional panels open.

Each open instance of MapTool has an application window which contains a few ever-present components.

The application window always consists of a title bar, a menu bar, the map building and navigation tools, and the map view. One or more panels may be docked to sides of the map view or even floated seperate from the main application window.

The default layout also docks the `Resource Library` panel at the top left side, and a tabbed panel containing the `Map Explorer` and `Draw Explorer` in the lower left side, and the `Chat` panel. This default layout can be restored by selecting Window > Restore Layout.

Getting Help

There are two built-in help features available to you in MapTool before you have to resort to searching the wiki or asking the MapTool community.

  • Hover Tooltips: Hovering your mouse over many menu items, buttons, and dialog box options buttons reveal helpful tooltips throughout MapTool. Even macros written by other users might have tooltips, so always take a moment to check if there is a feature you have a question about.
  • The Status Bar: Once a tool is selected, instructional help text often appears in the lower left of the Status Bar. Glance down every once in a while to get a handle on the different tools available to you.

Multiple instances of MapTool

Users may open multiple instances of MapTool at once; for example to test the player view on one instance while serving a campaign file in another view on the same computer. When doing this, each instance of the program will have its own application window with its own user interface.

If running multiple instances of MapTool, it is helpful to keep all panels docked rather than floating to prevent confusion between open instances.

Menu bar

MapTool’s menu bar consists of seven dropdown menus. (Prior to version 1.12.0, there were eight. See the Themes menu below.) Underlined letters in a menu command indicates the hotkey that selects that command when the menu is open. Code-styled commands next to a menu command indicate a default shortcut key for that command. The Meta shortcut key listed is usually the Control key on Windows and Linux and Command on Mac. You can always verify your shortcut keys by looking in the menus of your MapTool installation.

In MapTool 1.5.8 and later, a down/up toggle on the right edge of the menu bar can be clicked to hide/show the toolbar.

File Menu

MapTool's File Menu

The File menu mainly contains Campaign File and networking commands, along with other miscellaneous export functions.

  • New Campaign
This creates a new campaign file with default properties, states, and a single map called 'Grasslands' configured according to the installation's new map defaults.
  • Open Campaign... Meta-O
Opens a file explorer window to select and open a MapTool Campaign File.
  • Save Campaign Meta-S
Saves the current campaign file. If it is a new campaign, MapTool opens a file explorer window to select a save location and name the campaign file.
  • Save Campaign As... Meta-A
Opens a file explorer window to select a save location and name the campaign file.
  • Save Chat Log History...
Opens a file explorer window to select a save location and name an HTML file containing the entire content of the current chat panel.
Export Submenu
  • Export
Submenu containing additional options.
  • Screenshot Meta+Shift-S
Opens the Export Screenshot dialog.
  • Screenshot As...
Opens the Export Screenshot dialog.
  • Campaign As...
Opens the Export Campaign dialog, which allows saving a campaign file in a format compatible with older versions of MapTool.
  • Campaign Repository File...
Opens a file explorer window to select a save location and name a ZIP file containing the entire content of the campaign for use as a Campaign Repository.
  • Add Resource to Library...
Opens the Add Resource to Library dialog, which will add new resources to the Resource Library.
  • Start Server...
Starts a new MapTool server from the current instance of MapTool with the currently open campaign file. See Introduction to Game Hosting.
  • Connect to Server...
Connect to a local or remote MapTool server.
  • Disconnect from Server...
Disconnect from the current server. This opens the campaign file which was open before connecting to a server.
  • Connection Information...
Displays additional connection information, such as the IP address.
Recent Campaigns Submenu
  • Recent Campaigns
Shows a list of up to 9 recently opened campaign files.
  • Exit
Will prompt the user to save the current campaign and close MapTool.

Edit Menu

MapTool's Edit Menu

The Edit menu contains drawing and token editing commands along with access to campaign settings and MapTool preferences.

  • Undo Drawing Meta-Z
Removes the most recent drawing object that was created via the Draw tool.
This menu command only affects drawings created with the Drawing Tool. Token movement can be undone by right-clicking a token and selecting 'Revert last move'. Token removal, and changes to the Vision Blocking Layer and Fog of War cannot be undone/redone. However, the key command may affect text in input areas such as the chat window and macro editor.
  • Redo Drawing Meta-R
Re-adds the most recently drawing object that was removed via Undo Drawing.
This menu command only affects drawings created with the Drawing Tool. Token movement can be undone by right-clicking a token and selecting 'Revert last move'. Token removal, and changes to the Vision Blocking Layer and Fog of War cannot be undone/redone. However, the key command may affect text in input areas such as the chat window and macro editor.
  • Clear All Drawings Meta+Shift-D
Removes all drawings on the selected layer of the current map.
This menu command only affects drawings created with the Drawing Tool. Tokens, the Vision Blocking Layer, and Fog of War are not affected.
  • Copy Meta-C
Copies a token to the clipboard.
This menu command only affects Tokens, although the key command can affect text in input areas such as the chat window and macro editor.
  • Cut Meta-X
Cuts a token, removing it from the map and placing it in the clipboard.
This menu command only affects Tokens, although the key command can affect text in input areas such as the chat window and macro editor.
  • Paste Meta-V
Pastes any token in the clipboard to the current map underneath the current cursor position.
This menu command only affects Tokens, although the key command can affect text in input areas such as the chat window and macro editor.
  • Campaign Properties...
Opens the Campaign Properties dialog. These are settings which are saved with the current campaign such as token properties, states, and more.
  • Preferences...
Opens the Preferences dialog. These are settings which are saved with the local installation of MapTool. They are not saved with a campaign, and will need to be reconfigured on any new installation of MapTool.

Edit Menu - Expanded

Expanded Edit Menu, only visible when a Macro Editor is open

When one or more macro editors is open, the Edit menu is appended with editing options useful for macro authors. These extra commands only effect the macro editor, and can't be used with text entered into the chat panel or other text input areas. If multiple Macro Editors are open, these menu items will appear once for every open Macro Editor.

  • Find... Meta-F
Opens the Find dialog box to search the macro editor for some arbitrary text. Works with Regular Expressions when 'Regex' is ✓checked.
  • Replace... Meta-H
Opens the Replace dialog box to search the macro editor for some arbitrary text to replace with a second string of arbitrary text. Works with Regular Expressions when 'Regex' is ✓checked.
  • Go to Line... Meta-L
Opens a simple Goto Line dialog box, letting you immediately transport the macro editor cursor to the line number provided.
  • Show Find Search Bar... Meta+Shift-F
Toggles a bar with text search functionality docked to the bottom of the Macro window. If the Replace Search Bar is visible, the Find bar takes its place. Works with Regular Expressions when 'Regex' is ✓checked.
  • Show Replace Search Bar... Meta+Shift-H
Toggles a bar with text search/replace functionality docked to the bottom of the Macro window. If the Find Search Bar is visible, the Replace Search Bar takes its place. Works with Regular Expressions when 'Regex' is ✓checked.

Map Menu

MapTool Map Menu
  • New Map... Meta-N
Opens the Map Properties dialog box to select options for a new map.
Quick Map Submenu
  • Quick Map
The Quick Map submenu provides a visual list of textures which, when clicked, instantly creates new maps with the settings configured in your MapTool_Preferences with the selected texture. Textures for the Quick Map submenu are automatically pulled from your Data Directory in the Resources/Default/Textures subdirectory.
You can add or remove textures from the default resources folder to alter the Quick Map options, but it is not recommended to remove Grass.png, as it is the default texture for all new MapTool maps and campaigns. If you do remove it without replacing it, a red 'X' will populate any new maps you create until you manually set a different texture in the map properties.
  • Import Map...
Imports a MapTool map with the .rpmap extension via a file browser dialog into the open campaign. When importing maps with Fog of War, an option will be given to reset the fog for the whole map.
  • Import Universal VTT...
Imports a Universal VTT map with the .dd2vtt extension via a file browser dialog into the open campaign. Universal VTT (UVTT) maps can include VBL and Light definitions along with the map image. The UVTT format was created by Megasploot as an export format in Dungeondraft. Other map creation programs also support the format now including DungeonFog and Arkenforge's Master's Toolkit. For files with other extensions select the All File option in the dialog.
  • Export Map...
Exports a MapTool map with the .rpmap extension to the local file system via a file browser dialog.
  • Player Visible Meta-H
When ✓checked, the current map can be viewed by players and will be visible to them in the Select Map dropdown on the right side of the MapTool Toolbar.
  • Restore Fog-of-War Meta+Shift-R
Resets any exposed areas of Fog of War on the current map so they appear unexplored.
  • Fog-of-War Meta-W
Enables the display of Fog of War.
  • FoW: Expose only at way points Meta+Shift-W
Vision Submenu
  • Vision
The vision submenu has controls how players can see tokens on the current map. When Fog of War is enabled, tokens under unexplored Fog of War are always obscured regardless of which vision setting is selected. Also, these settings do not control when Fog of War is revealed, which is controlled by a combination of client preferences and server settings. Aura effects are always rendered regardless of which Vision setting is checked.
Troubleshooting tip: If players cannot see on the 'Day' or 'Night' settings, make sure player tokens are both owned by them and have 'Has Sight' checked in their properties.
Troubleshooting tip: If players can't see anything on a map with Fog of War enabled regardless of these settings, try exposing an initial area of Fog of War around their tokens.
  • Off
When ✓checked, all tokens on the map (or explored areas of the map if Fog of War is enabled) will be shown to players regardless of token ownership, vision and light settings, and the Vision Blocking Layer (VBL). Hovering over Tokens with vision settings will still display a projected outline of what they can 'see' that accounts for the VBL.
  • Day
When ✓checked, players can only see the map and other tokens through tokens they own which have sight enabled in their preferences. Tokens will 'see' up to the maximum distance of their vision settings, and Vision Blocking Layer will block tokens from 'seeing' one another. Most light sources are ignored as all areas of the map is considered fully illuminated for vision purposes, though Auras remain visible.
  • Night
When ✓checked, players can only see the map and other tokens through their own tokens' vision just as with the Day setting, but additionally can only see into illuminated areas.
  • Edit Map...
Opens the Map Properties dialog to adjust the map's name, background color/texture, base map, fog color, grid settings, and vision distance.
  • Adjust Grid...
Enters an 'Adjust Grid' Map View mode to quickly find workable grid settings for the current map. The Map View's modal panel will change and display contain controls for grid size, x-y offsets, and color, as well as a map zoom slider. Further UI features of this mode are as listed:
Tip: Also look at Auto Resize for a semi-automatic way of fitting map images to the grid.
  • Left-clicking and dragging the Map View while this tool is open offsets the grid.
  • Scrolling the mouse wheel or holding Shift and hitting the arrow keys will change the grid size.
  • Right-clicking and dragging will pan the Map View as usual, and holding the Meta key while scrolling the mouse wheel will zoom the map as normal.
  • Clicking the 'close' button will save your changes and close Adjust Grid mode.
  • Hitting the Escape key will exit the Adjust Grid mode without saving your changes.
  • Adjust Map Board...
Enters an 'Adjust Grid' Map View mode to adjust the position of a background map if any is set. This is the only way to adjust the position of the background map. The Map View's modal panel will change to display Snap to options and background map x-y offset values.
  • Left-clicking and dragging will move the background map around. Right-clicking lets you pan the Map View as usual.
  • The 'Snap to' option lets you either freely drag the map ('None'), snap the background to the grid as you drag it ('Grid'), or to the set repeating texture ('Tile').
  • All changes are immediately saved and cannot be automatically undone. Clicking the 'close' button OR hitting the Escape key will exit the Adjust Map Board mode.
  • Rename...
Opens a dialog box to adjust the current map's name.
  • Copy...
Opens a dialog box to create a copy of the current map in the current campaign with a new name.
  • Delete...
Opens a dialog box to irreversibly remove a map from the current campaign. It is recommended to export any maps before deleting them unless you are sure you will never need them anymore.

View Menu

MapTool View Menu

The View menu helps you control and customize the appearance of the Map View.

  • Show As Player Meta+Shift-P
Helps a GM simulate what players would see on the currently selected map when ✓checked. This option is very helpful when building maps with vision and/or light sources, and the Vision Blocking Layer.
  • Unexplored/Hard Fog of War will appear solid black as it appears to players.
  • Selecting a token will limit vision to only the lights, exposed Fog of War, and tokens that token can see.
  • When no tokens are selected, any tokens matching the toolbar Fog of War display settings are shown. If all the player tokens are 'PC' tokens, selecting the 'PC' Fog of War display setting on the Toolbar can further help narrow down what players can actually see.
Zoom Submenu
  • Zoom
The zoom menu exposes map zooming functions. The current zoom level can be seen on the right side of the Status Bar.
  • Zoom In =
Zooms the map in an increment of roughly 7% of the current zoom level. Scrolling up on the mouse wheel also does this.
  • Zoom Out -
Zooms the map out an increment of roughly 7% of the current zoom level. Scrolling down on the mouse wheel also does this.
  • Zoom 1:1 +
Resets the zoom level to 100%.
  • Show Token Names Meta-T
Displays all token names beneath their tokens when ✓checked. Visible PC token names are shown in black text in light grey boxes, Visible NPC names are shown with white text on blue boxes, and No Visible token names are shown as white in dark grey boxes.
  • Show Text Labels
Displays text labels created with the Drawing Tools.
  • Show Movement Distances Meta-D
When ✓checked, the current total movement distance is shown below the selected token while dragging. This accounts for terrain modifiers and the current diagonal movement rules of current server (or the MapTool installation if not connected to a server).
  • Show Light Sources Meta-K
Displays a light bulb graphic over tokens with light sources attached when ✓checked. This option is only available to GMs, and won't work when 'Show as Player' is checked.
  • Show Grid Meta-G
Toggles the grid on or off.
  • Show Coordinates
Displays large orange numbers along the top, and yellow letters along the left side designating the grid rows and columns for quick reference. This scheme can be useful to communicate a particular grid location secretly to a player over chat without pointing it out to everyone, for instance.
Grid Line Width Submenu
  • Grid Line Width
Controls how many pixels thick you prefer your grid lines to be when the Grid is enabled. This is a per-client setting.
  • Display Drawing Distances
Displays distances when using the drawing and template tools (except for the Freehand and Text tools).
  • Straight Line Width Doubled
When ✓checked, the line template tool from a point will make straight lines at double width. If unchecked, you will have to choose which side of the line the template will be drawn on.
  • Fullscreen Mode Meta+Alt-Enter
Toggles a fullscreen mode where only the Map View is visible. This hides all menus, the toolbar, and all panels. Repeating the key command or pressing Escape will return to the normal windowed view.

Tool Menu

MapTool Tool Menu
  • Chat Meta-Enter
Toggles the Chat panel. Identical to the Window > Chat menu option.
  • Run Macro /
Focuses the Chat panel (toggling it visible if necessary) and begins the input with a '/' character. Using the '/' shortcut is a convenient way to access the chat at any time within MapTool and quickly enter Chat Commands.
  • Center Players on Current View Meta-F
Allows a GM on a server to move all players on the same map as the GM to pan to center on the GM's view and zoom level.
  • Enforce Players to Current Map Meta-E
Allows a GM on a server to pull all connected players to the GM's currently selected map (as long as it is visible to players).
  • Center Players on Current View (Continuous) Meta+Shift-F
When ✓checked, players' views will be panned and zoomed automatically to match the GM whenever the GM moves their view.
  • Lock Player Movement Meta+Shift-L
When ✓checked, players cannot move tokens they own unless it is that token's turn on the Initiative panel.
  • Lock Zoom
Disables zooming functions when ✓checked. Affects only current client, not other players on a server.
  • Enforce Typing Notifications
Forces all connected players to see typing notifications, even if they are disabled in a player's local Chat panel.
  • Collect Performance Data
Opens a window displaying performance data. This feature can help advanced users with macro troubleshooting and MapTool development.
  • Open Log Console
Opens a window displaying MapTool's debugging log. To learn more about using this feature, you can explore Log Macro Functions. This feature can help advanced users with macro troubleshooting and development.

Window Menu

MapTool Window Menu

All panels will show as ✓checked when they are open. If you cannot find a panel, it may be in a tabbed panel or undocked from the Map View. Using the Restore Layout tool may help.

  • Restore layout
Resets to a default arrangement of panels docked to the left and bottom portions of the Map View. The default panels are the Map Explorer (lower left), Library (top left), and Chat (lower edge). All other panels are hidden and also have their default size and position reset.
  • Connections
Toggles the Connections panel. When playing on or running a server, this panel shows which players are currently connected.
  • Map Explorer
Toggles the Map Explorer panel. This panel shows all the Tokens on the currently selected map, organized by layer.
  • Draw Explorer
Toggles the Draw Explorer panel. This panel shows all the drawing objects (shapes, text, and cuts) on the currently selected map, organized by layer.
  • Initiative
Toggles the Initiative panel, which is a tool to help set and track rounds, current turn, and turn order for tokens on the the current map.
  • Library
Toggles the Library panel, a file browser to drag and drop images and tokens from added folders on the file system onto the map.
  • Chat
Toggles the Chat panel where all connected players can type, run chat commands, and run macros directly.
  • Tables
Toggles the Tables panel. Tables for the current campaign are created, configured, and can be run directly from this panel.
  • Global
Toggles the Global panel, which contains any macros attached to the current installation of MapTool.
  • Campaign
Toggles the Campaign panel, which contains any macros attached to the currently open campaign file.
  • Selected
Toggles the Selected panel, which contains any macros attached to the currently selected Token.
  • Impersonate
Toggles the Impersonate panel, which contains any macros attached to the currently impersonated Token.
  • Show Transfer Window
Opens a window showing any pending images that are currently being retrieved from the server or a repository.

Help Menu

MapTool Help Menu
  • Add Default Tables...
Uses the default MapTool resources to create image tables for 6 dice types (D4, D6, D8, D10, D12, D20) and two playing card-decks (One with a joker, one without). If any of the default resources are missing from the default data directory (which can be set in your MapTool Preferences), the images will be shown as red Xes until they are either edited to point to new images or the default images restored.
  • Restore Default Images...
Fetches the default MapTool image assets and places them in the current data directory according to your MapTool Preferences. This can be helpful if you've changed the data directory but later want to restore 'Quick Map' or 'Add Default Tables' functionality.
  • Documentation
Opens a web browser to the RPTools' MapTool page.
  • Tutorials
Opens a web browser to the RPTools' MapTool Tutorials page.
  • Forums
Opens a web browser to the RPTools Forum.
  • Networking Setup (forum thread)
Opens a web browser to a Networking FAQ thread on the RPTools forum.
  • Macro Scripting
Opens a web browser to this wiki's main page.
  • Frameworks
Opens a web browser to this wiki's frameworks page.
  • Gather Debug Information...
Displays system information useful for debugging and development. If you ever report a bug, you may want to include this information in your report.

Themes Menu

Prior to version 1.12.0, there is a Themes menu (themes are controlled in Preferences from 1.12.0 on).

MapTool Themes Menu
  • Default - The default MapTool theme.
  • more themes... - Other themes found in the MapTool USERDATA/themes/ui folder will be found here.
Add your own custom themes to this folder to have them displayed in the menu. You must restart MapTool for a theme to take effect.
  • About...
Displays a dialog with version information and attribution to MapTool's wonderful developers and community members.

Toolbar and Map View

The MapTool Toolbar lets you interact with the Map View in different ways. The toolbar has a handle on the left side, allowing the user to undock it from the application window. Closing the popped-out toolbar or dragging it beneath the menu bar returns it to its default position. In MapTool 1.5.8 and later, the toolbar can be hidden or shown by clicking the down/up toggle on the right edge of the menu bar.

About the Map View

Beneath the Toolbar's default position, most of the application window is used to display the current map. Any docked panels will appear alongside the Map View. Map view is semi-modal, meaning its use and options change somewhat depending on the tools and menu options you select.

Controls in the Map View

In most modes, MapTool describes the available commands for the Map View in the #Status Bar at the bottom-left of the application window. The following controls are what are available to players and GMs using the Pointer tool:

  • Left click on a token: Select that token. A red border means an owned token is selected and can be manipulated; a green border means an unowned token is selected, which is useful for targeting when using macros.
  • Left click + drag: If no tokens are selected, drag a selection box to select multiple tokens. If a token or token(s) are selected, move selected token(s).
  • Add Spacebar or Right Click while dragging a token to set waypoints to control the path taken by the token.
  • Right click: Select a token and open its right-click context menu.
  • Right click + drag: Pan the Map View.
  • Mouse Wheel: Zoom the Map View in/out.
  • Spacebar: Holding spacebar will show a blue arrow on the map pointing to your cursor position to all connected players. Your name is shown next to the arrow.
  • Meta + Spacebar: Changes the pointer image to a cartoon-style speech bubble.
  • Shift + Spacebar: Changes the pointer image to a cartoon-style thought bubble.
  • Meta + Shift + Spacebar: Changes the pointer image to an illustrated pointing hand. This pointer has special use for GMs:
  • If used by the GM, this illustrated pointer also moves the map view of all players on the same map to center on the pointing location and at the GM's zoom level. When used in this way, the GM can release the Spacebar first to let player views snap back to their previous location, or release either Meta or Shift first to keep the player views centered on the new location.
  • Hover over a token:
  • When the token is on the Token layer, will display the token's Stat Sheet by default (can be turned off by the client in their Preferences settings, in which case Shift must also be held down to see the stat sheet).
  • When the token is on the Object layer, the mouse pointer will change to the selection image and a Left click on the token will display the Notes from the token where the stat sheet is normally displayed. (This is for GMs to provide information about areas that players can review on their own. Also, when the GM left clicks, they see both the Notes and the GM Notes.)
  • When the token is on the Hidden or Background layers, no special interaction is performed.

Modal Panel

For GMs, the Map View usually has a small panel present in the top right. This panel most often displays the different map layers so the GM can choose which layer to interact with. Following is a rundown of the different modal panels that exist in MapTool.

  • Layers Selection
This panel lets the GM select which layer to use their pointer, draw (except the text tool), or template tools on.
  • Color and Stroke Options
This panel is displayed to GMs and Players when the Drawing and Template tools are selected, except for the Text tool. For GMs, this panel is appended with the option to select layers.
  • No Panel
The modal panel is not displayed at all when the Measure, Fog of War, Text, or Vision Blocking tools are selected. The panel is also not shown for players connected to a server using Interaction tools, since they cannot interact with anything but the Token layer.
  • Adjust Grid Settings
This is a special mode accessed by GMs under the Map Menu.
  • Adjust Map board Settings
This is a special mode accessed by GMs under the Map Menu.

Toolbar Overview

The Toolbar

Hovering your mouse over a tool will tell you what it does in a tool-tip. Reading the Status Bar in the bottom left will often tell you how to use a tool in the Map View once it is selected.

Tool Palettes and Tools

These buttons change how you interact with the Map View and make different tools available.

  • Interaction Tools
  • Pointer: Lets you select and move tokens. This tool is used the vast majority of the time when playing with others.
  • Measuring Tool: Lets you click and drag to measure a distance on the map. You can use Spacebar while measuring to set a waypoint to measure a path.
The Measuring Tool ignores AI pathfinding, VBL, and terrain modifiers. If you want to measure distances with those modifiers, consider dragging a token with Show Movement Distances enabled in the View menu.
  • AI Toggle: Toggles AI Pathfinding. When enabled (green), all dragged tokens on the Token layer will try to find the shortest path from point A to point B while avoiding vision-blocked areas, accounting for terrain modifiers, and counting diagonal movement rules. In MapTool 1.6.0 and later, clients will now follow the server setting for this button.
When dragging tokens that would have to take very long paths, or impossible paths (such as entering a space not accessible due to the vision blocking layer), there can be a few seconds of delay as the algorithm times out. If this is happening to you frequently (such as when building maps) you can disable the AI system until you want it back on.
  • VBL Blocks Movement: Tokens will navigate around VBL if this is enabled. In MapTool 1.6.0 and later, clients will now follow the server setting for this button.
  • Drawing Tools
Selecting this palette exposes the Drawing Options in the Map View's modal panel (unless the Text tool is selected). Drawing tools create vectors that can be viewed in the Draw Explorer panel.
  • Text Tool
The Text Tool is a little different than other drawing tools. When this tool is selected, clicking on the map will create a new text label. You can also click and drag to move existing labels, or double click a label to change its text or properties. Text labels appear for all players, are hidden by Fog of War, and do not appear on the Draw Explorer panel.
  • Template Tools
Selecting this palette exposes the Drawing Options in the Map View's modal panel. Template tools create vectors that can be viewed in the Draw Explorer panel.
Template tools let you draw a variety of quick shapes on the map to aid with tasks such as determining areas of effect. With the line Template Tools, you must click three times; once to set an origin, a second time to set a direction of the effect, and a third time to set the distance of the effect.
  • Fog of War Tools
When Fog of War is enabled on the current map, these tools can restore or remove Fog of War. Read more in the Introduction_to_Lights_and_Sights.
  • Vision Blocking Layer (VBL) Tools
These tools let you designate parts of the map that block vision and AI movement. Read more in the Introduction_to_Vision_Blocking and Introduction to AI Pathfinding.

Clip and Stream Volume Control

Some macro functions can cause sounds to play on your client. Clicking the speaker icon will mute these sounds, and adjusting the slider changes their maximum volume on your system.

Fog of War Vision Settings

When connected to a server with Individual Views ✓checked, these buttons filter which tokens' vision you will see when no tokens are selected.

  • ME: Show tokens owned explicitly by you
  • All: Show tokens owned by you OR with Owned by All ✓checked
  • PC: Show tokens owned by you OR Owned by All that are PC tokens
  • NPC: Show tokens owned by you OR Owned by All that are NPC tokens

Select Map Dropdown

This dropdown menu contains all the maps in the current campaign in alphabetical order with the the current map ✓checked. Selecting a map will move your view to that map.

The GM will see maps not visible to players listed with crossed-out eye icons, while players will not see these maps listed at all.

When naming maps, using a numeric prefix (i.e. 1.0 Start Map, 1.2 Castle, 2.0 Forest) can help organize your Select Map drop-down considerably.

The Select Map dropdown as of MapTool 1.7.0

Panels

Panels are windows which expose additional MapTool features. They can be toggled visible or hidden by using the Window menu, and their position is customizable; they can be docked to the edge of the Map View, resized, tabbed to share a location with other panels, and floated apart from the application window entirely.

You can reset all the panels by Selecting Restore Layout from the Window menu. MapTool saves the current panel configuration when it is closed.

Connections

The Connections Panel

When playing on or running a server, this panel shows which players are currently connected. Right-clicking on a player's name will let you whisper them (anyone), or boot them (Host only).

Map Explorer

The Map Explorer Panel

This panel shows all the Tokens on the currently selected map, organized by layer. Right-clicking on a token shows its full context menu.

Draw Explorer

The Draw Explorer Panel

This panel shows all the drawing objects (shapes, text, and cuts) on the currently selected map, organized by layer. Below the layer tree is a preview of the selected drawing.

Right-clicking on a drawing exposes additional options. You can change their layer, group drawings, set their style to match the current drawing options, or copy their style to the drawing options modal panel.

Initiative

The Initiative Panel

A tool to help set and track rounds, current turn, and turn order for tokens on the the current map. See the Introduction to Initiative.

Library

The Resource Library Panel

A file browser to drag and drop images and tokens from added folders on the file system onto the map. To add new folders, you must use the 'Add Resources to Library' option on the File menu.

  • Type text into the box by the magnifying glass to only show files in the selected folder whose names anywhere match what you type. For example, typing 'gob' in the search box could return both 'goblin.jpg' and 'hobgoblin.jpg'.
  • Be careful when selecting 'Search subdirectories?' in very large folder trees.
  • The slider on the left side of the file preview changes the zoom level of the preview.

For more information see the Introduction to Mapping.

Chat

  • The Chat Panel
  • The Chat Panel when impersonating a token

Panel where all connected players can type, run chat commands, and run macros directly. Additionally, provides options to change text color, insert emoticons, and toggle scroll lock and typing notifications.

When impersonating a token, your chat messages will appear to come from that token. You'll see the token image to the left of the input area, and have the option to cease impersonation by clicking a red 'x'.

Tables

The Tables Panel

Tables for the current campaign are created, configured, and can be run directly from this panel by double-clicking their image. To add simple tables to your campaign and get a sense for how they work, you can create some simple default dice and playing card tables in the Help menu by selecting 'Add Default Tables...'. For more information read the Introduction to Tables article.

Macro Panels

The Global Macro Panel The GM Macro Panel The Campaign Macro Panel The Selected Macro Panel The Impersonate Macro Panel

Global

Contains any macros attached to the current installation of MapTool. Global macros are saved when MapTool is properly closed, but are not available to other connected players on a server.

GM

Contains GM-only macros attached to the currently open campaign file. GM macros are saved with the campaign, and when on a server are available to all connected GMs.

Campaign

Contains public macros attached to the currently open campaign file. Campaign macros are saved with the campaign, and when on a server are available to all connected players, although players may not add or remove macros from this panel (see Managing Macros in Panels).

Selected

Contains any macros attached to the currently selected Token(s). It also lists identical macros across tokens in a 'Common Macros' area at the top of the panel, if relevant. Token macros are saved with the token, and are available to any GMs or owners of the token on a server.

Impersonate

Contains any macros attached to the currently impersonated Token, and otherwise shows an option to impersonate a selected token. Token macros are saved with the token, and are available to any GMs or owners of the token on a server.

Status Bar

The Status Bar
  • Instructions / Help Text: This portion of the status bar often displays context-sensitive instructions on how to use a selected tool. If you are struggling to understand a tool, look here first.
  • Assets Cache and Image Thumbs Cache: These numbers show, usually in megabytes (MB) the amount of disk space occupied by various image caches. Double clicking on them flushes the caches, freeing disk space (until it fills back up with more cache). Warning! Flushing the Assets Cache while a campaign file is open can result in missing assets if you then save the campaign file. Save and close any open campaign file before flushing the cache.
  • Free Space: A quick reminder of how much free space is on the drive where the MapTool Data Directory is located, usually in gigabytes (GB).
  • Map Coordinates: The x-y position of the cursor on the grid. This corresponds to the coordinates enabled by the Show Map Coordinates option in the View menu, except that the y value in the status bar is numeric rather than alphabetical (0 = A, -1 = -A).
  • Zoom Level: The current zoom level as a percentage. Additionally, clicking on the zoom level allows a custom zoom level to be manually entered.
  • Used RAM: The memory used out of the total amount allocated. Hovering over this section of the Status Bar also displays the Maximum Memory. Clicking here will reclaim some of the used memory.
  • Network Info: The icon on the left shows the server status, while the two grey dots will light up green when sending data, or red when receiving data.

Other Important UI Components

The following additional windows and subjects are key parts of using MapTool for the majority of users.

See Also

Retrieved from "https://wiki.rptools.info/index.php?title=MapTool_User_Interface&oldid=17530"