Skip to content

Getting Started

This guide walks you through installing Item Control and setting up your first rules.

Place the Item Control jar in your server’s mods/ folder:

your-server/
+-- mods/
| +-- KyuubiSoftItemControl-3.0.1.jar

Item Control works on its own. Two other mods add a little if you have them:

OptionalWhat it adds
KyuubiSoft CoreAn 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
DynamicTooltipsLibThe “Soulbound” and “Drop Protected” lines in item tooltips

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.json

Check the server console for:

[ItemControl] Setup complete - <number> items registered

With KyuubiSoft Core installed you also see [ItemControl] Registered with Core admin menu.

Admins need both ks.item.admin and kyuubisoft.itemcontrol.admin. Operators with * already have them. See Permissions.

Type /ksitem admin. The Admin Hub opens on the Modules page, and everything else is in the column on the left.

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 }
}
}
Terminal window
# 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-all

Each of these takes a minute. Open /ksitem admin and pick the place in the left column.

  1. Open Crafting.
  2. Click Select and pick an item, or type a pattern such as Weapon_*.
  3. Check how many items it affects, then click Add.
  1. Open Death and set the Death Mode to Selective.
  2. Add the items that players should keep.

Everything else is lost on death, except a player’s own soulbound items.

  1. Turn on Soulbound on the Modules page.
  2. Open Soulbound and add the items that should bind on pickup.
  1. Turn on Cooldowns on the Modules page.
  2. Open Cooldowns, pick an item on the Items tab and enter a duration.
  3. 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.

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.