Skip to content

Editing your config.yml

toadbomb edited this page May 26, 2012 · 2 revisions

This page assumes:

  • You have the latest version of QuickTravel installed on a supported version of CraftBukkit.
  • You have access to your server's plugins folder.
  • You are reasonably familiar with running a CraftBukkit server.

Your config.yml file can be found in your server's plugins\QuickTravel folder. By default, it should look like this:

radius: 5
height-modifier: 2
enabled-by-default: true
require-discovery-by-default: true
require-permissions-by-default: false
multiworld-by-default: false
qt-from-anywhere: false
enable-economy: false
withdraw-from-player-not-bank: true
free-by-default: false
price-multiplier: 0.8
multiworld-multiplier: 1.2
multiworld-tax: 500
free-from-qts: false
enable-safety-checks: false
enable-fx: true

The settings are defined as follows:

  • radius : This value controls the default radius size for QTs of type radius on your server. Can be an integer or double. Default: 5
  • height-modifier : The height-modifier allows users to be x blocks above or below a QT to be counted as within its area, where x is the value set here. Can be an integer or double. Default: 2
  • enabled-by-default : This setting controls whether QTs are enabled by default. Must be a boolean. Default: true
  • require-discovery-by-default : This setting controls whether users must discover QTs before they can warp to them by default. Must be a boolean. Default: true
  • require-permissions-by-default : This setting controls whether users must have the permissions for individual QTs before they can use/discover/warp to them by default. Must be a boolean. Default: false
  • multiworld-by-default : This setting controls whether users can warp to QTs that are located on a different world to the user by default. Must be a boolean. Default: false
  • qt-from-anywhere : This setting controls whether users can warp to QTs from anywhere, or whether they must be at a QT. Must be a boolean. Default: false
  • enable-economy : This setting controls whether QuickTravel will look for the Vault plugin, and if found, hook into it for charging users. Must be a boolean. Default: false
  • withdraw-from-player-not-bank : This setting controls whether QuickTravel will charge the user's in-hand balance, instead of their bank account (if your Economy plugin supports them). Must be a boolean. NB: This setting will only take effect if Vault is installed and enable-economy is set to true. Default: true
  • free-by-default : This setting controls whether users can warp for free if no price has been set. When set to false, QuickTravel will calculate a price for you based on distance if no price has been set. Must be a boolean. NB: This setting will only take effect if Vault is installed and enable-economy is set to true. Default: false
  • price-multiplier : This value affects how much QuickTravel charges to warp to QTs. The calculated price will be multiplied by this by this value and then rounded up. This allows you to make all of your calculated prices higher or lower to fit with your server's economy. Does not affect prices that are set manually. Must be a double. NB: This setting will only take effect if Vault is installed and enable-economy is set to true. Default: 0.8
  • multiworld-multiplier : This value affects how much QuickTravel charges to warp to QTs across worlds. The calculated price will be multiplied by this by this value and then rounded up. This allows you to charge more or less for warps from one world to another. Does not affect prices that are set manually. Must be a double. NB: This setting will only take effect if Vault is installed and enable-economy is set to true. Default: 1.2
  • multiworld-tax : This value will be charged on top of the price set or calculated for all multiworld warps. Can be an integer or a double. NB: This setting will only take effect if Vault is installed and enable-economy is set to true. Default: 500
  • free-from-qts : When set to true, warps from QTs will be free (excluding multiworld tax) unless you have manually set prices. Warps from non-QT locations will not be affected. In this way, you can allow users to warp for from QT to QT, but still charge them to warp from non-QT locations. Must be a boolean. NB: This setting will only take effect if Vault is installed and both enable-economy and qt-from-anywhere are set to true. Default: false
  • enable-safety-checks : BETA When set to true, when a player warps to a QT, the server will check whether the destination is safe or not, and attempt to make it safe if it determines a problem, before warping the player. Must be a boolean. NB: This feature is a work in progress. Feel free to use it if you are curious and wish to help with beta testing. Default: false
  • enable-fx : When set to true, sound and visual FX will be played whenever a player warps to or from a QT. Must be a boolean. Default: true

Clone this wiki locally