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.
@KanaYamamoto
Great! Then probably it can be merged in time for the next beta :)
@ebenwert
I just wanted to let you know that I'm working on it. I got the base system running, just have to add all messages to the language file and the code. I should have it finished in two weaks or so, depending how long I need to lern for university. If you want to take a look, you can find it here
I enabled the Bukkitdev ticket tracker for Gringotts. Please use that for posting help requests, bug reports and feature requests from now on. Thanks!
@Sadragos
I do have a feature like that planned, but not for the next version.
He ebenwert,
I've a feature request for your great Plugin. Could you add another Line of Information to the vault signs like how much money is stored in the chest below? LIke "$153"? Could you also add an Infosign, that displays the total current amount of money? I'd love that feature for shops, so that customers can see the balance of the shopowner with ease.
Also I'd like to inform you, that my Server (trollum.de) is using your Plugin :) We're a Survival Economy Server with playerheld towns and Shops.
@Betsalel
That sounds rather odd. What server are you on, so that I could take a look myself? Gringotts does allow a small amount of virtual currency, but that should not result in item duplication. Also, Gringotts does not require any other economy plugin - it is the economy plugin. Thanks!
@KanaYamamoto
Externalizing the strings to a config is on my to do list for next version. However, it might take a bit until I get around to it. So if you'd like to take on that part yourself or just replace them in source, you're welcome to ;)
Is there a way to change the language? While I understand English, some users on my server don't and I would like to change all Strings to German. I'm willing to edit the Strings in the sourcecode if I have to but if there is a simpler way, please let me know.
KanaYamamoto
I'm not sure if anyone else has had this issue but I appear to be experiencing a glitch on my server having to do with purchasing items.
I can sell items perfectly well, no issues there. However, when I go to buy items, it doesn't start subtracting the currency item (in this case, gold nuggets, bars, and blocks) from the player's inventory until after the second consecutive transaction. It does, however, subtract their equivalent value from the player's balance.
The inventory updates if they use a chest, be it an actual [vault] or not. However, because they can purchase at least one item without the currency being deducted, they can then drop the currency items on the ground and pick them back up to add it back to their balance, resulting in item duplication.
Am I doing something wrong or is this an actual error? Are there any known fixes at this time? The current economy plugin I'm using with Gringotts is Essentials Economy; is it possible that there are compatibility issues between the two?
Also, on a slightly less related note, this one issue aside, I absolutely love the mod. Fantastic idea, very clean, and easily implemented. Two thumbs up!
Sorry, I'm wrong. I had a strange coincidence where I was raided, and had something bought from me immediately after. So, instead of money remaining where it shouldn't have, money was stolen and other money was given. It was just similar amounts, so I got a little confused.
@Willrandship
Thanks for the report! There's a bug either in Gringotts or Craftbukkit that might be causing this, and I'm trying to track it down. Was the vault in the main world, in the nether/end, or a custom world?
I have an interesting glitch. I was offline while a vault of mine was raided, but when I logged in the money balance failed to register that I had lost any money. I was able to use the withdraw command and get it all back.
The player was xraying, so he was banned and presumably there was no gained currency, but I find it odd nonetheless
@CraftThatBlock
I don't know of any. You could try using a economy plugin that stores its data in a sql database, and reference the same db from multiple servers. No idea how well that would work.
@ebenwert
Ok, is their any way to link economies?
@CraftThatBlock
No, I'm afraid that would be nontrivial to do the way Gringotts works.
Hello, if i have this on many servers, will the economy be linked?
@Grinjr
I might implement that, but I don't consider it high priority.
Is there any way to make it so that this plugin is compatible with Backpack? When I put the emeralds in my backpack it doesn't count towards my balance.
@ebenwert
Definitely one of the best mods that exist, and you seem like a great developer, hope to hear back on this soon :)
@firelook
There is no migration because there is no mysql support yet.
how to switch /migrate from "flatfile" to mysql please ?