# Tweetzy's Documentation

View information about all our resources.

## Welcome to Tweetzy's Documentation!

**Tweetzy** is the home of high quality Minecraft plugins. On this website you will be able to find all the information you will need about any plugin developed by Tweetzy.

### Resource Information

Check out the categories on the left to find the plugin you're looking for. Each category also has their own drop down for more detailed information.

### Suggestions

Have a suggestion for one of our plugins? We'll love to hear it, you can leave the suggestion in the #suggestions channel on our discord.

### Require Additional Help?

If you weren't able to find the information you need. Feel free to contact me on discord **discord.tweetzy.ca**


# Auction House

Auction House is a complete auction system for your server.

![](https://593513551-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MUFPaPRYe0Hg6oS4Dif%2F-MXYJR9eUJow0O5v93XJ%2F-MXYJmNuENOlQdav2Wf1%2Fah-top.png?alt=media\&token=5ac1e5aa-ac47-4866-a294-8847e673370b)

![](https://593513551-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MUFPaPRYe0Hg6oS4Dif%2F-MXYJR9eUJow0O5v93XJ%2F-MXYJmNyb8TYSSTvgqkT%2Fah-key%20features.png?alt=media\&token=9d870cab-0e6b-428f-bd1f-ca09ca681ccd)

![](https://593513551-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MUFPaPRYe0Hg6oS4Dif%2F-MXYJR9eUJow0O5v93XJ%2F-MXYJmNvKGDuclqIifIg%2Fah-feature%20bar%201.png?alt=media\&token=268968bb-7289-4576-8e60-72a0b0d3df93)

![](https://593513551-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MUFPaPRYe0Hg6oS4Dif%2F-MXYJR9eUJow0O5v93XJ%2F-MXYJmNwGrvUNp2741Ra%2Fah-feature%20bar%202.png?alt=media\&token=0981c9ee-7580-4ed5-aa91-0c54aa612bf5)

![](https://593513551-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MUFPaPRYe0Hg6oS4Dif%2F-MXYJR9eUJow0O5v93XJ%2F-MXYJmNxtvFO_rk5vD5S%2Fah-feature%20bar%203.png?alt=media\&token=9207f6fa-c57b-406f-9d6c-36bc0c1b807f)


# Commands & Permissions

A complete list of all the commands and permissions that can be used in the plugin.

| Command                                                                                                                                                               | Permission                               | Description                                                                                                                                                                                                                                            |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| /ah                                                                                                                                                                   | auctionhouse.cmd                         | Allows the user to open the auction GUI                                                                                                                                                                                                                |
| /ah sell \<basePrice> \[bidStart] \[bidIncr] \[-b, -p, -t, -server]                                                                                                   | auctionhouse.cmd.sell                    | Allows the user to sell an item in the auction house. (-p allows a non bid item with more a qty > 1 to be partially purchased.). Using -server requires (auctionhouse.admin) and doing so creates a listing that is not returned or sold by the lister |
| /ah active                                                                                                                                                            | auctionhouse.cmd.active                  | Allows the user to open their active auction GUI through the command.                                                                                                                                                                                  |
| /ah expired                                                                                                                                                           | auctionhouse.cmd.expired                 | Allows the user to open their expired auctions GUI through the command.                                                                                                                                                                                |
| /ah confirm                                                                                                                                                           | auctionhouse.cmd.confirm                 | Allows user to confirm certain actions                                                                                                                                                                                                                 |
| /ah transactions                                                                                                                                                      | auctionhouse.cmd.transactions            | Allows the user to open the transactions menu through the command                                                                                                                                                                                      |
| /ah payments                                                                                                                                                          | auctionhouse.cmd.payments                | Allows the user to open the payment collection menu                                                                                                                                                                                                    |
| /ah cart                                                                                                                                                              | auctionhouse.cmd.cart                    | Allows the user to acces /ah cart                                                                                                                                                                                                                      |
| /ah watchlist                                                                                                                                                         | auctionhouse.cmd.watchlist               | Allows the user to open the watch list                                                                                                                                                                                                                 |
| /ah search \<keywords>                                                                                                                                                | auctionhouse.cmd.search                  | Allows the user to search the auction house for an item.                                                                                                                                                                                               |
| /ah ban \[player] \[time] \[reason]                                                                                                                                   | auctionhouse.cmd.ban                     | Allows the user to ban another user from the auction house                                                                                                                                                                                             |
| /ah unban \<player>                                                                                                                                                   | auctionhouse.cmd.unban                   | Allows the user to unban another user from the auction house                                                                                                                                                                                           |
| /ah request \<price>                                                                                                                                                  | auctionhouse.cmd.request                 | Allows user to request a specific item on the auction house.                                                                                                                                                                                           |
| /ah settings                                                                                                                                                          | auctionhouse.cmd.settings                | Allows the user to open the in game config editor                                                                                                                                                                                                      |
| /ah convert                                                                                                                                                           | auctionhouse.cmd.convert                 | Converts from pre 2.0.0 auction house versions to the new 2.0.0 format.                                                                                                                                                                                |
| /ah reload                                                                                                                                                            | auctionhouse.cmd.reload                  | Reloads the configuration files.                                                                                                                                                                                                                       |
| /ah markchest                                                                                                                                                         | auctionhouse.cmd.markchest               | Allows user to mark/unmark a target chest.                                                                                                                                                                                                             |
| /ah upload                                                                                                                                                            | auctionhouse.cmd.upload                  | Allows the user to perform the upload command, (uploads flat file data to the database)                                                                                                                                                                |
| /ah status                                                                                                                                                            | auctionhouse.cmd.status                  | View statistic information about auction house                                                                                                                                                                                                         |
| /ah filter \[additem] \[category]                                                                                                                                     | auctionhouse.cmd.filter                  | Allows the user to add items to category whitelist filters                                                                                                                                                                                             |
| /ah pricelimit \[set \<min/max> \<price>]                                                                                                                             | auctionhouse.cmd.pricelimit              | Used to view price limit gui or to set the minimum or maximum price for a specific item.                                                                                                                                                               |
| /ah admin \<relistall \| endall \| logs \| viewexpired \| open \| clear \| clearbids> \[secondsForRelist] \[playerNameForExpired or open] \[true/false] \[true/false] | auctionhouse.cmd.admin                   | Allows the user to run admin commands (relisting all expired items / ending all active auctions)                                                                                                                                                       |
|                                                                                                                                                                       | auctionhouse.cmd.admin.logs              |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.cmd.admin.viewexpired       |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.cmd.admin.endall            |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.cmd.admin.relistall         |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.cmd.admin.clearall          |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.cmd.admin.clearbids         | /ah admin clearbids \<player> \<returnMoney (true/false)>                                                                                                                                                                                              |
|                                                                                                                                                                       | auctionhouse.cmd.admin.opensell          |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.cmd.admin.clear             | /ah admin clear \<Player> \<returnItems (true/false)> \<GiveBiddersMoneyBack (true/false)>                                                                                                                                                             |
|                                                                                                                                                                       | auctionhouse.cmd.admin.open              |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.admin.returnitem            |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.admin.claimitem             |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.admin.deleteitem            |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.admin.copyitem              |                                                                                                                                                                                                                                                        |
|                                                                                                                                                                       | auctionhouse.maxsell.\*                  | Allows the user to sell unlimited items at any given time in the auction house                                                                                                                                                                         |
|                                                                                                                                                                       | auctionhouse.maxsell.<#>                 | Replace <#> with a number 1 or higher. Limits the max listings a player can have in the auction house.                                                                                                                                                 |
|                                                                                                                                                                       | auctionhouse.admin                       | Allows the user to have admin permission in the auction house (Press Drop Key (Default is Q) to remove items)                                                                                                                                          |
|                                                                                                                                                                       | auctionhouse.time.\<configNodeName>      | Depending on the config node and time given, this will be the max auction time a player's listing will stay active.                                                                                                                                    |
|                                                                                                                                                                       | auctionhouse.inspectshulker              | Allows the user to shift-right click a shulker box inside the auction menu to view it's contents.                                                                                                                                                      |
|                                                                                                                                                                       | auctionhouse.transactions.viewall        | Allows the user to view every transaction made on the server                                                                                                                                                                                           |
|                                                                                                                                                                       | auctionhouse.auctionchestbypass          | Allows the user to bypass the auction chest mode if enabled. (Allows normal usage while auction chest mode is in use)                                                                                                                                  |
|                                                                                                                                                                       | auctionhouse.cmdflag.stack               | Allows user to use -s/-stack when using smart min price mode                                                                                                                                                                                           |
|                                                                                                                                                                       | auctionhouse.currency.\<plugin>\_\<name> | For example if you want players to be allowed to use gems from ultra economy assuming the limit by permission is enabled. The format for the permission would look like this: auctionhouse.currency.ultraeconomy\_gems                                 |


# Placeholders

A list of all available placeholders for Auction House

**Valid Time Frames**

These are used to lookup statistics between the current date and x amount of time prior.

* s (seconds)
* m (minutes)
* h (hours)
* d (days)
* w (weeks)

**Valid Statistic Options**

* createdauctions
* createdbin
* soldauctions
* soldbin
* moneyspent
* moneyearned

**Placeholder List**

**All** placeholders are prefixed with auctionhouse *and start and end with %. Example: %auctionhouse\_test%*

* active\_auctions (Gets the total listings a player currently has active)
* expired\_auctions (Gets total expired listings a player has)
* server\_active\_auctions (Gets the total listing count for the entire server)

For the following placeholders **gstat** refers to global statistics, while **pstat** refers to player statistics.

* gstat\_\<valid statistic option> (to get the lifetime total)
* gstat\_*\<valid statistic option>\_\<duration>\<valid time frame/unit>* (to get the statistic for x duration in the past until the current date).&#x20;
* pstat\_*\<valid statistic option>*\_\<player name>  (to get the lifetime total)
* pstat\_*\<valid statistic option>*\_\<player name>*\_\<duration>\<valid time frame/unit>* (to get the statistic for x duration in the past until the current date).&#x20;

Examples:&#x20;

* *%auctionhouse*\_*gstat\_createdauctions%*&#x20;
* *%auctionhouse*\_*gstat\_createdauctions\_3d%*&#x20;
* *%auctionhouse*\_p*stat\_moneyearned\_itsmekiran%*&#x20;
* *%auctionhouse*\_p*stat\_moneyearned\_itsmekiran\_1w%*


# Plugin Files

Files that are generated by the plugin.

### Config.yml

```
# Default language file
lang: en_US

auction setting:

  # The default auction time before an item expires (in seconds)
  default auction house: 3600
  pricing:

    # The max price for buy only / buy now items
    max auction price: 1000000000

    # The max price starting a bidding auction
    max auction start price: 1000000000

    # The max amount for incrementing a bid.
    max auction increment price: 1000000000

    # The min price for buy only / buy now items
    min auction price: 1

    # The min price starting a bidding auction
    min auction start price: 1

    # The min amount for incrementing a bid.
    min auction increment price: 1
  purchase:

    # Should the owner of an auction be able to purchase it?
    # This probably should be set to false...
    owner can purchase own item: true

    # Should the owner of an auction be able to bid on it?
    # This probably should be set to false...
    owner can bid on own item: false

  # Should auction pages auto refresh?
  auto refresh auction pages: true

  # Should numbers be shortened into a prefixed form?
  use short numbers: false

  # Should the remaining time be increased when a bid is placed?
  increase time on bid: true

  # How many seconds should be added to the remaining time?
  time to increase by on the bid: 20

  # How many seconds should pass before the plugin updates all the times on items?
  tick auctions every: 1

  # Should the auction gui be re-opened (not redrawn) when a user places a bid, so they get the latest items?
  refresh gui when bid: true

  # Should the gui refresh when the player changes the filter mode?
  refresh gui when filter changed: true

  # Should every transaction be recorded (everything an auction is won or an item is bought)
  record transactions: true

  # Should the entire server be alerted when a player lists an item?
  broadcast auction list: false

discord:

  # Should the discord webhook feature be enabled?
  enabled: true

  # Should a message be sent to the discord server when someone lists a new auction item
  alert on auction start: true

  # Should a message when an auction finishes?
  alert on auction finish: true

  # A list of webhook urls (channels) you want a message sent to
  webhooks:
  - https://discord.com/api/webhooks/821837927444119563/Yd3cWzVB56Tk_VuN1Lv2iGgvsbZt2YV5SDyCkVo6EjRAUqJk3nA2nSG9PH_Bl6rcFNnz
  user:

    # The name of the user who will send the message
    username: Auction House

    # The avatar image of the discord user
    avatar picture: https://cdn.kiranhart.com/spigot/auctionhouse/icon.png
  msg:

    # colour of the message bar
    use random colour: true

    # The color of the embed, it needs to be in hsb format.
    # Separate the numbers with a -
    default colour: 137-100-100

    # The title of the message when a new auction is made
    auction start title: New Auction Available

    # The title of th message when an auction finishes
    auction finish title: Auction Finished
    seller:

      name: Seller

      value: '%seller%'

      inline: true
    buyer:

      name: Buyer

      value: '%buyer%'

      inline: true
    buy now price:

      name: Buy Now Price

      value: $%buy_now_price%

      inline: true
    final price:

      name: Final Price

      value: $%final_price%

      inline: true
    is bid:

      name: Was Bid

      value: '%is_bid%'

      inline: true
    purchase type:

      name: Purchase Type

      value: '%purchase_type%'

      inline: true
    item:

      name: Item Name

      value: '%item_name%'

      inline: true
    item amount:

      name: Item Amount

      value: '%item_amount%'

      inline: true

# Materials that should be blocked (not allowed to sell)
blocked items:
- ENDER_CHEST

# Special time permissions for users.
# If they have the following permission in this format:
# auctionhouse.time.rankone
# rankone refers to the list item under auction time, they will get the time specified (in seconds)
auction time:
- rankone:30

gui:
  global items:
    back button:

      # Settings for the back button
      item: ARROW

      name: '&e<< Back'

      lore:
      - '&7Click the button to go'
      - '&7back to the previous page.'
    close button:

      # Settings for the close button
      item: BARRIER

      name: '&cClose'

      lore:
      - '&7Click to close this menu.'
    next button:

      # Settings for the next button
      item: ARROW

      name: '&eNext >>'

      lore:
      - '&7Click the button to go'
      - '&7to the next page.'
    refresh button:

      # Settings for the refresh page
      item: CHEST

      name: '&6&LRefresh Page'

      lore:
      - '&7Click to refresh the currently'
      - '&7available auction listings.'
  auction house:

    title: '&7Auction House'
    items:
      guide:

        item: BOOK

        name: '&e&lGuide'

        lore:
        - '&7This is the auction house, here you can'
        - '&7list items for sale and purchase items'
        - '&7that others have listed for sale.'
        - ''
        - '&7The auction is also a great way to make'
        - '&7money by selling farmable items other'
        - '&7players may be interested in buying.'
        - ''
        - '&7Any unsold items are sent to your collection bin.'
        - ''
        - '&7Each item is listed as a auction, so'
        - '&7players can out bid each other, or simply'
        - '&7purchase it right away with a set price.'
      transactions:

        item: PAPER

        name: '&e&lTransactions'

        lore:
        - '&7Click to view transaction history'
      how to sell:

        item: GOLD_INGOT

        name: '&e&lHow to Sell'

        lore:
        - '&7To list an item on the auction house, just hold'
        - '&7the item in your hand and type the following command.'
        - '&e/ah sell <buyNowPrice> [startPrice] [bidIncrement]'
      your auctions:

        item: DIAMOND

        name: '&e&lYour Auctions'

        lore:
        - '&7Click here to view all of the items you'
        - '&7are currently selling on the auction.'
        - ''
        - '&e&l%active_player_auctions% Item(s)'
      collection bin:

        item: ENDER_CHEST

        name: '&e&lCollection Bin'

        lore:
        - '&7Click here to view and collect all of the'
        - '&7items you have cancelled or have expired.'
        - ''
        - '&e&l%expired_player_auctions% Item(s)'
      filter:

        item: NETHER_STAR

        name: '&e&lFilter Options'

        lore:
        - '&eItem Category&f: &7%filter_category%'
        - '&eAuction Type&f: &7%filter_auction_type%'
        - ''
        - '&7Left-Click to change item category'
        - '&7Right-Click to change change auction type'
  confirm buy:

    title: '&7Are you sure?'
    'no':
      item: RED_STAINED_GLASS_PANE
      name: '&c&LCancel'
      lore:
      - '&7Click to cancel your purchase'
    'yes':
      item: LIME_STAINED_GLASS_PANE
      name: '&a&lConfirm'
      lore:
      - '&7Click to confirm your purchase'
  active auctions:

    title: '&7Active Listings'
    cancel all:

      item: ENDER_CHEST

      name: '&e&lEnd All'

      lore:
      - '&7Click here to end all of the active listings'
      - '&7that you have posted.'
  expired auctions:

    title: '&7Expired Listings'
    cancel all:

      item: ENDER_CHEST

      name: '&e&lClaim All'

      lore:
      - '&7Click here to claim all of your expired auctions'
  transactions:

    title: '&7&LTransaction History'
    items:
      toggle own:

        item: NETHER_STAR

        name: '&e&LToggle Your Transactions'

        lore:
        - '&7Click to toggle whether you see'
        - '&7only your transactions or all'
        - '&7the transactions ever made.'
      transaction:

        item: PAPER

        name: '&e%transaction_id%'

        lore:
        - '&7Seller&F: &e%seller%'
        - '&7Buyer&F: &e%buyer%'
        - '&7Date&F: &e%date%'
        - ''
        - '&7Click to view more details'
  transaction view:

    title: '&7&LViewing Transaction'
    background:

      fill: true

      item: BLACK_STAINED_GLASS_PANE
    items:
      seller:

        name: '&e%seller_name%'

        lore:
        - '&7This is the player who sold the item.'
        - '&7ID&F: &e%seller_id%'
      buyer:

        name: '&e%buyer_name%'

        lore:
        - '&7This is the player who bought the item.'
        - '&7ID&F: &e%buyer_id%'
      information:

        item: PAPER

        name: '&e%transaction_id%'

        lore:
        - '&7ID&f: &e%transaction_id%'
        - '&7Sale Type&f: &e%sale_type%'
        - '&7Date&f: &e%transaction_date%'
        - '&7Final Price&f: &e%final_price%'

auction items:

  # This the item stack lore that will be appended to
  # auction items in /ah (lore will be applied first, then these)
  auction stack:
  - '&7-------------------------'
  - '&eSeller&f: &b%seller%'
  - ''
  - '&eBuy Now: &a$%buynowprice%'
  - ''
  - '&eTime Left: &b%remaining_days%&fd &b%remaining_hours%&fh &b%remaining_minutes%&fm &b%remaining_seconds%s'

  # This the item stack lore that will be appended to
  # auction items in /ah listings (lore will be applied first, then these)
  listing stack:
  - '&7-------------------------'
  - '&eBuy Now: &a$%buynowprice%'
  - '&eTime Left: &b%remaining_days%&fd &b%remaining_hours%&fh &b%remaining_minutes%&fm &b%remaining_seconds%s'

  # This the item stack lore that will be appended to
  # auction items in /ah (lore will be applied first, then these)
  auction stack with bid:
  - '&7-------------------------'
  - '&eSeller&f: &b%seller%'
  - ''
  - '&eBuy Now: &a$%buynowprice%'
  - '&eCurrent Price: &a$%currentprice%'
  - '&eBid Increment: &a$%bidincrement%'
  - '&eHighest Bidder: &a%highestbidder%'
  - ''
  - '&eTime Left: &b%remaining_days%&fd &b%remaining_hours%&fh &b%remaining_minutes%&fm &b%remaining_seconds%s'

  # This the item stack lore that will be appended to
  # auction items in /ah listings (lore will be applied first, then these)
  listing stack with bid:
  - '&7-------------------------'
  - '&eBuy Now: &a$%buynowprice%'
  - '&eCurrent Price: &a$%currentprice%'
  - '&eBid Increment: &a$%bidincrement%'
  - '&eHighest Bidder: &a%highestbidder%'
  - '&eTime Left: &b%remaining_days%&fd &b%remaining_hours%&fh &b%remaining_minutes%&fm &b%remaining_seconds%s'
  controls:

    # This will be appended at the end of the lore
    # If the auction item is using a bid, this will show
    using bid:
    - '&7-------------------------'
    - '&eLeft-Click&f: &bBid'
    - '&eRight-Click&f: &bBuy Now'
    - '&7-------------------------'

    # This will be appended at the end of the lore
    # If the auction item is not using a bid, this will show
    not using bid:
    - '&7-------------------------'
    - '&eLeft-Click&f: &bBuy Now'
    - '&7-------------------------'

sounds:

  listed item on the auction house: ENTITY_EXPERIENCE_ORB_PICKUP

  navigated between gui pages: ENTITY_BAT_TAKEOFF

  not enough money: ENTITY_ITEM_BREAK

```


# Translations

List of available translations that can be used with the plugin.

To use a specific language translation you will need to change the default language code within your config.yml. If the translation is available, the plugin will attempt to download it, otherwise if a translation file matching the Language code format is found it will read that instead!

| Language             | Language Code |
| -------------------- | ------------- |
| English              | en\_US        |
| Brazilian Portuguese | pt\_BR        |

{% hint style="info" %}
We accept user translated files, if you would like to contribute, please contact us on Discord.
{% endhint %}

### Default Language File (en\_US.lang)

```
general:
    prefix: "&8[&eAuctionHouse&8]"
    notanumber: "&cThe entry &4%value% &cis not a valid number!"
    locked: "&cThe Auction House is currently locked!"
    notenoughmoney: "&cYou do not have enough money!"
    cantbidonown: "&cYou cannot bid on your own item!"
    cantbuyown: "&cYou cannot buy your own item!"
    blockeditem: "&cYou are not allowed to auction that item. (%item%)"
    air: "&cSorry, but you cannot sell air o.O"
    blocked: "&cSorry, you are not allowed to sell &e%item%"
    sellinglimit: "You cannot sell more items, please remove/sell current active items"

pricing:
    minbaseprice: "&cThe minimum base price must be &a$%price%"
    minstartingprice: "&cThe minimum starting bid price must be &a$%price%"
    minbidincrementprice: "&cThe minimum bid increment must be &a$%price%"
    maxbaseprice: "&cThe maximum base price is &a$%price%"
    maxstartingprice: "&cThe maximum starting bid price is &a$%price%"
    maxbidincrementprice: "&cThe maximum bid increment is &a$%price%"
    moneyremove: "&c&l- $%price%"
    moneyadd: "&a&l+ $%price%"

discord:
    player_lost: "Player Lost o.O"
    no_buyer: "No Buyer"
    not_sold: "Not Sold"
    not_bought: "Was not bought"
    sale_bid_win: "Won Bid"
    sale_immediate_buy: "Bought Immediately"
    is_bid_true: "true"
    is_bid_false: "false"

auction_filter:
    sale_types:
        biddable: "Biddable"
        non_biddable: "Not Biddable"
        both: "All"
    categories:
        all: "All"
        food: "Food"
        armor: "Armor"
        blocks: "Blocks"
        tools: "Tools"
        misc: "Misc"

auction:
    listed:
        withbid: "&eListed &fx%amount% &6%item% &e&lBuy Now&f: &a%base_price% &e&lStarting&f: &a%start_price% &e&lIncrement&f: &a%increment_price%"
        nobid: "&eListed &fx%amount% &6%item% &efor &a%base_price%"
    broadcast:
          withbid: "&e%player% listed &fx%amount% &6%item% &e&lBuy Now&f: &a%base_price% &e&lStarting&f: &a%start_price% &e&lIncrement&f: &a%increment_price%"
          nobid: "&e%player% listed &fx%amount% &6%item% &efor &a%base_price%"
    bidwon: "&eYou won the bid for&fx%amount% &6%item% &efor &a%price%"
    itemsold: "&eYou sold &6%item% &efor &a%price%"
    itemnotavailable: "&cThat item is no longer available :("
```

### Brazilian Portuguese (pt\_BR)

```
general:
  prefix: '&8[&eAuctionHouse&8]'
  notanumber: '&cOpa.. &4%value% &cnao é um numero valido!'
  locked: '&cA Casa de Leilões está atualmente bloqueada!'
  notenoughmoney: '&cVocê não tem dinheiro suficiente!'
  cantbidonown: '&cVocê não pode licitar em seu próprio item!'
  cantbuyown: '&cVocê não pode comprar seu próprio item!'
  blockeditem: '&cVocê não tem permissão para leiloar esse item. (%item%)'
  air: '&cDesculpe, mas você não pode vender ar o.O'
  blocked: '&cDesculpe, você não tem permissão para vender &e%item%'
  sellinglimit: Você não pode vender mais itens, remova/venda os itens ativos atuais
pricing:
  minbaseprice: '&cO preço base mínimo deve ser &a$%price%'
  minstartingprice: '&cO preço mínimo do lance inicial deve ser &a$%price%'
  minbidincrementprice: '&cO lance mínimo do lance deve ser&a$%price%'
  maxbaseprice: '&cO preço base máximo é &a$%price%'
  maxstartingprice: '&cO preço máximo do lance inicial é &a$%price%'
  maxbidincrementprice: '&cO aumento máximo do lance é &a$%price%'
  moneyremove: '&c&l- $%price%'
  moneyadd: '&a&l+ $%price%'
auction:
  listed:
    withbid: '&eListed &fx%amount% &6%item% &e&lCompra Agora&f: &a%base_price% &e&lStarting&f: &a%start_price% &e&lIncrement&f: &a%increment_price%'
    nobid: '&eListed &fx%amount% &6%item% &epor &a%base_price%'
  bidwon: '&eVocê venceu a licitação por &fx%amount% &6%item% &epor &a%price%'
  itemsold: '&eVocê vendeu &6%item% &epor &a%price%'
  itemnotavailable: '&cEsse item não está mais disponível :('
  broadcast:
    withbid: '&e%player% listed &fx%amount% &6%item% &e&lBuy Now&f: &a%base_price% &e&lStarting&f: &a%start_price% &e&lIncrement&f: &a%increment_price%'
    nobid: '&e%player% listed &fx%amount% &6%item% &efor &a%base_price%'
discord:
  player_lost: Player Lost o.O
  no_buyer: Sem Comprador
  not_sold: Não vendido
  not_bought: Não foi comprado
  sale_bid_win: Lance vencido
  sale_immediate_buy: Comprado imediatamente
  is_bid_true: 'Verdadeiro'
  is_bid_false: 'Falso'
auction_filter:
  sale_types:
    biddable: Biddable
    non_biddable: Not Biddable
    both: All
  categories:
    all: All
    food: Food
    armor: Armor
    blocks: Blocks
    tools: Tools
    misc: Misc
```


# Shops

Ever wanted to setup categorized shops, this plugin is for you


# Commands & Permissions

A complete list of all the commands and permissions that can be used in the plugin.

| Command                                                      | Permission             | Description                                           |
| ------------------------------------------------------------ | ---------------------- | ----------------------------------------------------- |
| /shops                                                       | shops.command          | Opens the main menu                                   |
| /shops admin                                                 | shops.command.admin    | Opens the admin menu                                  |
| /shops add item \<shopId> \<BuyPrice> \<SellPrice> \[minQty] | shops.command.add      | Allows you to add an item to a shop using the command |
| /shops cart                                                  | shops.command.cart     | Opens your cart directly                              |
| /shops delete \<shopId>                                      | shops.command.delete   | Deletes an exisitng shop and it's items               |
| /shops reload                                                | shops.command.reload   | Reloads the settings and language files               |
| /\<shop command>                                             | shops.access.\<ShopId> | See the shop command section for more information     |


# Plugin Files

Files that are generated by the plugin.

### config.yml

```yaml
# The prefix for the plugin
prefix: '&8[&eShops&8]'
# The primary language of the plugin
language: en_us
settings:
  currency:
    # When using default/vault currency, what symbol should be used. Mainly for admin guis
    vault symbol: $
    # The default currency selection, PluginName/CurrencyName -> Ex. Vault/Vault
    default selection: Vault/Vault
    format:
      # An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code.
      country: US
      # An ISO 639 alpha-2 or alpha-3 language code.
      language: en
    # A list of owning plugins & the currency to be blacklisted. Ex. UltraEconomy:Gems
    black listed:
      - UltraEconomy:Gems
    # If true, Shops will only allow the usage of another item for currency.
    use item only: false
  tax:
    # The tax percentage. By default it's 13%
    percentage: 13.0
    # If true, will apply sales tax to the total when a user is buying an item
    enabled: false
    # If true, selling items to a shop will remove tax percentage
    tax on sell: false
  # How should timestamps be formatted
  date time format: MMM dd, yyyy hh:mm:ss a
gui:
  layout control picker:
    items:
      filter:
        # 
        item: REPEATER
      exit:
        # 
        item: BARRIER
      search:
        # 
        item: DARK_OAK_SIGN
      prev page:
        # 
        item: ARROW
      cart:
        # 
        item: MINECART
      next page:
        # 
        item: ARROW
  shared buttons:
    back button:
      # 
      item: DARK_OAK_DOOR
    previous button:
      # 
      item: ARROW
    next button:
      # 
      item: ARROW
    exit button:
      # 
      item: BARRIER
  shops main:
    # If true, shops will auto fill into specified slots
    use auto fill: true
    # You can use MATERIAL:Model Number if you want here, or textures.minecraft links
    background: WHITE_STAINED_GLASS_PANE
    # Used manually specify shop slots, auto fill must be off. format -> slot:<slotNumber> shop:<shopId>
    fixed shops:
      - slot:10 shop:food
    # TBD
    decorations:
      - slot:0-8 item:BLACK_STAINED_GLASS_PANE
      - slot:45-53 item:BLACK_STAINED_GLASS_PANE
      - slot:9 item:BLACK_STAINED_GLASS_PANE
      - slot:18 item:BLACK_STAINED_GLASS_PANE
      - slot:27 item:BLACK_STAINED_GLASS_PANE
      - slot:36 item:BLACK_STAINED_GLASS_PANE
      - slot:17 item:BLACK_STAINED_GLASS_PANE
      - slot:26 item:BLACK_STAINED_GLASS_PANE
      - slot:35 item:BLACK_STAINED_GLASS_PANE
      - slot:44 item:BLACK_STAINED_GLASS_PANE
    # Number of rows for the gui, min 2 max 6
    rows: 6
    # The slots shops will be placed into if auto fill is on.
    fill slots:
      - 20
      - 21
      - 22
      - 23
      - 24
      - 30
      - 31
      - 32
  shop contents:
    items:
      filter:
        # 
        item: REPEATER
      review:
        # 
        item: DARK_OAK_SIGN
      cart:
        # 
        item: MINECART
  checkout:
    items:
      breakdown:
        # 
        item: PAPER
      increase:
        # Format: item, slot, change amount(how much the qty will increase/decrease by)
        items:
          - item:LIME_STAINED_GLASS_PANE quantity:1 slot:24 change:1
          - item:LIME_STAINED_GLASS_PANE quantity:5 slot:34 change:5
          - item:LIME_STAINED_GLASS_PANE quantity:10 slot:42 change:10
      checkout:
        # 
        item: LIME_DYE
      decrease:
        # Format: item, slot, change amount(how much the qty will increase/decrease by)
        items:
          - item:RED_STAINED_GLASS_PANE quantity:1 slot:20 change:1
          - item:RED_STAINED_GLASS_PANE quantity:5 slot:28 change:5
          - item:RED_STAINED_GLASS_PANE quantity:10 slot:38 change:10
  cart:
    items:
      clear:
        # 
        item: LAVA_BUCKET
      checkout:
        # 
        item: LIME_DYE
```

## **en\_us.yml**

```yaml
gui:
  admin main:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &7v%plugin_version%
  shared buttons:
    back button:
      lore: '&e&l%left_click% &7to go back'
      name: <GRADIENT:5CAEFF>&LGo Back</GRADIENT:9F57FF>
    previous button:
      lore: '&e&l%left_click% &7to go back a page'
      name: <GRADIENT:5CAEFF>&lPrevious Page</GRADIENT:9F57FF>
    next button:
      lore: '&e&l%left_click% &7to go to next page'
      name: <GRADIENT:5CAEFF>&lNext Page</GRADIENT:9F57FF>
    exit button:
      lore: '&e&l%left_click% &7to exit menu'
      name: <GRADIENT:5CAEFF>&LExit</GRADIENT:9F57FF>
  shops main:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF>
  shop edit:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7Edit &8> &e%shop_id%
    items:
      settings:
        lore:
          - '&7Used to adjust shop specific settings'
          - ''
          - '&e&lClick &7to open shop settings'
        name: <GRADIENT:5CAEFF>&LShop Settings</GRADIENT:9F57FF>
      create:
        lore:
          - '&7Used to add new items to this shop.'
          - ''
          - '&e&l%left_click% &7to add item/command'
          - '&b&l%right_click% &7to quick select material'
        name: <GRADIENT:5CAEFF>&LAdd Item</GRADIENT:9F57FF>
      item content:
        lore:
          - '&8&m------------------------------'
          - '&7Buying&f: %is_buy_enabled%'
          - '&7Selling&f: %is_sell_enabled%'
          - ''
          - '&7Buy Price (&fx&e1&7)&f: &a%shop_item_buy_price%'
          - '&7Sell Price (&fx&e1&7)&f: &a%shop_item_sell_price%'
          - ''
          - '&7Minimum Buy Qty&f: &e%shop_item_purchase_qty%'
          - ''
          - '&e&l%left_click% &7to edit shop item'
          - '&c&l%right_click% &7to delete item'
      delete:
        lore:
          - '&7Used to delete the shop'
          - ''
          - '&c&lClick &7to delete this shop'
        name: <GRADIENT:5CAEFF>&LDelete Shop</GRADIENT:9F57FF>
  admin shop list:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7List
    items:
      create:
        lore: '&7Click to create a new shop'
        name: <GRADIENT:5CAEFF>&LNew Shop</GRADIENT:9F57FF>
  shop edit content:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7Editing Item
    items:
      add:
        lore: '&e&lClick &7to update item.'
        name: <GRADIENT:5CAEFF>&LUpdate Item</GRADIENT:9F57FF>
  layout editor:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7Layout Editor
    items:
      filter:
        lore:
          - '&7Used to adjust the filtering'
          - '&7options for this shop'
        name: <GRADIENT:5CAEFF>&lFilter</GRADIENT:9F57FF>
      search:
        lore:
          - '&7Used to search for items'
          - '&7within this shop.'
        name: <GRADIENT:5CAEFF>&lSearch</GRADIENT:9F57FF>
      empty slot:
        lore:
          - '&7This is a free slot, you can add'
          - '&7decorations here or assign it as a '
          - '&7populated slot or even move controls.'
          - ''
          - '&e&l%left_click% &7to set as fill slot'
          - '&b&l%right_click% &7to move a control here'
          - '&d&l%right_click% &7with an item on your cursor'
          - '&7to decorate this slot.'
        name: <GRADIENT:5CAEFF>&lEmpty Slot</GRADIENT:9F57FF>
      decoration slot:
        lore:
          - '&7This is a decoration slot'
          - ''
          - '&e&l%left_click% &7to make empty slot'
          - '&d&l%right_click% &7with an item on your cursor'
          - '&7to change the decoration item.'
        name: <GRADIENT:5CAEFF>&lDecoration Slot</GRADIENT:9F57FF>
      cart:
        lore:
          - '&7Your shopping cart, may contain'
          - '&7items from other shops.'
        name: <GRADIENT:5CAEFF>&lCart</GRADIENT:9F57FF>
      fill slot:
        lore:
          - '&7This slot will be populated by'
          - '&7the contents added to the shop'
          - ''
          - '&e&l%left_click% &7to disable this slot'
        name: <GRADIENT:5CAEFF>&lFill Slot</GRADIENT:9F57FF>
  shop contents:
    items:
      filter:
        lore:
          - '&7Used to filter items in shop'
          - ''
          - '&7Current Type&F: &e%shop_filter_type%'
          - ''
          - '&e&lClick &7to change filter order.'
        name: <GRADIENT:5CAEFF>&lFilter</GRADIENT:9F57FF>
      search:
        lore:
          - '&7Used to search for items'
          - '&7within this specific shop.'
          - ''
          - '&e&lLeft Click &7to search in this shop.'
          - '&b&lRight Click &7to reset search'
        name: <GRADIENT:5CAEFF>&lSearch</GRADIENT:9F57FF>
      content:
        lore:
          sell lore: '&7Sell Price (&fx&e1&7)&f: &a%shop_item_sell_price%'
          description lore: '&e%shop_item_description%'
          base lore:
            - '&8&m------------------------------'
            - '%shop_content_desc_info%'
            - '%shop_content_purchase_qty_info%'
            - '%shop_content_buy_info%'
            - '%shop_content_sell_info%'
            - ''
            - '&e&l%left_click% &7to buy now'
            - '&b&l%right_click% &7to add to cart'
          min buy lore:
            - ''
            - '&7Minimum Purchase Qty&f: x&e%shop_item_purchase_qty%'
          buy lore: '&7Buy Price (&fx&e1&7)&f: &a%shop_item_buy_price%'
      cart:
        lore:
          - '&7Your shopping cart contains any items'
          - '&7you may have added from other shops.'
          - ''
          - '&7Total Items&F: &e%shopping_cart_item_count%'
          - ''
          - '&e&lClick &7to view your cart.'
        name: <GRADIENT:5CAEFF>&lYour Cart</GRADIENT:9F57FF>
  currency picker:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7Select Currency
    items:
      custom currency:
        lore:
          - '&7If you want to use use a specific item for'
          - '&7the currency, you can set that here.'
          - ''
          - '&b&l%right_click% &7to open a material picker &eor'
          - '&e&l%left_click% &7with the item you want to use'
          - '&7as the currency onto this icon.'
        name: <GRADIENT:5CAEFF>&LCustom Item</GRADIENT:9F57FF>
  transactions:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7Transactions
    items:
      transaction:
        lore:
          - '&8&m------------------------------'
          - '&7Transaction Type&f: &e%transaction_type%'
          - '&7Content Type&f: &e%content_type%'
          - ''
          - '&7Original Shop&f: &e%shop_name%'
          - '&7Player Name&f: &e%player_name%'
          - ''
          - '&7Quantity&F: &e%quantity%'
          - '&7Final Price&F: &e%final_price%'
          - '&7Currency&F: &e%currency%'
          - '&7Date&f: &e%transaction_date%'
          - ''
          - '&8&m------------------------------'
  cart:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7Your Cart
    items:
      clear:
        lore:
          - '&7Used to clear your cart'
          - ''
          - '&e&lClick &7to clear cart items'
        name: <GRADIENT:f12525>&LClear Cart</GRADIENT:f49918>
      checkout:
        lore:
          - '&e&l%left_click% &7to buy items'
          - '&b&l%right_click% &7to sell items'
        name: <GRADIENT:5CAEFF>&LConfirm Checkout</GRADIENT:9F57FF>
      content:
        lore:
          sell lore: '&7Sell Price (&fx&e1&7)&f: &a%shop_item_sell_price%'
          selected qty lore:
            - ''
            - '&7Selected Qty&f: x&e%shop_item_purchase_qty%'
          buy total lore: '&7Buy &fx&e%shop_item_purchase_qty%&f: &a%shop_item_buy_price_total%'
          base lore:
            - '&8&m------------------------------'
            - '%shop_content_desc_info%'
            - '%shop_content_purchase_qty_info%'
            - '%shop_content_buy_info%'
            - '%shop_content_sell_info%'
            - ''
            - '%shop_content_buy_info_total%'
            - '%shop_content_sell_info_total%'
            - ''
            - '&e&l%left_click% &7to quick buy item'
            - '&c&l%right_click% &7to remove from cart'
          description lore: '&e%shop_item_description%'
          sell total lore: '&7Sell &fx&e%shop_item_purchase_qty%&f: &a%shop_item_sell_price_total%'
          buy lore: '&7Buy Price (&fx&e1&7)&f: &a%shop_item_buy_price%'
  shop settings:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7Settings &8> &e%shop_id%
    items:
      deco:
        lore:
          - '&7How the shop content will be positioned,'
          - '&7and any extra decoration items in the gui'
          - ''
          - '&e&lClick &7to edit the layout/decoration'
        name: <GRADIENT:5CAEFF>&lShop Deco/Layout</GRADIENT:9F57FF>
      display name:
        lore:
          - '&7The display name of the shop'
          - ''
          - '&7Current&F: %shop_display_name%'
          - ''
          - '&e&lClick &7to edit display name'
        name: <GRADIENT:5CAEFF>&lDisplay Name</GRADIENT:9F57FF>
      icon:
        lore:
          - '&7The display icon that is shown in /shops'
          - ''
          - '&e&lClick &7to edit the display icon'
        name: <GRADIENT:5CAEFF>&lShop Icon</GRADIENT:9F57FF>
      description:
        lore:
          - '&7The description of the shop'
          - ''
          - '&7Current&F:'
          - '%shop_description%'
          - ''
          - '&e&lClick &7to edit description'
        name: <GRADIENT:5CAEFF>&lShop Description</GRADIENT:9F57FF>
      permission:
        lore:
          - '&7The permission required to access the'
          - '&7shop in /shops or through commands'
          - ''
          - '&7Shop Permission&f: %shop_permission%'
          - '&7Enabled&f: %is_true%'
          - ''
          - '&e&l%left_click% &7to change shop permission'
          - '&b&l%right_click% &7to toggle on/off'
        name: <GRADIENT:5CAEFF>&lShop Permission</GRADIENT:9F57FF>
      open:
        lore:
          - '&7Opens & Closes the shop, if closed then it will'
          - '&7not appear within /shops or be accessible through commands.'
          - ''
          - '&7Shop Opened&f: %is_true%'
          - ''
          - '&e&lClick &7to toggle open status'
        name: <GRADIENT:5CAEFF>&lOpen/Close Shop</GRADIENT:9F57FF>
      command:
        lore:
          - '&7The custom command that can be used'
          - '&7to access the shop without going through /shops'
          - ''
          - '&7Shop Command&f: %shop_command%'
          - '&7Enabled&f: %is_true%'
          - ''
          - '&e&l%left_click% &7to change shop command'
          - '&b&l%right_click% &7to toggle on/off'
        name: <GRADIENT:5CAEFF>&lShop Command</GRADIENT:9F57FF>
  layout control picker:
    title: '&EShops &f- &7Select Layout Control'
    items:
      filter:
        lore:
          - '&7Used to filter the shop items'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:5CAEFF>&lFilter Button</GRADIENT:9F57FF>
      exit:
        lore:
          - '&7Used to exit shop menu'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:5CAEFF>&lExit Button</GRADIENT:9F57FF>
      search:
        lore:
          - '&7Used to search for items in the shop'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:5CAEFF>&lSearch Button</GRADIENT:9F57FF>
      prev page:
        lore:
          - '&7Used to navigate back if theres multiple pages'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:5CAEFF>&lBack Button</GRADIENT:9F57FF>
      cart:
        lore:
          - '&7Used to view items added to your cart'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:5CAEFF>&LCart Button</GRADIENT:9F57FF>
      next page:
        lore:
          - '&7Used to navigate forward if theres multiple pages'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:5CAEFF>&lNext Button</GRADIENT:9F57FF>
  shop select content type:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7Select Content Type
    items:
      item:
        lore:
          - '&7An item content is pretty much just'
          - '&7a normal item you want to sell to players.'
          - ''
          - '&e&lClick &7to select this content type.'
        name: <GRADIENT:5CAEFF>&lItem Content</GRADIENT:9F57FF>
      cmd:
        lore:
          - '&7A command content is essentially a command '
          - '&7that gets executed when the player buys it.'
          - ''
          - '&e&lClick &7to select this content type.'
        name: <GRADIENT:5CAEFF>&lCommand Content</GRADIENT:9F57FF>
  shop add content:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7New Item
    items:
      add:
        lore: '&e&lClick &7to add to shop.'
        name: <GRADIENT:5CAEFF>&lAdd Item</GRADIENT:9F57FF>
      toggle buy:
        lore:
          - '&7Used to toggle whether this item can be'
          - '&7purchased within this shop or not.'
          - ''
          - '&7Purchase Allowed&f: %is_true%'
          - ''
          - '&e&lClick &7to toggle on or off'
        name: <GRADIENT:5CAEFF>&lAllow Purchase</GRADIENT:9F57FF>
      command icon:
        lore:
          - '&8&m------------------------------'
          - '&7Buy Price (&fx&e1&7)&f: &a%shop_item_buy_price%'
          - ''
          - '&7Minimum Buy Qty&f: &e%shop_item_purchase_qty%'
          - '&7Command&f: &7/&e%shop_item_command%'
          - ''
          - '&7This item will cost the player a total of &a%shop_item_purchase_total%'
          - '&7to purchase in this shop before tax & discounts.'
          - ''
          - '&8&m------------------------------'
          - '&e&l%left_click% &7to open material picker'
          - '&b&l%right_click% &7to use item on cursor'
      sell price:
        lore:
          - '&7The sell price for &fx&e1 &7of this item.'
          - ''
          - '&7Current Price&f: &e%shop_item_sell_price%'
          - ''
          - '&e&lClick &7to adjust sell price.'
        name: <GRADIENT:5CAEFF>&lSell Price</GRADIENT:9F57FF>
      toggle sell:
        lore:
          - '&7Used to toggle whether this item can be'
          - '&7sold within this shop or not.'
          - ''
          - '&7Sell Allowed&f: %is_true%'
          - ''
          - '&e&lClick &7to toggle on or off'
        name: <GRADIENT:5CAEFF>&lAllow Sell</GRADIENT:9F57FF>
      buy price:
        lore:
          - '&7The purchase price for &fx&e1 &7of this item.'
          - ''
          - '&7Current Price&f: &e%shop_item_buy_price%'
          - ''
          - '&e&lClick &7to adjust purchase price.'
        name: <GRADIENT:5CAEFF>&lPurchase Price</GRADIENT:9F57FF>
      icon:
        lore:
          - '&8&m------------------------------'
          - '&7Buying&f: %is_buy_enabled%'
          - '&7Selling&f: %is_sell_enabled%'
          - ''
          - '&7Buy Price (&fx&e1&7)&f: &a%shop_item_buy_price%'
          - '&7Sell Price (&fx&e1&7)&f: &a%shop_item_sell_price%'
          - ''
          - '&7Minimum Buy Qty&f: &e%shop_item_purchase_qty%'
          - ''
          - '&7This item will cost the player a total of &a%shop_item_purchase_total%'
          - '&7to purchase in this shop before tax & discounts.'
          - ''
          - '&8&m------------------------------'
          - '&e&l%left_click% &7to open material picker'
          - '&b&l%right_click% &7to use item on cursor'
      currency:
        lore:
          - '&7Used to adjust which currency'
          - '&7will be used to buy/sell this item'
          - ''
          - '&7Current&f: &e%currency%'
          - ''
          - '&e&lClick &7to edit currency'
        name: <GRADIENT:5CAEFF>&lSwitch Currency</GRADIENT:9F57FF>
      purchase qty:
        lore:
          - '&7The minimum amount of this item'
          - '&7that a player must purchase.'
          - ''
          - '&7Purchase Qty&f: &e%shop_item_purchase_qty%'
          - ''
          - '&e&lClick &7to adjust purchase quantity'
        name: <GRADIENT:5CAEFF>&lPurchase Quantity</GRADIENT:9F57FF>
      command desc:
        lore:
          - '&7The description that will be used'
          - '&7when showing this command in the shop.'
          - ''
          - '&7Description&f:'
          - '%shop_item_command_desc%'
          - ''
          - '&e&lClick &7to change the description'
        name: <GRADIENT:5CAEFF>&lDescription</GRADIENT:9F57FF>
      command:
        lore:
          - '&7The command that will be executed'
          - '&7when a player purchases this item'
          - ''
          - '&7Command&f: &7/&e%shop_item_command%'
          - ''
          - '&e&lClick &7to change the command'
        name: <GRADIENT:5CAEFF>&lCommand</GRADIENT:9F57FF>
      command name:
        lore:
          - '&7The display name that will be used'
          - '&7when showing this command in the shop.'
          - ''
          - '&7Name&f: %shop_item_command_name%'
          - ''
          - '&e&lClick &7to change the name'
        name: <GRADIENT:5CAEFF>&lName</GRADIENT:9F57FF>
  checkout:
    title: <GRADIENT:5CAEFF>&lShops</GRADIENT:9F57FF> &8> &7Checkout
    items:
      decrement:
        lore: '&e&lClick &7to decrement qty'
        name: '&c&l-%decrement_value%'
      breakdown:
        no tax lore: '&cNo tax is currently applied.'
        lore:
          - '&8&m------------------------------'
          - '&7Selected Quantity&F: &e%checkout_item_qty%'
          - ''
          - '&A&LPurchase'
          - '&7Subtotal&F: &a%checkout_item_buy_subtotal%'
          - ''
          - '&7&e&lTaxes'
          - '%checkout_tax_info%'
          - ''
          - '&A&LPurchase (Total)'
          - '&7Total&F: &a%checkout_item_buy_total%'
          - ''
          - '&8&m------------------------------'
        name: <GRADIENT:5CAEFF>&LPricing Breakdown</GRADIENT:9F57FF>
        has tax lore: '&eServer Tax Rate &F(&7%tax_rate%&a%&f)'
      increment:
        lore: '&e&lClick &7to increment qty'
        name: '&a&l+%increment_value%'
      checkout:
        lore:
          - '&e&l%left_click% &7to buy now'
          - '&b&l%right_click% &7to add to cart'
        name: <GRADIENT:5CAEFF>&LConfirm Purchase</GRADIENT:9F57FF>
      content:
        lore:
          selected qty lore:
            - ''
            - '&7Selected Qty&f: x&e%shop_item_purchase_qty%'
          sell lore: '&7Sell Price (&fx&e1&7)&f: &a%shop_item_sell_price%'
          buy total lore: '&7Buy &fx&e%shop_item_purchase_qty%&f: &a%shop_item_buy_price_total%'
          description lore: '&e%shop_item_description%'
          base lore:
            - '&8&m------------------------------'
            - '%shop_content_desc_info%'
            - '%shop_content_purchase_qty_info%'
            - '%shop_content_buy_info%'
            - '%shop_content_sell_info%'
            - ''
            - '%shop_content_buy_info_total%'
            - '%shop_content_sell_info_total%'
          sell total lore: '&7Sell &fx&e%shop_item_purchase_qty%&f: &a%shop_item_sell_price_total%'
          buy lore: '&7Buy Price (&fx&e1&7)&f: &a%shop_item_buy_price%'
prompts:
  server shop item min qty:
    subtitle: '&fEnter the minimum purchase amount.'
    title: <GRADIENT:5CAEFF>&lEnter Minimum Qty</GRADIENT:9F57FF>
  server shop item buy price:
    subtitle: '&fEnter the price for &ex&f1 of this item.'
    title: <GRADIENT:5CAEFF>&lEnter Buy Price</GRADIENT:9F57FF>
  server shop item command:
    subtitle: '&fEnter the command for this item in chat.'
    title: <GRADIENT:5CAEFF>&lEnter Command</GRADIENT:9F57FF>
  server shop item sell price:
    subtitle: '&fEnter the price for &ex&f1 of this item.'
    title: <GRADIENT:5CAEFF>&lEnter Sell Price</GRADIENT:9F57FF>
  search:
    subtitle: '&fEnter search keywords into chat'
    title: <GRADIENT:5CAEFF>&lSearch</GRADIENT:9F57FF>
  server shop item command name:
    subtitle: '&fEnter display name for command'
    title: <GRADIENT:5CAEFF>&LCommand Name</GRADIENT:9F57FF>
  server shop description:
    subtitle: '&fEnter the new description in chat.'
    title: <GRADIENT:5CAEFF>&lShop Description</GRADIENT:9F57FF>
  server shop command:
    subtitle: '&fEnter the new command in chat.'
    title: <GRADIENT:5CAEFF>&lShop Command</GRADIENT:9F57FF>
  server shop display name:
    subtitle: '&fEnter the new display name in chat.'
    title: <GRADIENT:5CAEFF>&lShop Name</GRADIENT:9F57FF>
  server shop item command desc:
    subtitle: '&fEnter description for command'
    title: <GRADIENT:5CAEFF>&LCommand Description</GRADIENT:9F57FF>
  server shop id:
    subtitle: '&fEnter id for new shop in chat.'
    title: <GRADIENT:5CAEFF>&lShop Id</GRADIENT:9F57FF>
  server shop permission:
    subtitle: '&fEnter the new permission in chat.'
    title: <GRADIENT:5CAEFF>&lShop Permission</GRADIENT:9F57FF>
info:
  shop:
    add:
      item: '&aSuccessfully added &e%item_name% &ato &b%shop_id%'
    deleted: '&aSuccessfully deleted that shop!'
    closed: '&cThat shop is currently closed!'
  money:
    add: '&f&l+ &a&l%currency%'
    remove: '&f&l- &c&l%currency%'
error:
  no permission: '&cYou do not have enough permission!'
  shop not found: '&cCould not find any shops with that id!'
  shop:
    delete: '&cError, could not delete that shop!'
  player offline: '&4%value% &cis not online currently!'
  one fill slot required: '&cThis layout requires at least one fill slot!'
  not enough money: '&cYou do not have enough money!'
  number cannot be zero: '&cPlease enter a number greater than 0'
  player not found: '&4%value% &cwas not found!'
  checkout is not min qty: '&cYou must buy at least &fx&e%shop_item_purchase_qty%
    &cof this item!'
  not a number: '&4%value% &cis not a valid number!'
  item cannot be air: '&cYou cannot add air to the shop.'
  shop id taken: '&cA shop with that id already exists!'
  no shop permission: '&cYou are not allowed to use that shop'
button:
  number key: 'Press # Key'
  left click: Left Click
  right click: Right Click
  left shift click: Shift+Left Click
  middle click: Middle Click
  drop key: Press Drop Key
conditionals:
  'true': '&aTrue'
  'false': '&CFalse'
  closed: '&cClosed'
  disabled: '&cDisabled'
  open: '&aOpen'
  enabled: '&aEnabled'

```


# Shop Commands

A quick explanation for shop specific commands

* Inside the shop settings menu, you are able to specify a specific command for the shop. Meaning if enabled, players can use the command directly without the /shops bit. Example: /food instead of /shops food

<figure><img src="https://593513551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MUFPaPRYe0Hg6oS4Dif%2Fuploads%2FFzRZkkJ7x15lfJ3l1Fga%2FScreenshot_3.png?alt=media&amp;token=387d65e1-68df-4026-9297-a3e1eebaedb8" alt=""><figcaption></figcaption></figure>

* Shops can also require a special permission to access them, it's disabled by default

<figure><img src="https://593513551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MUFPaPRYe0Hg6oS4Dif%2Fuploads%2FYnA5Ajmze4OmqhGxTyde%2FScreenshot_5.png?alt=media&amp;token=c63abb55-d305-4ae2-a2c1-76cf87710453" alt=""><figcaption></figcaption></figure>


# Markets

Markets takes an entirely new approach to traditional player shops.

![](https://593513551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MUFPaPRYe0Hg6oS4Dif%2Fuploads%2FBURwy9buq7seqWVqBELV%2FMarkets.png?alt=media\&token=35696ace-3ff2-4682-b303-608d50d4196b)

![](https://593513551-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MUFPaPRYe0Hg6oS4Dif%2F-M_EPZOxpJCgHqqeamBr%2F-M_EPkOKgH3j9MCnGOKi%2Fkey%20features.png?alt=media\&token=fc6d3703-c84d-49b8-aa11-d3a854795e4b)

![](https://593513551-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MUFPaPRYe0Hg6oS4Dif%2F-M_EPZOxpJCgHqqeamBr%2F-M_EPkOGCsbNgAg2KG1R%2Ffeature%20bar%201.png?alt=media\&token=198752e3-b0e6-4e43-9222-b46c8defbb17)

![](https://593513551-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MUFPaPRYe0Hg6oS4Dif%2F-M_EPZOxpJCgHqqeamBr%2F-M_EPkOIo7bT_3QiiXAE%2Ffeature%20bar%202.png?alt=media\&token=c858e991-2112-4a57-946b-292ea880057f)


# Commands & Permissions

A complete list of all the commands and permissions that can be used in the plugin.

| Command                                                               | Permission                     | Description                                                                          |
| --------------------------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------ |
| /markets                                                              | None                           | Open the market main menu                                                            |
| /markets bank                                                         | markets.command.bank           | Opens your bank                                                                      |
| /markets offers                                                       | markets.command.offers         | Opens your offers                                                                    |
| /markets payments                                                     | markets.command.payments       | Opens your payment collections                                                       |
| /markets search \<keywords>                                           | markets.command.search         | Used to search all open markets                                                      |
| /markets view \<player>                                               | markets.command.view           | Used to view a player's market                                                       |
| /markets add \<category> \<price> \[-nooffers, -wholesale, -infinite] | markets.command.add            | Allows users to add items to a category                                              |
| /markets transactions                                                 | markets.command.transactions   | Allows player to view sales that occurred while they were offline                    |
| /markets admin \<player> openmain                                     | markets.command.admin          | Allows console/player to force open main menu for another user                       |
| /markets delete \<player>                                             | markets.command.delete         | Allows user to delete another player's market                                        |
| /markets reload                                                       | markets.command.reload         | Reloads the plugin files                                                             |
|                                                                       | markets.maxalloweditems.#      | The maximum number of items a player can have in their market # being the total      |
|                                                                       | markets.maxallowedcategories.# | The maximum number of categories a player can have in their market # being the total |
|                                                                       | markets.maxallowedrequests.#   | The maximum number of requests that a player can have active, # being the total      |
|                                                                       | markets.admin                  | Need to use -infinite flag in add command                                            |


# Plugin Files

Files that are generated by the plugin.

### config.yml

````
```yaml
# The prefix for the plugin
prefix: '&8[&eMarkets&8]'
# The primary language of the plugin
language: en_us
settings:
  # The maximum # of categories a player can add to their market before special permissions.
  max allowed market categories: 20
  creation cost:
    # How much should market's charge the player to create their market
    cost: 1000
    # If enabled, players will be charged to create their market
    enabled: true
  # If true, anyone can create a market. Otherwise they will need the permission: markets.createmarket
  allow anyone to create market: true
  # How many seconds must a player wait before they can rate the same market?
  time between ratings: 5
  # The maximum # of items a player can add to their market before special permissions.
  max allowed market items: 64
  tax:
    # The tax percentage. By default it's 13%
    percentage: 13.0
    # If true, will apply sales tax to the total when a user is buying an item
    enabled: false
  currency:
    # When using default/vault currency, what symbol should be used.
    vault symbol: $
    # The default currency selection, PluginName/CurrencyName -> Ex. Vault/Vault
    default selection: Vault/Vault
    # If true, players will be able to select which currency they want to use.
    allow user to pick: true
    # If true, Markets will only allow the usage of another item for currency.
    use item only: false
  confirmations:
    purchase: true
  # The maximum # of requests a player can make without further permission
  max allowed requests: 64
gui:
  category add item:
    items:
      offers:
        # 
        item: FLOWER_BANNER_PATTERN
      price for all:
        # 
        item: RED_SHULKER_BOX
      price:
        # 
        item: SUNFLOWER
      new item:
        # 
        item: LIME_DYE
      currency:
        # 
        item: GOLD_INGOT
  market view:
    items:
      search:
        # 
        item: DARK_OAK_SIGN
      reviews:
        # 
        item: NETHER_STAR
  shared buttons:
    back button:
      # 
      item: DARK_OAK_DOOR
    previous button:
      # 
      item: ARROW
    next button:
      # 
      item: ARROW
    exit button:
      # 
      item: BARRIER
  market settings:
    items:
      banned users:
        # 
        item: SHIELD
      close when out of stock:
        disabled:
          # 
          item: RED_STAINED_GLASS_PANE
        enabled:
          # 
          item: LIME_STAINED_GLASS_PANE
      category layout:
        item:
          # 
          item: CHEST
      home layout:
        # 
        item: PINK_BED
      closed:
        # 
        item: RED_STAINED_GLASS_PANE
      open:
        # 
        item: LIME_STAINED_GLASS_PANE
  offer creation:
    items:
      offered amount:
        # 
        item: SUNFLOWER
      breakdown:
        # 
        item: PAPER
      currency:
        # 
        item: GOLD_INGOT
      create offer:
        # 
        item: LIME_DYE
  purchase item:
    items:
      decrement:
        # 
        item: RED_STAINED_GLASS_PANE
      buy:
        # 
        item: LIME_DYE
      price breakdown:
        # 
        item: PAPER
      increment:
        # 
        item: LIME_STAINED_GLASS_PANE
  market overview:
    items:
      settings:
        # 
        item: REPEATER
      display name:
        # 
        item: NAME_TAG
      new item:
        # 
        item: LIME_DYE
      description:
        # 
        item: ENCHANTED_BOOK
      unStore market:
        # 
        item: LAVA_BUCKET
      new category:
        # 
        item: LIME_DYE
  layout editor:
    items:
      search:
        # 
        item: DARK_OAK_SIGN
      review:
        # 
        item: NETHER_STAR
  new rating:
    star:
      # 
      item: SUNFLOWER
    message:
      # 
      item: DARK_OAK_SIGN
    items:
      # 
      item: LIME_DYE
  market banned users:
    items:
      new ban:
        # 
        item: LIME_DYE
  bank:
    items:
      add:
        # 
        item: LIME_DYE
  layout control picker:
    items:
      exit:
        # 
        item: BARRIER
      search:
        # 
        item: DARK_OAK_SIGN
      prev page:
        # 
        item: ARROW
      review:
        # 
        item: NETHER_STAR
      next page:
        # 
        item: ARROW
  edit market item:
    items:
      accepting offers:
        # 
        item: LIME_STAINED_GLASS_PANE
      wholesale disabled:
        # 
        item: RED_STAINED_GLASS_PANE
      currency:
        # 
        item: GOLD_INGOT
      rejecting offers:
        # 
        item: RED_STAINED_GLASS_PANE
      wholesale enabled:
        # 
        item: LIME_STAINED_GLASS_PANE
      stock:
        # 
        item: HOPPER
  all markets:
    items:
      search:
        # 
        item: DARK_OAK_SIGN
  market category edit:
    items:
      settings:
        # 
        item: REPEATER
      display name:
        # 
        item: NAME_TAG
      unStore category:
        # 
        item: LAVA_BUCKET
      description:
        # 
        item: ENCHANTED_BOOK
  main view:
    items:
      offers:
        # 
        item: CREEPER_BANNER_PATTERN
      bank:
        # 
        item: ENDER_CHEST
      payments:
        # 
        item: GOLD_INGOT
      global:
        # 
        item: https://textures.minecraft.net/texture/fc1e73023352cbc77b896fe7ea242b43143e013bec5bf314d41e5f26548fb2d2
      requests:
        # 
        item: PAPER
  request:
    items:
      toggle:
        # 
        item: LEVER
      create:
        # 
        item: LIME_DYE
  create request:
    items:
      currency:
        # 
        item: GOLD_INGOT
      amount:
        # 
        item: SUNFLOWER
      price:
        # 
        item: SUNFLOWER
      create:
        # 
        item: LIME_DYE

```
````


# Translations

List of available translations that can be used with the plugin.

To use a specific language translation you will need to change the default language code within your config.yml. If the translation is available, the plugin will attempt to download it, otherwise if a translation file matching the Language code format is found it will read that instead!

| Language | Language Code |
| -------- | ------------- |
| English  | en\_us        |
|          |               |

{% hint style="info" %}
We accept user translated files, if you would like to contribute, please contact us on Discord.
{% endhint %}

### Default Language File (en\_us.yml)

```

gui:
  offers:
    title: '&eMarkets &f- &7Offers'
    items:
      offer:
        lore:
          footer: '&7----------------------------'
          reject: '&d&l%right_click% &7To reject this offer'
          reject stock:
            - '&C&OYou can only reject this item since it is no'
            - '&c&olonger available or the stock count is too low.'
            - ''
          header: '&7----------------------------'
          info:
            - '&b&lOriginal'
            - '&7Price&F: &a%market_item_price%'
            - '&7Currency&f: &a%market_item_currency%'
            - '&7Quantity&f: &a%offer_requested_amount%'
            - ''
            - '&d&lOffered'
            - '&7Price&F: &a%offer_amount%'
            - '&7Currency&F: &a%offer_currency%'
            - ''
          accept: '&e&l%left_click% &7To accept this offer'
  user profile:
    title: '&e%player_name%&f''&7s Profile'
    items:
      rating:
        lore:
          - ''
          - '&e&lFeedback'
          - '&7%rating_feedback%'
          - ''
          - '&7Stars&f: &6%rating_stars%'
          - ''
          - '&e%rating_date%'
        name: <GRADIENT:65B1B4>&l%rater_name%</GRADIENT:2B6F8A>
      user:
        lore:
          - '&7Last Login&F: '
          - '&e%user_last_seen%'
          - ''
          - '&7Online&F: %true%'
        name: <GRADIENT:65B1B4>&l%player_name%</GRADIENT:2B6F8A>
  category add item:
    title: '&eCategory &f- &7%category_name% &f- &7New Item'
    items:
      offers:
        lore:
          - '&7By default offers are enabled, if enabled'
          - '&7players can make an offer on an item they want.'
          - ''
          - '&7Current&f: %enabled%'
          - ''
          - '&e&l%left_click% &7to toggle offers'
        name: <GRADIENT:65B1B4>&lToggle Offers</GRADIENT:2B6F8A>
      price for all:
        lore:
          - '&7By default the price will be for a single item'
          - '&7from the entire stack/stock. If enabled, the price will'
          - '&7be for the entire stack/stock that is available.'
          - ''
          - '&7Current&f: %enabled%'
          - ''
          - '&e&l%left_click% &7to toggle price mode'
        name: <GRADIENT:65B1B4>&lToggle 'Wholesale'</GRADIENT:2B6F8A>
      price:
        lore: '&7The current price is &f: &a%market_item_price%'
        name: <GRADIENT:65B1B4>&LItem Price</GRADIENT:2B6F8A>
      new item:
        lore: '&a&lClick &7to add item to category'
        name: <GRADIENT:65B1B4>&lAdd Item</GRADIENT:2B6F8A>
      custom currency:
        lore:
          - '&7----------------------------'
          - '&eThis item is the custom currency'
          - '&7----------------------------'
      currency:
        lore:
          - '&7Used to adjust which currency you will'
          - '&7be accepting for this particular item.'
          - ''
          - '&7Current&f: &e%market_item_currency%'
          - ''
          - '&e&l%left_click% &7to edit currency'
        name: <GRADIENT:65B1B4>&lSwitch Currency</GRADIENT:2B6F8A>
  market view:
    title: '%market_display_name%'
    items:
      search:
        lore:
          - '&7Used to search for items within'
          - '&7all open categories of this market'
          - ''
          - '&e&l%left_click% &7to search market'
        name: <GRADIENT:65B1B4>&lSearch</GRADIENT:2B6F8A>
      review:
        lore:
          - '&7Used to leave a review of the current market'
          - '&7there''s a delay between leaving reviews.'
          - ''
          - '&e&l%left_click% &7to leave a review'
          - '&b&l%right_click% &7to view reviews'
        name: <GRADIENT:65B1B4>&LReview</GRADIENT:2B6F8A>
      profile:
        lore:
          - '&7Used to view the profile of the'
          - '&7current market owner&F: &e%market_owner%'
          - ''
          - '&e&l%left_click% &7to view owner profile'
        name: <GRADIENT:65B1B4>&lProfile</GRADIENT:2B6F8A>
      category:
        lore:
          - ''
          - '&e&l%left_click% &7to open category'
        name: '%category_display_name%'
  market settings:
    title: '&eMarkets &f- &7Settings'
    items:
      banned users:
        lore:
          - '&7Used to add and remove certain users from'
          - '&7your market ban list, banned users cannot buy anything.'
          - ''
          - '&e&l%left_click% &7to edit banned users'
        name: <GRADIENT:65B1B4>&lBanned Users</GRADIENT:2B6F8A>
      category layout:
        lore:
          - '&7The category layout is where all'
          - '&7the items you add in a category'
          - '&7will be shown to others.'
          - ''
          - '&e&l%left_click% &7to edit category layout'
          - '&b&l%right_click% &7to open item picker for bg'
          - '&d&l%right_click% &7with an item on your cursor'
          - '&7to set this layout''s background'
        name: <GRADIENT:65B1B4>&lCategory Layout</GRADIENT:2B6F8A>
      home layout:
        lore:
          - '&7The home layout is the main view'
          - '&7of your market, it''s where all'
          - '&7of your will be shown'
          - ''
          - '&e&l%left_click% &7to edit home layout'
          - '&b&l%right_click% &7to open item picker for bg'
          - '&d&l%right_click% &7with an item on your cursor'
          - '&7to set this layout''s background'
        name: <GRADIENT:65B1B4>&lHome Layout</GRADIENT:2B6F8A>
      toggle close when out of stock:
        lore:
          - '&7Used to toggle whether or not your market'
          - '&7will auto close when you completely run out of stock.'
          - ''
          - '&7Current&F: %enabled%'
          - ''
          - '&e&l%left_click% &7to toggle auto close'
        name: <GRADIENT:65B1B4>&lToggle Auto Close</GRADIENT:2B6F8A>
      toggle open:
        lore:
          - '&7Used to toggle whether or not your market'
          - '&7is open/closed. If closed, player''s will not see it.'
          - ''
          - '&7Current&F: %open%'
          - ''
          - '&e&l%left_click% &7to open/close market'
        name: <GRADIENT:65B1B4>&lToggle Open</GRADIENT:2B6F8A>
  shared buttons:
    back button:
      lore: '&e&l%left_click% &7to go back'
      name: <GRADIENT:65B1B4>&LGo Back</GRADIENT:2B6F8A>
    previous button:
      lore: '&e&l%left_click% &7to go back a page'
      name: <GRADIENT:65B1B4>&lPrevious Page</GRADIENT:2B6F8A>
    next button:
      lore: '&e&l%left_click% &7to go to next page'
      name: <GRADIENT:65B1B4>&lNext Page</GRADIENT:2B6F8A>
    exit button:
      lore: '&e&l%left_click% &7to exit menu'
      name: <GRADIENT:65B1B4>&LExit</GRADIENT:2B6F8A>
  offer creation:
    title: '&eMarkets &f- &7Send an Offer'
    items:
      offered amount:
        lore:
          - '&7Current Offer &f: &a%offer_amount%'
          - ''
          - '&e&l%left_click% &7to change offer amount'
        name: <GRADIENT:65B1B4>&LOffer Amount</GRADIENT:2B6F8A>
      breakdown:
        lore:
          - ''
          - '&a&lYou &7(&f%sender_name%&7) &eis offering &b&lSeller &7(&f%seller_name%&7)'
          - '&fx&a%offer_amount% &a%offer_currency% &efor &fx&a%requested_amount%
            &a%market_item_name%'
          - ''
          - '&c&oThis offer will be created assuming stock levels stay the'
          - '&c&osame, if it changes this offer will be automatically voided.'
        name: <GRADIENT:65B1B4>&LOffer Breakdown</GRADIENT:2B6F8A>
      currency:
        lore:
          - '&7Used to adjust which currency you will'
          - '&7be be offering for this market item.'
          - ''
          - '&7Current&f: &e%offer_currency%'
          - ''
          - '&e&l%left_click% &7to edit currency'
        name: <GRADIENT:65B1B4>&lSwitch Currency</GRADIENT:2B6F8A>
      create offer:
        lore: '&e&l%left_click% &7to send the offer'
        name: <GRADIENT:65B1B4>&LCreate Offer</GRADIENT:2B6F8A>
  user picker:
    title: '&eMarkets &f- &7Pick a user'
  purchase item:
    title: '%market_display_name% &7- &eCheckout'
    items:
      increment one:
        lore:
          - ''
          - '&e&l%left_click% &7to increment by &a1'
        name: '&a&l+1'
      increment five:
        lore:
          - ''
          - '&e&l%left_click% &7to increment by &a5'
        name: '&a&l+5'
      purchasing item:
        lore:
          - '&7----------------------------'
          - '&7Available Stock&F: &e%market_item_stock%'
          - '&7----------------------------'
      decrement ten:
        lore:
          - ''
          - '&e&l%left_click% &7to decrement by &c10'
        name: '&a&l-10'
      buy:
        lore:
          - ''
          - '&e&l%left_click% &7to purchase item(s)'
        name: <GRADIENT:65B1B4>&lPurchase</GRADIENT:2B6F8A>
      price breakdown:
        lore:
          total:
            - '&b&lTotal'
            - '&a%purchase_total%'
          subtotal:
            - '&b&lSub Total'
            - '&a%purchase_sub_total%'
            - ''
          tax:
            - '&b&LTax'
            - '&a%sales_tax%'
            - ''
          info:
            - '&7Purchase Quantity&f: &E%purchase_quantity%'
            - '&7Cost Per Item&f: &a%market_item_price%'
            - '&7Currency&f: %market_item_currency%'
            - ''
        name: <GRADIENT:65B1B4>&lPrice Breakdown</GRADIENT:2B6F8A>
      increment ten:
        lore:
          - ''
          - '&e&l%left_click% &7to increment by &a10'
        name: '&a&l+10'
      custom currency:
        lore:
          - '&7----------------------------'
          - '&eThis item is the required currency'
          - '&7----------------------------'
      decrement five:
        lore:
          - ''
          - '&e&l%left_click% &7to decrement by &c5'
        name: '&a&l-5'
      decrement one:
        lore:
          - ''
          - '&e&l%left_click% &7to decrement by &c1'
        name: '&a&l-1'
  offline payments:
    title: '&eMarkets &f- &7Collect Payments'
    items:
      payment:
        lore:
          - ''
          - '&7Quantity Received&f: &a%payment_total%'
          - ''
          - '&b&lReason'
          - '%payment_reason%'
          - ''
          - '&d&lReceived On'
          - '&e%payment_date%'
          - ''
          - '&e&l%left_click% &7to collect payment'
  new rating:
    title: '%market_display_name% &f- &7Review'
    items:
      star:
        lore: '&e&l%left_click% &7to rate &e%star_level% &7star'
        name: <GRADIENT:65B1B4>&l%star_level% Star</GRADIENT:2B6F8A>
      create:
        lore:
          - '&7If you are happy with your review'
          - '&7then you can use this to confirm it.'
          - ''
          - '&e&l%left_click% &7to leave market review.'
        name: <GRADIENT:65B1B4>&lLeave Review</GRADIENT:2B6F8A>
      message:
        lore:
          - '&7The message content of the review,'
          - '&7a brief statement why you gave the rating.'
          - ''
          - '&7Current Message&f:'
          - '&e%review_message%'
          - ''
          - '&e&l%left_click% &7to edit message'
        name: <GRADIENT:65B1B4>&lReview Message</GRADIENT:2B6F8A>
  layout editor:
    title:
      category: '&eMarkets &f- &7Layout &F- &7Category'
      home: '&eMarkets &f- &7Layout &F- &7Home'
    items:
      search:
        lore:
          - '&7Used to search for items within'
          - '&7all open categories of this market'
        name: <GRADIENT:65B1B4>&lSearch</GRADIENT:2B6F8A>
      review:
        lore:
          - '&7Used to leave a review of the current market'
          - '&7there''s a delay between leaving reviews.'
        name: <GRADIENT:65B1B4>&LReview</GRADIENT:2B6F8A>
      profile:
        lore:
          - '&7Used to view the profile of the'
          - '&7current market owner&F: &e%market_owner%'
        name: <GRADIENT:65B1B4>&lProfile</GRADIENT:2B6F8A>
      empty slot:
        lore:
          - '&7This is a free slot, you can add'
          - '&7decorations here or assign it as a '
          - '&7populated slot or even move controls.'
          - ''
          - '&e&l%left_click% &7to set as fill slot'
          - '&b&l%right_click% &7to move a control here'
          - '&d&l%right_click% &7with an item on your cursor'
          - '&7to decorate this slot.'
        name: <GRADIENT:65B1B4>&lEmpty Slot</GRADIENT:2B6F8A>
      decoration slot:
        lore:
          - '&7This is a decoration slot'
          - ''
          - '&e&l%left_click% &7to make empty slot'
          - '&d&l%right_click% &7with an item on your cursor'
          - '&7to change the decoration item.'
        name: <GRADIENT:65B1B4>&lDecoration Slot</GRADIENT:2B6F8A>
      fill slot:
        lore:
          - '&7This slot will be populated by'
          - '&7your market categories.'
          - ''
          - '&e&l%left_click% &7to disable this slot'
        name: <GRADIENT:65B1B4>&lFill Slot</GRADIENT:2B6F8A>
  market overview:
    title: '&eMarkets &f- &7Your Market'
    items:
      unstore market:
        lore:
          - '&7This action &4&lCANNOT &7be undone!'
          - ''
          - '&a&lClick &7to unStore market'
        name: '&c&lDelete Market'
      settings:
        lore:
          - '&7This is used to configure market details.'
          - ''
          - '&a&lClick &7to adjust settings'
        name: <GRADIENT:65B1B4>&LMarket Settings</GRADIENT:2B6F8A>
      display name:
        lore:
          - '&7The display name of your market, this'
          - '&7is what others will see in the search.'
          - ''
          - '&7Current&f: %market_display_name%'
          - ''
          - '&a&lClick &7to change display name'
        name: <GRADIENT:65B1B4>&LMarket Name</GRADIENT:2B6F8A>
      new item:
        lore:
          - '&7Used to add a new item'
          - '&a&lClick &7to add item to category'
        name: <GRADIENT:65B1B4>&LNew Item</GRADIENT:2B6F8A>
      description:
        lore:
          - '&7A brief description of market, something'
          - '&7to help catch someone''s attention'
          - ''
          - '&7Current&f: '
          - '%market_description%'
          - ''
          - '&a&lClick &7to change description'
        name: <GRADIENT:65B1B4>&LMarket Description</GRADIENT:2B6F8A>
      new category:
        lore:
          - '&7Used to make a new category'
          - '&a&lClick &7to create new category'
        name: <GRADIENT:65B1B4>&LNew Category</GRADIENT:2B6F8A>
  currency picker:
    title: '&eMarkets &f- &7Pick a currency'
    items:
      custom currency:
        lore:
          - '&7If you want to use use a specific item for'
          - '&7the currency, you can set that here.'
          - ''
          - '&b&l%right_click% &7to open a material picker &eor'
          - '&e&l%left_click% &7with the item you want to use'
          - '&7as the currency onto this icon.'
        name: <GRADIENT:65B1B4>&lCustom Item</GRADIENT:2B6F8A>
  market banned users:
    title: '&eMarkets &f- &7Settings &F- &cBans'
    items:
      new ban:
        lore:
          - '&7Used to add a new user to the ban list'
          - '&e&l%left_click% &7to ban a player'
        name: <GRADIENT:65B1B4>&lAdd Banned User</GRADIENT:2B6F8A>
      player:
        lore:
          - '&7This user is currently banned from'
          - '&7interacting with your market.'
          - ''
          - '&e&l%left_click% &7to unban them'
        name: <GRADIENT:65B1B4>&l%player_name%</GRADIENT:2B6F8A>
  search:
    title: '&eMarkets &f- &7Search &f- &7%search_keywords%'
  bank:
    title: '&eMarkets &f- &7Bank'
    items:
      add:
        lore: '&eDrop items on here to deposit'
        name: <GRADIENT:65B1B4>&LDeposit</GRADIENT:2B6F8A>
      entry:
        lore:
          - '&7Quantity&f: &E%entry_quantity%'
          - ''
          - '&e&l%left_click% &7to withdraw all'
          - '&b&l%right_click% &7to withdraw qty'
  layout control picker:
    title: '&eMarkets &f- &7Select Layout Control'
    items:
      exit:
        lore:
          - '&7Used to exit market menu'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:65B1B4>&lExit Button</GRADIENT:2B6F8A>
      search:
        lore:
          - '&7Used to search your market for items'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:65B1B4>&lSearch Button</GRADIENT:2B6F8A>
      prev page:
        lore:
          - '&7Used to navigate back if theres multiple pages'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:65B1B4>&lBack Button</GRADIENT:2B6F8A>
      review:
        lore:
          - '&7Used to open market review'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:65B1B4>&lReview Button</GRADIENT:2B6F8A>
      profile:
        lore:
          - '&7Used to open your profile'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:65B1B4>&lProfile Button</GRADIENT:2B6F8A>
      next page:
        lore:
          - '&7Used to navigate forward if theres multiple pages'
          - '&e&l%left_click% &7to select this control'
        name: <GRADIENT:65B1B4>&lNext Button</GRADIENT:2B6F8A>
  edit market item:
    title: '&eMarkets &f- &7Item Settings'
    items:
      offers:
        lore:
          - If enabled, other players will be
          - '&7able to send you offers om this item'
          - ''
          - '&7Current&F: %enabled%'
          - ''
          - '&e&l%left_click% &7to toggle offers'
        name: <GRADIENT:65B1B4>&LOffers</GRADIENT:2B6F8A>
      wholesale:
        lore:
          - If enabled, the price will be for
          - '&7the entire stack/stock that is available.'
          - ''
          - '&7Current&F: %enabled%'
          - ''
          - '&e&l%left_click% &7to toggle wholesale'
        name: <GRADIENT:65B1B4>&LWholesale</GRADIENT:2B6F8A>
      currency:
        lore:
          - '&7Used to adjust which currency you will'
          - '&7be accepting for this particular item.'
          - ''
          - '&7Current&f: &e%market_item_currency%'
          - ''
          - '&e&l%left_click% &7to edit currency'
        name: <GRADIENT:65B1B4>&lSwitch Currency</GRADIENT:2B6F8A>
      stock:
        lore:
          - '&7If you have any of this item in your'
          - '&7inventory you can &edrop &7it here to add to stock.'
          - ''
          - '&7Current Stock&F: &e%market_item_stock%'
        name: <GRADIENT:65B1B4>&lStock</GRADIENT:2B6F8A>
  all markets:
    title: '&eMarkets &f- &7Open Markets'
    items:
      market:
        lore:
          - ''
          - '&7Ratings&f: &6%market_ratings_stars% &f(&7%market_ratings_total%&f)'
          - ''
          - '&e&L%left_click% &7To enter market'
      search:
        lore:
          - '&7Used to search for items in'
          - '&7every market that is open currently.'
          - ''
          - '&e&l%left_click% &7to search markets.'
        name: <GRADIENT:65B1B4>&lSearch</GRADIENT:2B6F8A>
  ratings:
    title: '%market_display_name% &f- &7Ratings'
    items:
      rating:
        lore:
          - ''
          - '&e&lFeedback'
          - '&7%rating_feedback%'
          - ''
          - '&7Stars&f: &6%rating_stars%'
          - ''
          - '&e%rating_date%'
        name: <GRADIENT:65B1B4>&l%rater_name%</GRADIENT:2B6F8A>
  market category view:
    title: '%market_display_name% &7- %category_display_name%'
    items:
      search:
        lore:
          - '&7Used to search for items within'
          - '&7this specific category'
          - ''
          - '&e&l%left_click% &7to search category'
        name: <GRADIENT:65B1B4>&lSearch</GRADIENT:2B6F8A>
      item:
        lore:
          view currency: '&d&l%shift_right_click% &7to view currency'
          footer: '&7----------------------------'
          make offer: '&b&l%right_click% &7to make offer'
          buy: '&e&l%left_click% &7to purchase item'
          header: '&7----------------------------'
          info:
            - '&7Price&f: &a%market_item_price%'
            - '&7Currency&f: &e%market_item_currency%'
            - '&7Stock&f: &e%market_item_stock%'
            - '&7Wholesale&f: %market_item_wholesale%'
            - ''
      review:
        lore:
          - '&7Used to leave a review of the current market'
          - '&7there''s a delay between leaving reviews.'
          - ''
          - '&e&l%left_click% &7to leave a review'
          - '&b&l%right_click% &7to view reviews'
        name: <GRADIENT:65B1B4>&LReview</GRADIENT:2B6F8A>
      profile:
        lore:
          - '&7Used to view the profile of the'
          - '&7current market owner&F: &e%market_owner%'
          - ''
          - '&e&l%left_click% &7to view owner profile'
        name: <GRADIENT:65B1B4>&lProfile</GRADIENT:2B6F8A>
  market category edit:
    title: '&eMarkets &f- &7Edit &f- &7%category_name%'
    items:
      market item:
        lore:
          - '&7----------------------------'
          - '&7Price&f: &a%market_item_price%'
          - '&7Currency&f: &e%market_item_currency%'
          - '&7Stock&f: &e%market_item_stock%'
          - '&7Wholesale&f: &e%market_item_wholesale%'
          - '&7Accept Offers&f: &e%market_item_accepting_offers%'
          - ''
          - '&e&l%left_click% &7to edit price'
          - '&b&l%right_click% &7to edit settings'
          - '&c&l%drop_button% &7to remove item'
          - '&7----------------------------'
      settings:
        lore:
          - '&7This is used to configure market details.'
          - ''
          - '&a&lClick &7to adjust settings'
        name: <GRADIENT:65B1B4>&lCategory Settings</GRADIENT:2B6F8A>
      display name:
        lore:
          - '&7The display name of your category, this'
          - '&7is what others will see in the search.'
          - ''
          - '&7Current&f: %category_display_name%'
          - ''
          - '&a&lClick &7to change display name'
        name: <GRADIENT:65B1B4>&lCategory Name</GRADIENT:2B6F8A>
      icon:
        lore:
          - '&7The icon of your category, this'
          - '&7is what is shown to other players'
          - ''
          - '&7Current&f: %category_icon%'
          - ''
          - '&e&l%left_click% &7to use selector'
          - '&b&l%right_click% &7while holding the item'
          - '&7you wish to use as the category icon.'
        name: <GRADIENT:65B1B4>&lCategory Icon</GRADIENT:2B6F8A>
      description:
        lore:
          - '&7A brief description of category, something'
          - '&7to describe what the category contains.'
          - ''
          - '&7Current&f: '
          - '%category_description%'
          - ''
          - '&a&lClick &7to change description'
        name: <GRADIENT:65B1B4>&lCategory Description</GRADIENT:2B6F8A>
      unstore category:
        lore:
          - '&7This action &4&lCANNOT &7be undone!'
          - ''
          - '&a&lClick &7to unStore this category'
        name: '&c&lDelete Category'
  main view:
    title: '&eMarkets &f- &7Home'
    items:
      offers:
        lore:
          - '&7Used to view any offers that'
          - '&7other users have sent regarding your items.'
          - ''
          - '&e&l%left_click% &7to view offers'
        name: <GRADIENT:65B1B4>&LOffers</GRADIENT:2B6F8A>
      bank:
        lore:
          - '&7Used to store any physical (item) currency'
          - '&7that you want to use as payment for offers.'
          - ''
          - '&e&l%left_click% &7to view bank'
        name: <GRADIENT:65B1B4>&LYour Bank</GRADIENT:2B6F8A>
      payments:
        lore:
          - '&7Used to collect any payments that were'
          - '&7made to your market while you were offline.'
          - ''
          - '&e&l%left_click% &7to collect payments'
        name: <GRADIENT:65B1B4>&LCollect Payments</GRADIENT:2B6F8A>
      your market:
        view: '&a&lClick &7to view market'
        lore:
          - '&7You currently don''t have a market'
          - ''
          - '&a&lClick &7to create one.'
        name: '&e&lYour Market'
      global:
        lore:
          - '&7Used to view all open markets'
          - '&7that are owned by other players'
          - ''
          - '&e&l%left_click% &7to view open markets'
        name: <GRADIENT:65B1B4>&LAll Markets</GRADIENT:2B6F8A>
      requests:
        lore:
          - '&7Used to view all open player'
          - '&7requests or to create your own.'
          - ''
          - '&e&l%left_click% &7to view requests'
        name: <GRADIENT:65B1B4>&LRequests</GRADIENT:2B6F8A>
  request:
    title:
      all: '&eMarkets &f- &7All Requests'
      yours: '&eMarkets &f- &7Your Requests'
    items:
      toggle:
        lore:
          - '&7Used to toggle between viewing all open'
          - '&7requests and just requests you''ve made'
          - ''
          - '&e&l%left_click% &7to toggle view'
        name: <GRADIENT:65B1B4>&lSwitch View</GRADIENT:2B6F8A>
      request:
        lore:
          self:
            - '&7Price&F: &a%request_price%'
            - '&7Currency&f: &a%request_currency%'
            - '&7Quantity&f: &a%request_amount%'
            - ''
            - '&e&l%left_click% &7to cancel request'
          others:
            - '&7Price&F: &a%request_price%'
            - '&7Currency&f: &a%request_currency%'
            - '&7Quantity&f: &a%request_amount%'
            - ''
            - '&e&l%left_click% &7to fulfill request'
      create:
        lore:
          - '&7Used to create a new request for a'
          - '&7particular item you are looking for.'
          - ''
          - '&e&l%left_click% &7to make a request'
        name: <GRADIENT:65B1B4>&lCreate Request</GRADIENT:2B6F8A>
  create request:
    title: '&eMarkets &f- &7New Request'
    items:
      currency:
        lore:
          - '&7Used to adjust which currency you will'
          - '&7be offering for the requested item(s).'
          - ''
          - '&7Current&f: &e%request_currency%'
          - ''
          - '&e&l%left_click% &7to edit currency'
        name: <GRADIENT:65B1B4>&lSwitch Currency</GRADIENT:2B6F8A>
      requested item:
        lore:
          - '&7----------------------------'
          - '&e&l%left_click% &7to open a material picker &eor'
          - '&b&l%right_click% &7with the item you want'
          - '&7to request more of.'
          - '&7----------------------------'
        name: <GRADIENT:65B1B4>&lNo Item Selected</GRADIENT:2B6F8A>
      amount:
        lore:
          - '&7Current&f: &a%request_amount%'
          - ''
          - '&e&l%left_click% &7to change request amount'
        name: <GRADIENT:65B1B4>&lRequest Amount</GRADIENT:2B6F8A>
      price:
        lore:
          - '&7Current&f: &a%request_price%'
          - ''
          - '&e&l%left_click% &7to change request pay'
        name: <GRADIENT:65B1B4>&lOffered Amount</GRADIENT:2B6F8A>
      create:
        lore: '&e&l%left_click% &7to make request'
        name: <GRADIENT:65B1B4>&lCreate Request</GRADIENT:2B6F8A>
error:
  no permission: '&cYou do not have enough permission!'
  category name used: '&cYou already have a category named&F: &4%category_name%'
  player offline: '&4%value% &cis not online currently!'
  item out of stock: '&cSorry that item is now out of stock'
  one fill slot required: '&cThis layout requires at least one fill slot!'
  market name too long: '&cMarket name too long, max is 72 characters.'
  not enough money: '&cYou do not have enough money!'
  player not found: '&4%value% &cwas not found!'
  insufficient bank entry balance: '&cWithdrawal amount exceeds your stored total!'
  at maximum item limit: '&cYou aren''t allowed to add more items!'
  category name too long: '&cCategory name too long, max is 32 characters.'
  not allowed to review: '&cYou need to wait longer to review again.'
  must be higher than zero: '&cPlease enter a number that is higher than 0'
  take out item: '&cPlease remove your item from the menu first!'
  not a number: '&4%value% &cis not a valid number!'
  banned from market: '&4%market_owner% &chas banned you from viewing their market!'
  at maximum category limit: '&cYou aren''t allowed to create more categories.'
  cannot pay creation fee: '&cInsufficient funds to pay the creation fee'
  not allowed to create: '&cYou are not allowed to create a market'
  item no longer available: '&cSorry that item is no longer available'
  review feedback too long: '&cReview too long, max is 128 characters.'
  no market found: '&cCould not find any market for&F: &4%player_name%'
  market is closed: '&4%market_owner%&c''s market is currently closed!'
  placed item to add: '&cPlease put the item you wish to add into the empty slot'
  provide requested item: '&cYou need to place/select a requested item first'
  max stack size: '&cCannot request that many, max stack size is &4%max_stack_size%'
  at maximum request limit: '&cYou aren''t allowed to create more requests!'
  requester cannot pay: '&4%requester_name% &cdoes not have enough money to for you!'
  not enough items: '&cYou do not have enough items to fulfill that request'
prompts:
  search:
    subtitle: '&fEnter search keywords into chat'
    title: <GRADIENT:65B1B4>&LSearch</GRADIENT:2B6F8A>
  category name:
    subtitle: '&fEnter new name for category into chat'
    title: <GRADIENT:65B1B4>&LCategory Name</GRADIENT:2B6F8A>
  market description:
    subtitle: '&fEnter new description into chat'
    title: <GRADIENT:65B1B4>&LMarket Description</GRADIENT:2B6F8A>
  item price:
    subtitle: '&fEnter item price into chat'
    title: <GRADIENT:65B1B4>&LItem Price</GRADIENT:2B6F8A>
  withdraw bank entry:
    subtitle: '&fEnter how much you want to withdraw'
    title: <GRADIENT:65B1B4>&LEnter Amount</GRADIENT:2B6F8A>
  market name:
    subtitle: '&fEnter new market name into chat'
    title: <GRADIENT:65B1B4>&LMarket Name</GRADIENT:2B6F8A>
  new review:
    subtitle: '&fEnter your feedback into chat'
    title: <GRADIENT:65B1B4>&LReview Message</GRADIENT:2B6F8A>
  category description:
    subtitle: '&fEnter new category description'
    title: <GRADIENT:65B1B4>&LCategory Description</GRADIENT:2B6F8A>
  offer price:
    subtitle: '&fEnter how much you want to offer'
    title: <GRADIENT:65B1B4>&LOffer Price</GRADIENT:2B6F8A>
  new category:
    subtitle: '&fEnter new category id into chat'
    title: <GRADIENT:65B1B4>&LNew Category</GRADIENT:2B6F8A>
  request amount:
    subtitle: '&fEnter how many of that item you want'
    title: <GRADIENT:65B1B4>&lRequest Amount</GRADIENT:2B6F8A>
  price:
    subtitle: '&fEnter how much you''ll pay for the request'
    title: <GRADIENT:65B1B4>&lRequest Price</GRADIENT:2B6F8A>
info:
  offer:
    rejected:
      insufficient stock: '&b%owner_name% &crejected your offer on &e%market_item_name%
        &c(insufficient stock)'
      no money: '&b%owner_name% &crejected your offer on &e%market_item_name% &c(insufficient
        balance)'
      not accepted: '&b%owner_name% &crejected your offer on &e%market_item_name%!'
      item not available: '&b%owner_name% &crejected your offer (item no longer available)'
    accepted payment: '&eThe offer request was accepted'
    accepted: '&b%owner_name% &eaccepted your offer on &e%market_item_name%'
    received: '&b%sender_name% &ehas sent you an offer on an item!'
    sent: '&EYou offer has successfully be sent to &b%owner_name%'
  market item bought:
    seller: '&fx&a%purchase_quantity% &f%item_name% &ewas bought by &b%buyer_name%'
    out of stock: '&EAll &f%item_name% &estock has been sold!'
    buyer: '&eBought &fx&a%purchase_quantity% &f%item_name% &efrom &b%seller_name%'
  request payment: '&eA request was completed'
  request:
    fulfilled: '&b%fulfill_name% &efulfilled your request for &e%request_item_name%'
    payment: '&eA request was completed'
button:
  number key: 'Press # Key'
  left click: Left Click
  right click: Right Click
  left shift click: Shift+Left Click
  middle click: Middle Click
  drop key: Press Drop Key
conditionals:
  'true': '&aTrue'
  'false': '&CFalse'
  closed: '&cClosed'
  disabled: '&cDisabled'
  open: '&aOpen'
  enabled: '&aEnabled'
```


# Spawners

Spawners is the ultimate solution when it comes to upgradeable spawners.


# Commands & Permissions

A complete list of all the commands and permissions that can be used in the plugin.

### **Commands**

| Command                                                                             | Permission               | Description                                                  |
| ----------------------------------------------------------------------------------- | ------------------------ | ------------------------------------------------------------ |
| /spawners                                                                           | spawners.command         | Opens the main menu (view your placed spawners & shop)       |
| /spawners butcher \[entity] \[world]                                                | spawners.command.butcher | Removes all mobs spawned from a Spawners' spawner            |
| /spawners give \<player/\*> <#> \[-preset \<presetName>] / \[-entity \<entityType>] | spawners.command.give    | Allows user to give spawner's by entity type or preset.      |
| /spawners set                                                                       | spawners.command.set     | Force sets the entity type of the spawner you're looking at. |
| /spawners admin                                                                     | spawners.command.admin   | Allows access to the administrative menu                     |

### Permissions

All entity names are lowercased with no spaces.

<table><thead><tr><th width="267.3992922574333">Permission</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>spawners.mine.&#x3C;entity></td><td>Allows user to mine a specific entity type</td><td>spawners.mine.cow</td></tr><tr><td>spawners.place.&#x3C;entity></td><td>Allows user to place a specific entity spawner</td><td>spawners.place.sheep</td></tr><tr><td>spawners.eggchange.&#x3C;entity></td><td>Allows user to change a spawner type w/egg</td><td>spawners.eggchange.slime</td></tr><tr><td>spawners.throwegg.&#x3C;entity></td><td>Allows user to throw a spawn egg to spawn entity</td><td>spawners.throwegg.tropicalfish</td></tr><tr><td>spawners.minechance.#</td><td>Determines spawner drop chance when mining.</td><td>spawners.minechance.10, (max: spawners.minechance.100)</td></tr><tr><td>spawners.nosilktouch</td><td>Allows the player to mine spawners without silktouch</td><td></td></tr></tbody></table>


# Plugin Files

Files that are generated by the plugin.

### config.yml

```
# The global prefix for the plugin
prefix: <GRADIENT:fc67fa>&LSpawners</GRADIENT:f4c4f3> &8»
# The default language for the plugin
language: english
# This should probably be a block if you decide to change it..
spawner item: SPAWNER
# If true, player's who don't own the spawner item/block can still place it
allow non owner place: false
# If true, player's who don't own the spawner item/block can still break it
allow non owner break: false
# If true, the shop icon will appear in /spawners for users to buy spawners (items need to be added first)
enable shop: true
max spawners per chunk:
  # If true, spawners will limit the amount of spawners within a chunk
  enabled: true
  # If max spawners per chunk.enabled is enabled, it will use this limit
  max: 16
# Can be overridden using the perm: spawners.maxplace.#, # being the new total
max spawners per player: 16
spawner defaults:
  # For non Spawners spawners, what should the default mob be when placed
  entity: PIG
  delay: 240
  spawn count: 4
  activation range: 16
  max nearby entities: 12
  default level cost: 1000.0
eggs:
  # If a player right clicks a spawner with a spawn egg, should it update the entity?
  # Normal ownership rules will apply
  allow spawner change: true
  # Should the egg be used when they apply it to the spawner?
  remove egg on spawner change: true
  # Should players be able to throw spawn eggs?
  allow spawn egg throw: true
# When a natural spawner is broken, should the miner become the owner?
assign owner to natural: true
mine:
  # Chance for the spawner to drop when mined
  drop chance: 50.0
  # Should silk touch be required to mine spawners?
  requires silk touch: true
explosion:
  # Should spawners break during an explosion
  drop enabled: true
  # The chance for the spawner to drop if exploded by tnt
  drop chance: 25.0
  # If the spawner is dropped by explosion, should the owner be reset?
  reset owner: true
  # If the spawner is broken due to an unknown explosion source, should it cancel?
  prevent unknown source: true
gui:
  entity change:
    # The size (rows, min = 2, max = 6) of the spawner mob change gui
    rows: 6
    # The default background material
    background: BLACK_STAINED_GLASS_PANE
    # The slots in which mob heads will be placed into
    fill slots:
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
    # Option Decoration items (slot:material_name)
    decoration:
      - 0:BLACK_STAINED_GLASS_PANE
  player select:
    # The size (rows, min = 2, max = 6) of the player select change gui
    rows: 6
    # The default background material
    background: BLACK_STAINED_GLASS_PANE
    # The slots in which player heads will be placed into
    fill slots:
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
    # Option Decoration items (slot:material_name)
    decoration:
      - 0:BLACK_STAINED_GLASS_PANE
  main:
    # The size (rows, min = 2, max = 6) of the main player gui
    rows: 6
    # The default background material
    background: BLACK_STAINED_GLASS_PANE
    # Option Decoration items (slot:material_name)
    decoration:
      - 0:BLACK_STAINED_GLASS_PANE
  your spawners:
    # The size (rows, min = 2, max = 6)
    rows: 6
    # The default background material
    background: BLACK_STAINED_GLASS_PANE
    # The slots in which items will be placed into
    fill slots:
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
    # Option Decoration items (slot:material_name)
    decoration:
      - 0:BLACK_STAINED_GLASS_PANE
  spawner shop:
    # The size (rows, min = 2, max = 6)
    rows: 6
    # The default background material
    background: BLACK_STAINED_GLASS_PANE
    # The slots in which items will be placed into
    fill slots:
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
    # Option Decoration items (slot:material_name)
    decoration:
      - 0:BLACK_STAINED_GLASS_PANE
mob change:
  elder guardian:
    # Should players be able to set their spawner to a Elder Guardian
    enabled: true
    # The cost to switch the spawner to a Elder Guardian
    cost: 5000.0
  wither skeleton:
    # Should players be able to set their spawner to a Wither Skeleton
    enabled: true
    # The cost to switch the spawner to a Wither Skeleton
    cost: 5000.0
  stray:
    # Should players be able to set their spawner to a Stray
    enabled: true
    # The cost to switch the spawner to a Stray
    cost: 5000.0
  husk:
    # Should players be able to set their spawner to a Husk
    enabled: true
    # The cost to switch the spawner to a Husk
    cost: 5000.0
  zombie villager:
    # Should players be able to set their spawner to a Zombie Villager
    enabled: true
    # The cost to switch the spawner to a Zombie Villager
    cost: 5000.0
  skeleton horse:
    # Should players be able to set their spawner to a Skeleton Horse
    enabled: true
    # The cost to switch the spawner to a Skeleton Horse
    cost: 5000.0
  zombie horse:
    # Should players be able to set their spawner to a Zombie Horse
    enabled: true
    # The cost to switch the spawner to a Zombie Horse
    cost: 5000.0
  donkey:
    # Should players be able to set their spawner to a Donkey
    enabled: true
    # The cost to switch the spawner to a Donkey
    cost: 5000.0
  mule:
    # Should players be able to set their spawner to a Mule
    enabled: true
    # The cost to switch the spawner to a Mule
    cost: 5000.0
  evoker:
    # Should players be able to set their spawner to a Evoker
    enabled: true
    # The cost to switch the spawner to a Evoker
    cost: 5000.0
  vex:
    # Should players be able to set their spawner to a Vex
    enabled: true
    # The cost to switch the spawner to a Vex
    cost: 5000.0
  vindicator:
    # Should players be able to set their spawner to a Vindicator
    enabled: true
    # The cost to switch the spawner to a Vindicator
    cost: 5000.0
  illusioner:
    # Should players be able to set their spawner to a Illusioner
    enabled: true
    # The cost to switch the spawner to a Illusioner
    cost: 5000.0
  creeper:
    # Should players be able to set their spawner to a Creeper
    enabled: true
    # The cost to switch the spawner to a Creeper
    cost: 5000.0
  skeleton:
    # Should players be able to set their spawner to a Skeleton
    enabled: true
    # The cost to switch the spawner to a Skeleton
    cost: 5000.0
  spider:
    # Should players be able to set their spawner to a Spider
    enabled: true
    # The cost to switch the spawner to a Spider
    cost: 5000.0
  giant:
    # Should players be able to set their spawner to a Giant
    enabled: true
    # The cost to switch the spawner to a Giant
    cost: 5000.0
  zombie:
    # Should players be able to set their spawner to a Zombie
    enabled: true
    # The cost to switch the spawner to a Zombie
    cost: 5000.0
  slime:
    # Should players be able to set their spawner to a Slime
    enabled: true
    # The cost to switch the spawner to a Slime
    cost: 5000.0
  ghast:
    # Should players be able to set their spawner to a Ghast
    enabled: true
    # The cost to switch the spawner to a Ghast
    cost: 5000.0
  zombified piglin:
    # Should players be able to set their spawner to a Zombified Piglin
    enabled: true
    # The cost to switch the spawner to a Zombified Piglin
    cost: 5000.0
  enderman:
    # Should players be able to set their spawner to a Enderman
    enabled: true
    # The cost to switch the spawner to a Enderman
    cost: 5000.0
  cave spider:
    # Should players be able to set their spawner to a Cave Spider
    enabled: true
    # The cost to switch the spawner to a Cave Spider
    cost: 5000.0
  silverfish:
    # Should players be able to set their spawner to a Silverfish
    enabled: true
    # The cost to switch the spawner to a Silverfish
    cost: 5000.0
  blaze:
    # Should players be able to set their spawner to a Blaze
    enabled: true
    # The cost to switch the spawner to a Blaze
    cost: 5000.0
  magma cube:
    # Should players be able to set their spawner to a Magma Cube
    enabled: true
    # The cost to switch the spawner to a Magma Cube
    cost: 5000.0
  ender dragon:
    # Should players be able to set their spawner to a Ender Dragon
    enabled: true
    # The cost to switch the spawner to a Ender Dragon
    cost: 5000.0
  wither:
    # Should players be able to set their spawner to a Wither
    enabled: true
    # The cost to switch the spawner to a Wither
    cost: 5000.0
  bat:
    # Should players be able to set their spawner to a Bat
    enabled: true
    # The cost to switch the spawner to a Bat
    cost: 5000.0
  witch:
    # Should players be able to set their spawner to a Witch
    enabled: true
    # The cost to switch the spawner to a Witch
    cost: 5000.0
  endermite:
    # Should players be able to set their spawner to a Endermite
    enabled: true
    # The cost to switch the spawner to a Endermite
    cost: 5000.0
  guardian:
    # Should players be able to set their spawner to a Guardian
    enabled: true
    # The cost to switch the spawner to a Guardian
    cost: 5000.0
  shulker:
    # Should players be able to set their spawner to a Shulker
    enabled: true
    # The cost to switch the spawner to a Shulker
    cost: 5000.0
  pig:
    # Should players be able to set their spawner to a Pig
    enabled: true
    # The cost to switch the spawner to a Pig
    cost: 5000.0
  sheep:
    # Should players be able to set their spawner to a Sheep
    enabled: true
    # The cost to switch the spawner to a Sheep
    cost: 5000.0
  cow:
    # Should players be able to set their spawner to a Cow
    enabled: true
    # The cost to switch the spawner to a Cow
    cost: 5000.0
  chicken:
    # Should players be able to set their spawner to a Chicken
    enabled: true
    # The cost to switch the spawner to a Chicken
    cost: 5000.0
  squid:
    # Should players be able to set their spawner to a Squid
    enabled: true
    # The cost to switch the spawner to a Squid
    cost: 5000.0
  wolf:
    # Should players be able to set their spawner to a Wolf
    enabled: true
    # The cost to switch the spawner to a Wolf
    cost: 5000.0
  mushroom cow:
    # Should players be able to set their spawner to a Mushroom Cow
    enabled: true
    # The cost to switch the spawner to a Mushroom Cow
    cost: 5000.0
  snowman:
    # Should players be able to set their spawner to a Snowman
    enabled: true
    # The cost to switch the spawner to a Snowman
    cost: 5000.0
  ocelot:
    # Should players be able to set their spawner to a Ocelot
    enabled: true
    # The cost to switch the spawner to a Ocelot
    cost: 5000.0
  iron golem:
    # Should players be able to set their spawner to a Iron Golem
    enabled: true
    # The cost to switch the spawner to a Iron Golem
    cost: 5000.0
  horse:
    # Should players be able to set their spawner to a Horse
    enabled: true
    # The cost to switch the spawner to a Horse
    cost: 5000.0
  rabbit:
    # Should players be able to set their spawner to a Rabbit
    enabled: true
    # The cost to switch the spawner to a Rabbit
    cost: 5000.0
  polar bear:
    # Should players be able to set their spawner to a Polar Bear
    enabled: true
    # The cost to switch the spawner to a Polar Bear
    cost: 5000.0
  llama:
    # Should players be able to set their spawner to a Llama
    enabled: true
    # The cost to switch the spawner to a Llama
    cost: 5000.0
  parrot:
    # Should players be able to set their spawner to a Parrot
    enabled: true
    # The cost to switch the spawner to a Parrot
    cost: 5000.0
  villager:
    # Should players be able to set their spawner to a Villager
    enabled: true
    # The cost to switch the spawner to a Villager
    cost: 5000.0
  turtle:
    # Should players be able to set their spawner to a Turtle
    enabled: true
    # The cost to switch the spawner to a Turtle
    cost: 5000.0
  phantom:
    # Should players be able to set their spawner to a Phantom
    enabled: true
    # The cost to switch the spawner to a Phantom
    cost: 5000.0
  cod:
    # Should players be able to set their spawner to a Cod
    enabled: true
    # The cost to switch the spawner to a Cod
    cost: 5000.0
  salmon:
    # Should players be able to set their spawner to a Salmon
    enabled: true
    # The cost to switch the spawner to a Salmon
    cost: 5000.0
  pufferfish:
    # Should players be able to set their spawner to a Pufferfish
    enabled: true
    # The cost to switch the spawner to a Pufferfish
    cost: 5000.0
  tropical fish:
    # Should players be able to set their spawner to a Tropical Fish
    enabled: true
    # The cost to switch the spawner to a Tropical Fish
    cost: 5000.0
  drowned:
    # Should players be able to set their spawner to a Drowned
    enabled: true
    # The cost to switch the spawner to a Drowned
    cost: 5000.0
  dolphin:
    # Should players be able to set their spawner to a Dolphin
    enabled: true
    # The cost to switch the spawner to a Dolphin
    cost: 5000.0
  cat:
    # Should players be able to set their spawner to a Cat
    enabled: true
    # The cost to switch the spawner to a Cat
    cost: 5000.0
  panda:
    # Should players be able to set their spawner to a Panda
    enabled: true
    # The cost to switch the spawner to a Panda
    cost: 5000.0
  pillager:
    # Should players be able to set their spawner to a Pillager
    enabled: true
    # The cost to switch the spawner to a Pillager
    cost: 5000.0
  ravager:
    # Should players be able to set their spawner to a Ravager
    enabled: true
    # The cost to switch the spawner to a Ravager
    cost: 5000.0
  trader llama:
    # Should players be able to set their spawner to a Trader Llama
    enabled: true
    # The cost to switch the spawner to a Trader Llama
    cost: 5000.0
  wandering trader:
    # Should players be able to set their spawner to a Wandering Trader
    enabled: true
    # The cost to switch the spawner to a Wandering Trader
    cost: 5000.0
  fox:
    # Should players be able to set their spawner to a Fox
    enabled: true
    # The cost to switch the spawner to a Fox
    cost: 5000.0
  bee:
    # Should players be able to set their spawner to a Bee
    enabled: true
    # The cost to switch the spawner to a Bee
    cost: 5000.0
  hoglin:
    # Should players be able to set their spawner to a Hoglin
    enabled: true
    # The cost to switch the spawner to a Hoglin
    cost: 5000.0
  piglin:
    # Should players be able to set their spawner to a Piglin
    enabled: true
    # The cost to switch the spawner to a Piglin
    cost: 5000.0
  strider:
    # Should players be able to set their spawner to a Strider
    enabled: true
    # The cost to switch the spawner to a Strider
    cost: 5000.0
  zoglin:
    # Should players be able to set their spawner to a Zoglin
    enabled: true
    # The cost to switch the spawner to a Zoglin
    cost: 5000.0
  piglin brute:
    # Should players be able to set their spawner to a Piglin Brute
    enabled: true
    # The cost to switch the spawner to a Piglin Brute
    cost: 5000.0
  axolotl:
    # Should players be able to set their spawner to a Axolotl
    enabled: true
    # The cost to switch the spawner to a Axolotl
    cost: 5000.0
  glow squid:
    # Should players be able to set their spawner to a Glow Squid
    enabled: true
    # The cost to switch the spawner to a Glow Squid
    cost: 5000.0
  goat:
    # Should players be able to set their spawner to a Goat
    enabled: true
    # The cost to switch the spawner to a Goat
    cost: 5000.0
  allay:
    # Should players be able to set their spawner to a Allay
    enabled: true
    # The cost to switch the spawner to a Allay
    cost: 5000.0
  frog:
    # Should players be able to set their spawner to a Frog
    enabled: true
    # The cost to switch the spawner to a Frog
    cost: 5000.0
  tadpole:
    # Should players be able to set their spawner to a Tadpole
    enabled: true
    # The cost to switch the spawner to a Tadpole
    cost: 5000.0
  warden:
    # Should players be able to set their spawner to a Warden
    enabled: true
    # The cost to switch the spawner to a Warden
    cost: 5000.0
```

### english.yml

```
mob names:
  cat: Cat
  chicken: Chicken
  zombie horse: Zombie horse
  zombified piglin: Zombified piglin
  tadpole: Tadpole
  iron golem: Iron golem
  ravager: Ravager
  fox: Fox
  evoker: Evoker
  zombie villager: Zombie villager
  turtle: Turtle
  wither: Wither
  mule: Mule
  allay: Allay
  witch: Witch
  mushroom cow: Mushroom cow
  endermite: Endermite
  warden: Warden
  trader llama: Trader llama
  horse: Horse
  axolotl: Axolotl
  elder guardian: Elder guardian
  drowned: Drowned
  frog: Frog
  wolf: Wolf
  bat: Bat
  zombie: Zombie
  wither skeleton: Wither skeleton
  sheep: Sheep
  skeleton horse: Skeleton horse
  guardian: Guardian
  creeper: Creeper
  pillager: Pillager
  ghast: Ghast
  phantom: Phantom
  wandering trader: Wandering trader
  ocelot: Ocelot
  donkey: Donkey
  villager: Villager
  spider: Spider
  pufferfish: Pufferfish
  glow squid: Glow squid
  squid: Squid
  shulker: Shulker
  stray: Stray
  tropical fish: Tropical fish
  cod: Cod
  skeleton: Skeleton
  bee: Bee
  piglin: Piglin
  giant: Giant
  illusioner: Illusioner
  strider: Strider
  vindicator: Vindicator
  hoglin: Hoglin
  enderman: Enderman
  zoglin: Zoglin
  cave spider: Cave spider
  husk: Husk
  cow: Cow
  pig: Pig
  silverfish: Silverfish
  snowman: Snowman
  panda: Panda
  goat: Goat
  salmon: Salmon
  parrot: Parrot
  piglin brute: Piglin brute
  ender dragon: Ender dragon
  polar bear: Polar bear
  magma cube: Magma cube
  dolphin: Dolphin
  vex: Vex
  blaze: Blaze
  llama: Llama
  slime: Slime
  rabbit: Rabbit
gui:
  player select:
    items:
      player:
        name: <GRADIENT:fc67fa>&l%player_name%</GRADIENT:f4c4f3>
        lore:
          - ''
          - '&e&lClick &8» &7To select player'
    title: <GRADIENT:fc67fa>&lSpawners</GRADIENT:f4c4f3> &8> &7Select Player
  admin main:
    items:
      spawner presets:
        name: <GRADIENT:fc67fa>&LSpawner Presets</GRADIENT:f4c4f3>
        lore:
          - '&7View all created spawner presets'
          - ''
          - '&e&lClick &8» &7To view presets'
      level:
        lore:
          - '&7View all the known levels'
          - ''
          - '&e&lClick &8» &7To view levels'
        name: <GRADIENT:fc67fa>&lLevels</GRADIENT:f4c4f3>
      spawners:
        lore:
          - '&7View all the known spawners'
          - ''
          - '&e&lClick &8» &7To view player spawners'
        name: <GRADIENT:fc67fa>&lSpawners</GRADIENT:f4c4f3>
      spawner shop:
        name: <GRADIENT:fc67fa>&LSpawner Shop</GRADIENT:f4c4f3>
        lore:
          - '&7View all spawner shop items'
          - ''
          - '&e&lClick &8» &7To edit shop'
    title: <GRADIENT:fc67fa>&LSpawners</GRADIENT:f4c4f3> &7v%plugin_version%
  spawner overview:
    items:
      spawn count:
        name: <GRADIENT:fc67fa>&lSpawn Count</GRADIENT:f4c4f3>
        lore max:
          - ''
          - '&aSpawn count is at max level!'
          - ''
        lore:
          - ''
          - '&7Current&f: &a%level_number% &f(&e%level_value%&f)'
          - ''
          - '&e&lNext Level'
          - '    &7Level&f: &a%next_level_number% &f(&e%next_level_value%&f)'
          - '    &7Cost&f: &a$%level_upgrade_cost%'
          - ''
          - '&e&lClick &8» &7To upgrade'
      max nearby mobs:
        lore max:
          - ''
          - '&aMax nearby mobs is at max level!'
          - ''
        lore:
          - ''
          - '&7Current&f: &a%level_number% &f(&e%level_value%&f)'
          - ''
          - '&e&lNext Level'
          - '    &7Level&f: &a%next_level_number% &f(&e%next_level_value%&f)'
          - '    &7Cost&f: &a$%level_upgrade_cost%'
          - ''
          - '&e&lClick &8» &7To upgrade'
        name: <GRADIENT:fc67fa>&lMax Nearby Mobs</GRADIENT:f4c4f3>
      delay:
        lore max:
          - ''
          - '&aSpawner delay is at max level!'
          - ''
        name: <GRADIENT:fc67fa>&lSpawn Delay</GRADIENT:f4c4f3>
        lore:
          - ''
          - '&7Current&f: &a%level_number% &f(&e%level_value%&as&f)'
          - ''
          - '&e&lNext Level'
          - '    &7Level&f: &a%next_level_number% &f(&e%next_level_value%&as&f)'
          - '    &7Cost&f: &a$%level_upgrade_cost%'
          - ''
          - '&e&lClick &8» &7To upgrade'
      activation range:
        lore max:
          - ''
          - '&aActivation range is at max level!'
          - ''
        name: <GRADIENT:fc67fa>&lActivation Range</GRADIENT:f4c4f3>
        lore:
          - ''
          - '&7Current&f: &a%level_number% &f(&e%level_value%&f)'
          - ''
          - '&e&lNext Level'
          - '    &7Level&f: &a%next_level_number% &f(&e%next_level_value%&f)'
          - '    &7Cost&f: &a$%level_upgrade_cost%'
          - ''
          - '&e&lClick &8» &7To upgrade'
      owner:
        name: <GRADIENT:fc67fa>&lOwner</GRADIENT:f4c4f3>
        lore:
          - ''
          - '&7Current&f: &e%owner_name%'
          - ''
          - '&e&lClick &8» &7To transfer ownership'
      entity:
        name: <GRADIENT:fc67fa>&lEntity Type</GRADIENT:f4c4f3>
        lore:
          - ''
          - '&7Current&f: &e%entity_type%'
          - ''
          - '&e&lClick &8» &7To change entity'
      upgrade disabled:
        name: '&C&LUpgrade Disabled'
        lore:
          - '&cYou are not allowed to upgrade'
          - '&cthis particular spawner!'
    title: <GRADIENT:fc67fa>&lSpawner</GRADIENT:f4c4f3> &8> &7Overview
  spawner shop:
    items:
      spawner:
        name: <GRADIENT:fc67fa>&l%entity_type% Spawner</GRADIENT:f4c4f3>
        lore:
          - ''
          - '&7Price&f: &a%shop_item_price%'
          - '&7Quantity&f: &a%shop_item_qty%'
          - ''
          - '&e&lLevels'
          - '    &7Spawn Delay&f: &a%spawn_delay_level% &f(&e%spawn_delay%&as&f)'
          - '    &7Spawn Count&f: &a%spawn_count_level% &f(&e%spawn_count%&f)'
          - '    &7Max Nearby Mobs&f: &a%max_nearby_entities_level% &f(&e%max_nearby_entities%&f)'
          - '    &7Activation Range&f: &a%activation_range_level% &f(&e%activation_range%&f)'
          - ''
          - '&e&lClick &8» &7To purchase item'
    title: <GRADIENT:fc67fa>&lSpawner Shop</GRADIENT:f4c4f3>
  main:
    items:
      shop:
        lore:
          - ''
          - '&e&lClick &8» &7To view shop'
        name: <GRADIENT:fc67fa>&lSpawner Shop</GRADIENT:f4c4f3>
      your spawners:
        name: <GRADIENT:fc67fa>&lYour Spawners</GRADIENT:f4c4f3>
        lore:
          - ''
          - '&7Total&f: &e%total_placed_spawners%'
          - ''
          - '&e&lClick &8» &7To view placed spawners'
    title: <GRADIENT:fc67fa>&lSpawners</GRADIENT:f4c4f3>
  entity change:
    title: <GRADIENT:fc67fa>&lSpawners</GRADIENT:f4c4f3> &8> &7Change Mob
    items:
      entity:
        lore:
          - ''
          - '&7Cost&f: &a$%entity_cost%'
          - ''
          - '&e&lClick &8» &7To select entity'
        name: <GRADIENT:fc67fa>&l%entity_name%</GRADIENT:f4c4f3>
  confirm:
    items:
      cancel:
        name: '&c&lCancel'
        lore:
          - ''
          - '&c&lClick &8» &7To cancel action'
      confirm:
        lore:
          - ''
          - '&e&lClick &8» &7To confirm action'
          - '&c(This cannot be undone)'
        name: '&A&LConfirm'
    title: <GRADIENT:fc67fa>&lSpawners</GRADIENT:f4c4f3> &8> &7Confirm
  entity selector:
    items:
      entity:
        name: <GRADIENT:fc67fa>&l%entity_name%</GRADIENT:f4c4f3>
        lore:
          - ''
          - '&e&lClick &8» &7To select entity'
      mode:
        lore:
          - '&8Entity Behaviour'
          - ''
          - '&7Current&f: &e%entity_behaviour%'
          - ''
          - '&e&lClick &8» &7To switch mode'
        name: '&a&lSwitch Mode'
    title: <GRADIENT:fc67fa>&lSpawners</GRADIENT:f4c4f3> &8> &7Select Entity
  your spawners:
    items:
      spawner:
        lore:
          - ''
          - '&e&lLocation'
          - '    &7%world_name% &F/ &7%world_x% &f/ &7%world_y% &f/ &7%world_z%'
          - ''
          - '&e&lLevels'
          - '    &7Spawn Delay&f: &a%spawn_delay_level% &f(&e%spawn_delay%&as&f)'
          - '    &7Spawn Count&f: &a%spawn_count_level% &f(&e%spawn_count%&f)'
          - '    &7Max Nearby Mobs&f: &a%max_nearby_entities_level% &f(&e%max_nearby_entities%&f)'
          - '    &7Activation Range&f: &a%activation_range_level% &f(&e%activation_range%&f)'
          - ''
        name: <GRADIENT:fc67fa>&lSpawner</GRADIENT:f4c4f3>
    title: <GRADIENT:fc67fa>&lSpawners</GRADIENT:f4c4f3> &8> &7Your Spawners
misc:
  player not found: '&cThe player &4%player% &cis not online!'
  prev page: '&ePrevious Page'
  is false: '&cFalse'
  is disallowed: '&cDisallowed'
  need to create levels: '&cYou need to create 1 level for each upgrade first.'
  money remove: '&c&l- $%amount%'
  not a spawner: '&cThat block is not a spawner!'
  is allowed: '&aAllowed'
  no inventory space: '&cYou do not have enough inventory space.'
  spawner place limit reached: '&cYou cannot place anymore spawners!'
  no presets made: '&cThere are no presets currently made.'
  not a number: '&cThat is not a valid number'
  updated spawn type: '&aSuccessfully set spawner''s entity type to&f: &e%entity_type%'
  preset id taken: '&cThe preset id&f: &4%preset_id% &cis already in use.'
  next page: '&eNext Page'
  entity remove:
    entity: '&cRemoved a total of &4%total% %entity_type% &cspawner mobs.'
    all: '&cRemoved a total of &4%total% &cspawner mobs.'
  is true: '&ATrue'
  spawner per chunk limit reached: '&cYou cannot place anymore spawners within this
    chunk!'
  not enough money: '&cYou do not have enough money!'
spawner:
  name: '&e%entity_type% Spawner'
  not owner:
    place: '&cYou are not allowed to place &4%owner_name%&c''s spawner!'
    break: '&cYou are not allowed to break &4%owner_name%&c''s spawner!'
    overview: '&cYou are not the owner of this spawner!'
    egg change: '&cYou cannot use eggs &4%owner_name%&c''s spawner!'
  entity permission:
    place: '&cYou are not allowed to place &4%entity_type%&c spawners!'
    break: '&cYou are not allowed to break &4%entity_type%&c spawners!'
    egg change: '&cYou cannot change spawners with &4%entity_type%&c eggs!'
  upgrade:
    upgraded:
      nearby mobs: '&aUpgraded max nearby mobs from level &F%previous_level% &ato
        &f%current_level%'
      entity type: '&aSuccessfully converted spawner mob to&f: &f%entity_type%'
      activation range: '&aUpgraded activation range from level &F%previous_level%
        &ato &f%current_level%'
      delay: '&aUpgraded delay from level &F%previous_level% &ato &f%current_level%'
      spawn count: '&aUpgraded spawn count from level &F%previous_level% &ato &f%current_level%'
    max:
      activation range: '&cThe spawner is already at the max activation range'
      delay: '&cThe spawner is already at the max spawn delay'
      spawn count: '&cThe spawner is already at the max spawn count'
      nearby mobs: '&cThe spawner is already at the max nearby mobs'
  requires pickaxe: '&cYou need a pickaxe to mine spawners!'
  gave ownership: '&aYou transferred ownership to &2%player_name%'
  requires silk touch: '&cYou need silk touch to mine spawners!'
  no owner: No Owner
  received ownership: '&2%player_name% &Agave you ownership of their spawner'
  lore:
    - '&8Owner'
    - '&e%spawner_owner_name%'
    - ''
    - '&7Spawn Delay &8» &e%spawner_spawn_delay_level%'
    - '&7Spawn Count &8» &e%spawner_spawn_count_level%'
    - '&7Max Nearby Entities &8» &e%spawner_max_nearby_entities_level%'
    - '&7Activation Range &8» &e%spawner_player_activation_range_level%'
    - ''
    - '&e&lPlace &8» &7To activate spawner'
no egg throw permission: '&cYou are not allowed to throw &4%entity_type%&c eggs!'

# This is the default language for Funds to use another language
# change the default language in the config.yml
# if the file does not exists, it will generate using the default english
# translations, you can then make edits from there.
file language: english
```


# Crafty

Crafty is a simple yet powerful solution to creating custom recipes and mob/block drops.


# Commands & Permissions

Crafty is an admin tool, 99% of the things will be done through the main command

| Command                   | Permission         | Description                                                         |
| ------------------------- | ------------------ | ------------------------------------------------------------------- |
| /crafty                   | crafty.command     | The main command for the plugin. Opens the admin menu.              |
| /shops new \<Recipe Type> | crafty.command.new | A quick way to open the custom recipe creator for a specific block. |

**Valid \<Recipe Type>**

* crafting
* furnace
* blastfurnace
* campfire
* smoker

Example: ***/craft new furnace*** will open the crafting table recipe creator directly


# Mob & Blocks

With Crafty you can adjust the drops for any valid block and mob

**Shared Options**&#x20;

* **Drop Default Items** - If this is enabled, then blocks and mobs will no longer drop their default items.
* **Blocked Worlds** - These are worlds where Crafty will ignore any custom drops/changes to mobs/blocks.

**Drop Options**

* **Mobs** - When adding a drop to a mob, you will be able to toggle whether it gets dropped from naturally spawned mobs, mobs spawned in from an egg or from mobs spawned from a spawner.
* **Blocks** - When adding a drop to a block, you will be able to toggle if the drop is dropped from naturally spawned blocks and if they should drop from user placed blocks. &#x20;

**NOTICE:** By default any user placed blocks before the plugin is installed will be considered natural since Crafty tags user placed blocks manually.

For more information about drops see [**Drops**](/official-plugins/crafty/drops)


# Drops

Drops are items or commands that will be executing when a mob is killed or a block is broken.

**Base Options**

* **Item**: An item drop is an item you specify that will be dropped after killing a mob or block break
* **Commands**: As with the item drop, commands are just ran by the console. You can add as many commands as you want to a single drop.&#x20;
* **Chance**: This is pretty much just the chance of the item dropping / commands being run.&#x20;

**Conditions**

Conditions are optional to a drop, they are there to help make drops more "customizable" in the sense that specific things may be needed / met before the drop can even execute.

**List Of Drop Conditions:**

* **Minimum Players** - The minimum amount of players that must be online for a drop to activate&#x20;
* **Maximum Players** - Like the minimum # of players, if the max is exceeded the drop won't happen.
* **Mob Name** - Only shown when the drop is being added to a mob. If the mob doesn't have the specificized name, the drop will not execute.
* **Item** - A specific item that must be used to killed/break the mob/block to get the item.&#x20;
* **Permission** - The permission that a player must have for the drop to activate&#x20;
* **Enchantments** - If you aren't using a custom item condition, the item used to kill / break the mob/block must have any enchantment you select
* **Effects** - The potion effects that the player must have active for the drop to be obtained.

**(!) Item & Enchantment Conditions Conflict**

If you want to use a specific item, you will have to un-select the enchantments as they will conflict with each other.


# Custom Recipes

With Crafty, creating custom recipes is a pretty simple process

Currently you can create recipes for the following blocks:&#x20;

* Crafting Table
* Furnace
* Blast Furnace&#x20;
* Smoker
* Camp Fire

## **Creating A Recipe**

There are two different recipe creation menus in Crafty at the moment. One is for crafting table recipes and the other one is for cooking recipes (furnace, blast furnace, smoker and campfire).&#x20;

**Crafting Recipe Creator**

<figure><img src="https://593513551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MUFPaPRYe0Hg6oS4Dif%2Fuploads%2FXmEE0Ww9Mm5KBoGF9LEY%2FScreenshot_3.png?alt=media&amp;token=25e6f780-cc0c-4267-848b-bf08039add10" alt=""><figcaption><p>Crafting Recipe Creator</p></figcaption></figure>

1. Is the crafting recipe shape, place the items in the fake crafting grid how you want the recipe to be shaped.&#x20;
2. Place the item you want users to receive if they following the recipe shape
3. The toggle button to make the recipe shapeless, this means that the you just need to place one of each item in any slot for the item to be crafted
4. The create button for the creator, it will give you an error if the recipe name is taken
5. The recipe name, every single recipe regardless if its a crafting, smoker, furnace, etc must have a unique name otherwise it cannot be registered.

**Cooking Recipe Creator (Furnace, Blast Furnace, Smoker, Campfire)**

<figure><img src="https://593513551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MUFPaPRYe0Hg6oS4Dif%2Fuploads%2F5ZAkr8V4F2lK8TPksEKj%2FScreenshot_5.png?alt=media&amp;token=72d806d3-6a4d-4a6c-a227-52aca6f73ff5" alt=""><figcaption><p>Cooking Recipe Creator</p></figcaption></figure>

1. The item you will be placed into **Furnace, Blast Furnace, Smoker, or Campfire**
2. The item that will be produced / given to the player
3. The recipe, like the crafting recipe, it must be unique
4. The total amount of experience the player will receive everytime x1 of the item gets cooked / smelted
5. The create button, just like the crafting recipe creator it will give you an error if the recipe name is not changed/unique&#x20;
6. The total cooking time for the item in ticks. 20 ticks is equal to 1 second


# Funds

Funds the is the ultimate custom currency plugin


# Skulls

Skulls is a collection of 45k+ custom textured Minecraft heads. It is the perfect solution for servers who need a quick an easy way to access a large variety of custom textured heads.

### Features

* Customizable
* Search for heads by their name or tags
* GUI Based meaning that 90% of the things you do will be done in game.
* Favourite system, if you like a head you can simply favourite it later.
* Custom categories, need to organize heads better? Just make a new category and add the head.
* …and so much more.

### Developer API / Methods

* Skulls.getAPI()

```java
public interface SkullsAPI {

	/**
	 * Gets the skull with the given id.
	 *
	 * @param id The id of the skull.
	 * @return A skull object.
	 */
	Skull getSkull(final int id);

	/**
	 * It returns a skull item with the specified id
	 *
	 * @param id The id of the skull.
	 * @return An ItemStack
	 */
	ItemStack getSkullItem(final int id);

	/**
	 * Get all the skulls in the given category.
	 *
	 * @param category The category to get the skulls from.
	 * @return A list of Skulls.
	 */
	List<Skull> getSkulls(@NonNull final BaseCategory category);

	/**
	 * Get a list of skulls from the specified category.
	 *
	 * @param category The category of the skull you want to get.
	 * @return A list of Skulls.
	 */
	List<Skull> getSkulls(@NonNull final String category);

	/**
	 * This returns a list of skulls that match the given search phrase.
	 *
	 * @param phrase The phrase to search for.
	 * @return A list of Skulls that match the search phrase.
	 */
	List<Skull> getSkullsBySearch(@NonNull final String phrase);

	/**
	 * This returns a list of skulls, given a list of IDs.
	 *
	 * @param ids The list of ids to get the skulls for.
	 * @return A list of Skulls.
	 */
	List<Skull> getSkulls(@NonNull final List<Integer> ids);

	/**
	 * It returns the number of skulls in the given category.
	 *
	 * @param category The category of the skull.
	 * @return The number of skulls in the category.
	 */
	long getSkullCount(@NonNull final String category);

	/**
	 * Finds a SkullUser object for the given player.
	 *
	 * @param player The player to find the skull of.
	 * @return A SkullUser object.
	 */
	SkullUser findPlayer(@NonNull final Player player);

	/**
	 * Finds a player by their UUID
	 *
	 * @param uuid The UUID of the player you want to find.
	 * @return A SkullUser object.
	 */
	SkullUser findPlayer(@NonNull final UUID uuid);

	/**
	 * Find a category by its ID.
	 *
	 * @param id The id of the category to find.
	 * @return A Category object
	 */
	Category findCategory(@NonNull final String id);

	/**
	 * Get a list of all the custom categories.
	 *
	 * @return A list of categories.
	 */
	List<Category> getCustomCategories();
}

```

### Source Code

To view the source code for this plugin click this link: <https://www.github.com/tweetzy/skulls>


# Commands & Permissions

A complete list of all the commands and permissions that can be used in the plugin.

| Command                                    | Permission                                                                                                     | Description                                                                                               |
| ------------------------------------------ | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| /skulls                                    | none                                                                                                           | Open the Skulls menu                                                                                      |
| /skulls search \<keywords>                 | skulls.command.search                                                                                          | Search for a specific head (search tags and the name by default)                                          |
| /skulls inspect                            | skulls.command.inspect                                                                                         | Used to inspect a held skull or skull block to determine it's id                                          |
| /skulls give <\*/player> \<random/id> \[#] | skulls.command.give                                                                                            | Gives player(s) a random or specific quantity of skulls                                                   |
| /skulls phead \[player] \[#] \[target]     | skulls.command.phead                                                                                           | Gives user their own head or head of another player, adding target name gives head to target.             |
|                                            | skulls.command.main                                                                                            | Allows the player to use /skulls to open the main menu assuming the main menu require permission is false |
|                                            | skulls.admin                                                                                                   | Allows the user to create new categories, access settings and see patreon link                            |
|                                            | skulls.category.\<alphabet,animals,blocks,decoration,fooddrinks,humans,humanoid,miscellaneous,monsters,plants> | Allows user access to base category                                                                       |
|                                            | skulls.search                                                                                                  | Allows user to use the search button in the main gui                                                      |
|                                            | skulls.favourites                                                                                              | Allows the user to use the favourites button in the main gui                                              |
|                                            | skulls.favourite                                                                                               | Allows user to favourite a skull                                                                          |
|                                            | skulls.buyblocked                                                                                              | Allows user to buy blocked skulls                                                                         |
|                                            | skulls.freeskulls                                                                                              | Allows user to take skulls for free (assuming you have charge for heads on)                               |
|                                            | skulls.customcategory.\<category id>                                                                           | Allows user to access a custom made category                                                              |


# Plugin Files

Files that are generated by the plugin (Head JSON Files download into a heads folder)

### confi&#x67;**.yml**

```yaml
# Default language file
language: english
# Prefix to be used in chat
prefix: <GRADIENT:DD5E89>&lSkulls</GRADIENT:fbc7d4>&r &8»
# Should skulls charge users without permission for heads?
charge for heads: true
# You can use Vault or Item
economy: Vault
item economy item: GOLD_INGOT
enabled categories:
  alphabet: true
  animals: true
  blocks: true
  decoration: true
  food and drinks: true
  humans: true
  humanoids: true
  misc: true
  monsters: true
  plants: true
player head:
  name: '&e%player_name%'
  drop enabled: true
  drop chance: 50
gui:
  main:
    items:
      alphabet:
        slot: 11
      animals:
        slot: 12
      blocks:
        slot: 13
      decoration:
        slot: 14
      food and drinks:
        slot: 15
      humans:
        slot: 20
      humanoids:
        slot: 21
      misc:
        slot: 22
      monsters:
        slot: 23
      plants:
        slot: 24
default prices:
  alphabet: 1.0
  animals: 1.0
  blocks: 1.0
  decoration: 1.0
  food and drinks: 1.0
  humans: 1.0
  humanoids: 1.0
  misc: 1.0
  monsters: 1.0
  plants: 1.0
```

### englis&#x68;**.yml**

```yaml
misc:
  player not found: '&cThat category id is already in use!'
  not a number: '&cThat is not a valid number'
  no skull info: '&cCould not determine ID of that skull'
  no permission: '&cYou do not have permission to use that!'
  is false: '&cFalse'
  is disallowed: '&cDisallowed'
  skull not found: '&cNo skull by that id could be found'
  is true: '&ATrue'
  is allowed: '&aAllowed'
  category permission: '&cYou do not have permission to access that category!'
  not enough money: '&cYou do not have enough money!'
input:
  skull edit:
    title: '&eEditing Skull'
    price: '&fEnter the new skull price'
    name: '&FEnter the new name skull name'
  skull search:
    subtitle: '&fEnter search terms into chat'
    title: '&eSkull Search'
  category create:
    subtitle: '&fEnter id for new category'
    title: '&eCategory Creation'
categories:
  decoration: Decoration
  plants: Plants
  monsters: Monsters
  misc: Miscellaneous
  humans: Humans
  food and drinks: Food & Drinks
  alphabet: Alphabet
  animals: Animals
  blocks: Blocks
  humanoids: Humanoids
gui:
  custom category list:
    items:
      new:
        lore:
          - ''
          - '&e&lClick &8» &7To create new category'
        name: <GRADIENT:DD5E89>&lNew Category</GRADIENT:fbc7d4>
      category:
        lore:
          - '&8View heads by this category'
          - '&7Total Heads&F: &b%category_size%'
          - ''
          - '&e&lClick &8» &7To view category'
        name: '%category_name%'
    title: '&eSkulls &8> &7Custom Categories'
  skulls list:
    title:
      all: '&eSkulls &8> &7All'
      favourites: '&eSkulls &8> &7Favourites'
      search: '&eSkulls &8> &7%search_phrase%'
      category: '&eSkulls &8> &7%category_name%'
    items:
      skull:
        lore:
          un favourite: '&e&lRight Click &8» &7To unfavourite head'
          price: '&7Cost: &a$%skull_price%'
          blocked: '&c&oPurchase is blocked'
          favourited: '&e&lFAVOURITED'
          id: '&7Id: &e%skull_id%'
          tags: '&7Tags: &e%skull_tags%'
          take: '&e&lLeft Click &8» &7To take one'
          favourite: '&e&lRight Click &8» &7To favourite head'
          edit: '&b&lPress 1 &8» &7To edit this skull'
        name: '&e%skull_name%'
  edit:
    title: '&eSkulls &8> &7Edit &8> &7%skull_id%'
    items:
      name:
        lore:
          - ''
          - '&e&lClick &8» &7To change skull name'
        name: <GRADIENT:DD5E89>&lSkull Name</GRADIENT:fbc7d4>
      price:
        lore:
          - ''
          - '&e&lClick &8» &7To edit skull price'
        name: <GRADIENT:DD5E89>&lSkull Price</GRADIENT:fbc7d4>
      add category:
        lore:
          - ''
          - '&e&lClick &8» &7To add to another category'
        name: <GRADIENT:DD5E89>&lAdd To Category</GRADIENT:fbc7d4>
      blocked:
        lore:
          - ''
          - '&7Blocked&f: %is_true%'
          - ''
          - '&e&lClick &8» &7To toggle block status'
        name: <GRADIENT:DD5E89>&lSkull Blocked</GRADIENT:fbc7d4>
  histories:
    items:
      history:
        name: '&e%history_id%'
        lore:
          - ''
          - '&7Total Heads&f: &a%history_size%'
          - '&7Downloaded&f: %is_true%'
          - '&7Time&f: &a%history_time%'
          - ''
          - '&e&lClick &8» &7To download heads'
    title: '&eSkulls &8> &7Histories'
  main:
    items:
      search:
        lore:
          - ''
          - '&e&lClick &8» &7To search for heads'
        name: <GRADIENT:DD5E89>&lSearch</GRADIENT:fbc7d4>
      custom categories:
        lore:
          - ''
          - '&e&lClick &8» &7To view more categories'
        name: <GRADIENT:DD5E89>&lMore Categories</GRADIENT:fbc7d4>
      category:
        lore:
          - '&8View heads by this category'
          - '&7Total Heads&F: &b%category_size%'
          - ''
          - '&e&lClick &8» &7To view category'
        name: '&e%category_name%'
      favourites:
        lore:
          - '&7A collection of every single head'
          - '&7that you have favourited.'
          - ''
          - '&e&lClick &8» &7To view your favourites'
        name: <GRADIENT:DD5E89>&lFavourites</GRADIENT:fbc7d4>
    title: '&eSkulls'
  custom category selector:
    title: '&eSkulls &8> &7Select Category'
    items:
      category:
        lore:
          - '&e&lClick &8» &7To select category'
        name: '%category_name%'
skull:
  name: '&e%skull_name%'
inspect info:
  - '&8&m-----------------------------------------------------'
  - ''
  - '&eSkull ID&f: &a%skull_id%'
  - ''
  - '&8&m-----------------------------------------------------'

# This is the default language for Skulls to use another language
# change the default language in the config.yml
# if the file does not exists, it will generate using the default english
# translations, you can then make edits from there.
file language: english
```


# Vouchers

Vouchers is designed to make creating vouchers easy. Everything is done in-game through the use of GUIs, meaning you will never need to leave your client to edit the config, or vouchers.

### Features

* Unlimited vouchers can be created
* Unlimited broadcast messages
* Unlimited player messages
* Unlimited commands
* Complete in-game editor for vouchers

### Source Code

To view the source code for this plugin click this link: <https://www.github.com/tweetzy/vouchers>


# Commands & Permissions

A complete list of all the commands and permissions that can be used in the plugin.

| Command                                                 | Permission                    | Description                                         |
| ------------------------------------------------------- | ----------------------------- | --------------------------------------------------- |
| /vouchers                                               | vouchers.admin                | Main command to access admin menu                   |
| /vouchers give \<player/\*> <#> \<voucherId> \[-a args] | vouchers.command.give         | Grants access to the voucher give command           |
| /vouchers import                                        | vouchers.command.import       | Imports a v2 export into v3                         |
| /vouchers reload                                        | vouchers.command.reload       | Reloads the setting and translation files           |
| /vouchers clearredeems \<player/\*> \<voucherId>        | vouchers.command.clearredeems | Clears the redeem history for player(s)             |
| /vouchers export \[confirm]                             | vouchers.command.export       | Used to export vouchers into json files for editing |
| /vouchers sync \<voucherId/\*>                          | vouchers.command.sync         | Used to sync exported files or newly created ones.  |
|                                                         | vouchers.admin                | Gives admin access to the voucher plugin.           |


# Additional Args

A quick explanation on how to use custom args

**Take this picture for example**

When adding/creating lore, editing a voucher name, or adding commands. You are now able to use {#} to represent a custom parameter you provide during the give command.

<figure><img src="https://i.gyazo.com/d32a4bfe38a276827a0e3f9a062a4f4f.png" alt=""><figcaption></figcaption></figure>

**Command Example**

/vouchers give ItsMeKiran 1 money -a cad 5000

**Execution Result**

<figure><img src="https://i.gyazo.com/062077ea272f9bbafa86ca1a2b6d67ab.png" alt=""><figcaption></figcaption></figure>

Adding **cad** and **5000** to the give command after the voucher id, targets the corresponding index. So effectively, when the user redeems the voucher, the command that will be ran will convert to

**funds pay ItsMeKiran 5000 cad**

You can how unlimited arguments, but you will need to also provide them when using the give command for that particular voucher.


# Export & Syncing

A quick explanation on export and syncing works

**Before you run the export command, understand that you will likely receive no support when editing the voucher file directly as the GUI editor is the intended way.**

* **/Vouchers export confirm** - This will export all the currently created vouchers into a vouchers folder. Each voucher will be created as a json file. Example "money.json, rank1.json" etc.
* **/Vouchers sync \<voucherId/\*> -** This will allow you to sync all or a specific voucher/file back into vouchers. If you create a new voucher file and it does not exists in the Voucher's database, Vouchers will attempt to create and save it assuming you configured the file correctly.&#x20;

### **Important Sync Information**

**When running the sync command, it WILL OVERRIDE** the settings of any voucher(s) in the database that shares the id. It's suggested that you add all your item rewards first in game, then run the export command since it's easier to configure items that way. But if you are comfortable editing items as json, knock yourself out.

### **Example Voucher File**

This is an example voucher file with all the possible options filled in. Depending on how you setup your voucher initially, you might be missing title/subtitle or more options. Use this a reference if you want to add something.

#### example.json

<pre class="language-json"><code class="lang-json"><strong>{
</strong>  "item": "CAKE",
  "displayName": "&#x26;bExample Voucher",
  "description": [
    "§ethis is line #1",
    "§bthis is another line"
  ],
  "rewardMode": "AUTOMATIC",
  "maxUses": -1,
  "cooldown": -1,
  "removeOnUse": true,
  "askForConfirm": true,
  "glowing": false,
  "requirePermission": true,
  "permission": "vouchers.usevoucher",
  "playSound": true,
  "sound": "ENTITY_EXPERIENCE_ORB_PICKUP",
  "broadcastMessages": [
    "&#x26;bExample broadcast mesage",
    "&#x26;e%player% &#x26;7use a voucher"
  ],
  "chatMessages": [
    "&#x26;7Example chat message to player",
    "&#x26;eOnly you can see this"
  ],
  "actionbarMessages": [
    "&#x26;aSingle message for the action bar"
  ],
  "titleMessage": {
    "message": "§eTitle Message",
    "fadeIn": 20,
    "stay": 40,
    "fadeOut": 20
  },
  "subtitleMessage": {
    "message": "§eSubtitle Message",
    "fadeIn": 20,
    "stay": 40,
    "fadeOut": 20
  },
  "rewards": [
    {
      "type": "COMMAND",
      "chance": 100.0,
      "delay": 0,
      "command": "eco give %player% 5000",
      "claimMessage": ""
    },
    {
      "type": "COMMAND",
      "chance": 100.0,
      "delay": 0,
      "command": "give %player% cake 1",
      "claimMessage": "&#x26;aYou received cake"
    },
    {
      "type": "ITEM",
      "chance": 100.0,
      "delay": 0,
      "item": "{count:1,id:\"minecraft:cake\"}"
    },
    {
      "type": "ITEM",
      "chance": 100.0,
      "delay": 0,
      "item": "{count:1,id:\"minecraft:sugar\"}"
    }
  ]
}
</code></pre>


# Plugin Files

Files that are generated by the plugin.

### settings.yml

```
Voucher List Menu:
  Title: "&eVouchers"
  Background Item: BLACK_STAINED_GLASS_PANE

Confirm Menu:
  Title: "&eConfirm Redeem"
  Rows: 3
  Background Item: BLACK_STAINED_GLASS_PANE
  Confirm Item:
    Slots: [ 14, 15, 16 ]
    Material: LIME_STAINED_GLASS_PANE
    Name: "&a&lConfirm"
    Lore:
      - ""
      - "&dClick &7to confirm redeem"
  Cancel Item:
    Slots: [ 10, 11, 12 ]
    Material: RED_STAINED_GLASS_PANE
    Name: "&c&lCancel"
    Lore:
      - ""
      - "&dClick &7to cancel redeem"

Reward Select Menu:
  Title: "&eSelect a Reward"
  # If true, vouchers will ignore that reward's chance and always give the user
  # the item they selected
  Always Give: true
  Rows: 3
  Reward Slots: [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 ]
  Background Item: BLACK_STAINED_GLASS_PANE
  Command Item: PAPER
  Command Name: "&e&lCommand Reward"
  Command Lore:
    - ""
    - "&7Command&f: &e{reward_command}"
    - ""
  Command Lore Chance:
    - ""
    - "&7Command&f: &e{reward_command}"
    - "&7Chance&f: &a{reward_chance}&f%"
    - ""

# -------------------------------------------------------------------------------------------------
# * THE FIRST ALIAS IS THE MAIN LABEL, PLEASE DO NOT REMOVE IT. *
# -------------------------------------------------------------------------------------------------
Command_Aliases: [ vouchers, voucher ]

# -------------------------------------------------------------------------------------------------
# What language should we use for messages? If it exists, the language file will be copied
# to your messages/ folder where you can edit it.
# -------------------------------------------------------------------------------------------------
Locale: en

# -------------------------------------------------------------------------------------------------
# The prefix used in front of most chat or console messages
# -------------------------------------------------------------------------------------------------
Prefix: "&8[&eVouchers&8]"

# -------------------------------------------------------------------------------------------------
# We log a console message if an operation takes over the time below (milliseconds).
# Set to -1 to disable.
# -------------------------------------------------------------------------------------------------
Log_Lag_Over_Milis: -1

# -------------------------------------------------------------------------------------------------
# Do not change this value, otherwise it will corrupt your plugin installation!
# -------------------------------------------------------------------------------------------------
Version: 1
```


# Translations

List of available translations that can be used with the plugin.

To use a specific language translation you will need to change the default language code within your config.yml. If the translation is available, the plugin will attempt to download it, otherwise if a translation file matching the Language code format is found it will read that instead!

| Language | Language Code |
| -------- | ------------- |
| English  | en\_US        |

{% hint style="info" %}
We accept user translated files, if you would like to contribute, please contact us on Discord.
{% endhint %}

### Default Language File (messages\_en.yml)

```
Voucher Creation:
  Title: "&eVoucher Creation"
  Subtitle: "&7Enter voucher id"

Voucher Edit:
  Enter Name:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new display name"

  Enter Description:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new description line"

  Enter Broadcast:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new broadcast message"

  Enter Chat Message:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new chat message"

  Enter Title:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new title"

  Enter Subtitle:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new subtitle"

  Enter Actionbar:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new actionbar"

  Enter Permission:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new permission"

  Enter Command:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new command"

  Enter Chance:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new chance"

  Enter Cooldown:
    Title: "&eVoucher Edit"
    Subtitle: "&7Enter new cooldown"

Error:
  Voucher Already Exists: "&cThe voucher: &4{voucher_id}&c already exists"
  Voucher Does Not Exist: "&cThe voucher: &4{voucher_id}&c doesn't exist"
  Chance Too High: "&cCannot set chance higher than 100%"
  Chance Too Low: "&cCannot set chance lower than 1%"
  Missing Reward Item: "&cPlease provide a reward item"
  No Permission For Voucher: "&cYou do not have permission to use that voucher"
  Did Not Get Reward: "&cYou weren't lucky enough to get that reward"
  Cooldown: "&cYou must wait &4{remaining_time}&cs before you can use that voucher"

Success:
  Voucher Created: "&aCreated new voucher with the id: &2{voucher_id}"
  Voucher Deleted: "&aDeleted voucher with the id: &2{voucher_id}"

# -------------------------------------------------------------------------------------------------
# Do not change this value, otherwise it will corrupt your plugin installation!
# -------------------------------------------------------------------------------------------------
Version: 1
```


