Skip to content

USER_GUIDE.md

Latest commit

 

History

History
104 lines (69 loc) · 2.61 KB

USER_GUIDE.md

File metadata and controls

104 lines (69 loc) · 2.61 KB

User Guide

Prerequisites

  • A Spigot or Paper Minecraft server (1.13 or later)
  • Medieval Factions installed and configured

First Steps

After installing Currencies and restarting your server:

  1. Ensure you are a member of a faction in Medieval Factions.
  2. Use /currency create <name> to create a new currency for your faction.
  3. Use /currency mint <currency> <amount> to mint coins of your currency.
  4. Open your coinpurse with /coinpurse to view your current coins.

Common Scenarios

Creating a Currency

A faction leader or a player with the appropriate faction permission can create a new currency:

/currency create GoldCoin

Minting Currency

Once a currency exists, authorised faction members can mint coins. Minting costs faction power (configurable) and may require an item cost:

/currency mint GoldCoin 10

Viewing Your Balance

Check how many coins of each currency you hold:

/currency balance

Viewing Currency Information

Inspect the details of a specific currency:

/currency info <currency>

Listing Currencies

List all currencies associated with your faction:

/currency list

Renaming a Currency

Rename an existing currency (requires faction permission):

/currency rename <currency> <new-name>

Setting a Currency Description

Set or update the description of a currency (requires faction permission):

/currency set description <currency> <description>

Retiring a Currency

Permanently retire a currency so it can no longer be minted (requires faction permission):

/currency retire <currency>

Using Your Coinpurse

Open your coinpurse inventory to view and organise your coins:

/coinpurse

Permissions

Permission Default Description
currencies.coinpurse true Allows opening your coinpurse
currencies.balance true Allows viewing your balance
currencies.create true Allows creating currencies
currencies.list true Allows listing currencies
currencies.mint true Allows minting currencies
currencies.retire true Allows retiring currencies
currencies.desc true Allows setting the description of currencies
currencies.force.desc op Allows setting the description of currencies without being a member of the faction or having the faction permission
currencies.rename true Allows setting the name of currencies
currencies.force.rename op Allows setting the name of currencies without being a member of the faction or having the faction permission