SavedGameUpdater

From VASSAL
Jump to: navigation, search

VASSAL Reference Manual

Home > Updating Saved Games


Updating Saved Games

When a game is saved using one version of a VASSAL module, and then re-opened using a later version, the game pieces retain the original behavior, even if the piece has changed in the Game Piece Palette.   This is necessary for modules to be backward-compatible with old saved games.   The Update Saved Games dialog allows you to update a game saved with an older version of a module to use the corresponding piece definitions in the current version.   The intended use is to save work when creating Predefined Setups for a new module version.

The updater works by attempting to match each piece in a saved game to the component in the Game Piece Palette or Deck that it came from.   The name of the piece in the saved game is matched with a component in the Game Piece Palette.  For example, a piece named "4-6-7" may be defined in a list called "Squads" within a drop-down menu named "German" inside a tab named "Ground Units".  The Saved Game Updater notes the component in the Game Piece Palette where the "4-6-7" piece was defined in the old module version, then looks for the same component in the new module version (i.e. the "Ground Units"->"German"->"Squads"->"4-6-7" component).  If it finds the component, it will replace any "4-6-7" piece in the saved game with the piece from that component, matching the value of Text Labels, Layer activation, rotation, etc., to the best of its ability.  It is likely you will have to load the updated saved game and make some adjustments, as the process is not perfect.  

Because the updater relies on matching piece names with component names in the editor, it will not work well if many different kinds of pieces share the same name, or if the structure of the Game Piece Palette has changed significantly between module versions.

To update a saved game:

  1. Open the earlier module version in the VASSAL editor
  2. Select Tools->Update Saved Games->Export GamePiece info
  3. Save the info to a file on disk
  4. Close the editor
  5. Open the later module version in the VASSAL editor
  6. Select Tools->Update Saved Games->Import GamePiece info.
  7. Select the info file saved in step 3.  The  Module version of saved games field will list the earlier module version number
  8. Hit the Choose button and select any number of files in the same folder to update.  It is recommended to back up the files first.
  9. Hit Update games to overwrite the files.

SavedGameUpdater.png