This tutorial is valid as of: . Written by Mu0n.

Installation Guide

Installing the program Vassal
Go to the vassal homepage

http://www.vassalengine.org/

Current vassal version: 3.2.17

Where to get the X-Wing vassal module files?
Which module files are the ones I need?
  • Star_Wars_X-Wing_Miniatures_Game-6.5.2.vmod

That's it. Really. That's the only mandatory file. It contains a few 3x3 starfield maps (classic, light and deep), a teal nebula map (formerly known as blue nebula) and then a bunch of standard black maps (3x3, 4x4, 5x5, 3x6 and 6x3). It contains all ships, pilots, upgrades, tokens, dials currently released in its counterpart tabletop game, and then some, as previews from FFG filter out information to us. Vassal is a great way to try out some of the unreleased, but spoiled stuff from the game.

If you want more variety for the maps, there will be a new unified map pack carrying its own version number: Universal_Map_Pack_1.0.vmdx

Which module files are obsolete and can be safely discarded? (from previous installations?)
  • Star_Wars_X-Wing_Miniatures_Game-6.5.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.4.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.3.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.3.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.2.6.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.2.4.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.2.3.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.2.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.2.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.1.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.0.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.0.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.7.3.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.7.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.7.1.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.7.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.6.6.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.6.4.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.6.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.6.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.5.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.4.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.3.3.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.3.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.3.1.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.3.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.2.3.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.2.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.2.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.1.5.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.1.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.1.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.0.8.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.0.5.vmod
  • Star_Wars_X-Wing_Miniatures_Game-5.0.1.vmod
  • Star Wars X-Wing Miniatures Game-5.0.0.vmod
  • Star Wars X-Wing Miniatures Game-4.6.0.vmod
  • Star Wars X-Wing Miniatures Game-4.5.1.vmod
  • Star Wars X-Wing Miniatures Game-4.5.vmod
  • Star Wars X-Wing Miniatures Game-4.2.vmod
  • Star Wars X-Wing Miniatures Game-4.1.vmod
  • Star Wars X-Wing Miniatures Game-4.0.vmod
  • Star Wars X-Wing -Tournament.vmod
  • Star_Wars_X-Wing_miniatures_game.vmod
  • Every "single-ship" extension file, such as A-Wing_Booster_-4.6.0.vmdx

The following map packs (and earlier versions) are no longer supported. Please don't use them anymore.

  • Star_Wars_X-Wing_Vassal_Playmats-5.1.2.vmdx
  • Gabriel's_Map_Pack_-5.0.0.vmdx
  • Crazy_Toms_Playmats_-5.0.0.vmdx
  • Yagyu's_Map_Pack_-5.0.0.vmdx
Where are the module files supposed to go?
Anywhere that's convenient to you. Vassal does NOT impose any special location on your computer.

For ease of use and to find your files easily in the future, you can create a folder inside \My Documents\,
for example: \My Documents\Vassal\

Main module file: it ends with a .vmod file extension (as seen in the download page)

Map extension files: they end with a .vmdx file extension (as seen in the download page). They will be placed in a subfolder at the location of the main module file, (following the example) in \My Documents\Vassal\[--the module name followed by _ext--]\ when they are properly installed.

As an example, for version 5.0.5

This is the contents of \My Documents\Vassal\

  • The main module file (.vmod) is in the chosen directory and is called: Star_Wars_X-Wing_Miniatures_Game-5.0.5.vmod
  • The extension module files (.vmdx) are in a subdirectory of the chosen directory; in this case they are map collections
  • The subdirectory bears the name: "Star_Wars_X-Wing_Miniatures_Game-5.0.5_ext"
Now that I have the module files, how do I install them?
Go into the vassal launcher window, go to File/Open Module...

And select your main X-Wing module file. Vassal will then launch it.

If you want to install the map packs immediately, close those new windows and go back to the launcher. Add the map extensions by right clicking your module name in the launcher window and selecting "Add Extension..."

Do this for all map extensions.

I already have the X-Wing module, but must update to a new version. How to do it?
The first step is to remember where you put the module files. If you forgot, there's an easy way. Open up Vassal's launcher window, and do a mouse-over on the module file. A blue popup field will appear and show you the location of the module file, like so:

The second step is to simply delete the old .vmod file, which has this appearance:

The third step is to download the new file (from the page whose link is under "How to install the x-wing vassal modules for the first time") in that same location.

