VaultListener
JCVaultListener
JCVaultListener is a plugin that works in conjunction with Votifier 1.8, or better, to receive voting events allowing you to reward players with currency when they vote for your server. JCVaultListener uses Vault to interface with many popular econony plugins.
Features
- Multi-economy support - iConomy 4,5,6, BOSEconomy 6 & 7, EssentialsEcon, 3Co, MultiCurrency, eWallet, EconXP, CurrencyCore, CraftConomy, AEco, and more (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.
- Custom reward amounts/types for different voting services (+).
- Two reward types:
- fixed - every player receives a fixed amount
- rate - reward is a percentage of a player's balance or a fixed amount, whichever is larger.
- Reward amount can be adorned with a prefix and/or suffix to set currency names and/or symbols.
- Optional player verification to ignore votes from players not known to your server. (+)
- Configurable messages for confirming vote and payment to player.
- Configurable broadcast message sent to online players.
- Colorized multi-line messages.
(+) New feature.
Test Validation & Verification
JCVaultListener has been extensively tested against the following components:
Problems?
If you run into problems with JCVaultListener, we'd like to hear from you. However, we expect that you do some research first. Make sure to check out the Troubleshooting JCVaultListener 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
- v2.0.3 05/10/13
- Tested under CB 1.5.2-R0.1 Beta (b2771)
- 04/21/13
- Tested under CB 1.5.1-R0.2 Beta (b2754)
- v2.0.3 03/22/13
- Tested under CB 1.5.1-R0.1 Dev (b2723)
- v2.0.3 01/10/13
- Tested under CB 1.4.6-R0.3 Beta (b2586)
- v2.0.3 11/18/12
- Tested under CB 1.4.5-R0.1 Beta (b2483)
- v2.0.3 10/15/12
- Fixed what was supposed to be a simple fix. Custom messages, colors, and rewards should be functioning as expected.
- v2.0.2 09/21/12
- Minor bug fix. Periods in SERVICE_NAME were treated as configuration path separators. Path separator changed to '/'. Thank you to ModernDragoness for reporting the issue.
- v2.0.1 07/08/12
- Removed build artifacts that were causing McMyAdmin some grief.
- v2.0 06/11/12
- Converted to plugin supporting Votifier's
VotifierEvent
- Added support for custom reward configuration per voting service.
- Added optional player verification for ignoring votes from player unknown to a server.
- Eliminates potential concurrency issues with certain economy plugins
- Better error handling and diagnostics.
- Converted to plugin supporting Votifier's
- 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
See JCVaultListener Installation
Configuration
See JCVaultListener Configuration
@frelling
Can you possibly add a feature to allow some voting sites to rewards players with more money than others?
Like voting on minestatus gives 500 where voting on MCSL gives 250?
@rockxz3
Votifier plugin problem, please see their site.
It does not generate a config file but when I vote I get this error:
@lubblig
VaultListener can only work if Votifier is receiving votes. If VaultListener isn't doing anything, its because Votifier didn't get anything. When Minestatus reports a successful connection, it only means that it connected to something, not necessarily your plugin. The Minestatus test is fairly dumb and reports success as long as something accepted the encrypted vote record. This is a common problem in hosted environments where multiple servers are using the same ports for the same or other purposes. I strongly urge you to check with your hosting provider.
In short, from the information that you have provided, this is a Votifier configuration issue. However, for your benefit (and hopefully preventing future false alarms) I've described A Simple Test in the troubleshooting section.
I have looked at the troubleshooting page but couldn't find anything fixing my problem. My problem is simply that nothing happends. I have the latest RB of minecraft 1.2.5 and the correct version of both votifier and vault and the latest version of this plugin. I have loaded the plugin and such so I got the .properties file and I've edited it to my likings but when someone votes it doesn't broadcast it(even though it's enabled) and it doesn't give any money to anyone.(I have the latest version of iConomy). The port is only used by this plugin and is opened so that shouldn't be any problems. I've also made the test on minestatus where you can check if it works and it says that is does but I don't get any money and nothing is being broadcasted. What is wrong?
@Shvesley
RustyDagger nailed it on the head. The {ECONOMY} message token is replaced with the name of the economy plugin that Vault found and will use to make payments.
@Shvesley
No its just a global keyword that is used what ever system you are using will display there.
Would you change {ECONOMY} to something else in the .properties file if you use iConomy6?
@frelling
Is it possible to give not just economy money to players when they vote but also items?
If not, this might be a great feature to add :)
@pocketkings719
Although you can add newline characters (e.g. \n or \r) to any message, they are ignored by the client.
Is it possible to add a newline in the broadcast messages?
@GuildMasterLelo
See ticket reply.
@frelling
Thanks for taking your time to reply. I don't fully understand the meaning of "I suspect you have more than one version of Votifier installed and they are all trying to bind to the same port" But i have completely reinstalled the plugin with its listeners and this issue still exist. I'm asking for you to please let me know how its possible to get rid of the existence of the other versions.
@LordKainzo
Hum, good point and you have my sincerest apologies that this highly annoys you. :D Not that stating such added any material value to your question.
But you are right, I shouldn't have " USD" as a default, but instead leave it blank unless configured. I'll put that in the next release. Thanks for pointing it out.
In the interim, you can do one of two things: 1) configure an empty space as the suffix as follows:
where <space> is an actual space character. That is, if you don't mind an extra space after the amount.
Or, 2) configure the suffix as a text color, say
which wouldn't appear as an extra space and just color any following text in white (or whatever text color annotation is used) unless that text itself is configured with another color annotation.
BTW, this would have been better placed as an Enhancement request in the Ticket section; or, given your state of mind, a Defect report :D
@GuildMasterLelo
1. This should have been submitted as a Trouble Ticket.
2. I mean this with the best intentions; if you are going to include log information. wrap it in some [ code text] ...log stuff here...[ /code] tags AND don't cut off the most important log entry (i.e. the last [SEVERE]'s stack trace). All I'm asking you is to help me help you.
From what I can see, VaultListener initialized properly
likewise so did your FlatFileListener
and Votifier itself
Look at the last entry
The operative word here is "receiver", not "listener". Without knowing more, I suspect you have more than one version of Votifier installed and they are all trying to bind to the same port. That's all the feedback that I can provide at this time without some additional log data.
@frelling
Turned out it was someone DDOS'ing - is there a way to remove the "USD" out of the award message? I do not use a 'global' currency and find it highly annoying.
2012-03-23 23:28:48 [INFO] [Votifier] Loading Votifier v1.6 2012-03-23 23:28:56 [INFO] [Votifier] Enabling Votifier v1.6 2012-03-23 23:28:56 [INFO] [Votifier][VaultListener 1.1.3] Using economy plugin: iConomy 6 2012-03-23 23:28:56 [INFO] Loaded vote listener: VaultListener 2012-03-23 23:28:56 [INFO] Loaded vote listener: FlatfileVoteListener 2012-03-23 23:28:56 [INFO] Votifier enabled. 2012-03-23 23:28:56 [SEVERE] Error initializing vote receiver
Please help? Server is 1.2.3, I'm on the correct IP, the port is not taken. And nothing helped from http://dev.bukkit.org/server-mods/vaultlistener/pages/troubleshooting-vault-listener/
@LordKainzo
Interesting, a Bukkit API error. Its just a simple call to Server.broadcastMessage(). Not much I can do to fix that.
From the stack trace it looks like something is tying up Permissible sets when Bukkit tries to get an immutable copy. Not knowing your plugin configuration, I might suspect that a permissions plugin is holding on to something longer than it should.
Just because I'm curious, with what CraftBukkit build did this error happen?
Seeing this error on latest - http://pastie.org/3638140
@frelling
Works thanks :)