Skip to content
KyuubiSoft Wiki
News & Patchnotes

Getting Started

Getting Started

Section titled “Getting Started”

This guide walks you through installing and configuring the Item Control system.

Installation

Section titled “Installation”

Step 1: Install

Section titled “Step 1: Install”

Download and place the Item Control JAR in your server’s mods/ directory:

your-server/
+-- mods/
|   +-- kyuubisoft-itemcontrol.jar    <- Place here
|   +-- kyuubisoft-core.jar           <- Optional: enables extra features

:::tip Optional Core Integration Item Control works fully standalone. If you also have kyuubisoft-core.jar installed, you get additional features:

  • Admin menu integration (Item Control appears in /ksadmin)
  • Per-player language detection
  • Player avatar display in inventory view :::

Step 2: Start Server

Section titled “Step 2: Start Server”

Start or restart your Hytale server. The plugin will automatically generate the config folder:

configs/kyuubisoft_itemcontrol/
+-- config.json
+-- localization/
|   +-- en-US.json
|   +-- de-DE.json
|   +-- es-ES.json
|   +-- fr-FR.json
|   +-- it-IT.json
|   +-- pl-PL.json
|   +-- pt-BR.json
|   +-- ru-RU.json
|   +-- tr-TR.json

Step 3: Verify Installation

Section titled “Step 3: Verify Installation”

Check the server console for:

[KyuubiSoft ItemControl] Item Control loaded (13 modules)
[KyuubiSoft ItemControl] Loaded language: en-US

First Steps

Section titled “First Steps”

Open the Admin UI

Section titled “Open the Admin UI”

As an admin, type /ksitem admin to open the admin hub:

  • Recipes Tab — Browse all crafting recipes with search and filter
  • Rules Tabs — Manage crafting, death and usage rules
  • Browse Panel — Item browser on the right side for quick item lookup

Enable/Disable Modules

Section titled “Enable/Disable Modules”

By default, core modules (Browser, Give, Crafting, Death, Usage) are enabled. Enable additional modules as needed:

Terminal window
# List all modules and their status
/ksitem module list


# Enable soulbound system
/ksitem module enable soulbound


# Enable inventory tools
/ksitem module enable inventory-tools

Or edit config.json directly:

{
  "modules": {
    "soulbound": { "enabled": true },
    "cooldowns": { "enabled": true },
    "inventory-tools": { "enabled": true }
  }
}

Then reload:

Terminal window
/ksitem reload

Quick Admin Test

Section titled “Quick Admin Test”
Terminal window
# Open admin UI
/ksitem admin


# Browse items
/ksitem browse


# Give yourself an item
/ksitem give Sword_Iron 1


# Compare two items
/ksitem compare Sword_Iron Sword_Gold


# Block an item from crafting
/ksitem craft add Sword_Diamond


# Set death mode to keep-all
/ksitem death mode keep-all

Module Quick Setup

Section titled “Module Quick Setup”

Crafting Rules

Section titled “Crafting Rules”

Block items from being crafted:

Terminal window
/ksitem craft add Armor_Diamond_Chest    # Block diamond armor
/ksitem craft add Weapon_Bow_Legendary   # Block legendary bow
/ksitem craft list                        # See all blocked items

Death Protection

Section titled “Death Protection”

Protect valuable items from being lost on death:

Terminal window
/ksitem death mode selective              # Enable selective protection
/ksitem death add Weapon_Sword_Iron       # Protect iron swords
/ksitem death add Armor_Gold_Chest        # Protect gold armor

Soulbound Items

Section titled “Soulbound Items”

Bind items to players so they cannot be dropped or traded:

Terminal window
/ksitem module enable soulbound           # Enable the module
/ksitem soulbound autobind add Quest_Key  # Auto-bind quest keys

Item Cooldowns

Section titled “Item Cooldowns”

Add usage cooldowns to prevent spam:

Terminal window
/ksitem module enable cooldowns           # Enable the module
/ksitem cooldown set Potion_Health 30     # 30 second cooldown
/ksitem cooldown set Potion_Mana 15      # 15 second cooldown

Next Steps

Section titled “Next Steps”