The fourth step is to go into the vassal launcher window, go to File/Open Module...

Vassal will then attempt to launch the module - close those new windows and go back to the launcher.

The fifth step is to add the map extensions by right clicking your module name in the launcher window and selecting "Add Extension..."

Do this for all map extensions.

Same as above, but quicker advanced version
  • First step is to locate where your old module is. Check the previous item if you don't know where they are.
  • Delete the old module file (.vmod)
  • Download the new module file (.vmod)
  • Create a new folder that bears the same name as the new module file (without .vmod), but with "_ext" tacked on at the end, it should look like this:
  • Copy all old .vmdx extension files that you want to keep from your old "_ext" folder to the new "_ext" folder
  • Delete the old "_ext" folder
  • Open the new module under the vassal launcher window and you're good to go.
Why are the pilot and upgrade cards empty?
To make sure players keep supporting Fantasy Flight Games (the creators of X-Wing Miniatures), that they treat vassal as a complementary way to play the game rather than the main way and prevent any unfortunate loss of business
I logged in and it was empty. Where do I find players?
Players of all time zones come and go. North America, Germany, Singapore, Japan, Australia, France, etc. Just try at another time. If you really want to make sure to find players, you can find them discussing the game we all love in these places:
Who made the x-wing vassal module?
Someone named Aiden, who happened to post on afewmaneuvers back in 2012. Since then, the module has seen some sporadic work from Buhallin in 2013 to add some needed features (ship moves with right click menu). The modules are now maintained by Mu0n since August/September of 2013 (wave 3, firing arc corrections, length corrections, imperial aces, wave 4, transport, corvette, etc.), with help from theorist, chris B. for art, sigzog for helper ref cards, radarman5 for ship art, gabriel for map packs and silentubiquity for map packs + ship pictures + squad logfiles + side table logfile.
This is cool! I want to support this. How?
Thank you for your support. Any donation means a lot to me (Mu0n). I have bought ships to helping hands in the past, using a part of the donations. Here is a link to the donations page.

Playing Guide

First step, creating a game room
Alternatively, you can join a game room. Some players use the terminology LFG (looking for game). Players who consciously decide to broadcast they want to play will also click on the button, which puts a blue exclamation point besides their name in the list of logged in users. Insert game room title in the "New Game" text field and press enter:

Choose File/New Game

Select one of the players spots (1 to 8) and a map. The vast majority of players use 3x3 maps.

Last step is to simply open up the map window by clicking on the Map button.

How to organize all those windows?
This is purely a suggestion, but it will avoid some pitfalls new players routinely go into.

First, make sure you zoom the map window to "Fit to Height". This will allow you to check out the side table at the right of the map, if needed. Some players put tokens and templates there and it's useful to keep an access to them.

Second, it's important to free up the neutral area (the map) as much as possible, so try to keep your pilot, upgrade and various chits inside your assigned player window. This is the full list of the windows I recommend keeping open, in a full screen 1920x1080 screenshot:

  • Main Module window
  • Contested Sector (map window), zoomed: fit to height
  • Your player hand window
  • Opponent's player hand window
  • Dice window
  • Your damage deck window
How do I spawn a squad?
Everything can be found by clicking the "Pieces" button, which spawns a new window with everything organized in tabs. As an example, we want to create a XXBB list, so we go to Rebel/X-Wings and click on Red Squadron Pilot, then drag and drop it into the map window, or directly into your player hand window. Do it twice. Next, we go to Rebel/B-Wings, then drag and drop 2 copies of the Dagger Squadron Pilot. Last, we go to Upgrades/System and drag and drop 2 copies of Advanced Sensors and put them near the Dagger Squadron Pilot Cards. You now have a solid 100 point rebel list.

Here's a checklist of stuff you need in order to build a functional squad for vassal play

  • Pilot Cards under Rebel/[Ship type]/ or Imperial/[Ship Type]
  • Ship tokens in the same place as above
  • Movement Dials in the same place as above
  • Movement reference cards in the same place as above (optional)
  • Target lock tokens under Chits/Tokens (if needed)
  • Shield tokens under Chits/Tokens (optional, there is another way)
  • Miscellaneous tokens (evade, focus, crit, stress, ion) under Chits/Tokens (also optional, there is another way)
Editing the values on a ship token
Everything can be done in the slowly, but surely way of right clicking on ships and adjusting all the values, one by one:

