Configuration

The plugin's global configuration file is a standard YAML file located:

plugins/Transporter/config.yml

It is recommended you don't edit this file directly. The plugin provides commands to alter all the settings in the file either in-game or from the console. If you do decide to edit the file by hand, you should not edit while the server is running since your changes could be overwritten when the server is stopped or the configuration is explicitly saved. However, if you're careful, you can make direct edits, then issue the reload config command to the plugin.

The configuration file is in multiple sections. Each section corresponds to a group of commands. Only the options not covered by other pages are explained here.

Each gate also has a set of options. See the Gates page for more information.

If an option is not present in the configuration file, the indicated default is assumed.

Global

These options exist in the "global" section and can be configured with the trp set ... command, unless otherwise noted.

Option	Type	Default	Version	Description
allowBuild	boolean	true	All	Specifies whether or not players can use the trp design build command. This setting is global and is checked before the individual design's "build" option, and the player's build permission is checked.
allowLinkLocal	boolean	true	All	Specifies whether or not gates can be linked to other gates in the same world.
allowLinkWorld	boolean	true	All	Specifies whether or not gates can be linked to other gates across worlds on the same server.
allowLinkServer	boolean	true	All	Specifies whether or not gates can be linked to other gates on other servers.
allowSignCreation	boolean	true	v8.0+	Specifies whether or not players can create gates by placing signs that match designs.
arrivalWindow	integer	20000	All	Specifies the time, in milliseconds, in which a telporting player must connect to this server when they're teleporting in. If the player doesn't connect within this time, the teleportation is cancelled.
autoAddWorlds	boolean	true	v7.7beta4+	Specifies if a world where a new gate is created should be automatically added to the plugin's list of worlds.
autoLoadWorlds	boolean	true	All	Specifies if all the previously added worlds marked for autoLoading should be autoLoaded when the plugin is first enabled.
checkVersion	boolean	true	v8.11	Specifies whether or not a plugin version check is made against the VERSION page.
consolePMFormat	string	[console] %GREEN%%message%	v8.0+	Specifies the format to use when a player receives a PM from local console. Valid tokens are: %message% (the message).
debug	boolean	false	All	Specifies whether or not debugging is turned on. With debugging on, extra messages are displayed on the console. Alot of them. This can effect the performance of the MC server, so you shouldn't leave this on normally.
deleteDebugFile	boolean	true	All	Specifies whether or not the debug file generated for submission is deleted after it is submitted. If you want to seen what's being sent, set this to false and the file path will be displayed on the console.
dynmapMarkerSetLabel	string	Transporter Gates	All	Specifies the label to use for the marker set that controls display of Transporter gates when integrating with Dynmap.
exportedGatesFile	string	overviewer/gates.json	All	Specifies the path to the file where information about all the gates on this server will be written to. See MinecraftOverviewer or Dynmap for more information.
gateLockExpiration	integer	2000	All	Specifies the time, in milliseconds, a player is locked out from teleporting through a gate.
localPMFormat	string	[%fromPlayer%] %GREEN%%message%	v8.0+	Specifies the format to use when a player receives a PM from a player in the same world. Valid tokens are: %fromPlayer% (the display name of the player sending the message), %message% (the message).
resendLostPlayers	boolean	false	v8.14	If true, a player that joins this server when they have teleported to another server and not arrived on that server before their reservation times out will be re-sent to that server. Setting this to true can alleviate some cheating by helping prevent inventory duplication.
serverChatFormat	string	<%player%@%world%@%server%> %message%	All	Specifies the format to use when displaying chat messages from other servers. Valid tokens are: %player% (sending player's display name, which may include color), %world% (name of the world the sending player is in), %server% (name of the server the sending player in on), %message% (message text), %prefix% (sending player's prefix), %suffix% (sending player's suffix). NOTE: %prefix% and %suffix% only work when the plugin is integrated with Vault.
serverDeathFormat	string	%YELLOW%%player%/%world%@%server% died.	v8.0+	Specifies the format to use when displaying player death messages from other servers. Valid tokens are: %player% (player's display name, which may include color), %world% (player's world name), %server% (player's server name), %prefix% (sending player's prefix), %suffix% (sending player's suffix). NOTE: %prefix% and %suffix% only work when the plugin is integrated with Vault.
serverJoinFormat	string	%YELLOW%%player%@%world%@%server% joined the game.	All	Specifies the format to use when displaying player join messages from other servers. Valid tokens are: %player% (player's display name, which may include color), %world% (player's world name), %server% (player's server name), %prefix% (sending player's prefix), %suffix% (sending player's suffix). NOTE: %prefix% and %suffix% only work when the plugin is integrated with Vault.
serverKickFormat	string	%YELLOW%%player%@%world%@%server% was kicked.	All	Specifies the format to use when displaying player kick messages from other servers. Valid tokens are: %player% (player's display name, which may include color), %world% (player's world name), %server% (player's server name), %prefix% (sending player's prefix), %suffix% (sending player's suffix). NOTE: %prefix% and %suffix% only work when the plugin is integrated with Vault.
serverPMFormat	string	[%fromPlayer%/%fromWorld%@%fromServer%] %GREEN%%message%	v8.0+	Specifies the format to use when a player receives a PM from a player on a different server. Valid tokens are: %fromPlayer% (the display name of the player sending the message), %fromWorld% (the name of world the sending player is in), %fromServer% (the name of the server the sending player is on), %message% (the message), %fromPrefix% (sending player's prefix), %fromSuffix% (sending player's suffix), %toPrefix% (receiving player's prefix), %toSuffix% (receiving player's suffix).
serverQuitFormat	string	%YELLOW%%player%@%world%@%server% left the game.	All	Specifies the format to use when displaying player quit messages from other servers. Valid tokens are: %player% (player's display name, which may include color), %world% (player's world name), %server% (player's server name), %prefix% (sending player's prefix), %suffix% (sending player's suffix). NOTE: %prefix% and %suffix% only work when the plugin is integrated with Vault.
showGatesSavedMessage	boolean	true	v8.0+	Enables showing "gate saved" messages on the console.
updateMetrics	boolean	true	v8.11	Specifies whether or not plugin metrics are updated on http://mcstats.org/
useDynmap	boolean	false	All	Specifies whether or not to integrate with the Dynamp plugin, if it's configured on this server.
useGatePermissions	boolean	false	All	Specifies whether or not gates should use gate permissions for determining whether or not to allow sending and receiving. See Permissions for more information.
useBOSEconomy	boolean	false	v7.6-	Specifies whether or not to integrate with the BOSEconomy plugin, if it's configured on this server.
usePermissions	boolean	false	All	Specifies whether or not to integrate with the Permissions plugin, if it's configured on this server.
usePermissionsEx	boolean	false	All	Specifies whether or not to integrate with the PermissionsEx plugin, if it's configured on this server.
useRegisterEconomy	boolean	false	All	Specifies whether or not to integrate with the Register plugin, if it's configured on this server. The Register plugin integrates with numerous other economy plugins. In general, it uses the first one it finds on your server.
useTabAPI	boolean	false	v8.14	Specifies whether or not to integrate with the TabAPI plugin for tab list control, if it's configured on this server.
useVaultChat	boolean	false	v8.5	Specifies whether or not to integrate with the Vault plugin for chat functions, if it's configured on this server. The Vault plugin integrates with numerous other chat plugins. This option must be true in order to successfully use %prefix% and %suffix% substitution tokens in various formats.
useVaultEconomy	boolean	false	v7.7+	Specifies whether or not to integrate with the Vault plugin for economy functions, if it's configured on this server. The Vault plugin integrates with numerous other economy plugins.
useVaultPermissions	boolean	false	v7.7+	Specifies whether or not to integrate with the Vault plugin for permissions, if it's configured on this server.
worldLoadDelay	integer	5000	v7.7+	Specifies the time, in milliseconds, after which worlds are autoloaded. A value of 0 will cause the plugin to autoload worlds when it is enabled. Any other positive value will cause an event to fire and autoload worlds after the specified duration after the plugin is enabled.
worldPMFormat	string	[%fromPlayer%/%fromWorld%] %GREEN%%message%	v8.0+	Specifies the format to use when a player receives a PM from a player in a different world on the same server. Valid tokens are: %fromPlayer% (the display name of the player sending the message), %fromWorld% (the name of world the sending player is in), %message% (the message).

httpProxy

This subsection of the global section contains proxy information. These options are only required if the plugin is being hosted on a machine behind an HTTP proxy. These options can be set with the trp set httpProxy* ... commands

Option	Type	Default	Version	Description
host	string	none	All	Specifies the host name or address of the proxy server.
password	string	none	All	If the proxy requires authentication, this specifies the user name to use. To enable authentication, both a user name and password must be specified (see the previous option).
port	integer	80	All	Specifies the port number of the proxy server.
type	string	HTTP	All	Specifies the type of proxy in use. Values are HTTP or SOCKS.
user	string	none	All	If the proxy requires authentication, this specifies the user name to use. To enable authentication, both a user name and password must be specified (see the next option).

Pins

This section contains a mapping between player names and their PINs. PINs are stored in clear text. Players set their PIN using the trp pin ... command.