Command Line Options

From RPTools Wiki
Jump to navigationJump to search

Command Line Options for MapTool

You can pass MapTool options when launching from a shell, command prompt or desktop shortcut. They can be used both when using the MapTool executable launcher (MapTool.exe) or when launching the jar file (maptool-1.x.x.x.jar) directly.

This functionality is intended for use by advanced users or developers.

Applies To

MapTool Version: 1.5+
Java Version: MT version 1.5 can only use Java 10 with JavaFX.

Launching MapTool via Jar File

When launching MapTool via the jar file you should specify memory settings as in the example below. With no options, 2GB of memory and a 4MB stack size using the 1.5.0 jar file. Note the jar file name must match exactly.

javaw -Xmx2048M -Xss4M -jar maptool-1.5.0.0.jar

Command Line Options for MapTool

The following command line options are available. The full option name may be used or just the first letter.

The following options have no parameters and take the form of:

javaw -jar maptool-x.x.x.x.jar -option
d/debug - Turn on System.out enhanced debug output
m/macros - Output list of defined macro functions
r/reset - Reset startup options to defaults
f/fullscreen - Maximize MapTool window

The following options require a single parameter and take the form of:

javaw -jar maptool-x.x.x.x.jar -option=value
v/version - Override MapTool version
m/monitor - Sets which monitor to use beginning with 0.
F/file - Load a campaign file after starting MapTool

These options require the monitor option be specified on the same command line.

javaw -jar maptool-x.x.x.x.jar -monitor=n -option=value
w/width - Override MapTool window width
h/height - Override MapTool window height
x/xpos - Override MapTool window starting x coordinate
y/ypos - Override MapTool window starting y coordinate

High DPI Display Options

There are system properties that can be set to set the scaling of MapTool's UI. These can be passed as command line options or in the {code|[JavaOptions]} section of the MapTool.cfg file. The default scaling of 1.0 assumes a 96 DPI display. Using this option along with Windows High DPI scaling may produce undesirable effects.

For a 120 DPI display, use one of the following in your MapTool.cfg file:

java-options=-Dsun.java2d.uiScale=1.25
java-options=-Dsun.java2d.uiScale=125%
java-options=-Dsun.java2d.uiScale=120dpi

On Linux under X11, you can adjust MapTool's scaling by passing

-Dsun.java2d.uiScale=2.0

If you are using a system-wide install, this can be added to

/opt/maptool/lib/app/MapTool.cfg

under the [JavaOptions] section as

java-options=-Dsun.java2d.uiScale=2.0


Examples

javaw -Xmx2048M -Xss1M -jar maptool-1.5.0.0.jar -version=1.5.6.7
javaw -Xmx2048M -Xss1M -jar maptool-1.5.0.0.jar -v=1.5.6.7
javaw -Xmx2048M -Xss1M -jar maptool-1.5.0.0.jar -fullscreen
javaw -Xmx2048M -Xss1M -jar maptool-1.5.0.0.jar -f
javaw -Xmx2048M -Xss1M -jar maptool-1.5.0.0.jar -monitor=0 -width=800 -height=800
javaw -Xmx2048M -Xss1M -jar maptool-1.5.0.0.jar -monitor=0 -xpos=20 -ypos=20
javaw -Xmx2048M -Xss1M -jar maptool-1.5.0.0.jar -monitor=0 -x=20 -y=20 -w=800 -h=1200
javaw -Xmx2048M -Xss1M -jar maptool-1.5.0.0.jar -m=0 -xpos=150 -y=150 -width=1000 -height=1200
javaw -Xmx2048M -Xss1M -jar maptool-1.5.0.0.jar -file=mycampaign.cmpgn