Quick Start

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

---

System Requirements#

Item	Details
Minecraft Version	1.16.5+
Java Version	Java 16+
Server Type	Paper, Folia, Spigot, and compatible forks
Database	SQLite (default), MySQL 5.7+

---

Installation#

1. Download the Plugin#

Build from source on GitHub:

https://github.com/Katacr/KaMenu/releases

Or download from these plugin distribution platforms:

https://www.spigotmc.org/resources/133736/

https://www.minebbs.com/resources/15814/

2. Install Optional Dependencies#

All KaMenu features work standalone — no hard dependencies. The following are optional:

Optional Dependencies:

• PlaceholderAPI — Use %variable% PAPI placeholders in menus
• Vault — Economy integration (if you need to manipulate player balances in actions)
• ItemsAdder — Resolve :glyph_id: and :offset_pixels: in Dialog text and use ItemsAdder custom items
• Oraxen — Resolve <glyph:glyph_id> and <shift:pixels> in Dialog text and use Oraxen custom items
• CraftEngine — Display <image:namespace:id> and <shift:pixels> through CraftEngine's Dialog packet interceptor and use CraftEngine custom items

3. Install the Plugin#

1. Place the downloaded KaMenu .jar file into your server's plugins folder
2. Start the server
3. The plugin will automatically:
   • Create the plugins/KaMenu/ configuration directory
   • Generate the default config.yml
   • Initialize the database (SQLite by default)

4. Open the Getting Started Guide#

After the server starts, a player with the kamenu.admin permission can run:

/kamenu guide

The guide helps you set the plugin language and release sample menus for the selected language. Older platforms without Dialog support release only chest, furnace, and anvil Container examples. Platforms with Dialog support release both Container and Dialog examples. Sample menus are written to:

plugins/KaMenu/menus/example/

You can also release sample menus directly with commands:

# Release examples using the current plugin language
/kamenu examples

# Release Chinese examples
/kamenu examples zh_CN

# Release English examples
/kamenu examples en_US

---

Verify Installation#

After starting the server, the console should show the KaMenu startup banner, including the version, database type, and number of loaded menus.

You can also verify in-game with:

/kamenu guide

If the guide opens, the installation is working correctly. On older platforms, run /km open example/container_main after releasing examples to open the container example. Platforms with Dialog support can also run /km open example/actions_demo for the Dialog actions example.

---

Hot Reload#

After modifying configuration or menu files, reload without restarting the server. If no target is provided, all modules are reloaded:

/km reload

Common targeted reloads:

/km reload menu      # Reload menus only
/km reload config    # Reload configs, item bindings, Sprite overrides, language, and custom commands
/km reload actions   # Reload global action packages only
/km reload js        # Reload global JavaScript packages only
/km reload lang      # Reload the current language file only

Requires the kamenu.admin permission.