Skip to content

Modules

Item Control is made of 14 modules. Each one can be turned on or off by itself, and a module that is off does nothing on your server.

Use the switches on the Modules page of the Admin Hub, or /ksitem module list, enable <id> and disable <id>. A module that you turn on works right away in the window, but its /ksitem command only appears after the next restart. A module that is off keeps its entries saved, and they have no effect until you turn it on again.


These lists accept patterns as well as exact item IDs:

  • Crafting
  • Death
  • Soulbound (auto-bind)
  • Drop Protection (auto-protect)
  • Usage Rules
  • The item of a drop rule in the mode Remove

Cooldowns, Watched and Temp Rules compare exact item IDs, so a pattern has no effect there. The only other way to reach several items with one cooldown entry is an ID start.

Matching ignores upper and lower case and underscores, so ToolPickaxeIron matches Tool_Pickaxe_Iron.

PatternMatches
Weapon_Sword_IronExactly this item
Weapon_*, Weapon* or Weapon_Every item whose ID starts with Weapon
*_IronEvery item whose ID ends with _Iron
*Pickaxe*Every item whose ID contains Pickaxe
@weapon, @armor, @tool, @consumable, @block, @utility, @gliderEvery item of that type, also when its ID does not follow the naming scheme
@any or *Every item
@category:<Name> / @subcategory:<Name>Every item in that item category or sub category

You do not have to type these by hand. The form in the Admin Hub has buttons for them and shows how many items your entry affects.

NPC roles and block IDs in drop rules accept the same wildcards, for example Trork_* for all Trork roles or Ore_* for all ore blocks.


Module ID: item-browser | Default: On

Lets players look through all items in the game.

  • Search by name, filter by category
  • Details for each item: ID, level, stack size, durability, quality and categories
  • Recipes and the NPCs and blocks that drop the item
  • Two items side by side

Commands: /ksitem browse, /ksitem compare <item1> <item2>. See the window guide.


Module ID: admin-give | Default: On

Gives you any item, with Give Item in the Item Browser or with /ksitem give <itemId> [--amount=<n>]. Both need ks.item.give and kyuubisoft.itemcontrol.give.


Module ID: crafting-rules | Default: On

Controls what can be crafted on your server. Every item is craftable except the ones you block.

  • Block single items, patterns or whole item categories
  • Turn single recipes on and off
  • Create your own recipes and change existing ones
  • A bypass permission for VIPs or staff

Your own recipes appear in the normal crafting window next to the vanilla ones, without a client restart. Players without the permission of a recipe do not see it.

Vanilla progression locks: Some vanilla recipes are locked behind a bench upgrade, a recipe that must be learned first, or the world memories level. Editing such a recipe keeps these locks. The recipe editor lists them, so you can remove them on purpose. The recipe list marks these recipes as Locked.


Module ID: death-rules | Default: On

Controls what happens to items when a player dies.

ModeWhat happens
VanillaStandard Hytale behavior, items drop on the ground
Keep AllAll items stay in the inventory
SelectiveOnly protected items stay, every other item is lost. A player’s own soulbound items always stay.

You can protect single items, patterns or whole item categories, and switch off durability loss on death. The protection list only has an effect in Selective.


Module ID: usage-rules | Default: On

Decides who may use an item.

BlockWhat it stops
Block allEquipping, using and picking up
Equip onlyEquipping
Use onlyUsing
  • Who may use the item: Nobody, only the soulbound owner, or players with a permission you choose
  • Message: Your own text for players who are stopped, or the standard text
  • Pickup: A rule that only blocks picking up exists in config.json

Temporary rules of the type Block Usage need this module too.


Module ID: soulbound | Default: Off

Binds items to one player. The owner is stored on the item itself.

  • No dropping: Soulbound items cannot be dropped
  • No chests: They cannot be put into containers, and “Take All” cannot duplicate them
  • No stealing: Other players cannot pick them up
  • Safe containers: A container with soulbound items in it cannot be destroyed
  • Auto-bind: Items or patterns that bind to the player who picks them up
  • Recovery: /ksitem soulbound recover gets back your own lost items, 5 minutes after they were lost
  • Tooltip: An optional “Soulbound: PlayerName” line, with DynamicTooltipsLib installed

Every player can check the held item with /soulbound. Useful for quest items, class equipment and event rewards.


Module ID: drop-prevention | Default: Off

Marks items so that they cannot be dropped. Unlike soulbound items, they are not bound to a player.

  • No dropping: A protected item cannot be dropped
  • Kept on death: It stays in the inventory when the player dies, and everything else follows the death rules. With KyuubiSoft Graveyard installed, the lost items go into the gravestone.
  • Auto-protect: Items or patterns that are marked on pickup, in Drop Protection in the Admin Hub
  • By hand: Mark the held item with /ksitem dropprevention protect
  • Tooltip: An optional “Drop Protected” line, with DynamicTooltipsLib installed

Module ID: cooldowns | Default: Off

