Renaming Commands

Renaming, re-aliasing and disabling any command in commands.conf.

plugins/uxmEssentials/commands.conf renames, re-aliases or disables any command. It is one global file, keyed by each command's stable id.

The file moved in 0.8.1

It used to live at plugins/uxmEssentials/commands/commands.conf. If yours is still there, it is moved up to the data folder root the first time 0.8.1 loads, with your edits intact. An install that deliberately split the catalog across several files inside commands/ keeps being read from there, but that layout is deprecated: merge the blocks into one commands.conf when convenient.

How to Edit

Open plugins/uxmEssentials/commands.conf.
Edit the name, aliases, or enabled value for the command you want to change.
Save.
Reload (see the tip at the bottom).

This file is HOCON: # comments, quoted strings, [ … ] lists, { … } blocks. Keep braces and quotes balanced.

How the file is built

commands.conf is generated from the live command list the first time the plugin runs, and then left untouched; your edits are safe across upgrades. Each command is one block keyed by its stable id:

commands {
  tpaccept {
    enabled = true
    name = "tpaccept"
    aliases = ["tpyes"]
  }
  tpdeny {
    enabled = true
    name = "tpdeny"
    aliases = ["tpno"]
  }
}

Key	What it does
`enabled`	`false` drops the command entirely; it registers nothing.
`name`	The primary literal players type. Edit it to rename the command.
`aliases`	Extra literals that map to the same command.
`localized-aliases`	Extra literals offered only to players using a given language, keyed by locale tag.

Renaming a command

Change name to the word you want players to type. The id (the block key) stays the same:

commands {
  tpaccept {
    enabled = true
    name = "accept"           # players now type /accept
    aliases = ["tpyes", "yes"]
  }
}

Permission nodes never change on rename

Nodes are keyed to the command id, not to the name players type. Renaming tpaccept to accept leaves uxmessentials.tpa.use alone, so your permission setup keeps working. Do not rename the block key (tpaccept); edit only name and aliases inside it.

Adding or replacing aliases

aliases is a plain list. Add entries to give players more ways to type the command, or clear it to remove the alternates:

commands {
  balance {
    enabled = true
    name = "balance"
    aliases = ["bal", "money", "cash"]   # added "cash"
  }
}

commands {
  balance {
    enabled = true
    name = "balance"
    aliases = []                          # no alternates at all
  }
}

Avoid giving two commands the same name or alias: the first one registered wins and the other silently loses that literal.

Aliases for one language only

A command can carry aliases that exist only for players using a given language. Key them by locale tag under localized-aliases:

commands {
  home {
    enabled = true
    name = "home"
    aliases = ["homes"]
    localized-aliases {
      tr = ["ev"]
      de = ["zuhause"]
    }
  }
}

A tag may be a language (tr) or a full locale (pt-BR). Unicode is allowed, so a language that needs its own letters can have them.

Every localized alias is registered on the server like any other, so the console, a command block and a Geyser client can all use it. What changes is what a player sees: when the client asks for its command list, aliases that belong only to other languages are left out of it. A player on Turkish is offered /ev, a player on German is offered /zuhause, and neither is shown the other. The canonical name and the ordinary aliases are shown to everybody.

The language used is the player's own /lang choice when they made one, and their client locale otherwise.

Disabling a command

Set enabled = false to remove a command completely. It registers nothing: no literal, no aliases, no tab-completion:

commands {
  suicide {
    enabled = false           # /suicide is gone from this server
    name = "suicide"
    aliases = []
  }
}

Disabling a single command is different from disabling its whole module: the rest of the module keeps working. To turn off an entire feature, use the module's enabled key instead, see Per-Module Config.

Custom commands in the catalog

A custom command is a command like any other once it is loaded, so it gets a block here too. Its id is the definition's file name with a custom: prefix, which keeps an operator-chosen name out of the built-in id space. A file commands/custom/welcome.conf is keyed custom:welcome:

commands {
  "custom:welcome" {
    enabled = true
    name = "welcome"
    aliases = ["hello"]
  }
}

Everything on this page applies to it: rename it, give it aliases, add per-language aliases, or set enabled = false to drop it without touching the file that defines it. What the command does still lives in commands/custom/<id>.conf; this file only decides what it is called and whether it registers at all.

Reload after editing. Apply your changes with /uxmess reload (or restart). The command surface is re-published on reload, so renames, new aliases and disabled commands take effect immediately.

Was this page helpful?