Getting Started
This guide walks you through installing Item Control and setting up your first rules.
Installation
Section titled “Installation”Step 1: Install
Section titled “Step 1: Install”Place the Item Control jar in your server’s mods/ folder:
your-server/+-- mods/| +-- KyuubiSoftItemControl-3.0.1.jarItem Control works on its own. Two other mods add a little if you have them:
| Optional | What it adds |
|---|---|
| KyuubiSoft Core | An Item Control tile in the /ksadmin hub, the server’s default player language and the “players may choose” switch, and the item card hides while the world map is open |
| DynamicTooltipsLib | The “Soulbound” and “Drop Protected” lines in item tooltips |
Step 2: Start Server
Section titled “Step 2: Start Server”Start or restart your server. Item Control creates its folder:
mods/kyuubisoft_item-control/+-- config.json+-- itemcontrol.db+-- 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.jsonStep 3: Verify Installation
Section titled “Step 3: Verify Installation”Check the server console for:
[ItemControl] Setup complete - <number> items registeredWith KyuubiSoft Core installed you also see [ItemControl] Registered with Core admin menu.
First Steps
Section titled “First Steps”Give Yourself the Rights
Section titled “Give Yourself the Rights”Admins need both ks.item.admin and kyuubisoft.itemcontrol.admin. Operators with * already have them. See Permissions.
Open the Admin Hub
Section titled “Open the Admin Hub”Type /ksitem admin. The Admin Hub opens on the Modules page, and everything else is in the column on the left.
Turn On What You Need
Section titled “Turn On What You Need”Item Browser, Admin Give, Crafting Rules, Death Rules and Usage Rules are on by default. Turn on the others with their switch on the Modules page, or with /ksitem module enable <id>. A module works right away in the window, and its /ksitem command appears after the next restart.
To do this in the file instead, edit config.json and restart the server. /ksitem reload does not start or stop modules.
{ "modules": { "soulbound": { "enabled": true }, "cooldowns": { "enabled": true }, "inventory-tools": { "enabled": true } }}Quick Test
Section titled “Quick Test”# Open the Admin Hub/ksitem admin
# Browse items/ksitem browse
# Give yourself five iron swords/ksitem give Weapon_Sword_Iron --amount=5
# Compare two items/ksitem compare Weapon_Sword_Iron Weapon_Sword_Mithril
# Block an item from crafting/ksitem craft add Weapon_Sword_Mithril
# Keep all items on death/ksitem death mode keep-allQuick Setup in the Admin Hub
Section titled “Quick Setup in the Admin Hub”Each of these takes a minute. Open /ksitem admin and pick the place in the left column.
Crafting Rules
Section titled “Crafting Rules”- Open Crafting.
- Click Select and pick an item, or type a pattern such as
Weapon_*. - Check how many items it affects, then click Add.
Death Protection
Section titled “Death Protection”- Open Death and set the Death Mode to Selective.
- Add the items that players should keep.
Everything else is lost on death, except a player’s own soulbound items.
Soulbound Items
Section titled “Soulbound Items”- Turn on Soulbound on the Modules page.
- Open Soulbound and add the items that should bind on pickup.
Item Cooldowns
Section titled “Item Cooldowns”- Turn on Cooldowns on the Modules page.
- Open Cooldowns, pick an item on the Items tab and enter a duration.
- To make items wait together, create a group on the Groups tab. Every item in a group needs a duration of its own.
Players now see the time left on the item card above their hotbar.
Check Your Setup
Section titled “Check Your Setup”Back on the Modules page, To check lists entries that do nothing, such as a mistyped item ID. Check item shows every rule that hits an item.
Next Steps
Section titled “Next Steps”- Permissions: Permission nodes and who needs what
- Configuration: All options and data files
- Modules: What each module does
- Commands: All commands
- Admin UI: Every window explained
- FAQ & Troubleshooting: Common questions and solutions