A) The Vassal Engine & Running To Be King
Let's Get Started


Rules Index   ||  1 - Object of the Game >>

This chapter will go into how to use the Vassal Engine and it describes what you need for a game of "To Be King", hereafter called TBK. If you're familiar with using Vassal, the 'To Be King' Main Page will detail the version requirements and provide links to the latest version of the files and you can skip this chapter and hop down to A.2.1 - TBK Base Module. Just keep in mind that you will need to run a map extension along with the base module to play a game.

Vassal is a multi-platform game engine that can be played on any operating system. Note that these instructions are written for Windows OS. I'm not familiar with other Operating Systems but the instructions should be similar and/or you'll probably be more familiar with how to install programs on your computer's operating system.


A.1 - Installing Vassal

The 'To Be King' Main Page will detail the version requirements. You can usually install newer versions of the engine to run older versions of the game as the engine is backwards compatible. For example, if you are going to play a game that requires Vassal version 3.7.16, you can install 3.7.18 and it should run the game just fine. However, if you're going to be playing online with others, all players must have matching versions of the engine, the TBK module and have the same map extension active.

You can always download the latest version of the Vassal Engine on the Vassal Home Page. They also provide a link to the archives for older versions if you need one. Once you download the engine you want, run it to install:


If you're on Windows, you may get a warning like this:

This is because Windows does not recognize Vassal as an approved program but it is perfectly safe to use. I've been using Vassal since 2007 and it has never caused a problem on any of my computers.

Clicking the "More Info" link will provide you with a "Run Anyway" button:

Click that and you may get another Windows warning asking if you're sure you want to run this programs. Tell it "Yes" and you'll get the installation screen shown here:

Click the "Next" button to continue. You'll be asked to choose a Setup Type. This may be a personal thing but I always choose 'custom' whenever I'm installing something as I'm always afraid a 'standard' setup may be skipping something that I may want to adjust. In this case, go ahead and select 'custom' and "Next".

If this is the first time you've ever installed Vassal, you may not get this screen but I wanted to make sure you were aware of it. It will list other versions you have installed and ask if you wish to uninstall any of them.

As mentioned above, if you wish to play with others online, you need to have matching versions. Also, if you have saved a game in progress (or the host has saved a game that you are playing), you will have to continue that game with the same version of the engine. As you can see here, you can safely install other versions of the engine without harming any versions you already have installed.

The next screen gives you the option on where to install the program. You can install it anywhere on your computer you like or just use the default option shown and click "Next":

Select your preferred shortcut options and click "Next". If you choose to have a shortcut in the Start Menu, you'll get the following screen:

This shows the name of the Shortcut Folder it will use and gives you the option of renaming it or having the shortcuts placed in an existing folder. Click "Next":

Go ahead and click "Install". This will obviously install Vassal and it will also install the proper Java files necessary for that installation so you don't have to worry about upgrading or adjusting you current Java installation. This is what you'll see when it's completed:


Click "Next" and you'll be presented with the final screen:

If you're ready to go on to the next section, make sure the "Run VASSAL" box is checked and "Finish". Otherwise, you can uncheck the box and click "Finish" to come back later.


A.2 - Running Modules

Modules are basically games that run in the Vassal engine and there are currently over 3,400 of them. Here's a link to the Vassal Module Library if you want to browse around and see what's available.

Mostly, it's just a matter of downloading the module you want, opening the module in the Vassal engine and you're ready to go. There may also be extensions that may be loaded with the base module that adds other features, scenarios, etc. Some games, like TBK, require loading an extension.


A.2.1 - TBK Base Module

In order to play TBK, you'll need to load the base module and a map file extension. The base module by itself will run just fine but you won't be able to play a game with it as the maps will be missing and incomplete.

One of the nice features of TBK is that the combination of the module and the map file extension changes some of the map layouts thereby creating a new environment every time you play it. Between that and the literally billions of combinations of things that can occur during the game makes it infinitely re-playable.

Whenever I release a new version package, I'll include 2 map files for that version. Additional map files will be made available on the To Be King Main Page. Unless something really needs to be fixed, I'll wait at least 3 months before releasing new versions of the game so there won't be a constant flood of versions changes. The current bugs list and their statis can be found on the To Be King forum.

What I have here is a folder I've created on my computer and I've placed a version of the game along with 3 map files in that folder. The game module's filename ends with .vmod (Vassal Module) and the map extension files end with .vmdx (Vassal Module Extension). I've also created a "Saved" folder for later.

The TBK package that you unzipped into a new directory probably looks similar to this. As you'll note, the filenames for the .vmdx map files include the version of TBK they were made for. This is because the game will not run properly if you attempt to load a map extension into a base module not made for it.

Open the Vassal engine and you'll be presented with your Module Library. If this is the first time you've run Vassal, it will look like this:

Anytime you run a new Vassal module, it will list itself here so that you'll have a library of modules you've used in the past. If you want to remove any module from the library, right-click it and select "Remove". It may take some time to remove it as it clears a graphics cache that it created for the module. Note that this will only remove it from your module library. The actual module file will remain on your computer.

To start, I would suggest loading just the base module first so that we can adjust a couple of internal properties and get it listed in your Vassal Module Library. Click File -> Open Module and browse to the TBK_(version number).vmod file. It's ok if you're version of TBK is different, they all work the same way.

Since this is the first time you've opened the module, Vassal creates a graphics cache for it which will take a few moments to process.

When it's done processing graphics, it will display the title screen known as the Start Wizard. For now, select "Start new game offline" and click "Next"


If this is the first time you've used Vassal, it will now ask for a Nickname and password.

This simply establishes your player name that will appear in games and the password simply prevents someone else from taking over your player side in a game so, keep it simple and easy to remember. Then click "Next".

