# Documentation Index

**URL:** <https://forum.vassalengine.org/t/documentation-index/78944>\
**Category:** Documentation\
**Created:** [February 9, 2024, 8:08pm UTC](https://forum.vassalengine.org/t/documentation-index/78944 "2024-02-09T20:08:56Z")\
**Posts on this page:** 1\
**Showing post:** 1

<div class="post-metadata">

**Author:** ![uckelman](https://forum.vassalengine.org/user_avatar/forum.vassalengine.org/uckelman/32/10020_2.png) [@uckelman](https://forum.vassalengine.org/u/uckelman)\
**Post date:** [February 9, 2024, 8:08pm UTC](https://forum.vassalengine.org/t/documentation-index/78944/1 "2024-02-09T20:08:56Z")

</div>

This forum category contains documentation articles that are not covered by the guides.

Links to the guides and other useful links are below.

 

# VASSAL Release Notes

- [Verson 3.8](https://forum.vassalengine.org/t/vassal-3-8-release-notes/90445)
- [Version 3.7](https://forum.vassalengine.org/t/vassal-3-7-release-notes/78948)
- [Version 3.6](https://forum.vassalengine.org/t/vassal-3-6-release-notes/78947)
- [Version 3.5](https://forum.vassalengine.org/t/vassal-3-5-release-notes/78946)
- [Version 3.4](https://forum.vassalengine.org/t/vassal-3-4-release-notes/78942)

# Using VASSAL

### General

- [User Guide](https://vassalengine.org/doc/latest/userguide/userguide.pdf)
- [Installation Instructions](https://forum.vassalengine.org/t/installation-instructions/85146)
- [Getting Help and Raising Bug Reports](https://forum.vassalengine.org/t/getting-help-and-raising-bug-reports/79281)
- [Where is my error log?](https://forum.vassalengine.org/t/where-is-my-error-log/79314)
- [Module considerations](https://forum.vassalengine.org/t/module-considerations/89930)
- [Other sources of modules](https://forum.vassalengine.org/t/other-sources-of-modules/86242)
- [Does Vassal support computer opponents?](https://forum.vassalengine.org/t/does-vassal-support-computer-opponents/86628)
- [Unofficial videos on using Vassal](https://forum.vassalengine.org/t/unofficial-videos-on-using-vassal/89602)

### Play modes

- [How to play in Hotseat or Solitaire](https://forum.vassalengine.org/t/how-to-play-in-hotseat-or-solitaire/90015)
- [How to set up a networked game](https://forum.vassalengine.org/t/how-to-set-up-a-networked-game/90005)
- [How to set up a peer-to-peer game](https://forum.vassalengine.org/t/how-to-set-up-a-pier-to-pier-game/90004)
- [How to Play by EMail (PBEM)](https://forum.vassalengine.org/t/how-to-play-by-email-pbem/90008)

### Troubleshooting Common Problems

- [“Tearing” on maps and other Graphics Issues](https://forum.vassalengine.org/t/tearing-on-maps-and-other-graphics-issues/79315)
- [Issues with Download, Installation or Running being Blocked](https://forum.vassalengine.org/t/issues-with-download-installation-or-running-being-blocked/79316)
- [Issues with VASSAL not starting](https://forum.vassalengine.org/t/issues-with-vassal-not-starting/79317)
- [I tried to download a module, but I got a Windows Media or MPEG file instead](https://forum.vassalengine.org/t/i-tried-to-download-a-module-but-i-got-a-windows-media-or-mpeg-file-instead/79318)
- [The module I downloaded expanded into a bunch of files](https://forum.vassalengine.org/t/the-module-i-downloaded-expanded-into-a-bunch-of-files/79319)
- [Issues whilst using VASSAL](https://forum.vassalengine.org/t/issues-whilst-using-vassal/79320)
- [Where are my modules stored?](https://forum.vassalengine.org/t/where-are-my-modules-stored/90666)
- [Module library disappearing from the Module Manager](https://forum.vassalengine.org/t/module-library-disappearing-from-the-module-manager/90016) (largely obsolete - see also [above](https://forum.vassalengine.org/t/where-are-my-modules-stored/90666))
- [How to report problems](https://forum.vassalengine.org/t/how-to-report-problems/84989)
- [How to format forum posts](https://forum.vassalengine.org/t/how-to-format-posts/85002)
- [Where are my user preferences stored?](https://forum.vassalengine.org/t/where-are-my-user-preferences-stored/90468)

### Platforms

- [How to Run VASSAL on Android (VNC)](https://forum.vassalengine.org/t/how-to-run-vassal-on-android/79268)
- [How to Run VASSAL on Android (X11)](https://forum.vassalengine.org/t/how-to-run-vassal-on-android-x11/84398)
- [How to Run VASSAL on SteamDeck](https://forum.vassalengine.org/t/how-to-run-vassal-on-steamdeck/79338)
- [How to Integrate VASSAL into the Linux Desktop](https://forum.vassalengine.org/t/how-to-integrate-vassal-into-the-linux-desktop/84400)
- [How to set the VASSAL Look’n’Feel](https://forum.vassalengine.org/t/set-vassal-looknfeel/84865)

# Module Creation

- [Reference Manual](https://vassalengine.org/doc/latest/ReferenceManual/Concepts.html#top)
- [How to upload modules to the Game Library Service](https://forum.vassalengine.org/t/how-to-upload-modules-to-the-game-library-service/85586)
- [Basic Video Demonstration for creating a project and uploading a module](https://forum.vassalengine.org/t/basic-video-demonstration-for-creating-a-project-and-uploading-a-module/90161)
- [Designer’s guide (PDF)](https://vassalengine.org/doc/latest/designerguide/designerguide.pdf) (A bit out of date, but has good general information)
- [Creating VASSAL Modules](https://forum.vassalengine.org/t/creating-vassal-modules-written-for-vassal-3-1-but-still-generally-useful/85947) (also good info but out of date)
- [Which image format is best for my maps and counters?](https://forum.vassalengine.org/t/which-image-format-is-best-for-my-maps-and-counters/79284)
- [Tools for module developers](https://forum.vassalengine.org/t/tools-for-module-developers/84785)

## Tutorials

- [Miniatures Tutorial](https://forum.vassalengine.org/t/miniatures-tutorial/79230)
- [Video tutorials on module development](https://forum.vassalengine.org/t/video-tutorials-on-module-development/84786)
- [Projects of examples of module techniques](https://forum.vassalengine.org/t/projects-of-examples-of-module-techniques/90701)

## How-Tos

### Counting and Tracking Things

- [How to enable a Leader Board that tracks on-map unit status](https://forum.vassalengine.org/t/mini-tutorial-3-how-to-enable-a-leader-board-that-tracks-on-map-unit-status/72695)
- [How to count the number of cards in a player’s hand](https://forum.vassalengine.org/t/number-of-cards/2741)
- [How to manage counts of pieces and reporting of movement](https://forum.vassalengine.org/t/how-to-manage-counts-of-pieces-and-reporting-of-movement/79298)

### Automatically Changing Stuff

- [How to use a Trigger Action to flip a card](https://forum.vassalengine.org/t/how-to-use-a-trigger-action-to-flip-a-card/79291)
- [How to use a Global Key Command to reset a layer on all counters](https://forum.vassalengine.org/t/how-to-use-a-global-key-command-to-reset-a-layer-on-all-counters/79292)
- [How to Automatically Respond to the Outcome of Dice Rolls](https://forum.vassalengine.org/t/automatically-responding-to-the-outcome-of-dice-rolls/72615)
- [How to trigger a dice roll from a game piece - the difference between Hotkeys and Key Commands](https://forum.vassalengine.org/t/how-to-trigger-a-dice-roll-from-a-game-piece-the-difference-between-hotkeys-and-key-commands/72579)
- [How to add checkboxes to cards or counters](https://forum.vassalengine.org/t/marking-cards-how-can-i-do-it/3975)
- [How to deal cards from a deck](https://forum.vassalengine.org/t/a-deck-question/1476)
- [How to make terrain-based variants of the same map](https://forum.vassalengine.org/t/how-to-make-terrain-based-variants-of-the-same-map/79299)
- [How to send a card to the bottom of a Deck](https://forum.vassalengine.org/t/how-to-send-a-card-to-the-bottom-of-a-deck/79295)

### Beanshell Functions

- [How to use Alert in Beanshell to inform the user](https://forum.vassalengine.org/t/using-alert/10638)
- [How to use Random Numbers and other Math functions in VASSAL](https://forum.vassalengine.org/t/how-to-use-random-numbers-and-other-math-functions-in-vassal/79294)
- [How to use String functions in VASSAL](https://forum.vassalengine.org/t/how-to-use-string-functions-in-vassal/79293)

### Managing the Module File

- [How to recompress an unzipped module’s files to get a valid module](https://forum.vassalengine.org/t/how-to-recompress-an-unzipped-modules-files-to-get-a-valid-module/79296)
- [How to reduce the size of modules](https://forum.vassalengine.org/t/how-to-reduce-the-size-of-modules/79283)
- [How to have Windows 10 open VMOD files as if they were ZIP files](https://forum.vassalengine.org/t/how-to-have-windows-10-open-vmod-files-as-if-they-were-zip-files/79302)
- [How to handle Zipped Module files on a Mac](https://forum.vassalengine.org/t/how-to-handle-zipped-modules-on-the-mac/79313)

### Miscellaneous

- [How to crop pieces from a countersheet](https://obj.vassalengine.org/images/c/c8/Cropping-automated-way.pdf)
- [How to make text label color dynamic](https://forum.vassalengine.org/t/dynamic-label-text-color/1347/2#p9315)
- [How to include PDF of rulebook in VASSAL module help menu](https://forum.vassalengine.org/t/how-to-include-pdf-of-rulebook-in-vassal-module-help-menu/79301)
- [How to convert to a module from other tools to VASSAL](https://forum.vassalengine.org/t/how-to-convert-to-a-module-from-other-tools-to-vassal/84940)
- [How to merge modules or extensions](https://forum.vassalengine.org/t/how-to-merge-modules-or-extensions/84988)
- [Tip: Using Global Option User Preferences](https://forum.vassalengine.org/t/tip-using-global-option-user-preferences/72741)

# VASSAL Development

- [Building VASSAL on Linux](https://forum.vassalengine.org/t/building-vassal-on-linux/79282)
- [Bug Tracking Process](https://forum.vassalengine.org/t/bug-tracking-process/79280)
- [Using Git](https://forum.vassalengine.org/t/using-git-to-contribute-to-vassal-development/79286)
- [Getting started with IntelliJ](https://forum.vassalengine.org/t/getting-started-with-intellij-in-progress/79379)
- [Creating Custom Classes](https://forum.vassalengine.org/t/creating-custom-classes/84963/1)
- [Custom Terrain Recording [incomplete]](https://forum.vassalengine.org/t/custom-terrain-recording-incomplete/84962/1)
- [Internationalization (i18n) Guidelines for Vassal Developers](https://forum.vassalengine.org/t/internationalization-i18n-guidelines-for-vassal-developers/84965/1)
- [How to debug Vassal](https://forum.vassalengine.org/t/how-to-debug-vassal/90403)

---

_[View the full topic](https://forum.vassalengine.org/t/documentation-index/78944)._
