Skip to content

Configuration

The config is plugins/xUtilities/config.yml, written on first start. Apply changes with /xutilities reload (or /xu reload): everything applies, including turning commands on or off and changing aliases and permissions.

The theme section at the top sets the look of every message: a prefix, the text colour, and three styles the messages use as tags. Change a colour there and every message that uses it follows. This example restyles the prefix; the default is <#B48CFF>»</#B48CFF> .

theme:
prefix: "<dark_gray>[<gradient:#B48CFF:#5EE08A>MyServer</gradient>]</dark_gray> "
base: "<gray>" # text with no tag of its own
highlight: "<#B48CFF>" # <highlight>: names and values
success: "<#5EE08A>" # <success>: turned on, done
error: "<#FF6B6B>" # <error>: refused, turned off

The default messages start with <prefix> and use these tags, as in "<prefix>Flight <success><state></success>.". Your own messages can use them too, or ignore them and set colours directly. See Formatting text.

commands:
fly:
enabled: true # false removes the command
aliases: ["flight", "togglefly", "toggleflymode"]
permission: "xutilities.command.fly" # blank = anyone
permission-others: "xutilities.command.fly.others"
# ...then the command's messages

permission-others exists only on commands with a [player] form. All text is MiniMessage.

A permission you rename keeps its default: rename /ping’s and the new one is still everyone’s.

Beyond messages, a few commands have their own settings, each under commands:

Setting Default What it does
speed.min, speed.max 1, 10 The range /speed accepts, on a 1 to 10 scale (Minecraft’s 0.1 to 1.0).
speed.type-flying, speed.type-walking flying, walking The words /speed fills in for <type>, such as “Your flying speed is now 5”.
heal.restore-hunger true /heal also restores hunger.
heal.extinguish-fire true /heal also puts out fire.
heal.clear-negative-effects true /heal also removes harmful potion effects.
clear.include-armor true /clear also empties armour and off-hand; false clears only the main 36 slots.
trash.title Disposal The /trash menu’s title.
<workstation>.message blank Sent when a workstation menu opens. Blank sends nothing.
<workstation>.sound blank Played when a workstation menu opens: a Minecraft sound name, optionally with a volume (0 to 10) and pitch (0.5 to 2), such as "block.anvil.use 0.5 1.2". Blank plays nothing.
enderchest.sound, trash.sound the block’s own Played as the menu opens: the Ender Chest’s and a barrel’s opening sounds, at half volume.

Each command’s messages are under its own key (message-self, message-others and so on). These placeholders are available where they apply:

Placeholder In
<player> any -others message, and enderchest.message-too-far: the other player’s name
<mode> gamemode messages
<state> /fly messages: the word from messages.state (enabled / disabled)
<speed>, <min>, <max> /speed messages
<type> /speed messages: speed.type-flying or speed.type-walking (flying / walking)
<yaw>, <pitch> /setrotation messages
<ping> /ping messages, in milliseconds
<usage> messages.error.usage: how to type the command
<player> messages.error.player-not-found: the name typed

Every message can also use the theme’s <prefix>, <highlight>, <success> and <error>.

Shared errors are under messages.error: players only, no permission, player not found, wrong usage, and the message shown if a command hits an error (the console gets the details).

info-commands holds /discord, /store, /website and any you add: see Link commands.

update-checker looks for a new version on Modrinth at startup and once a day, and tells the console and players with xutilities.admin when they join. Turn it off with update-checker.enabled: false. What it sends: Privacy.

