Tutorials/Building A Board Mod

This tutorial will cover what is required to build a Board Mod. It will start from the empty template and go through everything required to make the mod playable. This tutorial assumes basic understanding of the mod editor, including how to access and create a new mod.

Creating the mod

The mod template being used for this tutorial is the "Empty" board mod template. This template has default values for all mod settings and has no gameobjects in the scene. The mod is unplayable in this initial state as there are no board spaces.

Minimum requirements

Boards are required to contain the following:

• A single Start space
• Every board space must have at least one outward connection to another board space.
• Every board space must be connected (e.g. can't have two disconnected loops)
• Every board space should be reachable through rolling the dice (so no board spaces that are only accessible through Move To Space Actions or similar)

They should optionally also have:

• At least one graveyard space
• Solid props in the WorldGround layer beneath all board spaces and paths between board spaces.

These last two points can be ignored and the mod will still be playable. Things might behave unexpectedly however, like players not respawning correctly or walking between spaces without following the ground.

Adding solid ground

Solid ground can be built from Prop Components with collision enabled. Gameobjects being used as floor in a board mod must be assigned to the WorldGround layer.

Adding board spaces

Create a board space from the Hierarchy Window by right-clicking and choosing Board Object > Board Space This creates a board space set to give keys.

You can move this space somewhere slightly above solid ground and click the "Align to ground" button in the inspector to have it automatically positioned and rotated so that it is flat on the ground. Since this is the first bird space, I'll change it's Type to "Start". This is where players will begin at the start of a game. You can only have one start space to a board mod, any more or less will give an error in the Mod Validator.

To add more board spaces, you can either repeat this process, duplicate and move the existing space, or use the blue connection arrows to automatically (and quickly) build a path of board nodes. Read on to learn about this last method.

Connecting board nodes

Each board node has a blue arrow somewhere around its edge (or four if it has no connections yet). Clicking these arrows will begin the creation of a board node connection. A connection is a directed path from one space to another. This is the path players will follow from space to space. A board space can have multiple incoming and outgoing connections.

To connect two board spaces, click the arrow on one board node. Notice a path is drawn between the space and the cursor. Now click another board node and the path will connect to the space you clicked. If you click somewhere that isn't a space, a new board space will be created there and connected. Using this, you can quickly build paths of board spaces without needing to manually add each space.

If you want to stop creating a connection, you can right click to cancel.

To delete a connection, select it in the Scene View so it is highlighted, then press the Delete key on your keyboard.

You can change the connection type by selecting the board space that the connection originates from. In the Inspector Window expend the "Outgoing Connections" foldout to view the connection type of all outgoing connections. You can choose between Walking and Teleport. Walking is the default where players walk between the spaces. Teleport will instead teleport the player instantly from one board space to another.