Bukkit

VaultListener is configured through its VaultListener.properties file found in the Votifier directory (not the listeners directory therein). If one does not exist, VaultListener will create a default configuration.

The information contained herein is applicable to VaultListener 1.1.5 and below. Configuration information for JCVaultListener 2.0 can be found on the JCVaultListener Configuration page.

Default Properties

reward_amount=30.0
reward_type=fixed
reward_rate=0.01
reward_prefix=
reward_suffix=\ USD
confirm_msg=Thanks for voting on {SERVICE}\!
payment_msg={AMOUNT} has been added to your {ECONOMY} balance.
broadcast=true
broadcast_msg=The server was voted for by {IGN}\!
debug=false

Configuration Items

reward_amount

The number of currency units to pay for each vote.

reward_type

fixed - every player receives a fixed amount set by reward_amount

rate - player reward is a percentage (given by reward_rate) of their current balance or reward_amount, which ever one is greater.

reward_rate

The rate used to calculate reward when reward_type=rate. e.g. 1.0 = 100%, 0.50 = 50%, 0.0075 = 0.75%

confirm_msg

The confirmation message sent to the player (if they are online).

payment_msg

Payment confirmation message. This message will only be displayed if Vault finds a suitable economy plugin and the player has a valid economy account. If the account does not exist, most economy plugins will create it.

broadcast

If set to true, VaultListener will broadcast a configurable message whenever a vote is received for the server.

broadcast_msg

Broadcast message. This message will be displayed if broadcast mode is enabled.

debug

If set to true, VaultListener will send a copy of all messages to the server log. Use this to test the format of custom messages. It should be noted that not all voting servers cast a vote during a connection test. Currently, Minestatus is the only one known that sends a mock vote with the IGN of 'Test Notification'. Other voting servers only test the ability to connect, rather than the voting process.

Please note that the exclamation point ('!') has special meaning in properties files and must be escaped if used within a string. Likewise, leading spaces must also be escaped (see reward_suffix above). For for information on properties file see .properties for more information.

Multi-Line Messages & Message Color/Font Styles

All configurable messages support basic Bukkit chat colors and font styles. To change colors, insert the appropriate color tag.

All configurable messages can be split into multiple lines by inserting newline characters ("\n"). Because each line is sent as a separate player/server message, care must be taken to set message colors/font styles for each line.

Message Tokens

Custom messages can include four different message tokens. These tokens are replaced with their corresponding value as described below:

{AMOUNT}

The reward amount paid adorned by reward_prefix & reward_suffix

{ECONOMY}

The name of the economy plugin that Vault detected and will use to make payments.

{SERVICE}

The name of the voting server, e.g. Minestatus

{IGN}

The in-game-name used by the voter.