VASSAL Reference Manual

Home > Module > Map > Board


Board

A Board represents the physical board on which pieces are moved by the players. A Map Window can consist of multiple Boards laid out next to one another.

If a board image is specified (a PNG, JPEG, SVG or GIF image file that must be created beforehand with some external tool), then the size of the image determines the size of the board.

If the board image is set to null (by clicking the "Select" button and then canceling the file dialog), then no image is used for the board, and the size and color may be specified directly.

To add a board to your map, use the Editor’s configuration window to navigate to the [Map Window] entry for your map. Click to the left of it to open its subcomponents and you should find a [Map Boards] component. You can then right-click on the [Map Boards] component and select Add Board. You will then have a [Board] component for your map!

BoardConfig

You can optionally add a Grid subcomponent to your board to regulate movement by right-clicking the [Board] component and selecting one of the appropriate Add options. See Sub-Components, below, for more details on grids.

Name:

The name of the Board.

Board image:

The image to use for the board display.

Board width:

The width of the Board in pixels if no image is used.

Board height:

The height of the board in pixels if no image is used.

Color:

The color of the board if no image is used.

Board

Board2


Sub-Components: Grids

If a Board contains no grid, then pieces may be placed anywhere on the board. Pieces dropped on top of one another will stack. If the board contains a Hex or Rectangular grid, they can be configured either to allow pieces anywhere or to have pieces snap to the nearest legal location on the board as defined by the grid. The grid may be drawn over the board’s image or drawing may be suppressed (for example if the image already has a grid drawn on it). Irregular grids may be used to define locations on maps where the positions are arbitrary; on such grids the option to have pieces snap to the nearest legal location is selectable. Maps can also be configured to use different grids in different zones through the use of a Multi-zoned Grid.

Hex Grid - a Hexagonal Grid

Rectangular Grid - A Square or Rectangular Grid

Irregular Grid - Manually Configured Spaces of Arbitrary Shape

Multi-zoned Grid - Multiple Zones, Each With Its Own Grid