Skip to content

Using BoardBuilder

Jump to bottom
Doug Rimmer edited this page Mar 22, 2017 · 14 revisions

This document describes how to use the BoardBuilder tool to build/compile the board archive files (i.e. bdXX) that are used by VASL to display mapboards. It is important to use BoardBuilder to ensure that only essential files are included in the board archive file to minimize file size, thereby improving performance for VASL users.

The build/compile (the terms have the same meaning in this context) action is one step in the larger process of creating or updating a VASL board. Instructions for the complete process are found at: Creating, adding LOS data to, and Updating Boards in the Age of Automatic Board Synchronization.

Boardbuilder is included in the VASL code repository. To use it, it is necessary to clone a copy of the VASL code repository. Instructions for doing so are included in the GettingStartedWithVASLDevelopment.docx found in the /dev documentation directory of github.com/vasl-developers/vasl.

Once the VASL code repository is installed on a local machine, it is necessary to configure BoardBuilder to run. Procedures for doing so will differ depending on the IDE being used. The following instructions are based on the IntelliJ IDE from JetBrains and mirror Section 4.1.3.2 of GettingStartedWithVASLDevelopment.docx.

  1. From the Menu bar, select Run → Edit Configurations. If no item is listed in left-hand listbox, click the green + sign and select “Application”. Enter "BoardBuilder" in the Name textbox and “VASL.BoardBuilder” in the Main Class textbox.

  2. Enter "boards/src BoardsOut" in the Program Arguments textbox.

  3. Ensure that the Working Directory textbox refers to the folder where the current project is located. If not, type in the folder name or navigate to it using the Directory button beside the textbox. Select an option from the dropdown list for the classpath of module: use the one that resembles your project name, do not use 'test'.

  4. Click OK to save the configuration and close the dialogue box.

From the Menu bar, select Run → Run BoardBuilder.

When running BoardBuilder will create a board archive file for each board with a corresponding folder in boards/src. Depending on the IDE, text will be displayed during the run process describing progress.

Once BoardBuilder has finished it will automatically terminate. You will be able to view the BoardsOut project directory from within the IDE. These files can be accessed outside of the IDE using your computer's file management tools (i.e. File Explorer) to complete the steps described in the Creating, adding LOS data to, and Updating Boards in the Age of Automatic Board Synchronization.

In this standard configuration, BoardBuilder will build all boards in the boards/src directory everytime it runs. It is possible to limit building to one board. To do so, add the board name (in the format bdXX) after "boards/src BoardsOut" in the Program Arguments textbox (eg. "boards/src BoardsOut bd37").

Clone this wiki locally