• Map

OpenRPG User Guide: Map

The map is generaly the area in the upper right of the program. See the User Interface if you haven't already located it.

When you save a map or load a map the data is stored in an xml file. This xml file contains a description of the map. It is not the image that is drawn on the map but a description of the contents. What this means is that the xml file contains things like if the map has hex or square grids, If snap to grid is on. If the background is just color, or a tiled image, or a picture.

For instructions on loading a picture on the screen as a map continue reading this page.

• The map has 6 tabs which include Background, Grid, Miniatures, Whiteboard, Fog, and General

The 6 tabs of the map are also called map layers. Each will be described below.

Note: When editing any option, you must hit the apply button for changes to take effect.

Background

Any normal image type can be used (jpeg, png, gif, bmp, etc can be used). Basically you click on the background tab of the map select either image, texture,color from the image/texture/color drop down button.

This selects the fixed background for the map area. There are four options:

None

This clears the current background, leaving you with a clean slate.

Image

This allows you to load an image -- the most useful of which are maps. Then you should see a text entry box where you can type in the URL to your image (Your image has to be hosted on a web page somewhere) i.e. http://www.openrpg.com/images/tavern.jpg (this is an example and the link doesn't really exist so try it with other images on the net.)

Texture

This applies an image which is repeated in the background. It's most useful if you want a textured background or other repeating pattern.

Colour

This option lets you set the colour of your map to a plain colour.

Grid

This lets you define if you want a grid overlaid on your map and if so how it is displayed.

Pixels Per Square

Despite the name, this determines the number of pixels per edge. A large value will result in larger hexes or squares on your map.

Ratio

This option scales the entire map and grid, exactly the same as using the zoom-in and zoom-out buttons. It can be used to quickly jump to a given level of zoom.

Line Type

The second drop-down box allows you to select solid, dotted, or no lines. Having a grid with no lines still has an influence on the map, as miniatures can be made to 'snap' to a grid square/hex.

Rectangular / Hexagonal

Lets you select between rectangular and hexagonal grids. Simple, really.

Snap to Grid

When enabled, any miniatures will 'snap' to the center of a square or hex on your map. Turn this feature on if your game works best with miniatures being in well-defined square and locations. Turn this option off if you need more finer placement of miniatures, particularly if you're placing locked tiles that will act as backgrounds or fixed features.

Color

This allows you to set the colour used by the grid.

Miniatures

This tab allows the loading of various miniatures onto the map area. The text-box allows the URL of the miniature to be specified, and the Add Miniature button loads the image. If Auto Label is selected, then the file's name (without extension) will be used as a label on the miniature, along with a counter (eg, Firebeetle 1).

Miniatures can be moved by selecting the miniature on the map (which will highlight it with a box), and then selecting its new position.

The rest of this manual entry to be completed

Miniature Properties

Hiding Miniatures

Miniatures can be marked as hidden. The primary reason for doing this is to have features on your map which are not visible to players until activated. Examples include secret doors or areas, hidden traps, and so on. Note that hiding a miniature hides it both for players and GMs, however GMs can locate and un-hide the miniature using the miniature locating tool (the leftmost icon on the map toolbar).

Locking Miniatures

A locked miniature cannot be used. This option is useful for features that should not be moved (such as walls, doors, tables, etc), or which are moved only rarely.

Facing and Heading

Miniatures can be assigned both a facing and a heading. Just as it's possible to walk down the street but look to either side, it's possible for your miniature to be heading in one direction, but facing in another. Setting these options will display colour arrows to indicate the miniature's facing and heading.

Whiteboard

Very simply, the whiteboard allows you to scribble on the map. A pen colour can be chosen, and notes, drawings, or doodles can then be drawn with your pointer. In version 1.6.1 the pen width can also be selected. You start drawing by clicking once on the whiteboard. You stop by double clicking. lines are selected by hovering over them.

As of 1.6.2 and later versions you can select from drawing lines or typing text. To enter text on the whiteboard click on the pulldown menu that says "Draw line" and select the "Draw Text" item. Then click on the map and you will be prompted with a dialog asking you what text you for the text. When you press OK the text will appear on the map in the current drawing color. You can edit the properties of the text by right clicking on the text.

Fog

Most maps wouldn't be very exciting if the players could see everything that is occurring, all of the time. 'Fog' allows the application of a simple 'fog of war', restricting the visible area of the players. Anything in 'fog', be it the map background or miniatures, cannot be seen by players or lurkers. While this tab is active, you can right-click on the map to bring up a menu. The two most useful options in this menu are the ability to hide everything, and the ability to remove all fog.

Fog can be applied or removed from particular areas by selecting 'show' or 'hide' from the fog toolbar, and then drawing around the region to display or hide.

If you find that fog makes it difficult to hide (for example) secret or hidden doors or areas, consider placing those features into hidden locked miniatures instead. You can then safely un-fog those areas, but the secrets will only be revealed when the GM chooses to un-hide the miniature.

General

This entry to be completed