JCVaultListener Configuration

Overview

This page describes configuration information for JCVaultListener 2.0 and greater. If you are looking for configuration information about VaultListener 1.1.5 or below, please see the VaultListener Configuration page.

JCVaultListener is a plugin - as opposed to its previous class file version - and gets configuration information from a standard config.yml file. The information presented on this page is similar to documentation comments found in the JCVaultListener Default Configuration File, but also includes support information and additional notes as they become evident.

Configuration Items

debug: [true | false]

checkPlayer: [true | false]

broadcastVote: [true | false]

messages:

This configuration section defines configurable messages. Messages can be made multi-line by including a newline character (\n). For example

configures a vote confirmation message to consist of three lines

Multi-line messages must be enclosed in double quotes ("). Furthermore, color and font styles are applicable to a single line. For example, if you want all three lines in the above example to display as gold, you need to apply the gold style to each line as follows:

It should also be noted that Minecraft chat displays are limited to a width of 55 characters in total. Lines longer than 55 characters are wrapped and color/font styles are not carried forward to subsequent lines.

confirm: "<text>"

payment: "<text>"

broadcast: "<text>"

currency:

This configuration section provides options to adorn currency values.

prefix: '<text>'

suffix: '<text>'

rewards:

This configuration section is used to set rewards for different voting services. The default configuration is used when there isn't a more specific configuration for a voting service. For example, the following configuration

rewards:
  default:
    type: fixed
    amount: 30.0
    rate: 0.01
  Minestatus:
    type: fixed
    amount: 50.0
    rate: 0.01

will reward players 50 currency units when voting on Minestatus and 30 currency units when voting on other vote services.

default:

This is the default configuration used when no specific vote service configuration is given. If the default configuration is not given, JCVaultListener will reward 30 currency units for each received vote.

type: [fixed | rate]

amount: <units>

rate: <rate>

Custom rewards

Custom reward configurations can be added for different voting services. Each voting service is identified by its SERVICE_NAME as given in the vote notification. Please note: this name is set by the voting service not JCVaultListener. If you are not sure what to use, contact the voting service and ask. The following list contains some SERVICE_NAME values for popular voting services.

If you come across other voting services, please feel free to drop a comment on the main page or submit a Ticket. We'll gladly add it to this list. Please make sure to provide the website address and SERVICE_NAME they use.

If you comes across a SERVICE_NAME that contains spaces or other special symbols outside of dashes ('-'), underscores ('_'), or periods ('.'), you'll want to enclose its identifier in quotes. For example, assume a voting service that uses the following SERVICE_NAME

its vote configuration would be as follows:

rewards:
  'Awesome & Best Votes!!':
    type: fixed
    amount: 100.00
    rate: 0.00

Supplemental Information

Message Color/Font Styles

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

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 prefix: & suffix: settings

{ECONOMY}

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

{SERVICE}

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

{IGN}

The in-game-name used by the voter.