Makes players wait between two uses of an item. Each player has their own timers. They see the time left on the item card and get a chat message.

KindHow it works
ItemsA duration for one exact item ID
CategoriesA duration for every item whose ID starts like this, such as Potion_. This is the start of an ID, not a game category, and upper and lower case count. A cooldown of the item itself comes first.
GroupsWhen a player uses an item of a group, all items of the group wait just as long. The duration comes from the item that was used.

Example: A 30 second cooldown on Potion_Health, and a group with both health potions, so nobody can spam-heal by switching potions.


Module ID: item-watchlist | Default: Off

Reports when certain items move, for example to keep an eye on rare items or to spot duplication.

  • Tracked: Crafted, picked up, dropped and dropped by an NPC
  • List: Exact item IDs, no patterns or categories
  • Chat: A line for everyone with kyuubisoft.itemcontrol.watchlist.notify
  • Alerts: The last 500 events with time, player and item, also after a restart

Module ID: inventory-tools | Default: Off

Tools to look into and repair player inventories.

  • View: A live view of a player’s inventory
  • Automatic backups: On joining and on death, and by hand whenever you want
  • History: All backups of a player, also while the player is offline, with a comparison against the inventory now
  • Restore: Replaces the inventory with a backup, for online players
  • Clear: Empties a whole inventory, or one slot with its own right
  • Remove an item from everyone: Takes one item from everyone online, with its own right

Before Item Control changes an inventory, it stores a safety backup and changes nothing if that fails. So a wrong clear, restore or removal can be undone from the history.


Module ID: temp-rules | Default: Off

Rules that end by themselves.

Type in the windowType in the commandWhat it does
Block Craftingcrafting-blockStops crafting of the item
Unlock Craftingcrafting-unlockAllows crafting of an item that is normally blocked
Block Usageusage-blockStops use of the item

A rule is pending until it starts, active while it runs, and removed when it has expired. It works with exact item IDs.

  • Start later: The window starts a rule now, in 1 hour or tomorrow
  • Announcement: A text that everyone online reads in chat when the rule becomes active. It can come up to 30 seconds late.
  • Types: By default Block Crafting and Block Usage both stop crafting and usage. temp-rules.strictTypes keeps them apart.

Good for event items, weekend events and items you need to take away while you look into a bug.


Module ID: drop-rules | Default: Off

Changes what NPCs and blocks drop, without touching game files.

ModeWhat it does
addComes on top of the vanilla drops (default)
replaceReplaces all vanilla drops
removeTakes this item away from the vanilla drops
  • Blocks: Block drops read the gathering setup of the game, so ores drop their real loot and not the block itself
  • Wildcards: * applies a rule to all NPCs, Trork_* or Ore_* to all matching roles or blocks
  • Patterns: In remove, the item can be a pattern such as Weapon_* or @weapon

Examples with the command:

Terminal window
# Trork Warriors also drop 1 to 3 iron swords, with a 50 % chance
/ksitem drops add Trork_Warrior Weapon_Sword_Iron 1 3 0.5
# Basalt iron ore no longer drops iron ore, but still drops basalt
/ksitem drops add Ore_Iron_Basalt Ore_Iron 1 1 1.0 remove
# A block drops only your own item
/ksitem drops add Ore_Gold_Basalt Custom_Gold_Nugget 2 5 1.0 replace

Module ID: item-overrides | Default: Off

Changes the values of single items while the server runs. The window for it is called Item Adjustments.

FieldKind of valueWhat it is
maxDurabilityNumberMaximum durability
durabilityLossOnHitNumberDurability lost per hit
maxStackWhole numberMaximum stack size
qualityIdTextItem quality
consumableYes or noWhether the item is consumed
dropOnDeathYes or noWhether the item drops on death
durabilityLossOnDeathYes or noWhether the item loses durability on death
toolSpeedNumberTool mining speed
armorResistanceNumberArmor damage resistance
craftingTierWhole numberRequired crafting tier
craftingOutputQtyWhole numberHow many items a craft gives
weaponDamageNumberWeapon damage, scaled across all damage types

Weapons and armor have their own editors for interactions, damage types, stats and knockback. The field list has all of them.

  • The original value is always kept, and you can reset one field or the whole item
  • Changes reach players at once and stay after a restart
  • A damage type that you add to a weapon also stays after a restart

Module ID: command-blocks | Default: Off

Gives blocks in the world a command that runs when a player hits the block.

  • Edit mode: Switch it on in the Admin Hub or with /ksitem cmdblock, then hit a block to open the editor
  • Placeholders: @p is the player name, @pos the block position as x y z
  • Run as: Player (default) runs with the rights and position of the player, Console with full server rights
  • Indestructible: Only admins can break the block
  • Cleanup: A block that is broken loses its command

Examples:

PurposeCommandRun as
Teleport/tp @p 100 64 200Console
NPC shopksnpcshop open weapons (needs KyuubiSoft Core)Player
Info book/ksinfoitemPlayer
Spawn an NPCnpc spawn SheepPlayer