# Commands

**Version:** 1.0.0

Players use `/ksorder` (alias `/orders`): `/orders deliver 412` is the same as `/ksorder deliver 412`. Admins use `/ksorderadmin`. Posting an order has no chat command; it is done in the window.

`/ksorder help` and `/ksorderadmin help` list the commands in chat, in your language.

## Overview

| Command | What it does | Permission |
|---------|--------------|------------|
| `/ksorder` | Opens the order window | `ks.orders.user.open` |
| `/ksorder list [mine\|box]` | Shows the board, your orders or your pickup box in chat | `ks.orders.user.open` |
| `/ksorder deliver <no.> [amount]` | Delivers from your inventory into an order | `ks.orders.user.deliver` |
| `/ksorder withdraw <no.>` | Withdraws one of your orders | `ks.orders.user.open` |
| `/ksorder collect [no.]` | Collects your pickup box, or one entry of it | `ks.orders.user.collect` |
| `/ksorder help` | Lists the commands | `ks.orders.user.open` |
| `/ksorderadmin` | Opens the admin window (from the console: the admin help) | `ks.orders.admin` |
| `/ksorderadmin remove <no.> <reason>` | Removes an order; the unpaid rest goes back | `ks.orders.admin` |
| `/ksorderadmin expire <no.>` | Lets an order expire now | `ks.orders.admin` |
| `/ksorderadmin review [<booking> yes\|no]` | Lists the unclear bookings, or decides one | `ks.orders.admin` |
| `/ksorderadmin reload` | Reloads `config.json` and the language files | `ks.orders.admin` |
| `/ksorderadmin help` | Lists the admin commands | `ks.orders.admin` |
| `/kslang [code]` | Chooses your language for all KyuubiSoft mods | none |

Every `ks.orders.user.*` node is allowed unless you set it to `false`. Players without it get "You do not have the permission for that." The `/ksorder` commands only work for players. All `/ksorderadmin` commands also work from the server console.

Order numbers can be typed with or without `#`: `/ksorder deliver #412` and `/ksorder deliver 412` are the same.

---

## Player commands

### `/ksorder`

Opens the order window on the **Board** tab. See [UI Pages](./ui-pages).

### `/ksorder list [mine|box]`

| Form | Shows |
|------|-------|
| `/ksorder list` | The board: every open order you may see and deliver into, at most 12 lines |
| `/ksorder list mine` | Your orders, open ones first, and how many of your open orders count against the limit |
| `/ksorder list box` | Your pickup box, numbered for `/ksorder collect <no.>` |

`meine` and `abholfach` work too. A board line looks like this:

```
Order board · 8 open orders
#412 · 200 × Iron Ingot · 80/200 · 1,000 coins (5 per piece) · from Aldric · 2 d 1 h left
#415 · 64 × Oak Log · 16/64 · 320 coins (5 per piece) · from Mira · 6 h left · guild The Night Watch
```

Item rewards show "shared per piece" instead of a price. Direct orders to you end with "· to you". Server orders show "from Server". When nothing is there: "Right now nobody is looking for something you could deliver."

### `/ksorder deliver <no.> [amount]`

Delivers fresh pieces from your inventory into the order. Without an amount you deliver as many as possible: as many as the order still needs and you carry.

```
/ksorder deliver 412 34
Delivered: 34 × Iron Ingot · 170 coins paid.
```

- Only plain, undamaged pieces of the wanted item count. Enchanted, soulbound or damaged items and heirlooms are left in your inventory.
- When the reward did not fit into your wallet or inventory: "Delivered: ... · what did not fit into wallet or inventory is in your pickup box."
- When your delivery fills the order: "Order #412 is now complete."
- It fails for your own orders ("You cannot deliver into your own orders."), for guild orders of a guild you are not in, for direct orders to someone else, for blocked items, and when you carry nothing that fits ("You carry nothing that fits (only undamaged items without special properties count).").

Two people delivering into the same order at the same moment are handled one after the other. The second one gets only what is still missing, or "Order #412 is not running any more."

### `/ksorder withdraw <no.>`

Withdraws one of your own open orders. The unpaid rest of the reward goes to your pickup box; goods already delivered stay there.

```
/ksorder withdraw 412
Order #412 (200 × Iron Ingot) withdrawn. The unpaid rest is in your pickup box.
```

Withdrawing needs only `ks.orders.user.open`, the same as the **Withdraw** button in the window, so taking back your own escrow is never blocked.

### `/ksorder collect [no.]`

| Form | What it does |
|------|--------------|
| `/ksorder collect` | Collects everything that fits |
| `/ksorder collect <no.>` | Collects only entry `no.` of `/ksorder list box` |

Coins go into your wallet, items into your inventory, as many as fit. The rest stays in the box under the same entry. The answer says what you got and why something stayed, for example "Collected: 170 coins · 64 items" and "36 items stay in your pickup box: no room left in your inventory." Without a connected economy, coins stay in the box. Nothing ever drops on the ground.

### `/ksorder help`

Lists the player commands in chat.

---

## Admin commands

### `/ksorderadmin`

For a player: opens the admin window. From the console: the admin help. See [UI Pages](./ui-pages#admin-window).

### `/ksorderadmin remove <no.> <reason>`

Removes an open order. The reason is required and is kept in the protocol and with the order; the owner gets a notice with it.

```
/ksorderadmin remove 412 block list avoided
Order #412 of Aldric removed.
```

The unpaid rest of the reward goes to the owner's pickup box. For a server order, the rest lapses. Goods already delivered stay where they are.

### `/ksorderadmin expire <no.>`

The order expires now, as if its time had run out: "Order #412 has expired." The unpaid rest goes back to the owner's pickup box.

### `/ksorderadmin review [<booking> yes|no]`

Without arguments it lists the unclear bookings:

```
Unclear bookings · 1
bmh3k2x9a-1f · Delivery · Mira · 34 × Iron Ingot · order 412 · no answer within 30 s
/ksorderadmin review <booking> yes|no · yes = it really moved
```

With a booking id and a decision it settles that booking:

| Decision | Meaning |
|----------|---------|
| `yes` | The coins or items really moved. Answer: "Booking ...: confirmed as moved." |
| `no` | They did not move. Answer: "Booking ...: confirmed as not moved." |

Yes and no are understood in all nine languages of the mod, with and without accents: `yes`, `y`, `ja`, `sí`, `si`, `oui`, `sì`, `tak`, `sim`, `да`, `evet` and `no`, `n`, `nein`, `non`, `nie`, `não`, `nao`, `нет`, `hayır`, `hayir`. Check the player's inventory or wallet before you decide. See [What is an unclear booking?](./faq#what-is-an-unclear-booking)

### `/ksorderadmin reload`

Reads `config.json` and the language files again: "config.json and the language files reloaded." `integration.json` is read again within a minute.

### `/ksorderadmin help`

Lists the admin commands in chat.

---

## `/kslang`

Chooses your language for all KyuubiSoft mods: `/kslang de-DE` sets a language, `/kslang auto` follows the game language again. `/kslang` alone shows the current language and the available codes. The command is registered by the first KyuubiSoft mod that loads.