Module considerations

Documentation
1

This page is adapted from the old wiki page entitled Module Section Information. However, irrelevant information has been removed.

Overview

The Game Library is the central repository for players, designers, and publishers to store and access Vassal modules and auxiliary files.

Guidelines

See also * How to upload modules to the Game Library Service for more on the practical steps of uploading a module.

  • A project should be named according to the published title of the game.
  • It is advisable to post a link to the games BoardGameGeek page.

Files

The file size limit is currently ?MB. If you need to store something bigger, you should contact the site administrators.

Typically, files are of one of the following types

  • .vmod for Vassal modules.
  • .vmdx for Vassal module extensions.
  • .vsav for saves a game in a specific Vassal module.
  • .vlog for logs (recordings) of a session in a specific Vassal module.
  • .vdck for saves of card decks in a specific Vassal module.

Do not place Vassal files into ZIP archives. Vassal files are already compressed archives.

Other file types may be uploaded, such as PDFs and so on.

External hosting of modules and files

Users, developers, and publishers may prefer to host their work on their own website - for example to drive traffic to that web-site, exorcise content control, and so on - it is still, however, recommended to post files in the game library.

One reason is, that all faults during execution, whether caused by a module or by Vassal, may trigger posting an Automatic Bug Report (ABR) in the Vassal GitHub Repository. If the triggered bug is module-specific, then the specific module is generally needed to resolve the bug, and for that reason, it is beneficial to have the module stored in the Game Library.

Restrictions

The below is in no way to be taken as an exhaustive list of restrictions of use, development, etc. of modules based upon copyrighted work by third-party. Copyright owners may - within the possibilities of applicable copyright law and conventions - impose other restrictions. Project pages in the Game Libary are advised to explicitly state any copyrights and licenses.

Vassal modules containing copyrighted materials by GMT Games can be obtained and used under specific conditions listed in their FAQ (at the very bottom of the page). These amount to

  • At least one player must own a physical copy of the game.
  • Modules may not be used for commercial use in any shape or form.

Vassal cannot post modules of copyrighted materials, nor links to external web-sites with such materials, published or copyrighted by

This is in accordance with the wishes of those publishers.

Exceptions to the above are possible if an explicit permission has been granted by the copyright owner, and that is adequately documented in the project page.

(*)Avalance Press appears to be reevaluating their stance. However, until a clear statement is issued by Avalance Press, no module can be posted without explicit permission.

Documentation Index