Images

From Fantasy Grounds Wiki
Jump to: navigation, search

Image and Map List

The campaign image and map list can be accessed via the appropriate tabletop sidebar button. For the GM, this list contains all the image and map entries for the campaign and any data modules open. For the player, this list contains any image or map entries shared by the GM.

Please see the Categories topic for information on category tabs that appear at the bottom of the campaign image and map list.

Please see the The_Basics#Lists for details on editing the list. Only GMs can edit the image and map list.

If a new image record is created manually, then the image will be a "drawing only" image with a blank base layer. A default size of 500x500 pixels is used for a blank base layer. The size of a blank image layer can be expanded by right clicking on the image, and selecting this Drawing->Expand Drawing menu options.

To add image records automatically using a graphics file, add the image to the campaign by dragging the file onto the images and maps list from Windows, or click on the Folder button and add the image files to the folder that is opened. Maps and images added in this way use the image as the base layer.

An image can be renamed in the campaign image and map list by right clicking on the image entry and selecting the Rename menu option.

Image Record

Image example.jpg

Each image record window consists of an image toolbar and the actual image or map.

To share an image record with all players, either right click on the image record window and select the Sharing->Share Sheet option, or drag and drop the record link from the campaign image list onto the chat window.

To share an image record with a single player, drag and drop the record link from the campaign image list onto the character portrait in the tabletop character list.

Viewing

The image control in the image record window is a viewport, or "window", onto the image that can be moved around and zoomed in/out.

  • Resize Viewport: Hold CTRL and then Left click and hold inside the viewport, then drag horizontally or vertically to resize in that dimension; or Left click and hold on the resize handle for the viewport and drag horizontally or vertically to resize in that dimension.
  • Move Viewport: Left click and hold inside viewport and drag horizontally or vertically to move the window in that direction.
  • Pan Image Inside Viewport: Left click and hold on the scroller button in the bottom right of the image window and drag in the direction you want to pan; or middle click anywhere on the image, hold and drag.
  • Zoom Image Inside Viewport: Mouse-scroll wheel up or down inside the image viewport; or Press and hold CTRL key and left click and hold on the scroller button in the bottom right of the image window and drag in or out to zoom in or out.
  • Reveal Push-Pin Shortcuts: Hold CTRL to reveal any linked items. Hover over the shortcut with CTRL still depressed to read the short description and click the shortcut pin to open that section.

There are a couple additional options available to the GM:

  • Toggle Client View Lock: Right click on the image, and select Sharing->Lock Client View. When the view is locked, the current GM viewport is the only portion of the image visible to the players. Any portion of the image outside the locked viewport is obscured.
  • Synch Client View: Right click on the image, and select Sharing->Synch Client View. This function sets the viewport of all players viewing this image record to be the same as the GM.

Grid

The GM can add a grid to any image to create a framework for game mechanics, such as movement, reach, etc. Once a grid has been defined, there are a number of features that will be enabled as well: token underlays (faction, size and reach); pointer measurements; token snap to grid center and vertex points.

  • Enable grid: Right click on the image, and select Layers->Set Grid. Then, the cursor will turn into a special grid setting mode. Left click and drag to define the distance of a single grid square.
  • Disable grid: Right click on the image, and select Layers->Grid Off.
  • Toggle grid type: Right click on the image, and select Layers->Grid to Square/Hex to toggle between square and hex grids.
  • Toggle grid snap: Right click on the image, and select Layers->Snap to Grid On/Off to toggle snapping of tokens and pointers to the grid.
  • Adjust grid: Use the toolbar to adjust the grid; or disable and re-enable grid.

Masking

In many situations, a GM would like to be able to share an image, but selectively decide what sections of the image will be shown to the players. Using the mask layer, the GM can add a mask over the image which hides the image, then the GM can select specific areas of the image to display.

Masks are often used with maps to show areas that the players have already explored, while keeping unexplored areas hidden. This is similar to how most face-to-face games are played with battle mats.

  • Enable mask: Click on the toolbar mask icon (when mask is disabled); or right click on the image and select Layers->Enter Mask Mode menu option.
  • Disable mask: Right click on the image, and select Layers->Disable Mask menu option
  • Toggle masking cursor: Click on the toolbar mask icon (when mask is enabled); or right click on the image, and select Layers->Enter/Exit Mask Mode menu option.

While the masking cursor is enabled, left click, hold and drag mouse on image to unmask a rectangular region. To remask a region, hold the CTRL key while dragging the mouse. To unmask/remask a freehand region, hold the SHIFT key while dragging and draw a shape around the region to unmask/remask. Holding the SHIFT key while defining a freehand region will lock to vertical/horizontal lines.

