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.
@Captain-Dingo
Thanks!
Fractions are implemented as virtual money that gets associated with your account. At some point I will also allow them to be represented as a different item type.
In general, yes, such transactions will fail properly. However some plugins, such as factions, don't check the return values from Vault properly, causing money to get lost when depositing to a full account.
Just gave it a test run. Gringotts is awesome, thanks. Just what I was looking for, something insanely simple that makes money physical. Can confirm that the latest version still works under 1.4.5.
Edit: I do have a question. How do fractions work (since you can't have a fraction of an emerald)?
And a second question. Will transactions properly fail if I (somehow) had no space left on my person or in the vault to add an emerald?
Could you please make Super Region vaults using HeroStronghold? And maybe a vault for people with a given permission?
@ebenwert I would really appreciate that! I can normally troubleshoot plugins by myself but this time I'm stuck because I haven't used either Towny of Gringotts before. I'm PM'ing you the IP. Thanks. :)
@LEOcab
Not sure what the problem could be. Can you try if it works when creating a vault? Did you change any of the permissions? If you'd like, message me the server details so I can have a look, please.
@ebenwert Thanks for the quick response! I updated Vault to the latest version (the one for 1.4, I was using the old 1.2.5 version) and it fixed the Towny issue. However, money is still not deducted from my inventory even though the town does get created. I don't have any vaults. I checked the console and there are no errors. What could be the problem? :/
EDIT: same thing happens with /town deposit. I can just keep depositing amounts up to the amount of coins I have in my inventory, and the coins stay there.
@LEOcab
Thanks for the report. Could you please check if you have a current version of Vault installed?
I don't understand how the plugin works. I'm running a Tekkit 3.1.3 server with the latest Towny and Gringotts 1.3.0. No errors on startup. I'm using IC2 industrial credits as currency. When I have the coins in my inventory and do /moneyadmin b leocab it shows the right amount, but I can't use it with Towny. I do /town new MyTown and it says I don't have sufficient funds, but I do. I have 300 coins on me and towns cost $250. Am I missing a step or something? Is there an exchange rate I'm not aware of? Thanks in advance!
This is my Gringotts config: http://pastebin.com/cr7UCqdf and my Towny config: http://pastebin.com/Wb6HMrZa
Also could you add My Server to your list of servers using Gringotts
Craft of War play.craftofwar.org - Hadrcore / PvP
XD Your right I didnt. What was I smoking. Thanks man
@Malik807
Did you remember to put the derby jar into the lib folder in your craftbukkit folder? (see installation instructions) :)
Plugin no work for me on server :(
18.11 20:24:06 [Server] INFO at com.earth2me.essentials.Essentials.onCommandEssentials(Essentials.java:314) 18.11 20:24:06 [Server] INFO at org.bukkit.command.PluginCommand.execute(PluginCommand.java:46) 18.11 20:24:06 [Server] INFO org.bukkit.command.CommandException: Unhandled exception executing command 'balance' in plugin Gringotts v1.3.1 18.11 20:24:06 [Server] SEVERE Unhandled exception executing command 'balance' in plugin Gringotts v1.3.1 18.11 20:24:04 [Server] INFO list 18.11 20:24:03 [Server] INFO Connection reset
This is error message
@Dilski
Yes, any plugin that uses Vault for economy-integration should work with Gringotts.
So will this work with things like chestshops and precious stones?
@Sadragos
Since 1.3.1 there already is the command /moneyadmin c <player> to check a player's capacity, but it needs the gringotts.admin permission. I could add an equivalent player command.
However, with multiple denominations, which I am currently working on, the capacity can't be clearly defined as a single number, because of how values can be partioned into items of different types, so I'm slightly hesitant to add a player command for this.
Could you add commands (and possible permissions) to allow players to see their own capacy or/and other players balance/capacity? Would be very usefull if you want to help somebody out to check if he can even handle that amount you want to pay...
@gosferano
That's not possible. One chest belongs to only one account.
Can multiple players share one vault chest, if I don't have factions or towny?
@n00bsaus
It's what the plugin uses as a database. Other plugins either use there own databases or something similar. We are considering converting to use the bukkit api's internal database.
For now, just make sure you put the derby library in your /lib directory and all will work :)
Oh, hey, yes.... Derby..... I should probably use that before I post a comment about it not working.
What is Derby and why do no other plugins need it?