Configuration
This page explains the options in each config file so that you can understand and tweak those values to your likings.
General Configuration
Section titled “General Configuration”Documentation for a few individual configuration files.
Main Configuration (config.yml)
check-for-updates: true#
Whether to check for updates automatically using Modrinth’s API.
log-transactions: true#
Whether to log any money changes related to Orderium made by players. Currently, manually querying the database is the only way to see these logs.
expires-after: 604800000#
The time in milliseconds after which an order will expire if not completed.
minimum-price: 0.1#
The minimum amount of money the player can set as the price per item when creating an order.
max-collect: 1000#
The maximum number the player can input when collecting items from an order. Setting this value too high might let players lag your server with large orders.
max-collect-per-minute: 1000#
The maximum amount of items a player can collect every minute. Setting this value too high might let players lag your server with large orders.
similarity-check: ...#
a list of data components determines how two items should be similar. If two items have these exact same components and their values are the same respectively on both items, these items are considered similar. A 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: true#
Whether to check shulker boxes recursively for items inside when delivering items to an order.
broadcast-order-creation: true#
Whether to broadcast a message to all players when a player creates a new order.
order-command-aliases: # - order
- orders
A list of aliases for the order command to open the main GUI. Only take effects on server restart or reload.
most-money-per-item: <aqua>Most Money Per Item#
Text component to display when this sort type is selected. Formatted using MiniMessage.
recently-listed: <aqua>Recently Listed#
Text component to display when this sort type is selected. Formatted using MiniMessage.
most-delivered: <aqua>Most Delivered#
Text component to display when this sort type is selected. Formatted using MiniMessage.
most-paid: <aqua>Most Paid#
Text component to display when this sort type is selected. Formatted using MiniMessage.
a-z: <aqua>A - Z#
Text component to display when this sort type is selected. Formatted using MiniMessage.
z-a: <aqua>Z - A#
Text component to display when this sort type is selected. Formatted using MiniMessage.
most-money-per-item: Most Money Per Item#
Text component to display when this sort type is not selected. Formatted using MiniMessage.
recently-listed: Recently Listed#
Text component to display when this sort type is not selected. Formatted using MiniMessage.
most-delivered: Most Delivered#
Text component to display when this sort type is not selected. Formatted using MiniMessage.
most-paid: Most Paid#
Text component to display when this sort type is not selected. Formatted using MiniMessage.
a-z: A - Z#
Text component to display when this sort type is not selected. Formatted using MiniMessage.
z-a: Z - A#
Text component to display when this sort type is not selected. Formatted using MiniMessage.
expired: <red>Order Expired#
Determines the text to display when an order is expired. Formatted using MiniMessage.
completed: <green>Order Completed#
Determines the text to display when an order is completed. Formatted using MiniMessage.
available: <gray>Expires after <day>d <hour>h <minute>m <second>s#
Determines the text to display when an order is active. Formatted using MiniMessage.
orders-limit: - limit: 27 permission: default#
A list of objects, where each object has 2 key-value pairs. Determines how many orders a player can create before getting rejected. If a player has multiple permissions, their limit is the maximum value. The default object should not be removed.
create-order-success: <gray>Your order has been created#
Sent when the player creates an order successfully.
invalid-input: <red>Invalid number or format#
Sent when the player inputs an invalid number in a dialog.
deliver: <gray>You earned <green>$<money><gray> from delivering an order#
Sent after the player delivers items to an order.
Available placeholders:
money: The amount of money earned from the delivery.
receive-delivery: <aqua><deliverer> <gray>delivered you <aqua><deliver-amount> <item>#
Sent to the order owner when the player delivers items to an order.
Available placeholders:
- Order placeholders;
deliverer: The name of the player who delivered items;deliver-amount: The amount of items the player delivered.
not-enough-money: <red>You do not have enough money#
Sent when the player does not have enough money when creating an order.
deliver-self: <red>You cannot deliver your own order#
Sent when the player tries to deliver items to their own order.
exceeded-max-collect: <red>You are collecting too many items#
Sent when the player inputs a number that exceeds the max-collect config value when collecting items from an order.
collecting-too-fast: <red>You are collecting items too fast. Wait a minute...#
Sent when the player tries to collect items from an order but they have exceeded the max-collect-per-minute config value within the current minute.
order-creation-broadcast: <green><player> <white>has just created a new order for <green><item> <white>in <gray>/orders#
Broadcast a message to all online players when a player creates a new order.
Available placeholders:
sounds: ...#
Sound to play when certain action is performed.
config-version: 8#
DO NOT TOUCH THIS!
Config version is used by Orderium to perform migrations, so that the format of the config can be updated when new config options are added or modified.
Webhook Configuration (webhook.yml)
create-order: ...#
A Webhook Option, sends webhook when a player creates a new order. Available placeholders:
collect-items: ...#
A Webhook Option, sends webhook when a player collects items from an order. Available placeholders:
- Order placeholders;
collect-amount: The amount of items the player collected.
cancel-order: ...#
A Webhook Option, sends webhook when a player cancels an order. Available placeholders:
- Order placeholders;
earn: The amount of money the player earned as a refund after the cancellation.
deliver-order: ...#
A Webhook Option, sends webhook when a player delivers items to an order. Available placeholders:
- Order placeholders;
deliverer: The name of the player who delivered items to this order;deliver-amount: The amount of items the player delivered.
order-complete: ...#
A Webhook Option, sends webhook when an order is completed. Available placeholders:
Order placeholders
Section titled “Order placeholders”Order placeholders are placeholders provided by an order. Order placeholders include:
money-per: Price per item of the orderpaid: The total money other players have earned from this ordertotal: The amount of money the order owner spent to create this orderdelivered: The number of items other players delivered to this orderamount: The number of items the owner requested to orderin-storage: The number of items the owner can collect from this orderplayer: The name of the order ownerorder-status: The status of the orderitem: The display name of this order
Webhook Option
Section titled “Webhook Option”Webhook Option is a section for configuring settings of a webhook sending behavior.