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.
@ebenwert
Hey there eben! Hurry up and slap on the feature to rename Gringotts!!!! I'd do it myself if I knew how to code, but i'm sure it cant be too hard. ;)
(esp rename "Gold Nugget" to "&6&lCoin
Yeah, the plugins great, but I REALLY want to be able to change the name of my coins!
@Rexacorp
You can use a third party plugin to rename items. There is an update in the pipeline to allow using renamed items to be used as currency.
Just a recap, I was able to change the code and I got it working now. Just a few things had to be changed so that made it simple.
Can I name the money? e.g. gold nugget a gold coin in the config and add a colour to the name?
@ebenwert
What all would I have to change in the code? I'm not that good at this, but a basic explanation would suffice.
Would it just be commands.java under Player Commands comment? Would I only have to change the word "money"? Or do I just change the plugin.yml commands? I'm not sure what to do here.
PS: I was able to change the plugin.yml over to "cash" as the command and it worked fine! Only problem is I'm getting payouts in a world I have Gringotts disabled in.
PPS: It didn't work actually, I didn't have time to test things out fully and it really just displays the info about the command. I do still need to know what needs changing in the code.
@roracle
Yes, your best bet is building your own version with a renamed /money command.
Is there a way to have the commands be something different? Not an alias, because I'm wanting to use this and Craftconomy (keeping things separate depending on world). The problem is that since Gringotts is disabled in one world, but loads first, it won't let me access /money when in the Craftconomy world (it denies access to /money because it sees it as a Gringotts command, not a Craftconomy one, though both use it).
I guess what I'm asking, is there a way to use /cash or something else for Gringotts? Would I have to build it myself for that?
@Zeemis
Yes, via the built-in bukkit mechanism. But that probably won't help you for your purposes, because it doesn't store the account balance there, since that is in items.
Does Gringotts support MySQL databases? I'm trying to hook my economy into my forums economy keeping them both synchronized.
@budopey
Both Gringotts and CraftConomy are registered as economy plugin via Vault, but Vault only supports one economy at a time, so they aren't compatible and can't easily be made so, sorry.
Is it possible to get Craftconomy support with this? Reason I ask is because craftconomy already uses /money command and need this to have its own alias for the master command. I want to have both a digital economy (craftconomy) and physical economy (gringotts) that work together on a Towny server that uses "Shop Keepers" on "Shop Plots". The Shop Keepers only use Emeralds so I wanted to find some way to give players more control of their physical economy such as what Grigotts offers. But I don't want it to conflict or override my economy already in place. Also I want to be able to set a value to the physical economy so it is worth so much in the digital economy. For an example, 1 emerald (physical) is worth 100 (digital) economy currency. I noticed this supports Vault already, does that mean my suggestion is already possible? The Wiki links are broken...
not 100% sure what you mean by a pull request.
@dragonfire967
This is not a feature in Gringotts. Technically it should be possible to implement, but I don't personally plan to do so. I will happily accept a pull request for this feature though :)
@ebenwert
Gotcha, thanks for the response. Here is a different question then. Is it possible, or will it be possible in a future update, to have more than one person be linked to a single vault? Say for example I want myself and a friend (my server has the marriage plugin, so lets say we are "married" in-game), to have a shared account, so we both share the same money. Can I setup a vault that has both of our names on it that can accomplish this to where if someone pays me or her, it goes into the same vault regardless? I tried this in-game and couldn't get it to work with the following syntax on the sign above the chest:
Line 1. [vault]
Line 2. {blank}
Line 3. {my name}
Line 4. {her name}
Thanks for your help! :)
Hey ebenwert,
I've been using the plugin for a long time now, thanks ! However with the latest set of updates, something seems to be happening when Towny tries to pull funds through fault and emeralds are lost along the way. I created a Ticket for you, hope it helps, I can provide more info if needed.
Roti.
@dragonfire967
Gringotts doesn't have support for these plugins built-in, but it is technically probably not very hard, just takes some time to figure out how to integrate it. If you or someone you know can do it, I'd be happy to help out, but I don't currently have the time to do it myself.
Looking over this plugin, it seems to do everything I'm wanting it to do for my server, but I have one questions. I notice it has Towny and Factions support. Would it support a plugin such as Kingdoms (the one for 1.8) or Residence / SimpleClans? This is a key requirement for my server, so as to avoid conflicts / issues.
@joannou1
Thanks
I added some more of my findings to my Github post.. Is anyone else experiencing bad lag with Towny/Vault/Gringotts?
@silentspectr
yes, you must use the mysql database that is built into bukkit/spigot. Open bukkit.yml and edit/add to bottom:
Create the user/database and be sure to assign the correct permissions if you aren't using root (which I do not suggest)