VASSAL Reference Manual

Home


General

This manual describes the features of the VASSAL module editor.  It is not necessary to be familiar with the contents if you are only using VASSAL to play games.  The information here is also available from VASSAL's on-line help.

All modifications to a module are done through the Configuration Window, which is a familiar file/folder type browser in which each file/folder represents a module component.  The Configuration Window can be used to edit either a Module or a Module Extension. It can also be used to create Module updaters and to update saved games


Editing Modules

Right-click on an any component to get a popup menu with options for that component.  Use the Cut, Copy, Paste, and Move commands to move components around within the module.

Properties

Brings up a dialog in which you specify the options for that components.  Double-clicking on a component also brings up its Properties dialog.

Delete

Delete's the component from the module.

Clone

Makes an exact copy of the component and inserts it after the existing component.

Help

Brings up the corresponding page in this manual.

Add ...

Adds a sub-component to this component



Module Updaters

Since VASSAL modules can be large in size, VASSAL provides a tool to build compact downloads for automatically updating a module.  The updater is a file named, for example,  updateMyModule.jar for a module file named MyModule.mod.  The user simply places the two files in the same folder and double-clicks on the .jar file to update the module.

To create a module updater, move a copy of the old module file and the new module file into your VASSAL folder.  You will need to leave the old module file with its original name and give the new module file a different name.  Then go to a command prompt and type

java -cp lib/Vengine.jar VASSAL.tools.ZipUpdater oldModuleFile newModuleFile