Giter Site home page Giter Site logo

gringotts's Introduction

Gringotts

Gringotts is an item-based economy 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 created for the Minecraft Wars PvP/survival server.

Get Gringotts from BukkitDev

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

Usage

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 or on it 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.

For full usage documentation, please see the usage page

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. Alias /m

/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>

Withdraw an amount from chest storage into inventory.

/money deposit <amount>

Deposit an amount from inventory into chest storage.

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 messages.yml and apply any changed settings.

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.

Development

This section is intended to help out developers who wish to make changes to Gringotts themselves. If you have any changes that you would like included in the main branch, please submit a pull request.

Gringotts uses the Maven 3 build system. Build a working plugin jar with the command

mvn compile package

This shades in some dependencies (such as plugin metrics). For this reason, creating a jar package manually or from an IDE may not work correctly.

License

All code within Gringotts is licensed under the BSD 2-clause license. See license.txt for details.

gringotts's People

Contributors

jastice avatar squidicuzz avatar exec64 avatar bezeek avatar ionaru avatar noidexe avatar rmachado avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.