plugins/xUtilities/config.yml
# xUtilities: every command you need. None you don't.
# Docs: https://docs.xenastudios.co/xutilities/configuration/
#
# Apply changes with /xutilities reload (or /xu reload). Everything applies, even
# turning commands on or off. A bad value falls back to its default with a warning in the
# console; xUtilities never stops over config. All text is MiniMessage:
# https://docs.xenastudios.co/start/formatting/
# Managed by the plugin, to carry your settings forward on updates. Don't edit it.
config-version: 2
# The look every message shares. The default messages use these as tags, so changing
# a colour here restyles them all. Write a style as MiniMessage tags: <gray>,
# <#B48CFF>, or <gold><bold>.
theme:
# <prefix> starts the default messages. Make it your server's name, such as
# "<dark_gray>[<gradient:#B48CFF:#5EE08A>MyServer</gradient>]</dark_gray> ", or blank for none.
prefix: "<#B48CFF>»</#B48CFF> "
# The colour of message text that has no tag of its own.
base: "<gray>"
# <highlight>: names and values, such as a player or a speed.
highlight: "<#B48CFF>"
# <success>: something turned on or done.
success: "<#5EE08A>"
# <error>: something refused or turned off.
error: "<#FF6B6B>"
# Messages the commands share.
messages:
error:
# The console or a command block ran a command only players can use.
player-only: "<prefix><error>Only players can use this command."
# The sender lacks the command's permission.
no-permission: "<prefix><error>You don't have permission to do that."
# No online player has that name. <player> is the name typed.
player-not-found: "<prefix><error>No player named <highlight><player></highlight> is online."
# The command was typed wrong. <usage> is how to type it.
usage: "<prefix><error>Usage:</error> <usage>"
# The command hit an error. The console has the details.
failed: "<prefix><error>Something went wrong. The console has the details."
# The words filled in for <state>.
state:
enabled: "enabled"
disabled: "disabled"
# Every command has the same settings:
# enabled false removes the command entirely
# aliases other names for it
# permission needed to use it; blank ("") lets anyone
# permission-others needed to use it on another player, on commands with a [player] form
# When one player changes another, the changed player gets the -self message too.
commands:
# /survival [player]
survival:
enabled: true
aliases: ["gms", "gm0"]
permission: "xutilities.command.survival"
permission-others: "xutilities.command.survival.others"
message-self: "<prefix>Your gamemode is now <highlight><mode></highlight>."
message-others: "<prefix>Set <highlight><player></highlight>'s gamemode to <highlight><mode></highlight>."
# /creative [player]
creative:
enabled: true
aliases: ["gmc", "gm1"]
permission: "xutilities.command.creative"
permission-others: "xutilities.command.creative.others"
message-self: "<prefix>Your gamemode is now <highlight><mode></highlight>."
message-others: "<prefix>Set <highlight><player></highlight>'s gamemode to <highlight><mode></highlight>."
# /adventure [player]
adventure:
enabled: true
aliases: ["gma", "gm2"]
permission: "xutilities.command.adventure"
permission-others: "xutilities.command.adventure.others"
message-self: "<prefix>Your gamemode is now <highlight><mode></highlight>."
message-others: "<prefix>Set <highlight><player></highlight>'s gamemode to <highlight><mode></highlight>."
# /spectator [player]
spectator:
enabled: true
aliases: ["gmsp", "gm3"]
permission: "xutilities.command.spectator"
permission-others: "xutilities.command.spectator.others"
message-self: "<prefix>Your gamemode is now <highlight><mode></highlight>."
message-others: "<prefix>Set <highlight><player></highlight>'s gamemode to <highlight><mode></highlight>."
# /gamemode <mode> [player]. Offers the modes whose own command is on, and needs
# that command's permission too. <mode> can be a name, a number or an alias such as gmc.
gamemode:
enabled: true
aliases: ["gm"]
permission: "xutilities.command.gamemode"
permission-others: "xutilities.command.gamemode.others"
# /fly [player]: turns flight on or off. <state> is a word from messages.state.
fly:
enabled: true
aliases: ["flight", "togglefly", "toggleflymode"]
permission: "xutilities.command.fly"
permission-others: "xutilities.command.fly.others"
message-on-self: "<prefix>Flight <success><state></success>."
message-off-self: "<prefix>Flight <error><state></error>."
message-on-others: "<prefix>Flight <success><state></success> for <highlight><player></highlight>."
message-off-others: "<prefix>Flight <error><state></error> for <highlight><player></highlight>."
# /speed <speed> [player]: fly speed while flying, walk speed otherwise. min and max bound
# what it accepts, on a 1 to 10 scale (Minecraft's 0.1 to 1.0; walking is 2 by default).
# <type> is a word from type-flying or type-walking.
speed:
enabled: true
aliases: ["setspeed"]
permission: "xutilities.command.speed"
permission-others: "xutilities.command.speed.others"
min: 1
max: 10
# The words filled in for <type>: which speed changed.
type-flying: "flying"
type-walking: "walking"
message-self: "<prefix>Your <type> speed is now <highlight><speed></highlight>."
message-others: "<prefix>Set <highlight><player></highlight>'s <type> speed to <highlight><speed></highlight>."
message-invalid: "<prefix><error>Speed must be from <min> to <max>."
# /top: teleports you to the highest block above you, or in the Nether, the highest below the roof.
top:
enabled: true
aliases: []
permission: "xutilities.command.top"
message-success: "<prefix>Teleported to the top."
message-unsafe: "<prefix><error>There's no safe block to stand on here."
# /setrotation <yaw> <pitch> [player]: sets which way a player faces.
setrotation:
enabled: true
aliases: []
permission: "xutilities.command.setrotation"
permission-others: "xutilities.command.setrotation.others"
message-self: "<prefix>Now facing yaw <highlight><yaw></highlight>, pitch <highlight><pitch></highlight>."
message-others: "<prefix><highlight><player></highlight> is now facing yaw <highlight><yaw></highlight>, pitch <highlight><pitch></highlight>."
# /ping [player]: network latency in milliseconds. Everyone has it by default.
ping:
enabled: true
aliases: []
permission: "xutilities.command.ping"
permission-others: "xutilities.command.ping.others"
message-self: "<prefix>Your ping is <highlight><ping>ms</highlight>."
message-others: "<prefix><highlight><player></highlight>'s ping is <highlight><ping>ms</highlight>."
# /back: returns you to where you were before your last teleport, or where you died.
back:
enabled: true
aliases: []
permission: "xutilities.command.back"
message-success: "<prefix>Teleported back to your previous location."
message-none: "<prefix><error>You have nowhere to go back to."
# /heal [player]: restores health, and these extras.
heal:
enabled: true
aliases: []
permission: "xutilities.command.heal"
permission-others: "xutilities.command.heal.others"
restore-hunger: true
extinguish-fire: true
clear-negative-effects: true
message-self: "<prefix>You've been <success>healed</success>."
message-others: "<prefix><success>Healed</success> <highlight><player></highlight>."
# /feed [player]: restores hunger.
feed:
enabled: true
aliases: []
permission: "xutilities.command.feed"
permission-others: "xutilities.command.feed.others"
message-self: "<prefix>You've been <success>fed</success>."
message-others: "<prefix><success>Fed</success> <highlight><player></highlight>."
# /repair [all] [player]: repairs the held item, or with all, the whole inventory.
repair:
enabled: true
aliases: ["fix"]
permission: "xutilities.command.repair"
permission-others: "xutilities.command.repair.others"
message-self: "<prefix>Your gear has been <success>repaired</success>."
message-others: "<prefix><success>Repaired</success> <highlight><player></highlight>'s gear."
message-nothing: "<prefix><error>Nothing needs repairing."
# /clear [player]: empties the inventory. include-armor: false keeps armour and the off-hand.
clear:
enabled: true
aliases: ["clearinventory", "ci"]
permission: "xutilities.command.clear"
permission-others: "xutilities.command.clear.others"
include-armor: true
message-self: "<prefix>Your inventory has been <success>cleared</success>."
message-others: "<prefix><success>Cleared</success> <highlight><player></highlight>'s inventory."
# /enderchest [player]: opens your Ender Chest, or another player's.
enderchest:
enabled: true
aliases: ["ec", "ender"]
permission: "xutilities.command.enderchest"
permission-others: "xutilities.command.enderchest.others"
# Played as the chest opens.
sound: "block.ender_chest.open 0.5"
message-others: "<prefix>Opened <highlight><player></highlight>'s ender chest."
# Folia only: the other player is too far away to share their chest safely.
message-too-far: "<prefix><error><highlight><player></highlight> is too far away to open their ender chest."
# Workstation menus: open the real menu without the block. When it opens, message is
# sent and sound is played; leave either blank for none. A sound is its Minecraft name,
# optionally followed by a volume (0 to 10) and pitch (0.5 to 2): "block.anvil.use 0.5 1.2".
anvil:
enabled: true
aliases: []
permission: "xutilities.command.anvil"
message: ""
sound: ""
craft:
enabled: true
aliases: ["workbench", "wb"]
permission: "xutilities.command.craft"
message: ""
sound: ""
grinder:
enabled: true
aliases: ["grindstone"]
permission: "xutilities.command.grinder"
message: ""
sound: ""
loom:
enabled: true
aliases: []
permission: "xutilities.command.loom"
message: ""
sound: ""
smith:
enabled: true
aliases: ["smithingtable", "smithtable"]
permission: "xutilities.command.smith"
message: ""
sound: ""
stonecutter:
enabled: true
aliases: []
permission: "xutilities.command.stonecutter"
message: ""
sound: ""
cartography:
enabled: true
aliases: ["cartographytable"]
permission: "xutilities.command.cartography"
message: ""
sound: ""
# /trash: an empty menu whose contents are deleted when it closes.
trash:
enabled: true
aliases: ["disposal"]
permission: "xutilities.command.trash"
title: "Disposal"
message: ""
sound: "block.barrel.open 0.5"
# Commands you write yourself. Each key becomes a command that sends its message,
# usually a clickable link. Add one, such as vote:, and reload to get /vote.
# permission is optional: it defaults to xutilities.command.<name>, which everyone has.
# A name or alias that clashes with one of the commands above is skipped.
# Replace the example links!
info-commands:
discord:
enabled: true
aliases: []
permission: "xutilities.command.discord"
message: "<prefix>Join our Discord: <click:open_url:'https://discord.gg/example'><hover:show_text:'<gray>Click to open'><highlight><underlined>discord.gg/example"
store:
enabled: true
aliases: []
permission: "xutilities.command.store"
message: "<prefix>Visit our store: <click:open_url:'https://store.example.com'><hover:show_text:'<gray>Click to open'><highlight><underlined>store.example.com"
website:
enabled: true
aliases: []
permission: "xutilities.command.website"
message: "<prefix>Visit our website: <click:open_url:'https://example.com'><hover:show_text:'<gray>Click to open'><highlight><underlined>example.com"
# Tells you when a new version is out.
update-checker:
# Ask Modrinth for the newest version at startup and every 24 hours. It sends
# only the plugin version, the platform and the Minecraft version.
enabled: true
# Logged, and shown to admins when they join, when a newer version is out.
# <plugin>, <current>, <latest> and <url> are filled in.
message: "<prefix><plugin> <highlight><latest></highlight> is out (you have <current>): <click:open_url:'<url>'><hover:show_text:'Open on Modrinth'><highlight><underlined><url>"