Configurations

Warning

This page is outdated/unfinished. Information may be missing.

This page explains what each config field means.

config.yml

This file includes general config values.

• bstats: a true/false value determines if the plugin should send anonymous data to bstats for metrics.
• check-for-updates: a true/false value determines if the plugin should check for new updates when the plugin is enabled.
• log-transactions: a true/false value determines if the plugin should save money changes to the database. Currently there is no way to view these transactions in-game.
• expires-after: an integer value determines when an order will be expired after its creation. The unit is millisecond, default value is 7 days.
• minimum-price: a decimal value determines the minimum input for money a player can enter when creating a new order.
• max-collect: an integer value determines the limit a player can input when collecting items from an order.
• max-collect-per-minute: an integer value determines the limit to the amount of items a player can collect from their orders each minute.
• similarity-check: a list of data components determines how two items should be similar. If two items have the same type and values of these components of each item are the same respectively, they are considered similar. An item similarity check is performed when a player delivers items to an order. The plugin checks each slot in the deliver GUI to see if that item is similar to the one in the order, if an item has minecraft:container component and shulker-delivering is enabled, that container will be checked recursively.
• shulker-delivering: a true/false value. Its use case and be seen above.
• broadcast-order-creation: a true/false value determines if the plugin should broadcast a chat message to all online players when a player creates an order.
• order-command-aliases: a list of strings determines the aliases for the command that opens the main GUI (discover orders GUI). Only takes effects after a server restart or command minecraft:reload execution.
• sorts-display: determines how different sort types should be displayed when it is not selected (inactive) and selected (active).
• order-status: determines how different status of an order should be displayed
• messages: determines the messages sent after a certain action.
  • create-order-success: sent after a successful order creation
  • invalid-input: sent after an invalid input for number, or input a number exceeding the limit (e.g. abc (not a number), 1000000000000M (too big))
  • deliver: sent after a successful delivery.
    • Placeholder:
      • money: the formatted amount of money the player earned
  • receive-delivery: sent after a successful delivery to the owner of the order, if they are online.
    • Placeholders:
      • deliverer: the name of the player who delivered
      • amount: the amount of items the player delivered
      • item: the name of the item of the order
  • not-enough-money: self-explanatory
  • deliver-self: self-explanatory
  • exceeded-max-collect: relates to max-collect
  • collecting-too-fast: relates to max-collect-per-minute
  • order-creation-broadcast: relates to broadcast-order-creation
• sounds: sounds to play for certain actions, this part is quite self-explanatory.

gui/

A file in this directory includes config values related to the corresponding GUI. Some GUIs may have different variants (dialog, paged dialog, container, scrollable container) or sub-GUIs (i.e. manage order GUI)

Container GUI format

• title: a string determines the title of the GUI
• rows: an integer between 1 and 6 (inclusive) determines the amount of rows of the GUI
• buttons: section for buttons in the GUI. There are two types of buttons for container GUIs: normal button and sort button
  • normal button:
    • item: an item to represent this button in the GUI
      • id: identifier of the type of the item
      • count: amount of this item
      • components: a section determines the data of components of this item
    • slot: the slot for this button in the GUI. Starts from 0
  • sort button: Contains the item and slot field like the normal button, with an addition of the lore field
    • lore: a list of string determines the lore of the item of this button. This lore overrides the one in the components field.

Dialog GUI format

Coming soon.