Skip to content

Fix command usage message ignoring color tags #8623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mvanhorn wants to merge 2 commits into
base: dev/patch
Choose a base branch
from
+14 −1
Open

Fix command usage message ignoring color tags #8623

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71f8844
Fix command usage message ignoring color tags (#8616)
mvanhorn May 3, 2026
156b2b0
fix: use unsafe parse() in getUsageComponent()
mvanhorn May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/main/java/ch/njol/skript/command/CommandUsage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

import ch.njol.skript.lang.VariableString;
import ch.njol.skript.util.Utils;
import net.kyori.adventure.text.Component;
import org.bukkit.event.Event;
import org.jetbrains.annotations.Nullable;
import org.skriptlang.skript.bukkit.text.TextComponentParser;

/**
* Holds info about the usage of a command.
Expand Down Expand Up @@ -63,6 +65,16 @@ public String getUsage(@Nullable Event event) {
return defaultUsage;
}

/**
* @param event The event used to evaluate the usage message.
* @return The evaluated usage message as an Adventure {@link Component} with
* Skript color tags ({@code <red>}, {@code &c}, etc.) parsed into real
* chat formatting via {@link TextComponentParser#parseSafe(Object)}.
*/
public Component getUsageComponent(@Nullable Event event) {
return TextComponentParser.instance().parseSafe(getUsage(event));
Comment thread
APickledWalrus marked this conversation as resolved.
Outdated
}

@Override
public String toString() {
return getUsage();
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/ch/njol/skript/command/ScriptCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ boolean execute2(final ScriptCommandEvent event, final CommandSender sender, fin
final LogEntry e = log.getError();
if (e != null)
sender.sendMessage(ChatColor.DARK_RED + e.toString());
sender.sendMessage(usage.getUsage(event));
sender.sendMessage(usage.getUsageComponent(event));
log.clear();
return false;
}
Expand Down