DUXPLIMA Documentation

The tool

The hotbar item, its three icons, its words, when it is handed out, and the lock that keeps it in its slot.

The tool is a dye in the hotbar. A right click with it in the main hand, at the air or at a block, moves to the next state; the click does nothing else, so it never opens a door or places the dye. The tool changes to the new state's icon at once.

The keys

Key under toolDefaultWhat it does
enabledtrueHand out the tool. Off, nobody gets it and the lock is off; /hide still works
slot7The hotbar slot, 0 to 8. 7 is the eighth slot
lock-in-slottrueThe tool cannot be moved, dropped, swapped to the off hand or placed, and never drops on death
give-on-jointrueHand it out when a player joins
give-on-respawntrueHand it out when a player respawns
give-on-world-changetrueHand it out when a player changes world
select-on-givefalseMake the tool the held item when it is handed out

The tool goes to its slot when that slot is empty or holds the tool; otherwise to the slot the player moved it to, or the first free slot. Another item is never written over, and a player never gets two.

A player who walks into a world not in worlds loses the tool, and gets it back when they walk into one that is.

The icons

Statematerialglowcustom-model-data
allLIME_DYEfalse0
importantYELLOW_DYEfalse0
noneGRAY_DYEtrue0

They are set under tool.icons.<state>. Every state needs an icon. A material the server does not know is drawn as PAPER, with a warning in the console once. custom-model-data above 0 picks a resource pack model.

The words

The tool has no name line; its tooltip is drawn from the messages files, in each player's language:

PartKeyShipped, in English
Titletool.titlePlayer Visibility
Categorytool.crumbLobby
Description header and texttool.lore.description, tool.descriptionDescription, Choose who you see in the lobby. The choice waits for you when you come back.
Details headertool.lore.detailsDetails
State rowtool.status-label, tool.<state>.nameShowing: Everybody, Staff and friends or Nobody
Click linetool.<state>.loreRight click to hide the crowd, to hide everybody, to show everybody

The words are drawn for each player on the way to them, so two players read the tool in their own language, and a player who changes language reads it in the new one within a second.

Related: States, config.conf