Skip to main content

Getting Started

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

Installation​

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
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 3: 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

Step 4: Verify Installation​

Check the server console for:

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

First Steps​

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​

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

# 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:

/ksitem reload

Quick Admin Test​

# 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​

Crafting Rules​

Block items from being crafted:

/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​

Protect valuable items from being lost on death:

/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​

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

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

Item Cooldowns​

Add usage cooldowns to prevent spam:

/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​