Bukkit

VaultListener is a Votifier listener class that rewards players with currency when they vote for your server. VaultListener uses Vault to interface with many popular econony plugins.

VaultListener 2.0 IMPORTANT NEWS

VaultListener 2.0 will be released within a week (6/4/12 - 6/10/12), or sooner. This release adds the ability to reward players based on the voting service used. It will also offer an option to enable player verification in order to ignore vote notifications from players that have not logged onto your server at least once. The latter option was requested primarily as a spam prevention measure.

MORE IMPORTANTLY, the newest features and other planned features are starting to tax limits of a single vote listener class; instead, VaultListener 2.0 will become a PLUGIN. It will still be very lightweight and support all current features. In addition, Version 2.0 configuration will be via a YAML configuration file as is common with most plugins.

I have worked closely with blakeman8192 of the Votifier team adding the ability to generate a custom Bukkit event that can be processed by any plugin that chooses to do so. In addition, we've improved Votifier's diagnostic messages in order to help admins figure out where problems lie when things aren't just right.

At this point, the only thing left is to determine the best migration strategy so as to make this transition as smoothly as possible. If all goes accordingly, you just need to drop VaultListener 2.0 into your plugins folder and it will do all the rest such as automatically importing configurations.

To recap:

• VaultListener 2.0 will be a plugin
• You will need Votifier 1.8, or greater.
• More to come.

Features

• Multi-economy support - iConomy 4,5,6, BOSEconomy 6 & 7, EssentialsEcon, 3Co, MultiCurrency, eWallet, EconXP, CurrencyCore, CraftConomy, AEco (thanks to the great work by Sleaker and his Vault team.) See Vault for a complete list of supported economy plugins.
• Pays online and offline players instantly. No queues to get lost during server reboots.
• Handles payments for multiple voting services.
• Two reward types:
  • fixed - every player receives a fixed amount
  • rate - reward is a percentage of the player's balance or a fixed amount, which ever is larger.
• Reward amount can be adorned with a prefix and/or suffix to set currency names and/or symbols.
• Configurable messages for confirming vote and payment to player.
• Configurable broadcast message sent to online players.
• Colorized messages.

Test Validation & Verification

VaultListener has been extensively tested against the following components:

• Craftbukkit Recommended Build 1.1-R2 (#1840) through Craftbukkit 1.2.5-R1.0 (#2149).
• Vault 1.1.18 though 1.2.15
• Votifier 1.4 through 1.6

Problems?

If you run into problems with VaultListener, we'd like to hear from you. However, we expect that you do some research first. Make sure to check out the Troubleshooting VaultListener section; check this site's discussions and Tickets to make sure that your issue hasn't already been addressed. If not, please feel free to submit a Ticket.

Revision History

• v1.1.5, 05/02/12
  • Added ability to use message font styles in customized messages.
  • Changed default reward_suffix from " USD" to "" (i.e. no suffix unless explicitly configured).
  • Multi-line customized messages. Embed newline ("\n") in message to split into separate lines.

• v1.1.4, 03/23/12
  • Cosmetic change only, no functional or operational changes.
  • Payment type value is now correctly reported in configuration debug dump.

• v1.1.3, 03/15/12
  • Tested and validated with CraftBukkit Beta Build 1.2.3-R0.2
  • Fixed debug property not being saved when creating default configuration
  • Added additional debug information for testing and verifying operation.
  • Fixed messages not showing correct reward amount when using rate-based calculations.

• v1.1.2, 03/11/12
  • Tested and validated against CraftBukkit beta Build 1.2.3-R0.2 (#2060)
  • Added reward prefix and suffix properties to set currency names or symbols.
  • Rewards can now be a fixed amount or a percentage of player's balance.

• v1.1.1, 01/30/12
  • Added basic chat color support

• v1.1, 01/29/12
  • Added broadcast message option to send a configurable message to all online players.

• v1.0, 12/06/11
  • Initial release.

Installation

1. If not already installed, download and install Vault & Votifier
2. Download VaultListener.class
3. Place VaultListener.class into Votifier's listener folder (e.g. plugins/Votifier/listeners).

Configuration

See VaultListener Configuration

Source Code

GitHub

Other Projects

JCDiver | VaultListener