This screen allows you to choose your player side in a game. In the case of TBK, you'll be selecting a clan that you're a member of. For this initial start up, though, just leave it as "Observer", then "Finish". This will bring up the main chat window interface. It may take a few moments to load up but once it's done, you'll see a chat window, with control icons, and a Shields window with a "New Round" button in it. These windows may be a different size and located differently on your display. That's ok. You can make adjustments later.


Click File -> Preferences. Under the 'General' tab, you'll see the following:

Insure that the "Use combined application window" is NOT checked. The game uses a lot of windows and I've found it's better to keep them independent.

Make sure that "Center on opponent's moves" is NOT checked. Otherwise, you'll find the map constantly shifting around every time someone selects or moves their token or something else.

I would set "JVM Maximum Heap" to 2048 (2 gigs) if you can devote that much memory and, if you have 6 gigs of RAM or more, I'd go with 4096 (4 gigs). I have 64 gigs of RAM so I have mine set to 8192 (8 gigs). If you don't have a lot of RAM, setting it to 1024 (1 gig) will probably run fine but it may be sluggish at times.

Checking the "Disable the Automatic Stack Display" is a good idea for this game, If you want to see a game component at full size without having to zoom the map, you can click the item and hit CTRL-SPACE.

There's an option under the 'Compatibility' tab I want to point out.

If you find that it's really hard to see a game piece while you're dragging it in the game, check the box shown above. This will make dragging pieces much easier to see.

Click "OK" to save your settings. Now that we've got everything set up, click File -> Close Game. If it asks to save the game, tell it 'No'. Then click File -> Quit or click the "X" at the top right of the chat window. Your new module should now be listed in your module library as shown here:




A.2.2 - TBK Saved Games

Now that the game is listed in your Module Library, let's set up your Saved Game folder. Right-click the module and select "Add Saved Game Folder" as shown here:

Browse to a folder where you'll be saving your games. If you followed my example above, it will be the "Saved" folder in your TBK folder. Click that folder and click "Open".

Your TBK listing in your library will now have a closed folder symbol in front of it. Expand the folder and you'll now see a "Saved" folder listed. Any game you save in this folder will appear here for easy access. If you have a saved game, you can just right-click it and "Open" and Vassal will load the base module, the map extensions and the saved game all at one time.



A.2.3 - TBK Map File Extensions

As mentioned above, you can't play a game unless you load a map file extension. Right-click the TBK Module, select "Add Extension", browse to your TBK folder files and open the Map01.vmdx file.

  

You'll note the map file you just added is printed in black. This indicates that it is the 'active' extension. You can add as many map extension files, made for this version of TBK, as you like. This second pic below shows that I am 'deactivating' the current extension so that I can add the next. I'll do this until all of my map files have been added.

  

Now that I've got my map extensions listed, I've 'deactivated' Maps 1 & 3 and 'activated' Map 2. You'll note that deactivated extensions are gray and have the notation (inactive) and the extension files have also been moved into an extension folder that Vassal has created in your TBK folder. I can now right-click the base TBK module and tell it to "Open". It will automatically open the activated extension. For TBK, make sure to only have one extension active when you open the module.

You'll see the Start Wizard and for now, select play mode as "Start New Game Offline". When you click "Next" you'll see a new screen asking you to Select Setup. click the drop-down arrow and you'll see a selection for an "Assets" file.

Click the Assets file and, when it's done loading, it will give you a "Next" button that will allow you choose a player side. In this case, select "Observer" as a player side and finish. When the "Shields" window is displaying a "New Round" button, the game is loaded and ready to go.

I would now suggest saving the game in the 'Saved' folder. Give it any file name you like (although you might want to include the Map # in the file name) and end the file name with .vsav (Vassal Saved File). In the future, you can go into your Module library, go into the 'Saved' folder, right-click the saved game and select "Open". It will completely load everything you need and return to exactly where you left off. Just make sure that the correct Map Extension used for the saved game is active.


A.3 - Playing Online

This section will explain how to play online, either by joining an existing game or hosting a game for others to join.

A.3.1 - Hosting a Game

Open TBK with an active map extension. Select the "Start new game offline" option when the Start Wizard appears.

Once the game is loaded, Click the Server button in the menu bar shown here:




This will open the server controls that looks like this:

The arrow is pointing to the connect button. Click that and you'll connect to the Vassal gaming server and a room named Main Room will appear with you in it. In the "New Game" box, type a name for your room and click "Create". You'll see the new room with you in it and you'll also see the versions of the Vassal Engine and TBK shown to the right of the room. Others may now connect to your room. Once everyone is in, you can begin play.

To disconnect from the server, click the broken lines icon that I've highlighted with an arrow in the second pic.

  

If you host a game, you are normally the one responsible for saving the game to continue later. No other player needs to save the game if you save the game.

If you are hosting a saved game, you can either open the saved game directly or select the "Load saved game" option when the Start Wizard appears. Then setup a new game room the same way as above. When your previous players connect to the room, the game will automatically update their gamestate to match the current game in progress as long as they have loaded the same versions of TBK and the map file that was used in the previous game session.


A.3.2 - Joining a Game

If you wish to join a game hosted by someone else, you do not need to load assets or a saved game. You just need to make sure you're running the same versions of TBK, the Vassal engine and the same active map extension that everyone else is playing.

Start the module and when the Start Wizard appears, select "Look for a game online". This will automatically open the server controls and any hosted games of TBK will appear. To join the game, right-click the room they've created and select "Join Game" or just double-click the room.

When you connect, the host game will automatically load everything necessary to match your gamestate to everyone else so you don't have to load a saved game... the host should have taken care of that.


Rules Index   ||  1 - Object of the Game >>

Dr Nostromo's Home Page