> For the complete documentation index, see [llms.txt](https://kynosdeveloping.gitbook.io/kynosdeveloping/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kynosdeveloping.gitbook.io/kynosdeveloping/kynosstaff/installation.md).

# 🚀 Installation

Follow these steps to get KynosStaff running on your server.

***

### Requirements

Before installing, make sure your server meets these requirements:

* Paper or Spigot **1.21** or higher
* Java **21** or higher
* **KynosLib** installed (see below)

***

### Step 1 — Download KynosLib

KynosStaff depends on **KynosLib**, a shared core library. You must install it first.

Download the latest release from the [KynosLib GitHub Releases](https://github.com/KynosDeveloping/KynosLib/releases/tag/1.0.1) page and place the `.jar` in your `plugins/` folder.

***

### Step 2 — Download KynosStaff

Download the latest `KynosStaff.jar` from the [GitHub Releases](https://github.com/KynosDeveloping/KynosStaff/releases/tag/1.0.0) page.

***

### Step 3 — Place both JARs in `plugins/`

Your `plugins/` folder should contain at minimum:

```
plugins/
├── KynosLib.jar
└── KynosStaff.jar
```

***

### Step 4 — Start or restart the server

On first boot, KynosStaff will generate the following default configuration files inside `plugins/KynosStaff/`:

```
plugins/KynosStaff/
├── config.yml       # General settings (update checker, freeze options)
├── lang.yml         # All messages and GUI display strings
└── settings.yml     # GUI layout: item slots, materials, custom model data
```

***

### Step 5 — Assign permissions

By default, all permissions are granted to **operators only**. Assign the appropriate permissions to your staff roles using a permissions plugin such as LuckPerms.

See the [Permissions](/kynosdeveloping/kynosstaff/permissions.md) page for the full list.

***

### Updating

When a new version is available, KynosStaff will print a warning in the console at startup:

```
[KynosStaff] A new update (vX.X.X) is available on GitHub!
```

To update, simply replace the old JAR with the new one and restart the server.

You can disable the update checker in `config.yml`:

```yaml
Settings:
  update-checker: false
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kynosdeveloping.gitbook.io/kynosdeveloping/kynosstaff/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
