# Getting Started

# Getting Started

## Installation

1. Stop the server.
2. Put `KyuubiSoftInfoHub-3.1.1.jar` into the server's `mods/` folder. When you update, remove the old `KyuubiSoftInfoHub-*.jar` first.
3. Start the server. The plugin creates `mods/kyuubisoft_infohub/` with English default content (with German translations), ready-to-use quick tiles and book links.

KyuubiSoft Core is optional. With Core you also get the Info Hub tile in the `/ksadmin` hub, the shared settings window `/kssettings` and the web editor.

### Updating from 2.x

On the first start the config files are upgraded once to the new format: new optional settings are added, nothing is lost and keys unknown to this version are kept. The shipped language files are replaced (old ones kept as `<lang>.json.backup-v11`); your texts in `custom_<lang>.json` stay untouched.

---

## Files after the first start

```
mods/kyuubisoft_infohub/
├── config.json
├── commands/categories.json
├── rules/rules.json
├── faq/faq.json
├── serverinfo/serverinfo.json
├── team/team.json
├── quickaccess/quickaccess.json
├── custom/pages.json
├── banner/
├── state/server_state.json
└── localization/
```

A file with broken JSON is never overwritten: it is kept, copied to `<file>.corrupt-<time>`, an error is logged and the defaults are used in memory until you fix it.

---

## Editing content

You have two ways:

- **In the game:** `/ksinfoadmin panel` opens the [admin window](./admin-panel). Changes are drafts until **Save**, then apply at once.
- **In the files:** edit the JSON files and run `/ksinfoadmin reload` (also works from the console).

A renamed or new **command name** (main command, section shortcut, custom page command) needs a server restart; everything else applies after a reload or save.

---

## For players

### Opening the Info Hub

| Way | Notes |
|-----|-------|
| `/ksinfo` | Main command (aliases `/hub`, `/hilfe`, `/menu` by default) |
| `/rules`, `/faq`, `/commands`, `/team` | Opens the book on that section |
| Info Book item | Right-click it. New players get it on their first join (hotbar slot 8 counted from 0, the last slot) |

### Inside the book

- **Start:** banner, the three newest news, the first eight quick tiles ("show all" opens every tile) and "Your books".
- **Left navigation:** every section and custom page; unread news and rules that need confirming are marked.
- **Breadcrumb with back button** on every tab except Start.
- **Search field** in the header (Enter or the magnifier opens Search).
- **Commands tab:** pick a command, fill its parameters, then **To chat** (puts it into your chat, nothing runs) or **Run** (runs it as you, if the server allows it).

---

## Quick configuration

### Server language

With KyuubiSoft Core, set the server language in `/kssettings`. Without Core, `language` in `config.json` is used (`en-US`, `de-DE`, `fr-FR`, `es-ES`, `pt-BR`, `ru-RU`, `pl-PL`, `tr-TR`, `it-IT`).

### Disable a section

```json
"sections": {
  "faq": {
    "enabled": false
  }
}
```

### Join message

```json
"joinMessage": {
  "enabled": true,
  "delaySeconds": 2,
  "message": [
    "",
    "&6Welcome to the server!",
    "&7Use &e/ksinfo &7for all information!",
    ""
  ]
}
```

Lines per language go into `joinMessage.i18n` (for example `"de-DE": ["...", "..."]`). See [Configuration](./configuration).

---

## Next steps

- [Commands](./commands) - command reference
- [Configuration](./configuration) - main configuration options
- [Admin Window](./admin-panel) - edit everything in game
- [Rules Config](./rules-config) - rules and the acknowledgement
- [Permissions](./permissions) - permission nodes