Quick Navigation

KothWars@v1.12.0:~$ CONNECTING...

KothWars v1.12.0

Complete Documentation

The ultimate KOTH plugin for Minecraft servers. Advanced GUI, web API, real-time tracking, rewards system, scheduling, and stunning visual effects.

Web API Integration
Smart Alert System
9 Reward Slots
bStats Analytics

Admin GUI

Permissions

Main: kothwars.admin includes:
• kothwars.reload - Reload config
• kothwars.start - Start KOTHs
• kothwars.stop - Stop KOTHs
• kothwars.remove - Remove KOTHs
• kothwars.headcache - Manage head cache

Main Menu Items

Capture Time
Seconds to capture
Schedule
Auto-start times
Rewards
9 configurable slots
Outline
Glow colors
Start/Stop
Toggle event
Auto Suspend
Inactivity timer
1

Access

Command: /koth opens the main admin GUI

API Developer

DEV

KothWars Public API

Extend and integrate KothWars with your own plugins using our complete API system.

KothWars API Repository

Access the complete API source code, documentation, and examples

Maven
<repository>
  <id>jitpack.io</id>
  <url>https://jitpack.io</url>
</repository>

<dependency>
  <groupId>com.github.zcrys</groupId>
  <artifactId>KothWars-Api</artifactId>
  <version>1.2.0</version>
</dependency>
Gradle
repositories {
  maven { url 'https://jitpack.io' }
}

dependencies {
  implementation 'com.github.zcrys:KothWars-Api:1.2.0'
}

Features

  • Complete KothAPI interface
  • Event-driven architecture
  • KothListener system
  • Real-time KOTH data access
  • Capture progress tracking
  • Player interaction events
  • Reward system integration
  • Schedule management
  • Glow effect control
  • Zone detection API
Access API Repository

Quick Example

public class MyKothListener implements KothListener {
    @Override
    public void onCaptureComplete(Koth koth, Player player, int rewardsCount) {
        Bukkit.broadcastMessage(player.getName() + " captured " + koth.getName());
        // Your custom logic here
    }
}
// Register your listener
KothAPI api = (KothAPI) Bukkit.getServicesManager().getRegistration(KothAPI.class).getProvider();
api.registerListener(new MyKothListener());

Placeholder System

PlaceholderAPI Required

All placeholders require PlaceholderAPI to be installed.

KOTH Information

Replace NAME with your KOTH name

%kothwars_capturer_NAME%
%kothwars_capturing_NAME%
%kothwars_progress_NAME%
%kothwars_active_NAME%
%kothwars_time_NAME%
%kothwars_time_hours_NAME%
%kothwars_time_minutes_NAME%
%kothwars_time_seconds_NAME%
%kothwars_next_NAME%
%kothwars_nextkoth_NAME%
%kothwars_last_capturer_NAME%

Player Stats

Display player statistics

%kothwars_stats_captures%
%kothwars_stats_kills%
%kothwars_stats_deaths%
%kothwars_stats_assists%
%kothwars_stats_kdr%
%kothwars_stats_time%
%kothwars_stats_participated%

Glow System

Player's current glow color

%kothwarsglow_color%
%kothwarsglow_hex%
%kothwarsglow_hex_no_hash%

Clan Integration

Display clan information (if enabled)

%kothwars_clan_user%
%kothwars_clan_user_raw%

KOTH Status

Check KOTH active status

%kothwars_active_NAME%

Examples

%kothwars_capturer_MyKoth% → Returns the name of the player capturing "MyKoth"
%kothwars_time_MyKoth% → Returns time until next start (HH:MM:SS)
%kothwars_stats_captures% → Returns total captures of the viewing player

Reward System

9 SLOTS

9 Configurable Reward Slots

Each KOTH has 9 independent reward slots that can be individually configured.

1
Slot 20
2
Slot 21
3
Slot 22
1

Adding Rewards

In the rewards menu, click on any slot to configure:

  • Left Click: Open item selection GUI
  • Right Click: Add a new command
  • Shift + Right Click: Remove last command/item
  • Middle Click: Toggle slot active/inactive
    • 2

    Command Format

    Commands are executed from console. Use %player% for the winner:

    give %player% diamond 64
    eco give %player% 1000
    lp user %player% parent add vip
    3

    Execution Modes

    Two modes available via the menu:

  • Execute All: Runs commands from ALL active slots
  • Specific: Only runs from manually selected slots
  • Order: Sequential (slots 1-9) or Random shuffle
    • 4

    Clan Rewards

    If clan integration is enabled, rewards are distributed to all clan members of the capturer.

    clan:
      enabled: true
      placeholder: "%uclans_tag_nocolor%"
      capturer-format: "[%clan%] %player%"

    Configuration

    Database

    Supports SQLite (default) and MySQL for multi-server networks.

    1

    Banned Items

    Prevent players from entering KOTH zones with specific items. Useful for competitive balance. 

    # Items prohibidos en zonas KOTH
banned-items:
  - ELYTRA
  - ENDER_PEARL
  - CHORUS_FRUIT
  - SHIELD
    2

    Alert Sounds

    Configure the dramatic sounds when a capture is imminent: 

    sounds:
  sound1: ENTITY_ENDER_DRAGON_AMBIENT
  sound2: ENTITY_EVOKER_PREPARE_ATTACK
  sound3: ITEM_FIRECHARGE_USE
  volume: 0.5
  pitch: 1.0
    3

    Default Timezone

    Set the default timezone for all new KOTHs: 

    default-timezone: 'America/El_Salvador'
    4

    Scoreboard Configuration

    Customize the dynamic scoreboard in scoreboard.yml: 

    enabled: true
distance-check: true
distance: 50
title: '&#FFD166&lKOTH WARS'
lines:
  - 'D99AE&m--------------------'
  - '&#FFB703&lKOTH: &#FFFFFF%koth_name%'
  - 'D6A0Progress: &#FFFFFF%progress%s / %total%s'
  - 'D99AE&m--------------------'

    Available placeholders: %koth_name%, %capturer%, %progress%, %total%, %percentage%, %date%

    Auto Suspension

    How it Works

    Automatically stops a KOTH after configured seconds of inactivity. Prevents wasted server resources on empty events.

    1

    Configuration

    In the KOTH menu, find the funnel icon. Default: 300 seconds (5 minutes). Minimum: 30 seconds, Maximum: 1800 seconds (30 minutes).

  • Left click: +30 seconds
  • Right click: -30 seconds
    • 2

    Reactivation

    Suspended KOTHs can be restarted:

  • Manually via /koth start
  • From GUI (Start button)
  • Automatically by schedule