Alternatively, you can use the keyboard shortcuts to do this much faster.

  • Alt-P to increase pilot skill; Ctrl-Alt-P to decrease pilot skill
  • Alt-A to increase attack rating; Ctrl-Alt-A to decrease attack rating
  • Alt-D to increase defense rating; Ctrl-Alt-D to decrease defense rating
  • Alt-H to increase hull rating; Ctrl-Alt-H to decrease hull rating
  • Alt-S to increase shield rating; Ctrl-Alt-S to decrease shield rating
  • Shift-N to add a ship name visible on the token at the top left
  • Shift-P to add a second/alternate ship name visible on the token at the bottom, much smaller

Important: you can always clone a ship by clicking on it (left mouse button), hitting Ctrl-C, then dragging the copy away from the original. This saves time when you have multiples of a ship type in a squad.

How do I save/load squads? How do I load replays?
These are explained inside the module itself, under the 'Quick Ref' helper window

Where's a convenient place to build squads and make sure the points add up?
Those are the two most popular options:
Where could I get some beginner squads to use in Vassal?
Major Juggler has compiled a well regarded pdf document over at this thread in the X-Wing FFG forums.
What's the proper way to use the dials under vassal? (planning and activation phase)
First, you should name your dials so that there's no mixup during play. Do this by clicking on a dial, then Shift-N to edit its name tag. There's a second, small name tag that you can edit with Shift-P. In this example, I used the first one and kept the second one empty:

The proper way to use the dials during the planning and activation phases of the game is the following:

  • Changing the maneuvers of a dial while it's in the map window will trigger an anti-cheating warning message in the main window, therefore...
  • (planning phase) ...you have to change your dials inside your personal player hand window
  • Make sure the dial is hidden with Ctrl-R. This is what your own dial will look like while hidden. A ship icon appears in the top left corner
  • This is what your hidden dial will look like to your opponent:
  • Use '.' and ',' to cycle through the available moves.
  • When ready, bring your dials (still hidden) on the map window, besides your ships and declare you're ready in the chat window. Most players use the word "set".
  • (activation phase) Respecting play order with regard to ascending pilot skill activation, reveal a dial with the same shortcut, Ctrl-R and activate your ship (see next item).

Some players enjoy rotating the dials, as it gives you an easier time to visualize the proper direction for turning ships when they're facing downward, for example. Do this by clicking on the dial and hitting the left or right arrow keys.

How do I move my ships (activation phase)
Way #1: through the right click menu.

Way #2: (heartily recommended) through the usage of keyboard shortcuts. There is a certain logic to their definitions

Forward moves:

  • Forward 1: Shift-1
  • Forward 2: Shift-2
  • Forward 3: Shift-3
  • Forward 4: Shift-4
  • Forward 5: Shift-5

Bank moves:

  • Left Bank 1: Ctrl-1
  • Left Bank 2: Ctrl-2
  • Left Bank 3: Ctrl-3
  • Right Bank 1: Alt-1
  • Right Bank 2: Alt-2
  • Right Bank 3: Alt-3

Turn moves:

  • Left Turn 1: Ctrl-Shift-1
  • Left Turn 2: Ctrl-Shift-2
  • Left Turn 3: Ctrl-Shift-3
  • Right Turn 1: Alt-Shift-1
  • Right Turn 2: Alt-Shift-2
  • Right Turn 3: Alt-Shift-3

Koiogran moves:

  • K-turn 1: Ctrl-Alt-1
  • K-turn 2: Ctrl-Alt-2
  • K-turn 3: Ctrl-Alt-3
  • K-turn 4: Ctrl-Alt-4
  • K-turn 5: Ctrl-Alt-5

How do you manage to remember all this? You can always check up on shortcuts under the button "Quick Ref", under "Ship Shortcuts".

How do I put a stress on my ship? (activation phase)
Click on a ship and hit Shift-S. This is a toggle shortcut, so use it again when you lose the stress condition. For other ship status condition tokens, check the right click menu, or go find the shortcuts in the "Quick Ref" button, under "Ship Shortcuts".

How do I declare what actions my ships do? (activation phase)
There are two ways to do this:

Way #1: more tedious, but more intuitive. Spawn enough tokens from the "Pieces" window under "Chits/Tokens". This is tedious because you'll have to manually put tokens during the activation phase, then take out every unused focus and evade tokens during the end phase. There is a faster way.

