DUXPLIMA Documentation

Overview

How the screens connect, and what opens each one.

uxmClaims is GUI-first. Nearly every operation in the command tree has a screen, so you can tell players one thing: type /claim.

The map

flowchart TD
    A["/claim"] --> B[Personal menu]
    A --> C[Claim management]
    B --> D[Your claims]
    B --> E[Public warps]
    B --> F[Invitation inbox]
    D --> C
    C --> G[Chunk map]
    C --> H[Flags]
    C --> I[Members]
    C --> P[Roles]
    C --> J[Invitations]
    C --> K[Bans]
    C --> L[Warps]
    C --> M[Vault]
    C --> N[Claim block]
    C --> T[Time]
    I --> O[Member management]
    P --> Q[Role management]
    L --> R[Warp management]
    N --> S[Block styles]

What opens what

CommandScreen
/claim in a claim you belong toClaim management
/claim in someone else's claimPersonal menu
/claim in the wildernessClaims or extends land when generalSettings.smartCommand is true (the default), otherwise the personal menu
/claim menuPersonal menu, always
/claim listYour claims
/claim selectClaim picker
/claim warpsPublic warps
/claim invites, /claim invite inboxInvitation inbox
/claim chunk viewChunk map
/claim vaultVault
/claim admin view <player>That player's claims, for admins

Typing text

Some buttons ask for text: a claim, role or warp name, or a player to invite or ban. The plugin picks the first screen that works for that player:

ScreenWho gets itHow to cancel
Dialog, a form with a text boxJava players on Minecraft 1.21.6 or newer, on a server that supports dialogsCancel or Escape
Bedrock formPlayers joining through Geyser or FloodgateClose the form
AnvilEveryone else, for screens set to ANVILClose the anvil
ChatEveryone else, for screens set to CHATType cancel

The rename dialog: a text box with Confirm and Cancel

In chat, a countdown title runs for 30 seconds and your message is not shown to other players. cancel always works; chatInputCancelWord in messages.yml adds a word of your own, such as a translated one. Submitting an empty box counts as cancelling. Which screen each file asks for is set in its type and fallback keys: see Menu layouts.

Dialogs also replace two chest screens on 1.21.6+: the confirmation screen becomes a yes/no dialog, and claim time is chosen with sliders.

Conventions

  • Left click acts, shift-click does the secondary thing. On the spawn button, click teleports and shift-click sets the spawn. Lore states which is which on every button that has both.
  • Destructive actions route through a confirmation screen: common_confirmation. Set generalSettings.confirmationEnabled: false in config.yml to skip it.
  • Permissions are checked when you click. Every button is shown, and the action behind it refuses if your role permission or ability node does not allow it.

Every screen is a file in menu/. See Menu layouts for the file format and Bedrock menus for players on Bedrock Edition.