Drawings

By default, anybody can draw an image record they can view. The drawing layer is shared by everyone for drawing and erasing. The GM can choose to lock the drawing layer for all players, if needed.

  • Toggle Drawing Mode: Click on the toolbar pencil icon; or right click on the image, and select Drawing->Enter/Exit Drawing Mode. The cursor will turn into a quill, which can be used to draw on the image by left clicking the mouse and dragging. Hold the SHIFT key to make vertical/horizontal lines while drawing.
  • Toggle Erase Mode: Click on the toolbar eraser icon; or right click on the image, and select Drawing->Erase (only while in Drawing mode). The cursor will turn into an eraser, which can be used to draw a freehand region around the area to be erased. Hold the SHIFT key to make vertical/horizontal lines in the erase region.
  • Toggle Drawing Lock: Right click on the image, and select Drawing->Lock/Unlock Drawing Layer.
  • Erase Drawing Layer: Right click on the image, and select Drawing->Clear Drawing.

Pointers

Pointers are markers that can be placed on maps and images to highlight regions on an image. By default, pointers can be arrows, circles, squares or cones. If a grid is present, the grid squares under the area markers are highlighted. For players, the pointers will be colored the same color as the active character. For GMs, the pointers will be match the GM color.

  • Add Quick Pointer: Hold the left and right mouse buttons on the image while dragging to create a quick pointer. An arrow pointer will be created by default. To create other quick pointers, hold the appropriate modifier key (SHIFT = Square, CTRL = Sphere, ALT = Cone). Only one quick pointer can exist at a time, and will be overwritten by the next quick pointer addition.
  • Delete Quick Pointer: Click the left and right mouse buttons on the image without dragging.
  • Add Pointer: Right click the image, and select Pointers->Draw Arrow/Circle/Square/Cone. The next time you click and drag on the map, the pointer specified will be drawn.
  • Adjust Pointer: Hover over a pointer to make the pointer start point and end point handles appear. The start point for circle and square pointers is the center of the pointer. Click and drag the start point handle to move the position of the pointer on the image. Click and drag the end point handle to adjust the length/radius of the pointer.
  • Delete Pointer: Right click while hovering over a pointer, and select the Pointers->Remove This menu option.
  • Delete All Pointers: Right click on the image, and select the Pointers->Remove Pointers menu option.

Pins

Pins can be placed on images to create shortcut links to other campaign records. Pins are often used to place links to location descriptions and encounter information relevant to a location on an image. The pin layer must be enabled for the GM to view, create or delete pins. Players can not see pins.

  • Toggle Pin Layer: Hold CTRL key while viewing image to temporarily view pins; or right click the image, and select Layers->Enable/Disable Shortcuts menu option to toggle the pin layer visibility permanently.
  • View Pin: Hover over a pin to view the description of the shortcut link associated with the pin, then click on the pin to open the shortcut link.
  • Add Pin: Drag and drop any shortcut link while the pin layer is enabled.
  • Delete Pin: While pin layer enabled, right click on a pin, and select the Delete Shortcut menu option.

Toolbar

In many rulesets, a toolbar is available at the top of the image record window to allow quick access to common image commands. The token specific commands are detailed in the Tokens topic, while the image specific commands are detailed above.

Some commands apply to the selected/active token(s). If no tokens selected, the active character token will be used for players, and the active combat tracker token will be used for the GM.

The player toolbar contains the following buttons:

  • Toggle Token Selection Mode: Toggle the token selection mode. See Tokens topic.
  • Toggle Token Targeting mode: Toggle the token targeting mode. See Tokens topic.
  • Clear Targets: Clear all targets for the selected/active tokens.
  • Target Friendly Units: Set all tokens with the same faction as targets for the selected/active token(s). See Combat Tracker topic for adding tokens with faction.
  • Target Enemy Units: Set all tokens not in the same faction as targets for the selected/active token(s). See Combat Tracker topic for adding tokens with faction.

The GM toolbar contains the following additional buttons:

  • Toggle Mask Mode: If mask not enabled for this image, a mask will be added. Otherwise, the button toggles the masking cursor. (eye)
  • Toggle Drawing Mode: Toggles the drawing cursor (quill).
  • Toggle Eraser Mode: Toggles the eraser cursor.
  • Toggle Grid Adjustment Sub-Bar: Adds/removes additional buttons to adjust grid.
  • Move Grid Left/Right/Up/Down: Moves the grid one pixel in the desired direction.
  • Make Grid Larger/Smaller: Makes the grid square larger or smaller in one pixel increments.

Tokens

Please continue to Tokens topic for more information on token usage on images.