Introduction to Tokens
Introduction to MapTool Tokens
As mentioned in the Introduction to Mapping guide, a token is the MapTool jargon for a visual marker that is placed on a map within the MapTool software. The most intuitive use for tokens is to represent characters in the game - in other words, tokens take the place of miniatures on the virtual tabletop.
This guide assumes that you have read the Introduction to Mapping, and that you know how to:
- Add folders to your Resource Library, and update/add images to those folders so that they appear in your resource library
- Create a map in MapTool
- Place tokens on a map, and move them around
- Change token names, GM names, labels
- Change the token's size
- Change the token's image
- Move tokens from one layer to another
If you don't know how to do these things, please read the Introduction to Mapping guide - otherwise, the stuff below might not make much sense!
Finally, this guide will be written predominantly from the point of view of the GM -- someone who has complete control over all token settings and campaign properties. Players (that is, individuals who join a game in the role of "Player") are restricted from changing many things in a particular campaign.
Although most MapTool users use the term "token" to refer only to images representing characters and creatures on a map, in reality, the word "token" refers to any image item that is dropped onto a map in MapTool. The way a particular token is handled is dependent on the Map Layer onto which it is placed. These layers are explained below, because they are important in understanding how to work with tokens.
- Items dropped on the Token layer are what we most commonly consider "tokens" - these represent characters, monsters, NPCs - the people and creatures of the game.
- Items dropped on the Object layer are most commonly images representing furniture, chests, and things in the game world - something that a person can manipulate or use. MapTool still considers them to be tokens, of course (everything is a token to MapTool - it's very singleminded) but for clarity's sake, most users call them Objects to distinguish them from tokens that represent characters.
- Items dropped on the Background layer are typically things that make up the map - walls, cliffs, dirt, grass. They might be unique, but are most often "stamped" onto the map over and over again, either in a pattern or because you're using several copies of the same image (for instance, using several copies of a wall image to make a complete room). Because of this, many users will call these images stamps.
The Hidden Layer
You'll note that I didn't discuss the Hidden layer in the above paragraph. That's because the Hidden Layer has a slightly different purpose.
While the Token, Object, and Background layers have a fairly intuitive relationship in terms of how one might think of the world -- I'm a person or creature, that item over there is an object, and surrounding us is the background -- the Hidden Layer is the things you cannot see. In MapTool, anything placed on the Hidden Layer is visible only to the GM until he or she decides to move it to one of the other layers.
Generally, you'll want to put characters and objects on this layer - there aren't many reasons to put a background stamp on the hidden layer, although I'm sure you can think of a couple.
Suffice it to say, when you place a token on a MapTool map, it pays to be aware of which layer you placed it on!
Creating a New Token
Creating a token is as simple as dragging an image from the Resource Library onto the Token Layer of a map. In addition to a few default tokens, MapTool has several great token packs freely available for download through the RPTools Library tab of the
File > Add Resource to Library... dialog. You can also drag an image directly from your file system into your map view in MapTool and it will create a token out of it.
But how do you create custom token images yourself, or find custom tokens for your game? There are several options.
Download an Image
MapTool's user community has created a wealth of token images that are available for use. Visit the RPTools Forums or check out the #artwork channel pins on the MapTool Discord Server for help finding the hundreds of token images already out there.
Create one Using TokenTool
Another option is to create your own images using TokenTool, a program built by the makers of MapTool to create token images quickly and easily.
To create an image using TokenTool:
1. Download TokenTool and open it by double-clicking on the file with the extension .jar (this is a Java "JAR file" which will run a java program).
2. Find an image you like (be cautious about copyright!) and drag it onto the left pane of the TokenTool window (this is the part with the small green ring and a black background).
3. When the image appears, drag it around with the mouse until the portion you want for your token is inside the green ring. You'll see a preview of what the token will look like in the upper right side of the TokenTool window.
- Tip: You can use the mouse wheel or the zoom buttons to adjust the image's size until it looks just right.
- Tip: You can change the look and color of the border, the final size of the token, and many other settings by using the drop-down menus on the right-hand side of the TokenTool window.
4. When you get it where you like it, go to File > Save Token, and save the newly created token in a directory that is either already in your Resource Library, or is one you plan to add to your resource library. Note that the file will be saved in PNG format (this is a good thing! it allows for transparency so your token isn't slopping outside the border!).
5. Go back to MapTool and add or refresh your Resource Library, and there you'll see your new token! Drag it onto a map, and you're good to go.
Draw One Yourself
You can create a token image of your own by using an art program and saving the file in PNG or JPG format, in a directory that is either in your Resource Library, or a directory you plan to add to your Resource Library. PNG format is the recommended format for MapTool tokens because it allows for transparency and, basically, looks the best.
You can of course combine drawing your own image with using TokenTool to create handsome and neatly formed tokens.
Editing a Token
Editing a token means changing any of the token's characteristics, be that its image, its name(s), or its configured settings. Changing token names, image, and size are covered in Introduction to Mapping.
The following sections deal with the various options, tabs, and drop-down boxes in the Edit Token Dialog.
Tokens have 2 possible types in MapTool: NPC and PC. These will be familiar to players of roleplaying games because they stand for "Player Character" and "Non-Player Character," and the most common use of this "type" setting is to distinguish between the two groups during actual play.
In general, tokens belonging to your players should have the type "PC." Tokens belonging to you should have the type "NPC".
NOTE: The type of a token does not have any bearing on who may manipulate that token or view it's properties - instead, that power is granted to the owner or owners of a token. As GM, you are considered to have ownership of all tokens on all maps in the campaign. See Ownership, below, for more details.
To change the token type:
1. Double-click the token to open the Edit Token dialog.
2. In the upper-right corner, use the drop-down box to select PC or NPC.
3. Click OK.
The Notes tab presents two areas where you can enter notes about the token. These fields support basic HTML tags, so you can format the note.
The upper text field is there for notes that are available and visible to anyone who wishes to see. The lower field (titled GM Notes) is for notes that only the GM(s) should see.
Notes are a little tricky - MapTool has a way to display them in a nifty popup, but you have to do a couple things first.
- Enter information in the notes field of a token.
- Place that token on the Object Layer or the Background Layer by right-clicking and selecting Change To >
- Switch back to the Token Layer
Now, you'll notice that when you put your mouse cursor over the token, the cursor will change to a hand. If you double-click, instead of the normal Edit Token dialog, you'll see a small popup in the lower-left corner of the map, which will display the notes.
The major lesson is that -- while Token notes can be accessed in many ways -- one of the more common uses is to place notes and reminders on tokens and objects that will be on either the Object or Background layer.
Properties are a topic that deserve their own guide, as they are heavily involved in the creation and use of token macros. This guide won't go into excruciating detail about properties, but will instead deal with only the most basic information about them.
Every token dropped onto a map in MapTool automatically gains a set of properties, which can basically be thought of as stats, characteristics, or traits (you know, the numbers on a character sheet). In effect, each token is carrying around it's own built-in character sheet. In programming terms, properties can thought of as variables that can be set to different values, and then used later by macros.
- Note: although people frequently refer to "token properties," the properties that are visible in the Edit Token dialog are only those properties that are set up for the specific campaign.
When you click on the Properties tab in the Edit Token dialog, you'll see a list of the properties that are currently set up for the Campaign you're using. If you've opened up a new campaign (or just started MapTool), you will see the default property set, which looks like:
For the rest of this guide, examples using properties will use the list above.
The property list you see is in a table (or spreadsheet) layout, with the property name on the left, and a blank space on the right. In the space on the right, you can enter the value you want to assign to that property. You can enter text, numbers, or in more advanced cases, macro statements as the value for a particular property.
Once you do that, and hit OK, that property on that token will be assigned the value you enter. Later on, if you write macros, you can refer to those properties to make calculations or roll dice.
Since properties are such a major topic on their own, check out the Introduction to Properties guide for detailed information.
VBL (Vision Blocking Layer)
Tokens can have VBL applied to them so they can block lights and sight.
- Generate Token VBL: Creates VBL on the token automatically from the token's image. This totally regenerates the VBL every time it is clicked.
- Color Selection: Use the eye-dropper to pick a color in the image to be turned into VBL. Defaults to using transparent areas of the image.
- Color Sensitivity: Adjusts how closely to match the selected color or transparency.
- Inverse VBL Color Selection
- Level: The distance a line segment between two points can be from the edge of an image. A higher level will reduce the total number of points but may not follow as closely to cave walls and other irregular surfaces.
- Method: Choose between Douglas Peucker(default), Topology Preserving, VW Simplifier and No Optimization.
- Clear Token VBL: Resets the VBL on this token, totally clearing it.
- Move VBL To Map: Copies the Token VBL to the Map's VBL layer. If Erase Source VBL is ✓checked, this also clears the token's VBL.
- Move VBL From Map: The inverse, replacing any Token VBL with any VBL which overlaps the token's occupied square. If Erase Source VBL is ✓checked, this also clears the map VBL which was copied.
- Erase Source VBL: When ✓checked, clears source VBL in the above two operations.
- Is Visible over FoW: Allows the whole token to render above Fog of War if some of it is visible (controlled by Visibility Tolerance). This is helpful for figure tokens on isometric maps, so they don't appear cut off at the waist when partially visible or up against VBL. Also useful on doors, pillars or other map objects that block line of sight but are difficult for players to spot if partially covered by Fog of War.
- Note: If Vision is Off on a map, this setting will always display the token over hard fog of war regardless of VBL, Token Sight, or Map Vision Distance. This can cause issues on maps with many 'Visible over FoW' doors, as all the doors will all appear over the hard fog which can spoil the map for players.
- Visibility Tolerance: How many of the 9 zones of the token need to be in Line of Sight of another token to be revealed to it. Has no effect if Vision on the map is set to 'Off'.
- Hide Token Image Preview: When ✓checked hides the token image preview and only shows the VBL in the preview area.
Shows the token image with VBL if present. When generating VBL the Original Point Count will appear in red and the Optimized Point Count will appear in green.
States are visual markers that can be applied to a token (typically appearing as an image superimposed on the token) that can be used for any sort of reminder that you might need in a game. For instance, if you want a marker that a particular NPC token is "dead", you can set the state "Dead" on the token, and whatever image you've selected to indicate "Dead" will appear on the token.
The default states that load when MapTool starts are:
- Other 2
- Other 3
- Other 4
The State tab also contains the setting information for the Bars that the token displays or can display. These bars are shown superimposed over the token (at the top, bottom, or sides), and can be used to track things like health (or ammunition, magic, or anything that can be lost or expended).
As of MapTool version 1.3.b54, the Macros tab of the Edit Token dialog is no longer enabled. It has been replaced by the Selection window. Select one or more tokens with the Selection window open and the macros for those tokens will be shown. This tab originally held the token macros, but as macro capabilities became more advanced, this tab became less and less useful, until finally, it was removed. It is present in earlier versions, though, if you want to take a look.
This tab contains the token's speech list. You can use this tab to configure sayings, aphorisms, battlecries, and anything you might want your token to "say" in chat. There are two fields for each speech item:
- ID: This field is the short identifier you assign to a speech item; the ID is used in chat to refer to the full text of the speech. It can be alphanumeric, so you could use number, or letters, or a mix. It cannot have any spaces in it, though!
- Speech Text: This is the actual text that will be displayed in the chat window.
To use a speech item, do the following:
- Select the token you want to have "say" something
- In the chat window, enter /tsay (ID), where "(ID)" is replaced by the actual ID of the speech item. So if you wanted to howl your battlecry - which you've cleverly given the ID "bcry" - you would select your token, and enter /tsay bcry in the chat window.
Token ownership determines who among the players connected to the game is allowed to select, move, or view the details of a given token.
If you are the owner of a token, you may select it, double-click on it to open and edit it, and move it around on the map. If you are not an owner of a particular token, you are limited to looking at it on the map -- you will not be able to select, move, or view its properties and configuration.
To set an owner, simply check the box next to that individual's name. The names shown in the box will be the names of each player (including the GM) connected to the game (so if you're looking at the Ownership tab when nobody else is connected, you'll see only your own name). If you want to give ownership to all players, just check All Players.
(Note that the selection of options when the server is started must include Strict token ownership if you want the functionality described above. See Introduction to Game Hosting#Starting Up a MapTool Server for details on server options.)
This tab contains a number of settings that affect how the token looks, moves, and interacts with MapTool.
Tokens can have four shapes in MapTool:
- Top Down: top-down tokens are usually hand-drawn or rendered images of creatures, objects, and people as if you were looking down from an aerial view. Setting the token shape to Top-down tells MapTool to allow the token image to rotate when you right-click on the token and select Change Facing (that way, your top-down token can turn to face its enemies!)
- Circle: circular tokens are like pogs or poker chips - round images that represent the creature or character. Because they are markers and not meant to be realistic "top-down" views of a creature, when you select Change Facing, instead of rotating the image - which would look bad - a small yellow arrow appears to indicate facing.
- Square: square tokens work like circular tokens, except that they are...wait for it...square.
- Figure: figure tokens have been introduced from Maptool 1.4 and like top-down tokens are usually images of creatures or people but this time designed to appear as though you are looking at a miniature figure on a table. Figure tokens are specifically designed so that if they are higher than they are wide, they will extend beyond the top of the cell.
A token can be given a number of sizes, which scale the token image larger or smaller.
The available size depend on the map grid used when setting up a map. If you set a map with a grid (hexagonal or square), you will have the Free Size option (which lets you scale the token as you need), or a number of sizes from "Fine" to "Colossal" (if you play D&D, you'll probably recognize them).
If you do not set a grid when you create the map, you will be able to scale the token along a number scale, from -11 to +20.
This field allows you to indicate which of the available property sets in the campaign this token has. The designer of a campaign can set up different sets of properties to be used by different tokens (for instance, a set of properties for player character tokens, and a different set of properties for non-player character tokens). This field lets you pick which property set to use.
This field allows you to indicate what kind of sight the token possesses. Sight settings allow the gamemaster to simulate darkness, light, hidden objects, and hiding enemies.
Introduced in Maptool 1.4, this field allows you to link a table to the token. If the token is given a facing, then the facing value will be used to select an image from the table which will replace the normal image of the token. This is frequently combined with the "Figure" token shape on isometric maps to simulate a 3D effect.
Snap to Grid
This checkbox simply indicates that the token snaps to the existing grid when it is moved. If unchecked, the token does not pay any heed to the grid when it is dragged around on the map.
Visible to Players
This checkbox lets you designate a particular token as invisible to players - when checked, no player connected to the game will be able to see the token or interact with it in any way.
Drop down selection of Terrain Modifier Type and numeric field to enter Terrain Modifier Value. Note that tokens or objects must not be set to Free Size for the terrain modifier to apply to all grid cells it covers.
- NONE - No modifier is applied to movement into the grid cells covered by the associated token, object or stamp.
- MULTIPLY - Movement cost into the cell is multiplied by the value field. Values less than 1.0 enhance movement. Think escalator, moving walkway or a highway.
- ADD - Adds the value to the movement cost of entering a cell.
- BLOCK - Blocks movement entirely. See Ignore Terrain setting below.
Set the opacity, i.e. transparency, of a token from 0 to 100% opaque (default).
Tokens can be set to ignore zero or more Terrain Modifier Types (Ctrl-Click for multi-select).
Layout, Portrait, and Handout
There are three fields dealing with the token's visual appearance:
- Layout: this shows how the token will look on the map
- Portrait: this is a separate image that will appear in the lower left corner of the map screen when you hover over the token
- Handout: this lets you designate an image to appear when you right-click on the token and select Show Handout