# Commands

**Version:** 2.0.0 (not released yet)

Claims has two commands: `/ksclaim` for players (aliases `/claim` and `/claims`) and `/ksclaimadmin` for admins (alias `/claimadmin`). The short forms `/ksc` and `/ksca` of older versions are gone, because they clashed with chat commands.

- `/ksclaim` alone opens the [claims window](./ui-pages#the-claims-window). `/ksclaimadmin` alone opens the [admin window](./ui-pages#the-admin-window).
- Most commands act on the claim **you stand in**. Outside a claim they answer `Stand inside a claim for this.`
- A player name can be anyone online or anyone Claims has seen before. Claim and zone names may contain spaces, for example `/ksclaim home Sunny Farm`.
- Every player command checks its own node `ks.claims.user.<action>`, which is allowed by default. Every admin command needs `ks.claims.admin`. See [Permissions](./permissions).
- Answers come in the player's language.

---

## Player commands

| Command | What it does | Who may in the claim | Permission |
|---------|--------------|----------------------|------------|
| `/ksclaim` | Opens the claims window | everyone | `ks.claims.user.open` |
| `/ksclaim claim [name]` | Claims the chunk you stand in | everyone, within their quota | `ks.claims.user.claim` |
| `/ksclaim unclaim` | Releases the chunk you stand in | owner | `ks.claims.user.unclaim` |
| `/ksclaim info` | Shows what is here | everyone | `ks.claims.user.info` |
| `/ksclaim list` | Lists your claims and claims where you have a role | everyone | `ks.claims.user.list` |
| `/ksclaim rename <name>` | Renames the claim | right "Manage people and settings" | `ks.claims.user.rename` |
| `/ksclaim home [claim]` | Travels to the home of a claim | owner, or right "Use the home" | `ks.claims.user.home` |
| `/ksclaim sethome` | Sets the home where you stand | right "Manage people and settings" | `ks.claims.user.sethome` |
| `/ksclaim trust <player> [coowner]` | Gives a player a role | right "Manage people and settings"; Co-owner only the owner | `ks.claims.user.trust` |
| `/ksclaim untrust <player>` | Takes the role away | right "Manage people and settings"; a co-owner only the owner | `ks.claims.user.untrust` |
| `/ksclaim ban <player>` | Bans a player from the claim | right "Manage people and settings"; a co-owner only the owner | `ks.claims.user.ban` |
| `/ksclaim unban <player>` | Lifts a ban | right "Manage people and settings" | `ks.claims.user.unban` |
| `/ksclaim transfer <player>` | Offers the claim to another player | owner | `ks.claims.user.transfer` |
| `/ksclaim accept` | Takes a claim that was offered to you | the player it was offered to | `ks.claims.user.accept` |
| `/ksclaim delete` | Dissolves the claim, after a confirmation | owner | `ks.claims.user.delete` |
| `/ksclaim buychunks <amount>` | Buys extra chunks for your quota | everyone, when the economy is on | `ks.claims.user.buychunks` |
| `/ksclaim border` | Lets the border of the claim glow for you | everyone | `ks.claims.user.border` |
| `/ksclaim help` | Lists the commands | everyone | `ks.claims.user.help` |

A player whose node is set to `false` gets `You do not have permission for this.`

### Land

**`/ksclaim claim [name]`** claims the chunk you stand in.

- If the chunk touches one of your claims in this world, that claim grows. If it touches none, a new claim is made, named after you (`Mira's Land`) or with the name you give.
- If it touches several of your claims, name the one that should grow: `/ksclaim claim <name>`. Claims never merge by themselves.
- It fails on foreign land, in a server zone, in a locked world, in an instance world, too close to foreign land (when the admin set a distance), without enough quota, or at the limit of claims per player.
- With the economy on, the price of the chunk is taken first, and the answer says `Paid: ...`.

**`/ksclaim unclaim`** releases the chunk you stand in. Only the owner may. Blocks stay where they are.

- The last chunk cannot be released this way: use `/ksclaim delete`.
- A chunk whose release would split the claim into two pieces cannot be released.
- Zones lose the chunk, a home in the chunk is removed. If the chunk was paid for, the refund is paid back (`Refunded: ...`): `economy.chunkUnclaimRefund` (50 by default), but never more than was paid for it.

**`/ksclaim info`** shows the place you stand on in chat: free land and your quota, a server zone, or a claim with its owner, size, zone, your role, your rights, whether fights between players are on, and its greeting.

**`/ksclaim list`** lists your own claims (name, world, chunks), then the claims where you have a role (name, role, owner), and your quota.

**`/ksclaim rename <name>`** renames the claim you stand in. Names have 3 to 24 characters: letters, digits, spaces and `- ' . , ! ? & ( ) # + :`. Two of your claims cannot have the same name.

### Home

**`/ksclaim sethome`** sets the home of the claim you stand in, where you stand and looking where you look. The home must lie inside the claim.

**`/ksclaim home [claim]`** travels to a home:

- Without a name: if exactly one of your claims (or claims with your role) has a home, you travel there. If several have one, the answer lists them: `Which home? /ksclaim home <name> – ...`.
- The trip starts after 3 seconds (`Travelling to “Mira's Farm” in 3 s – do not move.`). Moving more than one block, getting hurt or changing worlds cancels it. After a trip you wait 10 seconds before the next one.
- Players other than the owner need the right "Use the home" at the home. Banned players never get there.

### People

**`/ksclaim trust <player> [coowner]`** gives a player a role in the claim you stand in. Without a second word the role is **Trusted**; `coowner` (also `co-owner`) makes them **Co-owner**, and `trusted` turns a co-owner back into trusted.

- Only the owner gives or takes the role Co-owner.
- A banned player must be unbanned first. The owner always has every right and cannot get a role.
- The player gets a notice `New role`.

**`/ksclaim untrust <player>`** takes the role away. The player is a visitor again.

**`/ksclaim ban <player>`** bans a player. A ban also takes the role away. The player cannot enter the claim, is pushed back to its edge and cannot travel to its home.

**`/ksclaim unban <player>`** lifts the ban.

### Hand over and dissolve

**`/ksclaim transfer <player>`** offers the claim you stand in to another player. Only the owner may, and the other player must be online. They have 5 minutes to accept.

**`/ksclaim accept`** takes the claim that was offered to you. You need enough free quota for all its chunks and a free claim slot. The old owner keeps no role. If you already own a claim with the same name, ` 2` is added to the name.

**`/ksclaim delete`** dissolves the claim you stand in. Only the owner may. The answer asks for a confirmation with a short code, valid 60 seconds:

```
/ksclaim delete
Really dissolve “Mira's Farm” with 12 chunks? Type /ksclaim delete confirm K7QPM (valid 60 s).
/ksclaim delete confirm K7QPM
“Mira's Farm” is dissolved. The blocks stay.
```

Blocks stay, the log stays for 30 days. The owner gets the refund for every chunk that was paid for.

### Quota

**`/ksclaim buychunks <amount>`** buys extra chunks for your quota with the server currency. It only works when the admin switched the economy on (`Buying chunks is off on this server.` otherwise), and only up to your maximum (`No more: 15 chunks left up to the limit.`). One chunk costs 500 by default.

### Border

**`/ksclaim border`** lets the border of the claim you stand in glow for 10 seconds: golden light pillars on its outer edges within 64 blocks of you. Only you see them. It works in every claim, not only your own.

---

## Admin commands

Every admin command and subcommand needs `ks.claims.admin`.

| Command | What it does |
|---------|--------------|
| `/ksclaimadmin` | Opens the admin window |
| `/ksclaimadmin bypass` | Ignore the protection until you log out (switches on and off) |
| `/ksclaimadmin claimfor <player>` | Claims the chunk you stand in for a player |
| `/ksclaimadmin transfer <player>` | Gives the claim you stand in to a player at once |
| `/ksclaimadmin delete` | Dissolves the claim you stand in, after a confirmation |
| `/ksclaimadmin quota <player> [bonus <n> \| bought <n>]` | Shows or changes a player's quota |
| `/ksclaimadmin inspect` | Shows every detail of the claim or server zone you stand in |
| `/ksclaimadmin reload` | Reads `config.json` and the language files again |
| `/ksclaimadmin zone create <name> [radius]` | Makes a server zone around you |
| `/ksclaimadmin zone delete <name>` | Deletes a server zone |
| `/ksclaimadmin help` | Lists the admin commands |

### Details

**`/ksclaimadmin bypass`** switches the session bypass. While it is on, you ignore every claim and closed server zone: `Protection bypass ON until you log out – you ignore every claim.` A note next to the compass and a chat line after every world change remind you. It ends when you log out. It does not change fights between players: the PvP rules apply to admins too.

**`/ksclaimadmin claimfor <player>`** claims the chunk you stand in for that player, without quota, distance, price or showcase rules. If it touches one of their claims, that claim grows.

**`/ksclaimadmin transfer <player>`** gives the claim you stand in to that player at once, without asking and without a quota check. The old owner keeps no role.

**`/ksclaimadmin delete`** works like `/ksclaim delete`, for any claim. Confirm with `/ksclaimadmin delete confirm <code>`.

**`/ksclaimadmin quota <player>`** shows the quota of a player:

```
Quota of Mira
Base 25 · growth 0 · bought 10 · bonus 5 · cap 200
Used 31 of 40 chunks · 2 of 5 claims
```

- `bonus <n>` sets the bonus chunks. They come on top of everything, also above the maximum.
- `bought <n>` corrects the number of bought chunks.
- Permission tiers are only known while the player is online. For an offline player the answer says so.

**`/ksclaimadmin inspect`** shows the claim you stand in: ID, owner, chunks and world, last activity, people with their roles, banned players, zones, settings, and what was paid for its chunks. In a server zone it shows its ID, chunks and rules.

**`/ksclaimadmin zone create <name> [radius]`** makes a server zone of the chunks around you. The radius is in chunks: `0` (the default) is the chunk you stand in, `3` makes 7 × 7 chunks. The largest radius is `general.serverZoneRadiusMax` (16). Chunks that are claimed or in another server zone are skipped and stay as they are. The name can have spaces; a number at the end is the radius.

**`/ksclaimadmin zone delete <name>`** deletes a server zone. Its chunks become free land.

**`/ksclaimadmin reload`** reads `config.json` and the language files again. The **Claims** tile in the `/ksadmin` hub has the same reload button. Changes made in the admin window are written to the file at once and need no reload.

---

## /kslang

`/kslang` has no permission node. It is shared by all KyuubiSoft mods: `/kslang <code>` sets your language, `/kslang auto` follows the game language.