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.
Can't say enough great things about this mod, I hope to have my server public soon for testing, this is in my core of mods for the server
@BlueFusion95
Thanks for the report! Unfortunately, I expected something like this. I would have to investigate if the DB accesses are really the cause, because it may well be that the accesses to all the vaults to count, add or remove money take longer.
Workarounds I can think of:
Seems this plugin is causing quite a bit of lag. My console is constantly spammed with "[Essentials] Lag Notice - Slow Economy Response - Request took over 33.16ms!" with differing times, sometimes nearing 70ms. Furthermore, when people rapidly buy/sell to ChestShop shops, the entire server begins lagging up.
Under my assumption, this is likely due to polling the database each time a transaction occurs. I am currently using SQLite. Maybe if data was loaded into memory then saved periodically or saved at shutdown it would help, but my knowledge of java is quite minimal at the moment so this may not be the case.
Thanks anyways!
@Morphan1
@ebenwert
Nevermind, I found a way to bypass it. I just set the permission 'gringotts.createvault.admin'
@ebenwert
Ohhh, thanks...
But now I have another problem: That permission doesn't work... I've tried everything, including editing the plugin's (and sorry if I'm not supposed to do this) plugin.yml file in the jar so the default is 'true' instead of 'op', but nothing works - even using the '*' won't give the permission.
I'm using the latest beta build, by the way, if that helps any?
@ebenwert
Thanks for the awesome plugin! We use gringotts over at play.minecustoms.com for our skyblock server, and it works fabulously!
@Morphan1
This permission already exists :)
gringotts.createvault.forothers
Hey, I just want to say this plugin is awesome. It's exactly the kind of thing I need.
One suggestion, though: Can you make a permission for creating vaults for other players? I've noticed you can do it with Ops by doing this
but I'm trying to set up a bank-like system with players as bankers, and I don't want to go around opping everyone.
@DweightSVK
Then, if the player is online, they will receive the money in their inventory or enderchest. If they are offline, the transaction will fail.
Hello, how is working economy account without chest ? When player dont have vault chest and he has for example chestshop and other player buy from him some item ?
Hi sorry to post again :p
I'm very happy for this plugin it's work well but i have too more questions for my PVP server :
1/ The plugin don't do payday money for players so i install Payday with emeralds virtual and item money every hour but only the virtual money is debit, not the physical money. I mean in PVP when a player stole the physical money (emerald) from a player, the virtual money stay too ? I don't get already the interest with PVP environment and to have emeralds item (lot of to stock) if i can't use Shop (emeralds shop) with faction. Troubles with chest and TNT.
2/Faction account also is created ? Because i don't have seen already interaction with this plugins.
Hope you can help :)
@ebenwert
Thank you all :)
@Aeden87
Yes, it works with pretty much any shop plugin that uses the Vault plugin.
Player vaults are simply special chests with a sign on them, as described above. Since I don't speak French, I can't really describe it better than the documentation does :)
Gringotts supports disabling features on a per-world basis via permissions, but accounts are shared between all worlds.
@ebenwert is there a way to contact you short of tickets? I plan on utilizing your plugin on my WWM Youtube collab server. Just curious the best way to contact you.
@Aeden87
This plugin leverages a plugin named Vault, Vault in turn handles transactions. In theory anything which hooks into vault can utilize this mod.
Hi Chest-shop work with this plugin ? I'm french and i don't understand what's mean Faction or player "vaults" can you help me ? Multiworld supported ?
Thx
@cadika_orade
Second this! This would make keeping track of and managing my servers economy a lot easier and a lot less guess work.
@cadika_orade
An interesting proposal :D I think this can and should be a separate plugin, but I'll see what I can do. What are you trying to prove, though?
Keep in mind that due to how Gringotts works, you will only ever get a lower bound for the money in your economy, since people may have any amount of items in non-vault chests.
I ADORE this plugin. It is exactly what my economic model needed. However, in the interests of since and settling a score with an old macroeconomics professor, I need another feature.
Please add a command to output a CSV file of every user's account total. I need to be able to import this data into a spreadsheet so that I can analyze the quantity of money in the economy over time. It would be nice if I could configure the plugin to generate a new file every 24 hours, also.
Please note that when my study is concluded you will be credited for having produced this all-important component to my research. At that time, I will contact you personally in regards to how you wish to be cited.
@KittyTristy
Now it's pushed. Thanks and goodnight!