# Commands

**Version:** 1.0.0

All guild commands are subcommands of `/ksguild` (aliases `/guild` and `/gilde`): `/guild invite Mira` is the same as `/ksguild invite Mira`. The guild chat has its own command `/gc`. Every command needs a player; none of them runs from the console.

`/ksguild help` lists the commands in chat, in your language. Lines for parts that are not active (for example `land` without Claims, `admin` without the admin node) are left out.

## Overview

| Command | What it does | Permission |
|---------|--------------|------------|
| `/ksguild` | Opens the guild window | `ks.guilds.user.open` |
| `/ksguild create <TAG> <name>` | Founds a guild | `ks.guilds.user.create` |
| `/ksguild invite <player>` | Invites a player | `ks.guilds.user.invite` |
| `/ksguild accept [guild or player]` | Accepts an invitation or a join request | `ks.guilds.user.accept` |
| `/ksguild deny [guild or player]` | Declines an invitation or a join request | `ks.guilds.user.deny` |
| `/ksguild join <guild>` | Joins a guild, or asks to join | `ks.guilds.user.join` |
| `/ksguild request <guild>` | Asks to join a guild | `ks.guilds.user.request` |
| `/ksguild withdraw <guild>` | Takes back your join request | `ks.guilds.user.withdraw` |
| `/ksguild leave` | Leaves your guild | `ks.guilds.user.leave` |
| `/ksguild kick <member>` | Removes a lower rank | `ks.guilds.user.kick` |
| `/ksguild promote <member>` | Raises a member by one rank | `ks.guilds.user.promote` |
| `/ksguild demote <member>` | Lowers a member by one rank | `ks.guilds.user.demote` |
| `/ksguild transfer <member> confirm` | Hands over the leadership | `ks.guilds.user.transfer` |
| `/ksguild disband confirm` | Disbands your guild | `ks.guilds.user.disband` |
| `/ksguild info [guild]` | Shows a guild in chat | `ks.guilds.user.info` |
| `/ksguild contribute` | Hands in building material for the next level | `ks.guilds.user.contribute` |
| `/ksguild help` | Lists the commands | `ks.guilds.user.help` |
| `/ksguild lock [options]` | Locks the chest or door you look at, or changes its lock | `ks.guilds.user.lock` |
| `/ksguild unlock` | Removes the lock you look at | `ks.guilds.user.unlock` |
| `/ksguild lockinfo` | Shows who owns the lock you look at | `ks.guilds.user.lockinfo` |
| `/ksguild autolock [off\|private\|guild]` | Locks new chests and doors when you place them | `ks.guilds.user.autolock` |
| `/ksguild home [1\|2]` | Travels to the guild home | `ks.guilds.user.home` |
| `/ksguild sethome [1\|2]` | Sets the guild home where you stand | `ks.guilds.user.sethome` |
| `/ksguild land add\|remove\|list` | Guild land (only with KyuubiSoft Claims 2.0) | `ks.guilds.user.land` |
| `/ksguild admin` | Opens the admin window | `ks.guilds.admin` |
| `/gc [text]` | Writes in the guild chat, or switches the guild chat on and off | `ks.guilds.user.chat` |
| `/kslang [code]` | Chooses your language for all KyuubiSoft mods | none |

Every `ks.guilds.user.*` node is allowed unless you set it to `false`. Players without it get "You lack the permission for that." The permission only decides whether a player may use the command. What a member may do inside the guild is decided by the rights of their rank, see [Permissions](./permissions).

Names with spaces work without quotes: `/ksguild join The Night Watch`. A guild can be named by its name or its tag (`/ksguild join NW`); upper and lower case do not matter.

---

## Guild and membership

### `/ksguild`

Opens the guild window. Without a guild it opens on **Found a guild**. See [UI Pages](./ui-pages).

### `/ksguild create <TAG> <name>`

Founds a guild. The tag comes first, then the name.

| Argument | Rules |
|----------|-------|
| `TAG` | 2 to 4 letters or digits; written in capitals. Must be free and not reserved (`ADM`, `MOD`, `KS`, `GM`, `DEV` by default) |
| `name` | 3 to 24 characters: letters, digits, spaces and `' - . &`. Must be free (upper and lower case do not matter) |

