Skip to content

Settings

xZise edited this page Oct 1, 2011 · 8 revisions

The settings file used by xWarp is called “config.properties” and in the plugin configuration directory. By default this is plugins/xWarp/.

With xWarp 3.0.0 this file is called config.yml and is a yml file.

Nodes

  • data-connection – Defines which data connection should be used. Available values are “sqlite” and “hmod”. (In 3.0.0: data.connection)
  • cooldown-notify – Notify when the cooldown is over. (In 3.0.0: cooldown.notify)
  • warmup-notify – Notify that there is a warm up. (In 3.0.0: warmup.notify)
  • use-force-to – Use “force-to” by default which is ignoring if the warp is safe. (In 3.0.0: use-force-to)
  • show-free-price-message – Defines if xWarp shows a message, if the price for this warp operation was 0. (In 3.0.0: show-free-price-message)
  • cancel-warm-up-on-damage – Cancels the warmup if the player got hit. (In 3.0.0: warmup.cancel.damage)
  • cancel-warm-up-on-movement – Cancels the warmup if the player moves. (In 3.0.0: warmup.cancel.movement)
  • economy – Define the used economy here. It is not case sensitive. If not defined it will select the first usable. To disable economy select none or null as name (≥ 2.11.1 b3). (In 3.0.0: economy.plugin)
  • economy-base-account – This account will get the base price for the warp. If not defined nobody will get the basic price. (In 3.0.0: economy.base-account)
  • update-if-exists – If somebody creates a new warp which already exists, it will be updated. (In 3.0.0: update-if-exists)
  • permissions.plugin (since 3.0.0) – Defines the used permissions plugin. If not defined it will select the first usable. To disable permissions plugin usage select none or null as name. Note that this doesn't disable SuperPerms.
  • case-sensitive (since 3.0.0) – If somebody executes a command the names have to be case sensitively equal.
  • warp.defaultmsg (since 3.1.0) – Set the default welcome message. To add the name of the warp in the message, add the {NAME} variable (uppercase is important!).
  • marker.enabled (since 3.1.3) – Enables the markers on dynmap.
  • marker.png (since 3.1.0) – Set the marker's image for dynmap support. Due to the dynmap plugin it isn't possible to change the image after it was created once. The path is relative to the directory where the configuration is in. It is recommended to use only 16×16 pixel large images, as the layout of dynmap is working only with this size nicely.
  • marker.visibilities (since 3.1.0) – Defines which type of visibilities a warp needs to be shown on the map. To hide all, set it to an empty list.
  • list.columns (since 3.1.0) – Determines which columns in the warp list command are normally used.

Default (3.1.3)

warmup:
    notify: true
    cancel:
        movement: false
        damage: true
cooldown:
    notify: true
permissions:
    plugin: ''
economy:
    base-account: ''
    plugin: ''
data:
    connection: 'sqlite'
case-sensitive: false
use-force-to: false
show-free-price-message: false
update-if-exists: false
warp:
  defaultmsg: 'Welcome to {NAME}!'
marker:
  enabled: false
  png: 'marker.png'
  visibilities:
    - 'public'
    - 'global'
list:
  columns:
    - owner
    - world
    - location

Default (pre 3.0.0)

data-connection=sqlite
cooldown-notify=true
warmup-notify=true
use-force-to=true
show-free-price-message=true
cancel-warm-up-on-damage=true
cancel-warm-up-on-movement=false
economy=
economy-base-account=
update-if-exists=true