# KoTHX Plugin

**Versions:** <mark style="color:$warning;">**1.16.x**</mark> - <mark style="color:$warning;">**26.1.x**</mark>\
**Is Folia Supported?**\ <mark style="color:$info;">Yes, we support Folia and you can use plugin on paper,bukkit,spigot,pufferfish,purpur versions as well as on Folia!</mark>

<figure><img src="/files/QrkUfGg9DDLRO9Sa9YIi" alt=""><figcaption></figcaption></figure>

## Installation Guide <a href="#installation-guide" id="installation-guide"></a>

{% stepper %}
{% step %}

### Follow this guide to install the KoTHX Plugin&#xD;

{% endstep %}

{% step %}

### Upload JAR File to Your Server&#xD;

Start by uploading "KoTH&#x58;**-1.4.jar**" file to your Server's > **plugins folder**.\
![](/files/pCnVmgEeybRl2YPJrRCv)
{% endstep %}

{% step %}

### Install the Dependencies

• [<mark style="color:$primary;">PlaceholderAPI</mark>](https://www.spigotmc.org/resources/placeholderapi.6245/) (Free) - Optional
{% endstep %}

{% step %}

### Install Team/Clan Plugins (Optional)&#xD;

Available **Team** or **Clan** Hooks for KoTHX Plugin\
\
• [<mark style="color:$primary;">SimpleClans</mark>](https://www.spigotmc.org/resources/simpleclans.71242/) (Free)\
• [<mark style="color:$primary;">BetterTeams</mark>](https://www.spigotmc.org/resources/better-teams.17129/) (Free)\
• [<mark style="color:$primary;">ClansPlus</mark>](https://www.spigotmc.org/resources/clansplus-the-ultimate-clan-plugin-folia-vault-playerpoints-discord-supported.126787/) (Free)\
• [<mark style="color:$primary;">xTeams</mark>](https://modrinth.com/plugin/xteams) (Free)\
• [<mark style="color:$primary;">ZelTeams</mark>](https://builtbybit.com/resources/zelteams-clan-team-plugin.35015/?ref=621595) (Paid)\
• [<mark style="color:$primary;">UltimateClans</mark>](https://builtbybit.com/resources/ultimate-clans.40390/) (Paid)\
\
• Without a Team or Clan plugin installed, KoTHX captures will only track and display individual player.
{% endstep %}

{% step %}

### Enable Hooks

• If you install any Team or Clan plugin from the list above, you must follow the setup guide in the `config.yml` file.\
![](/files/vnF6D7nWnpgBFQxQdJWb)
{% endstep %}

{% step %}

### Start your Server&#xD;

• After starting the server, use the `/kothxadmin` command to access additional guides, setup information, and command help for setup.
{% endstep %}
{% endstepper %}

### **Usage Guide & Edit Help (ADMIN)**

This guide explains how to use and edit the plugin effectively as a server owner. It introduces all key features and provides a complete overview of the commands needed to manage them. We recommend reading through the entire guide before launching your server.

<details>

<summary><strong>Create a New KoTH</strong></summary>

• `/kothxadmin create <name> <time>`\
\
• Creates a brand new **KoTH event** with a custom name + color and capture time. After creation, you can configure **rewards, schedules** and more.

</details>

<details>

<summary><strong>Edit Existing KoTH</strong></summary>

• `/kothxadmin edit <name>`\
\
• Opens the **KoTH editor** for the selected event. Use it to modify settings like **capture time, rewards and delete koth option.**

</details>

<details>

<summary><strong>Start KoTH Event</strong></summary>

• `/kothxadmin start <name>`\
\
• Force starts a **KoTH event manually**. Useful for **staff events, tournaments, testing**, or special scheduled activities.

</details>

<details>

<summary><strong>Stop Active KoTH</strong></summary>

• `/kothxadmin stop`\
\
• Immediately stops the currently active **KoTH event** and ends the capture session for all players.

</details>

<details>

<summary><strong>Cuboid &#x26; Poly Selection Wand</strong></summary>

• `/kothxadmin wand`\
\
• Gives you the **cuboid selection wand** used to create standard KoTH regions by selecting **2 corners** of the capture area.\
\
• `/kothxadmin wand poly`\
\
• Gives you the **polygon region wand** for creating advanced custom-shaped KoTH areas. Perfect for **mountains, caves, arenas**, and irregular terrains.

</details>

<details>

<summary><strong>Edit Loot Rewards</strong></summary>

• `/kothxadmin loot <name>`\
\
• Opens the **loot editor** for the selected KoTH. Configure **items, crate keys, money rewards,** by using **commands** or **items.**

</details>

<details>

<summary><strong>Create KoTH Schedule and Edit TimeZones + Format</strong></summary>

• `/kothxadmin schedule set <kothname> <time> [day]`\
\
• Creates an automatic **event schedule** for the selected KoTH. Supports custom times and optional days like **weekdays, weekends**, or specific days.\
\ <mark style="color:$danger;">**IMPORTANT:**</mark> Before creating Schedule, you need to set your timezone in `config.yml` \
![](/files/13uRTX13pT40dmZaPUKG)\
\
• Or using **command** `/kothxadmin schedule timezone <timezone>`\
\
• **Change** your **schedule time format** using this **command**: \
`/kothxadmin schedule timezoneformat <12HR/24HR>`\
\ <mark style="color:$danger;">**Available TimeZones:**</mark>

America/New\_York
\
America/Chicago
\
America/Denver
\
America/Los\_Angeles
\
America/Toronto
\
America/Mexico\_City
\
America/Sao\_Paulo

Europe/London
\
Europe/Paris
\
Europe/Berlin
\
Europe/Amsterdam
\
Europe/Madrid
\
Europe/Rome
\
Europe/Athens
\
Europe/Moscow

Asia/Dubai
\
Asia/Kolkata
\
Asia/Singapore
\
Asia/Tokyo
\
Asia/Seoul
\
Asia/Shanghai

Australia/Sydney

Pacific/Auckland

</details>

<details>

<summary><strong>Schedule All KoTHs</strong></summary>

• `/kothxadmin scheduleall <time> [day]`\
\
• Automatically schedules **all existing KoTH events** at the selected time and day configuration.

</details>

<details>

<summary><strong>Random KoTH Rotation</strong></summary>

• `/kothxadmin kothrandom <all|enabled|disable> <kothname>`\
\
• Enables **random KoTH rotation** from configured events. You can use all KoTHs, only enabled ones, or disable specific events from the rotation pool.\
\
**Example:** 4 KoTH's at same time only 1 KoTH will start from 4 options.

</details>

<details>

<summary><strong>Reload Plugin Configuration</strong></summary>

• `/kothxadmin reload`\
\
• Reloads all **KoTHX configuration files** without restarting the server. Useful after editing **configs, rewards, schedules**, or language files.

</details>

<details>

<summary><strong>KoTHX Leaderboard Placeholders</strong></summary>

• `%kothx_top_1_daily%`, `%kothx_top_2_daily%`, `%kothx_top_3_daily%`\
• Displays the **Top Daily KoTH players** based on current daily captures and statistics.

• `%kothx_top_1_weekly%`, `%kothx_top_2_weekly%`, `%kothx_top_3_weekly%`\
• Displays the **Top Weekly KoTH players** from the weekly leaderboard rotation.

• `%kothx_top_1_alltime%`, `%kothx_top_2_alltime%`, `%kothx_top_3_alltime%`\
• Displays the **Top AllTime KoTH players** with the highest overall captures recorded on the server.

• `PlaceholderAPI & DecentHolograms Support`\
\
• Fully compatible with **PlaceholderAPI**, **DecentHolograms**, scoreboards, TAB plugins, menus, NPCs, chat formats, and other supported plugins.

</details>

<details>

<summary><strong>Default Player Commands</strong></summary>

A set of core KoTHX default commands used to view all important information about active King of The Hill events, schedules, and leaderboards. These commands are designed to give players quick access to capture details, upcoming schedules, and global rankings directly in-game.\ <br>

• `/kothx list`

* View all active KoTHs currently running on the server.

• `/kothx info`

* Display detailed information about a specific KoTH (location, status, capture time, rewards, etc.).

• `/kothx schedule list`

* Shows all scheduled KoTH events and their start times.

• `/kothx leaderboard`

* Opens the KoTH capture leaderboard gui showing top players and clans.

</details>

### **Support**

If you have any questions before or after the purchase, feel free to join our discord server \
where you can ask for support in the channel #open-ticket \
**Discord Link:** [<mark style="color:$primary;">Click Me</mark>](https://discord.gg/tT6mvrgtw6)


---

# 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://akiisx-studios.gitbook.io/akiisx-studios-docs/documentation/akiisxstudios/kothx-plugin.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.