Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

autoRestartOpportunisticCheckTimer

Opportunistically restart the server when nobody is online. Sets a wall timer in minutes to check for currently online players. If two checks in a row find nobody online, restart the server if it hasn’t been restarted within the last autoRestartOpportunisticMinInterval minutes.

Type: signed integer

Default:

0

autoRestartOpportunisticMinInterval

Minimum online interval for opportunistic server restart. Do not opportunistically restart the server unless at least this many minutes have elapsed since the last server start. This is to avoid restarting the server too often as people come and go.

Type: signed integer

Default:

0

autoRestartTimer

Sets a wall timer in minutes to restart the server. How often this is necessary depends on mods, population, and activity. 24h is a decent default. Set to 0 to disable.

The restart action will start a 15 minute timer, sending a global notification every 5 minutes to advise players about the restart. When the timer elapses, the unit is restarted.

Type: signed integer

Default:

0

gtnhPackage

GTNH package used for the server.

Type: package

Default:

pkgs."gtnh-${config.minecraft."instance-options".version}"

jvmInitialAllocation

Initial memory allocation pool for the JVM, as set by -Xms.

Defaults to not being set.

Type: string

Default:

"6G"

jvmMaxAllocation

Maximum memory allocation pool for the JVM, as set by -Xmx.

Default is JVM default. You definitely want to change this.

Type: string

Default:

"6G"

jvmOptString

The compiled value of $JVMOPTS, exported as a read-only value.

Type: string (read only)

Default:

mkJvmOptString config.minecraft."instance-options"

jvmOpts

JVM options used to call Minecraft on server startup.

The default value should serve you well unless you have specific needs.

Note: Do not include -Xms or -Xmx here.

See jvmMaxAllocation for -Xmx and jvmInitialAllocation for -Xms.

Type: string

Default:

"-Dfml.readTimeout=180 -Dfile.encoding=UTF-8 -Djava.system.class.loader=com.gtnewhorizons.retrofuturabootstrap.RfbSystemClassLoader --add-opens java.base/java.io=ALL-UNNAMED --add-opens java.base/java.lang.invoke=ALL-UNNAMED --add-opens java.base/java.lang.ref=ALL-UNNAMED --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.net.spi=ALL-UNNAMED --add-opens java.base/java.net=ALL-UNNAMED --add-opens java.base/java.nio.channels=ALL-UNNAMED --add-opens java.base/java.nio.charset=ALL-UNNAMED --add-opens java.base/java.nio.file=ALL-UNNAMED --add-opens java.base/java.nio=ALL-UNNAMED --add-opens java.base/java.text=ALL-UNNAMED --add-opens java.base/java.time.chrono=ALL-UNNAMED --add-opens java.base/java.time.format=ALL-UNNAMED --add-opens java.base/java.time.temporal=ALL-UNNAMED --add-opens java.base/java.time.zone=ALL-UNNAMED --add-opens java.base/java.time=ALL-UNNAMED --add-opens java.base/java.util.concurrent.atomic=ALL-UNNAMED --add-opens java.base/java.util.concurrent.locks=ALL-UNNAMED --add-opens java.base/java.util.jar=ALL-UNNAMED --add-opens java.base/java.util.zip=ALL-UNNAMED --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/jdk.internal.loader=ALL-UNNAMED --add-opens java.base/jdk.internal.misc=ALL-UNNAMED --add-opens java.base/jdk.internal.ref=ALL-UNNAMED --add-opens java.base/jdk.internal.reflect=ALL-UNNAMED --add-opens java.base/sun.nio.ch=ALL-UNNAMED --add-opens java.desktop/com.sun.imageio.plugins.png=ALL-UNNAMED --add-opens java.desktop/sun.awt.image=ALL-UNNAMED --add-opens java.desktop/sun.awt=ALL-UNNAMED --add-opens java.sql.rowset/javax.sql.rowset.serial=ALL-UNNAMED --add-opens jdk.dynalink/jdk.dynalink.beans=ALL-UNNAMED --add-opens jdk.naming.dns/com.sun.jndi.dns=ALL-UNNAMED,java.naming"

jvmPackage

JVM package used to run the server.

Note: Do not use the jre8_headless package. Modded minecraft needs awt.

Type: package

Default:

pkgs.jdk25

openRcon

Whether to open the RCON port in the firewall. Local RCON is used for server automation. Public RCON requires additional security.

Type: boolean

Default:

false

version

GTNH version to run. Must match an entry in the version-list and have a corresponding package exposed via the overlay (e.g. gtnh-2.8.4).

Type: string

Default:

"2.8.4"