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

About the X-Wing Vassal Module

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 work from Buhallin in early 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. A huge set of programmed features (that brought squad autospawn, overlapping backtracking, etc) appeared in early 2017 thanks to the tremendous help from ajmath, haslo, Guido Kessels, yours truly, and many others.
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. If you want to support this effort using patreon, which will charge a modest amount every time a major release hits, check out the details over at my patreon page. If you want to make a one-off donation, you can use my paypal donation link.
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:
I want to participate in tournaments. How do I find some and sign up?
Whenever you log into the Vassal server, pay attention to the text that pops right at the top of the chat window. This will contain a few links about upcoming tournaments and the Vassal league. A big hotspot of active players can be found in the Vassal League Players Slack Channel.

Installing the Module

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-7.7.0.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's an optional map pack found in the X-Wing Vassal download page (where you got the module): 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-7.5.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.5.1.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.5.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.4.3.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.4.1.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.1.2.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.1.0.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.0.7.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.0.5.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.0.3.vmod
  • Star_Wars_X-Wing_Miniatures_Game-7.0.1.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.5.3.vmod
  • Star_Wars_X-Wing_Miniatures_Game-6.5.2.vmod
  • 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)

(optional) 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
  • (optional) 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.

(optional) 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.

How can I know when to update the module? Is it important to update?
When you attempt to log onto the X-Wing Vassal server and if there's a new version available, a small popup will appear at the start of the logging process. This popup will display the current version, the newer version and contain a link to the x-wing vassal module download page. Follow it and update! It's fairly important to update your module version ASAP. Sometimes, some game pieces or mechanism will behave strangely as bugs are fixed and features added.

Basics

First step, going into a game room [VIDEO]
In order to manipulate X-Wing ships, tokens and do anything of substance, you need to be a numbered player inside a game room. When you first log into the X-Wing Vassal server, you're a generic user inside the 'Main Room'.
How do I spawn a squad?
Spawning a squad is done with some help from the known squad builder websites found online. These are a few of the more important ones which are supported: Build a list with these squadrons. Be in a vassal game room, as a numbered player. Open your numbered player window (button showing up as a yellow number on a black square). Click on the Squad Spawn button. Paste your squad's URL. Your squad will spawn inside your player's window.
Editing the values on a ship token
When you use the automatic squad spawn, all the stats are normally all entered in. However, there are game effects which alter the stats, so it's good to know how to change these things (including damage reducing your health) 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.

What's the proper way to use the dials under vassal? (planning and activation phase)

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. Right click on a ship, find your move in the template move submenu.

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 (k-turn) 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

Segnor's Loop (sloop) moves:

  • Left Sloop 1: Ctrl-Q
  • Left Sloop 2: Ctrl-W
  • Left Sloop 3: Ctrl-E
  • Right Sloop 1: Alt-Q
  • Right Sloop 2: Alt-W
  • Right Sloop 3: Alt-E

Tallon Roll (troll) moves:

  • Left Troll 2: Ctrl-Y
  • Left Troll 3: Ctrl-T
  • Right Troll 2: Alt-Y
  • Right Troll 3: Alt-T

Reverse moves:

  • Reverse 1: Shift-6
  • Left Bank Reverse 1: Ctrl-6
  • Right Bank Reverse 1: Alt-6

How do you manage to remember all this? You can always check up on shortcuts under the button "How To & Shortcuts", under "Movement Shortcuts". This image can be dragged and dropped around on the map or into your player window.

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. If you used the automatic squad spawn feature inside your player window, you should normally have all the tokens associated with the actions that your ships are capable of. If, for some reason, some are lost or missing, you can always spawn some more from the Pieces window, Chits/Tokens tab. 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. Shift-Z to remove it without have to cycle it out.
  • Ctrl-A to cycle through the first line of potential ship actions. Ctrl-Z to remove it
  • Shift-Ctrl-A to cycle through the third line of potential ship actions. Shift-Ctrl-Z to remove it
  • Alt-Ctrl-Shift-Z to remove all actions (up to 3) at once.
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 put a stress on my ship? (activation phase)
Click on a ship and hit Shift-S to increase the stress by 1 with a small icon at the side of your ship and it can go up to 4. To decrease the stress count, hit Ctrl-Shift-S. To remove all stress at once, hit Ctrl-Shift-Alt-S. For other ship status condition tokens, check the right click menu, or go find the shortcuts in the "How To & Shortcuts" button, under the "Ship Stats and Status" section, "Small & Large Ships" item.

Alternatively, if you used the Squad Spawn feature (heatily recommended), you will receive at least 1 stress token per ship. You can drag and drop those around. You can increase its value with Shift-S and decrease it with Ctrl-Shift-S.

If, for some reason, you lost all your stress tokens, you can go to the Pieces Window, under the Chits/Tokens tabs and spawn some more.

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. If a ship has a rear auxiliary arc, hit Ctrl-V to toggle it. If a ship has a mobile turret arc, hit Ctrl-Shift-V to toggle the left side and Alt-Shift-V to toggle the right side. If a ship has frontal-side auxiliary arcs (such as the YV-666 and Auzituck Gunship), hit Ctrl-N

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
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 (Alt-S to increase in case you go too far)
  • Decrease Hull value: Ctrl-Alt-H (Alt-H to increase in case you go too far)

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://xwvassal.info/crits
What's the proper way deal with the end phase? (end phase)
If you used the ship side action icons (Shift-A, Ctrl-A, etc.): Click on "Reset Actions" at the top of the map window. This will clear all actions on all ships. If you instead moved standalone tokens (ie provided from the automatic squad spawn), you will have to manually remove them from the play area. This is why using the action bars is so much more quicker than spawning and dragging around multiple token chits manually.

Time Savers

A moved ship overlaps another ship. How to resolve this quickly? [VIDEO]
How do I easily check the range of a shot?

Turret / Target Lock: CTRL-SHIFT-L

Front Arc: CTRL-SHIFT-F

Back Arc: CTRL-SHIFT-V

Front Auxiliary Arcs: CTRL-SHIFT-N

Mobile Turret Arc: ALT-SHIFT-F

Bullseye Arc: CTRL-SHIFT-X

Advanced Topics

How do you create and use log file that saves every step of a game?

In order to save a log of a game, you must start the recording of the log before the game starts. This is done with the File Menu/Begin logfile. When you're ready to end it, go to File Menu/End Logfile.

In order to load a log of a game, first, make sure you're in a game room. Next, without needing to create a new game in that room, you can directly open your log with File Menu/Load Continuation and pick your log file (.vsave file format). In order to step through the log, you must click on the right oriented arrow button in the chat window toolbar. Once you've clicked at least once on that button, you can optionally step through using the Page Down key. To step rapidly through the log during slow moments, you can hold down the Page Down key.

How do I use the Lancer-Class Pursuit Craft Mobile turret?
This image explains the shortcuts explicitly. Toggle your firing arc with CTRL-F, in the direction of the cyan mobile turret indicator. Works for all 4 directions. The rotation of the cyan 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
How do I get out a specific damage card ("I'll Show you the Dark Side" condition card)? [VIDEO]
How do use my M12-L Kimogila Fighter bullseye arc?
To toggle the Bullseye arc, hit CTRL-X. You may want to use it in conjonction with the bullseye autorange feature, activated with CTRL-SHIFT-X.