Table of Contents

Startup Properties

During the startup sequence of MapTool several properties can be defined on different places. This guide tries to make it a little bit more clear, which can be set where and how.

Definitions of Startup Properties

Startup Properties are properties, you can set only during the startup phase of the application. If you change same, you have to restart the application. There are several reasons for this behavior:

Locations To Set Values

First of all, try to use the startup tab on the option window in the maptool UI. The application will try to save your changes in the correct location.
But not all settings are changeable over the UI and if the UI tells you, to do the change by yourself, it is god to know some backgrounds.

You can set the value of a property on several locations. Since there are no guaranties, that the value of a property is set on only one location or that it has the same value on all locations, there is a clear hierarchy for the priority of a location.

The locations and there priority from high (overwrite) to low (will be overwritten) by higher locations first:

Property Overview

This table should give you an overview about all properties during the startup process.

KEY Default Value System Startup Command Line Set By Description
short long
os.nameos dependent Name of the operating system
user.homeos dependent Home directory of the os user
MAPTOOL_DATADIR.maptool+(+)DdatadiruserMain directory for runtime data (under user home)
Will be ignored in Startup, if MAPTOOL_STARTUP_FILE is relative to the data directory.
MAPTOOL_LOGDIRlogs++ userDirectory for logging data (under datadir)
CONFIG_SUBDIR_NAMEconfig Subdirectory under datadir for configuration data
TEMP_SUBDIR_NAMEtmp Subdirectory under datadir for temporary data
CMD_OPTIONS_HELP hhelpuserCommand options incl. description to log and information frame
DEBUG_FLAGfalse (not set)- ddebugadv.Set log level to debug and turn on system.out enhanced debug output
VERSION_OVERWRITEcurrent version- vversiondev.Overwrites the MapTool version. ONLY FOR DEVELOPMENT.
Some MapTool functions will break if the version is not set correct! This can corrupt your data!
FULLSCREEN_FLAGfalse (not set)-+ffullscreenuserMaximize the MapTool window on startup
MONITOR_TO USE-1 (not overwrite)- gmonitoradv.Sets which monitor (graphical device) to use.
WINDOW_WIDTH-1 (not overwrite)- wwidthadv.Override MapTool window width. Only usable together with monitor and height
WINDOW_HEIGHT-1 (not overwrite)- hheightadv.Override MapTool window height. Only usable together with monitor and width
WINDOW_XPOS-1 (not overwrite)- xxposadv.Override MapTool window starting x coordinate. Only usable together with monitor and ypos
WINDOW_YPOS-1 (not overwrite)- yyposadv.Override MapTool window starting y coordinate. Only usable together with monitor and xpos
LIST_MACRO_FLAGfalse (not set) mmacrosadv.Writes a list of the defined macro functions into the log
RESET_FLAGfalse (not set) rresetadv.Reset startup options to defaults
DEPRECATED_LOAD_CAMPAIGN_NAME - Ffile Load campaign from file on startup. Deprecated: Please use LOAD_CAMPAIGN_NAME (C or campaign)
LOAD_CAMPAIGN_NAME -+CcampaignuserLoad campaign on startup. Arg.: Full file path and name of the campaign
LOAD_SERVER_FLAGfalse (not set)-+SserveruserStart server on startup. Using server parameters from user preferences (last server start dialog)
LOAD_SERVER_DELAY0-+sserver-delayuserDelay the start of the server for x seconds, e.g. network needs more time to be ready
LOAD_AUTOSAVE_FILEask-+AautosaveuserIf there is a newer autosave file then the campaign to load, should the app load it (yes), not load it (no) or ask (ask) for the decision (default is ask)
MAPTOOL_STARTUP_FILEstartup.properties
under config dir.
- Pprops-fileuserOverride name (& path) of the startup properties file
SKIP_AUTO_UPDATE_FLAGfalse (not set) + userSkips the auto update process. There is also a user preference to do this.
user.languagedefault from OS++ userSets the (default) language for the MapTool UI. Fallback will be en (English).
user.regiondefault from OS++ userSets the (default) region (country) for the MapTool UI. E.g. how date or numbers are shown.
MAX_MEM + adv.
MIN_MEM + adv.
STACK_SIZE + adv.
ASSERTION + adv.
JAVA2D_D3D + adv.
JAVA2D_OPENGL_OPTION + adv.
MACOSX_EMBEDDED_OPTION + adv.

Legend / Notes

LegendDescription
KEYidentification of the value
Default ValueThe value, which is used if the value of the key is not set explicitly
SystemCan be set in the MapTool.cfg or by the JVM command line parameters, if there is a + in the key row
Can be set in the MapTool.cfg using the command line option key with a '-' as prefix in the[ArgOptions] section, if there is a - in the key row.
StartupCan be set in the startup properties file, if there is a + in the key row. (+) has side conditions, see description in the row of the key
Command Line ShortA single letter to use with a '-' as prefix in the command line of the application call to select the key
Command Line LongA single word to use with a '-' as prefix in the command line of the application call to select the key
Set ByNormally set by a normal user (user) or an advanced user (adv.) or a developer (dev.)
DescriptionDescription to the key meaning and usage
Note forNote
Keys ending with FLAGThis keys have a boolean value, true or false. There default value is false and if they are set somewhere, they will be true, no matter what value was used to set the key.
(E.g. If you set SKIP_AUTO_UPDATE_FLAG=“false” the value will be true!!! It can never be set back to false)
Command line has no argument. (E.g. -f or -fullscreen and not -f=“true”)

user.language

ISO 639 alpha-2 (-1) or alpha-3 (-2) language code, or registered language subtags up to 8 alpha letters (for future enhancements). When a language has both an alpha-2 code and an alpha-3 code, the alpha-2 code must be used.ISO 639 alpha-2 or alpha-3 language code, or registered language subtags up to 8 alpha letters (for future enhancements). When a language has both an alpha-2 code and an alpha-3 code, the alpha-2 code must be used.

MapTool has currently translations for the following languages:

CodeLanguage (en)
enEnglish (Default - Fallback)
achAcoli
csCzech
daDanish
deGerman
esSpanish; Castilian
frFrench
itItalian
jaJapanese
nlDutch; Flemish
plPolish
ptPortuguese
ruRussian
svSwedish
ukUkrainian
zhChinese

If the translation is not there (completely or just for a specific text), the fallback language is English.

How to Support Translations

Quote from MapTools Discord:
MapTool UI translations are crowd sourced on Crowdin. If the language you'd like to help with is not listed, ask in Discord MapTool#internationalisation-and-localisation and the dev team will set it up.
If it is, create an account and join the effort. Requests to join the translation team will be reviewed at the project manager(s) earliest opportunity.

user.region

ISO 3166 alpha-2 country code or UN M.49 numeric-3 area code.

Recommendation

First try to change the values over the startup tab on the option window. On some OS the MapTool.cfg file is not writeable, so you can not change everything what you can see.
Specially the command line options have to be set directly by yourself.

If you need your own dictionary location(s), best practice would be to set the -P command line option to tell MapTool, what the path & name of the startup property file is and define anything else in that file.
(The data dictionary directory can only be set in the startup properties file, if the startup properties file will be located independent from the data dictionary!)

If your MapTool application seems to be instable and your OS does not allow the setting of new values over the startup tab on the option window, then go and try to manipulate the MapTool.cfg file.

Try to avoid changes in the MapTool.cfg file, because the file will be overwritten by the next update.

State

Under Construction

For MapTool Version 1.13.x (under development)