Add world aliases for Chat (#3912)

Allows world names to be overridden with a defined value from the config in EssentialsX Chat. Closes #1793.
EssentialsX · Feb 5, 2021 · adef08a · adef08a
1 parent 1301e8f
commit adef08a
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 1 deletion.
diff --git a/Essentials/src/main/java/com/earth2me/essentials/ISettings.java b/Essentials/src/main/java/com/earth2me/essentials/ISettings.java
@@ -33,6 +33,8 @@ public interface ISettings extends IConf {
 
     String getChatFormat(String group);
 
+    String getWorldAlias(String world);
+
     int getChatRadius();
 
     int getNearRadius();

diff --git a/Essentials/src/main/java/com/earth2me/essentials/Settings.java b/Essentials/src/main/java/com/earth2me/essentials/Settings.java
@@ -129,6 +129,7 @@ public class Settings implements net.ess3.api.ISettings {
     private Set<Predicate<String>> nickBlacklist;
     private double maxProjectileSpeed;
     private boolean removeEffectsOnHeal;
+    private Map<String, String> worldAliases;
 
     public Settings(final IEssentials ess) {
         this.ess = ess;
@@ -542,6 +543,20 @@ public String getChatFormat(final String group) {
         return mFormat;
     }
 
+    @Override
+    public String getWorldAlias(String world) {
+        return worldAliases.getOrDefault(world.toLowerCase(), world);
+    }
+
+    private Map<String, String> _getWorldAliases() {
+        final Map<String, String> map = new HashMap<>();
+        final ConfigurationSection section = config.getConfigurationSection("");
+        for (String world : section.getKeys(false)) {
+            map.put(world.toLowerCase(), FormatUtil.replaceFormat(section.getString(world)));
+        }
+        return map;
+    }
+
     @Override
     public boolean getAnnounceNewPlayers() {
         return !config.getString("newbies.announce-format", "-").isEmpty();
@@ -656,6 +671,7 @@ public void reloadConfig() {
         vanishingItemPolicy = _getVanishingItemsPolicy();
         bindingItemPolicy = _getBindingItemsPolicy();
         currencySymbol = _getCurrencySymbol();
+        worldAliases = _getWorldAliases();
     }
 
     void _lateLoadItemSpawnBlacklist() {

diff --git a/Essentials/src/main/resources/config.yml b/Essentials/src/main/resources/config.yml
@@ -828,6 +828,12 @@ chat:
   # You can use permissions to control whether players can use formatting codes in their chat messages.
   # See https://essentialsx.net/wiki/Color-Permissions.html for more information.
 
+  # World aliases allow you to replace the world name with something different in the chat format.
+  # If you are using world aliases, make sure to remove the '#' at the start to allow the setting to be read.
+  world-aliases:
+  #  plots: "&dP&r"
+  #  creative: "&eC&r"
+
 ############################################################
 # +------------------------------------------------------+ #
 # |                 EssentialsX Protect                  | #

diff --git a/...lsChat/src/main/java/com/earth2me/essentials/chat/EssentialsChatPlayerListenerLowest.java b/...lsChat/src/main/java/com/earth2me/essentials/chat/EssentialsChatPlayerListenerLowest.java
@@ -54,7 +54,7 @@ public void onPlayerChat(final AsyncPlayerChatEvent event) {
 
         String format = ess.getSettings().getChatFormat(group);
         format = format.replace("{0}", group);
-        format = format.replace("{1}", world);
+        format = format.replace("{1}", ess.getSettings().getWorldAlias(world));
         format = format.replace("{2}", world.substring(0, 1).toUpperCase(Locale.ENGLISH));
         format = format.replace("{3}", team == null ? "" : team.getPrefix());
         format = format.replace("{4}", team == null ? "" : team.getSuffix());