# Getting Started

This guide will help you quickly install and configure the KaMenu plugin.

***

## 🎮 System Requirements

| Item              | Support Details                                     |
| ----------------- | --------------------------------------------------- |
| Minecraft Version | 1.21.7+                                             |
| Java Version      | Java 21+                                            |
| Server Type       | **Paper** and its derivative cores (such as Purpur) |
| Database          | SQLite (default), MySQL 5.7+                        |

{% hint style="info" %}
**Version Feature Support**:

* ✅ Paper 1.21.7+: Full support for basic features
* ✨ Paper 1.21.8+: Recommended version, API is more stable
* 🎨 Paper 1.21.9+: Full features (supports advanced features such as sprite item icons and player head avatars)
  {% endhint %}

{% hint style="warning" %}
KaMenu depends on the Paper Dialog API,**not supported**:

* Paper 1.21.6 and earlier versions (API not fully implemented yet)
* Spigot, CraftBukkit, and other non-Paper servers

Please make sure the server version is **Paper 1.21.7 or higher**!
{% endhint %}

***

## 📥 Installation Steps

### 1. Download the plugin

Download the built plugin from GitHub source code:

{% embed url="<https://github.com/Katacr/KaMenu/releases>" %}

Download the plugin from the following plugin release platforms:

{% embed url="<https://www.spigotmc.org/resources/133736/>" %}

{% embed url="<https://www.minebbs.com/resources/15814/>" %}

### 2. Install optional dependencies

All KaMenu features can run independently, with no mandatory dependencies. Optional dependencies are as follows:

**Optional dependencies:**

* [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) — Use `%variable%` format PAPI placeholders in menus
* [Vault](https://www.spigotmc.org/resources/vault.34315/) — Economy system integration (if you need to manipulate player balances in actions)

### 3. Install the plugin

1. Put the downloaded KaMenu `.jar` file into the server's `plugins` folder
2. Start the server
3. The plugin will automatically:
   * Create `plugins/KaMenu/` configuration directory
   * Release the default configuration file `config.yml` and sample menus
   * Initialize the database (SQLite by default)

{% hint style="info" %}
After the first startup,`plugins/KaMenu/menus/` the directory will automatically generate sample menu files, which you can directly refer to or modify.
{% endhint %}

***

## 🧪 Verify Installation

After the server starts, the console should display KaMenu's startup logo, including information such as version, database type, and number of loaded menus.

You can also run the following command in-game to verify whether the installation was successful:

```
/km open example/actions_demo
```

If a demo menu pops up successfully, the installation is working properly.

***

## 🔄 Hot Reload

After modifying configuration files or menu files, there is no need to restart the server; simply run the following command to reload:

```
/km reload
```

Requires `kamenu.admin` permission.


---

# Agent Instructions: 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://katacr.gitbook.io/plugins/kamenu-en/readme/start.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.