Way #2: (heartily recommended) Ships have space for 3 "action declarations". As always, you have access to this in their right click contextual menus, but here are the shortcuts:

  • Shift-A to cycle through the first line of potential ship actions.
  • Ctrl-A to cycle through the first line of potential ship actions.
  • Shift-Ctrl-A to cycle through the third line of potential ship actions.
As an example, Darth Vader (in a TIE Advanced x1) with push the limit can easily go up to 3 actions during a turn and would use all three 'lines'.

How do I perform a barrel roll? (activation phase)
There is a way to automate the extremeties of the barrel roll actions you can do. As an example, you could barrel roll on a side as forward as possible, or as backward as possible. Other non-extreme rolls are also legal, as long as you don't go beyond those extremes. The extremes are automated because they are quite popular choices. Here are the shortcuts for them:
  • BR left as forward as possible: CTRL-8
  • BR left as backward as possible: CTRL-SHIFT-8
  • BR right as forward as possible: ALT-8
  • BR right as backward as possible: ALT-SHIFT-8
If you want to perform a non-extreme barrel roll, fortunately, there's now a way to semi-automate it (since v5.3.0). You can place the barrel roll template midway on the side of your ship using:
How do I decloak (sideways)? (activation phase)
There is a way to automate the extremeties of the TIE Phantom's decloak. As an example, you could decloak on a side as forward as possible, or as backward as possible. Other non-extreme decloaks are also legal, as long as you don't go beyond those extremes. The extremes are automated because they are quite popular choices. Here are the shortcuts for them:
  • BR left as forward as possible: CTRL-9
  • BR left as backward as possible: CTRL-SHIFT-9
  • BR right as forward as possible: ALT-9
  • BR right as backward as possible: ALT-SHIFT-9
If you want to perform a non-extreme decloak (or an Echo decloak which uses bank 2), fortunately, there's now a way to semi-automate it (since v5.3.0).

How do I undock a ship (Gozanti, Ghost, YV-666)? (activation or combat phase)
STEP 1: Check the carrier ship's current bearing with ALT-B (it can be heavily modified during a game due to turns, banks and funky collisions):

The chat window will report its value (1 = facing up, 91 = facing right, etc)

STEP 2: Put the undocking ship on the map, close by:

STEP 3: Adjust the undocking ship's bearing so that it matches the carrier ship. Use Left or Right arrow to make big 15 degree rotations; use CTRL-Left Arrow or CTRL-Right Arrow to make small 1 degree rotations. Use ALT-B on this undocking ship to check your bearing value. When both ships show the same bearing, all is good.

STEP 4: If your ship has to undock through the rear of the carrier ship, you will need to U-turn it in place. There's a shortcut for that that's been added for a fairly good amount of module releases now, it's CTRL-U:

STEP 5: The next few steps are best done at 100% zoom, assuming the undocking ship is close enough to the carrier ship. We need precision, hence 100% zoom. First, copy the undocking ship in place using CTRL-C:

STEP 6: Perform the maneuver you want for your undocking ship (the example here shows a hard left 2) and hit 'C' to pop a maneuver template, as you would during collision management. BONUS MANAGEMENT: if the undocking ship DOES collide, you'll be in a great position to deal with it in a few moments! You should see that the copy has moved, the original ship is still in place and a maneuver guide exists between both copies of the ship:

