VASSAL Reference ManualHome > Module > Help Menu |
Help MenuThe "Help" menu in the main control window contain general helpfiles for VASSAL. You may add more helpfiles specific to the module you are creating.Sub-ComponentsHelp File![]() Each Help File added adds an entry to the help menu. Helpfiles be either plain text or simple HTML (no Javascript or frames). To add a single-page Help File simply create the file with any text editor on your machine and select it. To add a multi-page HTML Help File, first create all the HTML files in a single directory. Select the starting page as you would for a single-page help file. Then save the module and quit VASSAL. Open the module file with a Zip utility (On Windows, rename the file to have a .zip extension and double-click), manually add the contents of your help directory to the module and save. Another method of creating multi-page Help Files without having to quit VASSAL is to place all images used by the Help File into a sub-directory named 'images'. Select the HTML and image files one at a time from the Help File properties dialog. The last HTML file you select will be the starting page. The contents of the file will be displayed when the player selects that menu item from the help menu. Note: when editing a module, you will need to save before you are able to view the help contents. About Screen![]() You 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 the VASSAL and engine and module. If you name your About Screen image 'Splash.gif' on your hard drive before importing it into the module, then that image will be used as a splash screen when loading the module directly from command line (as described in the VASSAL README file). Tutorial![]() You may create a tutorial by writing a logfile and making it accessible from the help menu. Menu Text is the menu item under the Help Menu Logfile is 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 provides 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 is the message that displays in the main controls window chat area when the tutorial is loaded. |