VASSAL Reference ManualHome > Module > Help Menu |
Help MenuThe "Help" menu in the main control window contains general help files for VASSAL. You may add more help files specific to the module you are creating by right clicking on the [Help Menu] component in the Editor and selecting the appropriate Add option.This can also be used to include a PDF file, e.g. of a rulebook, in your module (see Using PDF Files , below). Sub-Components |
![]() |
Using PDF Files:To include a PDF file on your help menu, follow these steps:
|
![]() |
About ScreenYou may use any image you wish as an 'About' screen for your module. Feel free to include text in the image that credits you and any other contributors to the module. The About Screen will always display the current version of both the VASSAL and engine and your module. The About Screen image is also used as a "Splash Screen" when starting your module. |
TutorialYou may create a tutorial by writing a logfile and making it accessible from the help menu.Menu Text: The menu item under the Help Menu Logfile: The logfile that players will step through when they select the corresponding menu item. Launch automatically: If selected, then players will automatically be prompted to run the tutorial the first time they load the module. Confirm message: The text in the yes/no dialog that is displayed to the player when they load the module for the first time. Answering "yes" will load the tutorial logfile. Welcome message: The message that displays in the chat log when the tutorial is loaded. |
![]() |