TeleportRequest configuration
The TeleportRequest config.json controls how the plugin runs on your Ark Survival Ascended server. Every setting is listed below with what it does and its default value.
Where it lives
Drop the file on your server at ArkApi/Plugins/TeleportRequest/config.json then reload the plugin or restart the server. Keep a backup before large changes.
Every setting
General
- Debug togglefalse
- Debug: set to true to write extra lines to ArkApi.log. Leave it false for normal play.
Commands
Commands: the words players type in chat. Rename them or set one to "" to turn it off.
- AskCMD text"/tpa"
- ask to teleport to a player: /tpa <name>
- HereCMD text"/tphere"
- ask a player to come to you: /tphere <name>
- AcceptCMD text"/tpaccept"
- accept a request. Add a name to pick one: /tpaccept <name>
- DenyCMD text"/tpdeny"
- turn down a request. Add a name to pick one: /tpdeny <name>
- CancelCMD text"/tpcancel"
- cancel the requests you sent out
Teleport
Teleport: the rules.
- RequestTimeoutSeconds number30
- RequestTimeoutSeconds: how long a request waits before it times out. 30 means the other player has 30 seconds to accept. Set to 0 to let requests wait forever (not advised).
- CooldownSeconds number120
- CooldownSeconds: how long a player must wait between teleports. 120 means one every two minutes. The wait is counted per player. Set to 0 to turn it off.
- VipCooldownSeconds number30
- VipCooldownSeconds: the shorter cooldown for players with the VIP node below. 30 means a VIP waits only 30 seconds. This only matters if Permissions is on and the player has the node.
- BlockInCombatSeconds number15
- BlockInCombatSeconds: block a teleport for this long after a player takes or deals damage. This stops teleport from being used to run from a fight. 15 means a player who was just hit can not teleport for 15 seconds. Set to 0 to turn the combat block off. Needs the damage hook to load. If the hook fails after a game update, the block turns off on its own and the log says so.
- WarmupSeconds number0
- WarmupSeconds: a short hold before the teleport fires after a player accepts. During the hold, if either player takes damage, the teleport is cancelled and any points are returned. 0 means teleport right away. 3 means wait three seconds first.
- CheckForDino toggletrue
- CheckForDino: set to true so a teleport is blocked when a player is riding a dino. This stops players from bringing a mount along. Set to false to allow it.
- MaxDistance number-1
- MaxDistance: the farthest apart two players can be for a teleport, in game units. -1 means no limit. A number like 100000 blocks teleports across the whole map.
- AllowTpHere toggletrue
- AllowTpHere: set to true to allow the /tphere command (ask a player to come to you). Set to false to only allow /tpa (go to a player).
- PointCost number0
- PointCost: ArkShop points the asker pays for a teleport. The cost is taken when the other player accepts and is returned if the teleport fails. 0 means teleports are free. Needs ArkShop to be on, or teleports are free no matter what this is set to.
Permissions
Permissions: gate who can teleport and who gets the VIP cooldown. Needs Permissions.dll.
- Enabled toggletrue
- Enabled: set to true to check Permissions. If Permissions.dll is missing, everyone can teleport with the normal cooldown.
- UsePermission text"TeleportRequest.Use"
- UsePermission: the node a player needs to use teleport at all. If Permissions is off or missing, everyone is allowed.
- VipPermission text"TeleportRequest.VIP"
- VipPermission: the node that gives the shorter VipCooldownSeconds above.
- AdminPermission text"TeleportRequest.Admin"
- AdminPermission: kept for a future staff command. Not used yet.
ArkShop
ArkShop: the points economy for the teleport cost. Needs ArkShop.dll.
- Enabled toggletrue
- Enabled: set to true to charge PointCost through ArkShop. If ArkShop is off or missing, teleports are free.
Discord
Discord: log teleports to a channel through a webhook.
- Enabled togglefalse
- Enabled: set to true to send Discord posts. Leave false to keep everything in game.
- WebhookURL textempty
- WebhookURL: the Discord webhook for the log channel.
- Username text"TeleportRequest"
- Username: the name the webhook posts under.
- ServerName text"My ARK Server"
- ServerName: shown in the footer so you can tell servers apart. Set it to your server name.
- LogTeleports toggletrue
- LogTeleports: set to true to post each good teleport. Set to false to stop the log posts.
The full commented config
This is a reading copy with notes. It is not valid JSON, so do not load it. Use the editor or the plain config.json instead.
{
// This file explains every setting in config.json.
// It has notes in it, so it is NOT valid JSON. Do not load this file.
// Edit config.json instead. This file is just here to help you.
"General": {
// Debug: set to true to write extra lines to ArkApi.log. Leave it false for normal play.
"Debug": false
},
// Commands: the words players type in chat. Rename them or set one to "" to turn it off.
"Commands": {
"AskCMD": "/tpa", // ask to teleport to a player: /tpa <name>
"HereCMD": "/tphere", // ask a player to come to you: /tphere <name>
"AcceptCMD": "/tpaccept", // accept a request. Add a name to pick one: /tpaccept <name>
"DenyCMD": "/tpdeny", // turn down a request. Add a name to pick one: /tpdeny <name>
"CancelCMD": "/tpcancel" // cancel the requests you sent out
},
// Teleport: the rules.
"Teleport": {
// RequestTimeoutSeconds: how long a request waits before it times out. 30 means the other
// player has 30 seconds to accept. Set to 0 to let requests wait forever (not advised).
"RequestTimeoutSeconds": 30,
// CooldownSeconds: how long a player must wait between teleports. 120 means one every two
// minutes. The wait is counted per player. Set to 0 to turn it off.
"CooldownSeconds": 120,
// VipCooldownSeconds: the shorter cooldown for players with the VIP node below. 30 means a
// VIP waits only 30 seconds. This only matters if Permissions is on and the player has the node.
"VipCooldownSeconds": 30,
// BlockInCombatSeconds: block a teleport for this long after a player takes or deals damage.
// This stops teleport from being used to run from a fight. 15 means a player who was just hit
// can not teleport for 15 seconds. Set to 0 to turn the combat block off. Needs the damage
// hook to load. If the hook fails after a game update, the block turns off on its own and the
// log says so.
"BlockInCombatSeconds": 15,
// WarmupSeconds: a short hold before the teleport fires after a player accepts. During the
// hold, if either player takes damage, the teleport is cancelled and any points are returned.
// 0 means teleport right away. 3 means wait three seconds first.
"WarmupSeconds": 0,
// CheckForDino: set to true so a teleport is blocked when a player is riding a dino. This
// stops players from bringing a mount along. Set to false to allow it.
"CheckForDino": true,
// MaxDistance: the farthest apart two players can be for a teleport, in game units.
// -1 means no limit. A number like 100000 blocks teleports across the whole map.
"MaxDistance": -1,
// AllowTpHere: set to true to allow the /tphere command (ask a player to come to you).
// Set to false to only allow /tpa (go to a player).
"AllowTpHere": true,
// PointCost: ArkShop points the asker pays for a teleport. The cost is taken when the other
// player accepts and is returned if the teleport fails. 0 means teleports are free. Needs
// ArkShop to be on, or teleports are free no matter what this is set to.
"PointCost": 0
},
// Permissions: gate who can teleport and who gets the VIP cooldown. Needs Permissions.dll.
"Permissions": {
// Enabled: set to true to check Permissions. If Permissions.dll is missing, everyone can
// teleport with the normal cooldown.
"Enabled": true,
// UsePermission: the node a player needs to use teleport at all. If Permissions is off or
// missing, everyone is allowed.
"UsePermission": "TeleportRequest.Use",
// VipPermission: the node that gives the shorter VipCooldownSeconds above.
"VipPermission": "TeleportRequest.VIP",
// AdminPermission: kept for a future staff command. Not used yet.
"AdminPermission": "TeleportRequest.Admin"
},
// ArkShop: the points economy for the teleport cost. Needs ArkShop.dll.
"ArkShop": {
// Enabled: set to true to charge PointCost through ArkShop. If ArkShop is off or missing,
// teleports are free.
"Enabled": true
},
// Discord: log teleports to a channel through a webhook.
"Discord": {
// Enabled: set to true to send Discord posts. Leave false to keep everything in game.
"Enabled": false,
// WebhookURL: the Discord webhook for the log channel.
"WebhookURL": "",
// Username: the name the webhook posts under.
"Username": "TeleportRequest",
// ServerName: shown in the footer so you can tell servers apart. Set it to your server name.
"ServerName": "My ARK Server",
// LogTeleports: set to true to post each good teleport. Set to false to stop the log posts.
"LogTeleports": true
}
}