STEP 7: Grab select the 2 copies of the ship and the template (draw a rectangle around those 3 objects to highlight them - if you're successful, a yellow border will encircle them all). Alternatively, hold shift and left click all 3 of those objects.

STEP 8: Move those 3 objects so that the original position of the undocking ship is aligned with your carrier ship. Make fine adjustments of its position with Shift-Arrows to get pixel perfect. The nubs of the undocking ship have to coincide with the nubs of the carrier ship.

STEP 9: Delete the unwanted stuff. Congrats, you're done!

What's the proper way to check for range (i.e. during a target lock acquisition)? (activation phase)
Click on your ship and hit Ctrl-L to toggle the range 1-3 finder area. It will check for range 1-3 around your ship. Zooming might be necessary for close cases.

What's the proper way to check for a valid shot? (combat phase)
Click on your ship and hit Ctrl-F to toggle the firing arc.

What's the proper way to roll for dice and modify some results? (combat phase)
Have the dice window open at all times. Results get broadcasted in the chat window, but it's always faster to interpret results by having the graphics show it up.

Attacking: click on the graphic that shows a bundle of red dice and hit Ctrl-(a number) to roll this amount of dice. For example, Ctrl-3 will roll 3 attack dice:

Modifying attack dice results:

  • Using focus: click on the spend focus button at the left. This will automaticaly change all eye results to hits
  • Rerolling a particular die: click on a die you want to reroll and hit Ctrl-V
  • Miscellaneous modifications: These can happen with Marskmanship, Sensor Jammer, etc. Click on the die and use these shortcuts:
    • Change to hit: Shift-H
    • Change to crit: Shift-C
    • Change to focus: Shift-F
    • Change to blank: Shift-B

Defending: click on the similar green graphic and use the same kind of shortcut, Ctrl-(a number):

Modifying defense results:

  • Using focus: click on the spend focus button at the left. This will automaticaly change all eye results to evades
  • Rerolling a particular die: click on a die you want to reroll and hit Ctrl-V
  • Miscellaneous modifications: These can happen with Flight Instructor, etc. Click on the die and use these shortcuts:
    • Change to evade: Shift-E
    • Change to focus: Shift-F
    • Change to blank: Shift-B
What's the proper way to spend a focus, evade or target lock token? (activation and combat phase)
Declaring a focus, evade or target lock actions: through your ship's action bars (Shift-A, Ctrl-A or Shift-Ctrl-A)

Keeping a lock link between 2 ships: spawn a target lock token with the "Pieces" window, under Chits/Tokens. Spawn 2 tokens. Change the color for one of them to blue (Alt-C). Rename the tokens with Alt-L. Move those tokens manually during play.

Spending a focus or an evade token: Remove them from your ship's action bars (Shift-A, Ctrl-A or Shift-Ctrl-A) and you may also click on "spend focus" in the dice window to automate the modifications of a roll result.

How do you keep track of damage? (combat phase)
Most players keep track of it on the map itself, directly on the ships. You can adjust the relevant ship stats using these shortcuts:

  • Decrease shield value: Ctrl-Alt-S
  • Decrease Hull value: Ctrl-Alt-H

When you take damage to the hull (past shields), the game expects you to draw damage cards. Each player can spawn their own damage deck to their player window, then drag and drop cards from it, to their respective player hands as damage accumulates on the ship. This is on top of modifying the ship values on the ship pieces on the map.

As for critical damage, it is customary to draw the appropriate card on the map, flip it (Ctrl-F) there and wait for some acknowledgement from your opponent. On the map, every player can then mouse-hover the card and see a zoomed version of it, allowing to read it easily. If you spawn and flip the card in your player hand window instead, only you can benefit from the mouse-hover zoom.

How do I easily find what critical damage cards do?
This is a handy reference website from which you can automatically copy the text of any critical card (standard or huge ships) and have it ready for a paste into vassal's chat window (with CTRL-V): http://s93768914.onlinehome.us/xwing/crits.html
How do I easily find what critical damage cards do on the Huge ships?
Same link as the previous item: http://s93768914.onlinehome.us/xwing/crits.html
What's the proper way deal with the end phase? (end phase)
Removing the green tokens in the end phase: Click on "Reset Actions" at the top of the map window. This will clear all actions on all ships. This is why using the action bars is so much more quicker than spawning and dragging around multiple token chits manually.
Can't get a sense of how to play Epic.
This looks like a fantastic overall guide, with some pictures to help visualize some concepts: http://www.xwingminiaturesgame.com/review/rebel-ution-epic-play-i-playing-with-a-gr-75/
How do I use the Lancer-Class Pursuit Craft Mobile turret?
This image explains the shortcuts explicitly. All 4 sides have independant arc graphic toggles. The rotation of the red overlay can be done clockwise or counterclockwise.

How do I drop bombs?
The first step is to drop a bomb spawner with CTRL-B (CTRL-SHIFT-B is you want to drop in front of your ship instead). Then, you manipulate the spawner to drop a bomb.

  • You can change its length by performing the corresponding movement shortcut on it:
    • Forward 1,2,3: Shift-1,2,3
    • Hard Left 3: Ctrl-Shift-3
    • Hard Right 3: Alt-Shift-3
  • Next, you choose the bomb token itself:
    • Proximity Mine: Ctrl-M
    • Seismic Charge: Ctrl-S
    • Proton Bomb: Ctrl-P
    • Ion Bombs: Ctrl-I
    • Conner Net: Ctrl-O
    • Cluster Mines: Ctrl-L
    • Thermal Detonators: Ctrl-H