Gringotts
Gringotts: Item based currency.
Gringotts is an item-based economy (currency) plugin for the Bukkit Minecraft server platform. Unlike earlier economy plugins, all currency value and money transactions are based on actual items in Minecraft, per default emeralds. The goals are to add a greater level of immersion, a generally more Minecraft-like feeling, and in the case of a PvP environment, making the currency itself vulnerable to raiding.
Gringotts was originally created for the Minecraft Wars PvP/survival server.
Features
- Item-backed economy (configurable, default emeralds)
- multiple denominations with automatic conversion (for example, use emeralds and emerald blocks)
- Storage of currency in chests and other containers, player inventory and ender chests (configurable)
- direct account-to-account transfers commands
- optional transaction taxes
- fractional currency values (fixed decimal digits)
- Account support for Factions, Towny and WorldGuard
- Vault integration
Latest changes
To get notified of new versions, please subscribe to file updates.
v2.9
- DEPENDS ON JAVA 8. If your server is not on Java 8 yet, you should upgrade, or ask your service provider to upgrade. Java 7 isn't supported anymore by Oracle.
- Should now work both in regular as well as async context. This means there should be no more "Asynchronous entity world add" errors anymore, and Gringotts is now compatible with Towny in async mode, as well as other plugins that call economy methods asynchronously.
- The maximum virtual money allowed for an account is now equal to the lowest denomination, instead of the highest. I changed this because that behavior was causing lots of confusion.
- fixed other minor bugs
v2.8
- built for Minecraft 1.9 and Factions 2.8. May not be compatible with older Factions versions!
- unsupported versions of Factions should be handled more gracefully now.
- updated to current version of Metrics-Lite. Fixes annoying error messages.
v2.7
- Named denominations: Each denomination can now have its own name, which will be shown in /balance messages and the like. To activate this feature, use the
named-denominations
config setting. By default this will use the denomination's displayname or regular item name, but you can define a custom name as well. See configuration instructions for details. - Balance messages can now be configured to show only regular balance or also vault/inventory balances.
- Now also supports
&
prefix to color codes in messages and item displayname/lore in addition to the defaultยง
prefix. - can now also used Vault-supported item names in denomination config, not only regular Bukkit names. This can make the config a bit more intuitive. (requires Vault)
- lore config for denomination items now also allows a simple string instead of a string list.
- configuration should now always be loaded as UTF8.
- fixed an issue with
/money
commands failing on some servers.
v2.6
- adds display name and lore support for currency items. See configuration instructions on how to configure this. Note you will need a third-party plugin to rename items not created by Gringotts. Thanks to dj5566 for contributing this feature!
startingbalance
config option works again
Planned Features
See: Gringotts open enhancement issues on GitHub. You're welcome to vote on enhancements important to you, but I might not have the time to implement them.
Instructions
Wiki
Check out the Gringotts Wiki for more hints and a troubleshooting guide.
Installation and Configuration
Download Gringotts and place it in your craftbukkit/plugins folder.
Please see the Configuration and Permissions document on how to configure Gringotts.
Usage
For full information on configuration and usage in Gringotts v2.x, please see the configuration page and the usage page respectively.
Storing money in an account requires a Gringotts vault. A vault consists of a container, which can be either chest, dispenser or furnace, and a sign above declaring it as a vault. A player or faction may claim any number of vaults. Vaults are not protected from access through other players. If you would like them to be, you may use additional plugins such as LWC or WorldGuard.
Player vaults
Place a sign above a container block, with [vault]
written on the first line. If it was created correctly, the sign will display your name on the third line and you will receive a message that the vault has been created.
Faction vaults
Place a sign above a container block, with [faction vault]
written on the first line. If it was created correctly, the sign will display your faction's tag on the third line and you will receive a message that the vault has been created.
Towny vaults
- To make a vault for your town: place a sign above a container block, with
[town vault]
written on the first line. - To make a vault for your nation: place a sign above a container block, with
[nation vault]
written on the first line. If it was created correctly, the sign will display your town's or nation's tag on the third line and you will receive a message that the vault has been created.
User commands
/money
Display your account's current balance.
/money pay <amount> <player>
Pay an amount to a player. The transaction will only succeed if your account has at least the given amount plus any taxes that apply, and the receiving account has enough capacity for the amount.
/money withdraw <amount>
/money deposit <amount>
Withdraw an amount from vault storage into inventory, or deposit from inventory to a vault.
Admin commands
/moneyadmin b <account>
Get the balance of a player's account.
/moneyadmin add <amount> <account>
Add an amount of money to a player's account.
/moneyadmin rm <amount>
Remove an amount of money from a player's account.
/gringotts reload
Reload Gringotts config.yml and apply any changed settings.
Need Help?
- First, check the Wiki.
- For support requests, feature requests and bug reports, please open a ticket.
- Drop by the Gitter channel and talk to me (jastice), and I will drop by.
- When your issue is resolved, update the wiki troubleshooting page!
Also, follow me on twitter: @ebenwert
Source and Continuous Integration
Gringotts is open source. View, fork and edit on Github
CI Status: Current Development builds Automatic Release builds
CI Builds have not been review by BukkitDev staff. Install at your own risk, just like anything else from the internet.
@diannetea
Suddenly? Maybe sign bank was fixed? :)
Hooray working with sign bank!
@7Tys7
Yep, once I do get around to it, it will also work for factions :)
Hello, what would be really great for my server is what Sheepzez said, but than for factions. So that you do '/money topfactions' or something and that you get a list of the richest factions. It would make this plugin even more awesome. ;)
@Sheepzez
I'll add it to my to-do, but it probably won't be in the next version :)
If you'd like an update when I implement it, please open a ticket.
Hey, I use Gringotts on my server (play.sheepzez.com:25235, could go in that list up there ;) ), something that would be awesome is a way of finding out who is the richest on the server? Something like /money top would return a list like:
1. Bob - 5000 2. Jim - 3450 3. Kirt - 1000 etc
@ebenwert
True, but it would also mean that the items must be unprotected in order to actually be useful in transactions of most sorts... eh, perhaps, in rethinking it, it'd be easier to implement on the Lockette side anyway.
@tfkillzone
Hmm, this might be feasible, but I'm not sure how useful it would be either. If you allow locking of other chests, then players will probably just store most of their riches in those chests.
Actually, I was wondering something like the opposite of what Im_A_Creeper_Yay was wondering: whether it'd be possible to hook into Lockette and prevent Lockette locks from being placed on vault chests. I want users to be able to lock other chests for certain purposes, but just not their vaults or the town's vault, as that'd essentially defeat the purpose of Gringotts as an economy plugin :p
Understand if that'd be too tough though. The plugin concept is excellent. Having a physical currency really alters the way players think about money on the server.
Just so people know, we have been using Gringotts for a month solid, 24/7 and it is bullet proof. ebenwert deserves an award for this plugin, so go donate a few bucks to him. ;)
@rockon999
1) have you checked out the Vault convert feature? http://dev.bukkit.org/server-mods/vault/forum/40134-database-conversion/
2) if Gringotts had locks, and they were unlimited, that would circumvent any restrictions that you placed on locks, since Gringotts vaults could just be used as regular locked chests. If you don't want vault space to be a limiting factor, consider adding high-value denominations.
Dear ebenwert and Squidicc,
I love your plugin and it works great, although if I may two features it could benefit from are
1) EssentialsEco transfering (It just erases everyones balance)
2) A locking system, as without it we have to give players unlimited LWC or Lockette locks, otherwise we are putting a cap on the amount of money they can earn and have.
Thanks
-Rock :D
@ebenwert
Ticket created. I appreciate your help on this matter. Cheers!
@forsaken1111
I'd say anything from 2 weeks to 3 months :)
Best would be you open a ticket, so I don't lose track of your request.
@ebenwert
Understood. I got around the problem by making shops have infinite cash for now but I'd rather it not stay that way. No rush on this though. Do you have a time frame? weeks? months? I'll check back regularly.
@forsaken1111
Okay, I see. The upcoming Gringotts version makes custom vault types somewhat easier to add, so I'll consider it. I only have limited time to work on it though, so it may still take a while, unless you know somebody who would contribute the code.
@ebenwert
Yep, HyperConomy shops have their own balance of currency they draw from for transactions, and prices are adjusted on the fly depending on how much of an item is in stock at the moment. You designate a shop area by setting two points in a cube, so if you could make shop chests which worked like the towny vaults "[shop vault]" or something and link it to whatever shop area the chest is in, that would be great. I appreciate your help. :)
@forsaken1111
Since HyperConomy can use a vault-based eco, it should work together. Do shops in HyperConomy have their own accounts? In that case, it could be possible.
Is there any way to use this plugin with HyperConomy? Could you implement shop chests the same way you have town vaults for Towny?
@ebenwert You got a pull request (I hope, I'm not used to github yet)
I finished today, way faster than I thought. I put all Strings which are shown ingame in language.yml and left all log and thrown error messages alone, noone needs those translated and it would make it more difficult for you if you try to find an error using an edited log and edited error messages. I hope I did'nt miss anything and typed all the yml-nodes correctly. I have tested it roughtly but I coded it so that it does still work if I missspelled something so I'm not sure. I also hardcoded default-messages for the people messing up the language file.
I'm pretty sure I got it done for the next beta, I just started where over half of the strings were...
KanaYamamoto