Names, tags and announcements with a forbidden word are refused (see [Configuration](./configuration#general)).

```
/ksguild create NW The Night Watch
```

Answer: "Guild The Night Watch [NW] founded." Without both parts: "How it works: /ksguild create <TAG> <name>, for example /ksguild create NW The Night Watch". A guild founded with the command starts with the colour Blue, the Moon crest and joining **On request**. The window lets you choose these before founding.

If the admin set a founding fee and a currency is connected, the fee is taken first and given back if founding fails.

### `/ksguild invite <player>`

Invites a player into your guild. Needs the rank right **Invite members**.

- The player can be online or offline, as long as Guilds has seen them before.
- The invitation is valid for 10 minutes (`general.inviteMinutes`). Answer: "Invitation sent to Mira · valid for 10 min."
- Inviting the same player again only renews the time; they get no second notice.
- With KyuubiSoft Whisperstone, an offline player also gets the invitation as a message on their whisper stone.

### `/ksguild accept [guild or player]` and `/ksguild deny [guild or player]`

What they answer depends on whether you are in a guild:

| You are | `accept` / `deny` | Without an argument |
|---------|-------------------|---------------------|
| Not in a guild | Accept or decline the invitation of the named guild | Answers your only invitation. With several, it lists them: "Open invitations – accept with /ksguild accept <guild>:" |
| In a guild | Accept or decline the join request of the named player | Answers the only open request. With several: "Several requests are open – type /ksguild accept <name>." |

Accepting requests needs the rank right **Accept join requests**.

### `/ksguild join <guild>`

| The guild joins | Result |
|-----------------|--------|
| Open | You are in at once: "Welcome to the guild The Night Watch." |
| On request | A request is sent: "Request sent to The Night Watch." |
| Invite only | Refused: "This guild only takes players by invitation." |

If the guild has invited you, `join` accepts that invitation, whatever the joining mode. A full guild refuses with "The guild is full (25 slots)."

### `/ksguild request <guild>`

Sends a join request. You can have one open request per guild. Guilds that only take invited players refuse it.

### `/ksguild withdraw <guild>`

Takes back your own join request.

### `/ksguild leave`

Leaves your guild. Your private locks stay yours, guild locks stay with the guild, and the experience you earned stays with the guild.

The leader cannot leave: "Hand over the leadership with /ksguild transfer first, then you can leave." A leader who is alone in the guild disbands it instead.

---

## Ranks

### `/ksguild kick <member>`

Removes a member of a lower rank. Needs the rank right **Remove lower ranks**. Works for offline members too. The removed player gets a notice, also at the next login if they are offline.

### `/ksguild promote <member>` and `/ksguild demote <member>`

Moves a member one rank up or down. Needs the rank right **Promote and demote, up to below their own rank**.

- Only works on lower ranks, and promotes at most to one rank below your own.
- The order is Novice, Member, Veteran (from level 6), Officer. Nobody is promoted to Leader; the leadership is handed over.
- Answer: "Juno is now Officer." (with the guild's own rank name).

### `/ksguild transfer <member> confirm`

Hands over the leadership. Only the leader can do it. Without `confirm` it only says what would happen:

```
/ksguild transfer Mira
Mira would lead the guild and you become Officer. Confirm with /ksguild transfer Mira confirm
```

The old leader becomes Officer.

### `/ksguild disband confirm`

Disbands the guild. Only the leader can do it. Without `confirm` it only explains what happens:

> This disbands The Night Watch for everyone. Guild locks go to you, the storage must be empty. Confirm with /ksguild disband confirm

- The guild storage must be empty, and nobody may have it open.
- All guild locks become private locks of the leader.
- Guild land goes back to the owners of the claims.
- Every member gets a notice, offline members at their next login.

---

## Information

### `/ksguild info [guild]`

Shows a guild in chat: name and tag, level and experience, leader, members (with how many are online), the joining mode and the announcement. Without an argument it shows your own guild. Without a guild it tells you how to found or join one, and how many invitations are open.

### `/ksguild contribute`

Hands in building material for the next level from your inventory. For each material only what is still missing is taken; the rest stays with you.

```
412 pieces handed in · build 82 % done.
```

When experience and material are both complete, the guild reaches the next level at once: "The guild is level 5 now!" It fails when the level system is off, the guild has the highest level, nothing is missing ("No material is missing for the next level.") or you carry nothing that is missing ("You carry nothing that is still missing.").

### `/ksguild help`

Lists the guild commands in chat.

---

## Locks

All lock commands work on the block you look at, within 10 blocks. Lockable are containers (chests, barrels, cupboards, crates) and doors and gates, as far as the admin allows them. Anything else answers "... cannot be locked. Containers and doors can."

### `/ksguild lock`

Without words it opens the lock window for the block you look at: new lock, or change of an existing one. See [UI Pages](./ui-pages#lock-window).

- On a block with a lock you may not change: "... has a lock you may not change." plus who owns it.
- On a new lock for a chest that somebody else set down: "Someone else set down .... Only that person can lock it." The exceptions are players with `ks.guilds.admin` or `ks.guilds.admin.bypass`, and guild members with the right **Change and remove other members' guild locks** when that person is in the same guild. Chests that came with the world, and doors, have no known owner; anyone who finds them unlocked can lock them.
- With KyuubiSoft Claims 2.0: on a block in a claim where you may not use it: "... stands in a claim where you may not use it. Only people who may use it there can lock it."

### `/ksguild lock <options>`

The same in chat, without the window:

| Options | What it does |
|---------|--------------|
| `private` | A private lock: only you, plus players you add. Turns a guild lock that you set into a private one |
| `guild [rank]` | A guild lock that opens from `rank` (default: Member). Changes the rank of an existing guild lock |
| `rank <rank>` | Changes the lowest rank of a guild lock |
| `share <name>` | Lets one more player open it |
| `unshare <name>` | Takes that player off the list again |
| `info` | Shows the lock, like `lockinfo` |

German words work as well (`privat`, `gilde`, `rang`, `freigeben`, `entziehen`, ...), and a few English synonyms: `me`/`mine` for `private`, `add`/`allow` for `share`, `remove`/`revoke` for `unshare`, `show` for `info`, `minrank` for `rank`.

A rank can be typed as its name in your language (`Officer`), its id (`officer`), its number (`0` Leader to `4` Novice) or the name your guild gave it.

```
/ksguild lock guild Officer
/ksguild lock share Mira
```

### `/ksguild unlock`

Removes the lock of the block you look at. Answer: "Large Iron Chest is unlocked."

### `/ksguild lockinfo`

Shows who owns the lock, who else may open it, who set it and when, and your own access ("yours", "through the guild", "shared with you", "admin bypass" or "none").

### `/ksguild autolock [off|private|guild]`

What happens when you place a chest or door yourself:

| Mode | Result |
|------|--------|
| `off` (default) | Nothing; lock with `/ksguild lock` |
| `private` | A private lock, only for you |
| `guild` | A guild lock that opens from Member. Needs a guild |

Without an argument it shows your current mode. Also accepted: `aus`, `none`, `no` for `off`, and the words of `private` and `guild` above. If the admin switched automatic locking off, it answers "This is switched off on this server."

---

## Guild home

### `/ksguild home [1|2]`

Travels to home 1 or 2. Without a number it uses home 1, or home 2 if only that one is set. Needs the rank right **Travel to the guild home**.

- The trip starts after a warm-up of 5 seconds. A card counts down. Moving more than one block, taking damage or leaving the world cancels it.
- The home may be in another world.
- After a trip you wait 10 minutes (`home.cooldownSeconds`): "The next trip is possible in 412 s."

### `/ksguild sethome [1|2]`

Sets home 1 (default) or home 2 where you stand. Needs the rank right **Set the guild home** (only the leader by default) and the level that unlocks that home: level 2 for the first, level 7 for the second.

The spot needs solid ground and two blocks of air. Homes cannot be set in instance worlds. Answer: "Guild home 1 is now here · default 1150 / 70 / -402". The **Set here** button on the **Settings** tab runs this command.

---

## Guild land

### `/ksguild land add|remove|list`

Only exists with KyuubiSoft Claims 2.0.0 or newer.

| Command | What it does |
|---------|--------------|
| `/ksguild land add` | The claim you stand in becomes guild land. It must be your own claim |
| `/ksguild land remove` | Takes the claim you stand in out of the guild land |
| `/ksguild land list` | Lists the guild land of your guild with size, place and ranks |

`add` and `remove` need the rank right **Manage guild land**. New guild land lets members from **Member** build and members from **Novice** use chests, doors and other blocks. Change the ranks on the **Guild land** tab of the window.

---

## Admin

### `/ksguild admin`

Opens the admin window. Needs `ks.guilds.admin`. See [UI Pages](./ui-pages#admin-window).

---

## Guild chat

### `/gc [text]`

- `/gc <text>` writes to all online members of your guild: "Guild › Mira: text", in the guild colour.
- `/gc` alone switches the guild chat mode on or off. While it is on, your normal chat lines go to the guild. Lines that start with `!` and a word (such as VoiceHub's `!vc`) still go where they are addressed.

The **Write in the guild chat** switch on the **Settings** tab does the same.

---

## `/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.