Configuration

Everything is in four files. Run /order reload after a change. Storage and network changes need a restart.

Order rules

These are under orders: in config.yml. Each setting is shown exactly as it is in the file, so you can search for it.

Setting	Meaning
`duration-days: 7`	How long an order stays open, in days.
`delete-after-days: 90`	When finished orders are deleted, with items nobody collected.
`default-slots: 18`	Order slots every player has.
`max-slots: 90`	Slots shown in Your Orders.
`min-price: 1` `max-price: 0`	Lowest and highest price per item. 0 means no highest price.
`tax-percent: 0`	Percentage kept from every delivery.
`allow-damaged: false`	Accept damaged tools and armour in deliveries.
`pay-offline-players: true`	Pay players who are offline right away.
`action-cooldown-ms: 300`	Minimum time between two actions by the same player.
`log-to-file: true`	Write every order, delivery, cancel, expiry and collection to `logs/`.

Delivering and collect values

Setting	Meaning
`seconds: 3` under `delivering:`	How long “Delivering...” shows. `seconds: 0` delivers right away.
`source: orders` under `collect-value:`	`source: orders`: the best price an open order pays. `source: sellworth`: the price in Sell & Worth’s `worth.yml`.

Storage

These are under storage: in config.yml.

Setting	Meaning
`type: sqlite`	`sqlite` (a file in the plugin folder), `mysql`, `mariadb` or `mongodb`.
`table-prefix: "orders_"`	Prefix for every table or collection.
`mysql:`	Host, port, database, username, password, SSL and pool size. Also used for MariaDB.
`mongodb:`	MongoDB `uri` and `database`.

Blacklist

These are under blacklist: in config.yml. Items that match any of them can’t be ordered or delivered.

Setting	Blocks
`materials:`	Item types, for example `BEDROCK`. Command blocks, barriers and similar are listed by default.
`custom-items: []`	Custom items as `nexo:<id>`, `oraxen:<id>` or `itemsadder:<namespace>:<id>`.
`data-keys: []`	Items carrying a plugin data key, for example `myplugin:drill`. `myplugin:*` blocks every key of that plugin.
`nbt-contains: []`	Items whose raw data contains this text.
`name-contains: []` `lore-contains: []`	Items whose name or lore contains this text. Not case sensitive.
`check-containers: true`	Also check the contents of shulker boxes and bundles.
`max-item-data: 40000`	Largest item data allowed. 0 turns it off.

Menus

In menus.yml every menu has its own section (orders, your-orders, edit-order, cancel-order, deliver, confirm-delivery, collect). Change titles, rows, slots, colors and lore there. Set a button’s slot to -1 or delete it to hide it.

The sounds are under sounds: click, page-turn, sort, refresh, order-created, delivering, delivered and deny. Each one can be a single sound or a list of sounds that play together.

Default config

Open raw config.yml

yaml

# Paste your license key below, then restart the server.
# No key yet? Join my Discord: https://discord.gg/nRjDw9k2vJ
license-key: "AP-XXXX-XXXX-XXXX-XXXX"

storage:
  # sqlite, mysql, mariadb or mongodb. Use mysql, mariadb or mongodb when several servers share orders.
  type: sqlite
  # Prefix for every table or collection.
  table-prefix: "orders_"
  mysql:
    host: localhost
    port: 3306
    database: orders
    username: root
    password: ""
    use-ssl: false
    pool-size: 6
  mongodb:
    uri: "mongodb://localhost:27017"
    database: orders

network:
  # Share orders, payouts and messages between servers through Redis. Needs mysql, mariadb or mongodb storage.
  enabled: false
  # A unique name for this server.
  server-name: "survival"
  channel: "orders"
  redis:
    host: localhost
    port: 6379
    username: ""
    password: ""
    database: 0
    use-ssl: false

orders:
  # How long an order stays open, in days.
  duration-days: 7
  # Completed, expired and cancelled orders are deleted after this many days, together with items nobody collected.
  delete-after-days: 90
  # Order slots every player has. More with the permission orders.slots.<amount>.
  default-slots: 18
  # Slots shown in Your Orders. Slots above a player's limit are shown as locked.
  max-slots: 90
  # Lowest and highest price per item. 0 means no highest price.
  min-price: 1
  max-price: 0
  # Percentage kept as tax from every delivery (0-100).
  tax-percent: 0
  # Accept damaged tools and armour in deliveries.
  allow-damaged: false
  # Pay players who are offline right away. With network enabled, they are paid when they next join.
  pay-offline-players: true
  # Minimum time between two actions by the same player, in milliseconds.
  action-cooldown-ms: 300
  # Write every order, delivery, cancel, expiry and collection to plugins/Orders/logs, with the full item data.
  log-to-file: true

delivering:
  # How long "Delivering..." shows before items are delivered, in seconds. 0 delivers right away.
  seconds: 3

collect-value:
  # The ~$ value shown in Collect Items.
  # orders: the best price an open order pays for that item right now.
  # sellworth: the price in plugins/SellWorth/worth.yml.
  source: orders

blacklist:
  # Items that can never be ordered or delivered.
  materials:
    - BEDROCK
    - BARRIER
    - COMMAND_BLOCK
    - CHAIN_COMMAND_BLOCK
    - REPEATING_COMMAND_BLOCK
    - COMMAND_BLOCK_MINECART
    - STRUCTURE_BLOCK
    - STRUCTURE_VOID
    - JIGSAW
    - LIGHT
    - DEBUG_STICK
    - KNOWLEDGE_BOOK
  # Custom items, written as nexo:<id>, oraxen:<id> or itemsadder:<namespace>:<id>.
  custom-items: []
  # Plugin data keys, for example myplugin:drill. myplugin:* blocks every key of that plugin.
  data-keys: []
  # Blocks items whose raw item data contains this text, for example "drill_size".
  nbt-contains: []
  # Blocks items whose name or lore contains this text. Not case sensitive.
  name-contains: []
  lore-contains: []
  # Also check the contents of shulker boxes and bundles.
  check-containers: true
  # Largest item data allowed, in characters. Stops oversized books and shulkers that kick players who view them.
  # A normal full shulker is far below this. 0 turns the check off.
  max-item-data: 40000

numbers:
  # Show prices as 1.2K and 3.4M. false shows 1,200 and 3,400,000.
  compact: true

choose-item:
  # Item icons next to the names in the item list.
  icons: true
  item-atlas: "minecraft:items"
  block-atlas: "minecraft:blocks"

Other default files

Open raw menus.yml Open raw messages.yml Open raw slang.yml