Store user mention preferences in LuckPerms meta

Author: Jakubk15

chatformatter-core/build.gradle.kts

@@ -30,6 +30,9 @@ dependencies {
     compileOnly("me.clip:placeholderapi:2.12.1")
     compileOnly("com.github.MilkBowl:VaultAPI:1.7.1")
 
+    // LuckPerms API
+    compileOnly("net.luckperms:api:5.4")
+
     // GitCheck
     implementation("com.eternalcode:gitcheck:1.0.0")
 

chatformatter-core/src/main/java/com/eternalcode/formatter/ChatFormatterPlugin.java

@@ -56,8 +56,7 @@ public ChatFormatterPlugin(Plugin plugin) {
         new Metrics(plugin, 15199);
 
         this.chatHandler = new ChatHandlerImpl(miniMessage, pluginConfig, this.rankProvider, this.placeholderRegistry, this.templateService);
-        MentionPlayerSettings mentionPlayerSettings = new MentionPlayerSettings(plugin.getDataFolder(), plugin.getLogger(), configManager.getPluginConfig().mentions);
-
+        MentionPlayerSettings mentionPlayerSettings = new MentionPlayerSettings(server, plugin.getLogger(), configManager.getPluginConfig().mentions);
 
         server.getPluginCommand("chatformatter").setExecutor(new ChatFormatterCommand(configManager, audienceProvider, miniMessage, mentionPlayerSettings));
 

chatformatter-core/src/main/java/com/eternalcode/formatter/mention/MentionPlayerSettings.java

@@ -1,81 +1,80 @@
 package com.eternalcode.formatter.mention;
 
-import org.bukkit.configuration.file.YamlConfiguration;
+import net.luckperms.api.LuckPerms;
+import net.luckperms.api.LuckPermsProvider;
+import net.luckperms.api.model.user.User;
+import net.luckperms.api.node.types.MetaNode;
+import org.bukkit.Server;
 
-import java.io.File;
-import java.io.IOException;
-import java.util.HashMap;
-import java.util.Map;
 import java.util.UUID;
 import java.util.logging.Logger;
 
 public class MentionPlayerSettings {
 
-    private final File dataFile;
+    private static final String MENTION_SOUND_META_KEY = "chatformatter-mention-sound";
+
     private final Logger logger;
-    private final Map<UUID, Boolean> settings = new HashMap<>();
     private final MentionConfig config;
+    private final Server server;
+    private LuckPerms luckPerms;
 
-    public MentionPlayerSettings(File dataFolder, Logger logger, MentionConfig config) {
+    public MentionPlayerSettings(Server server, Logger logger, MentionConfig config) {
+        this.server = server;
         this.logger = logger;
         this.config = config;
-        this.dataFile = new File(dataFolder, "mention-settings.yml");
-        this.load();
+        this.initializeLuckPerms();
     }
 
-    public boolean isMentionSoundEnabled(UUID uuid) {
-        return this.settings.getOrDefault(uuid, this.config.enabled);
-    }
+    private void initializeLuckPerms() {
+        if (!this.server.getPluginManager().isPluginEnabled("LuckPerms")) {
+            this.logger.warning("LuckPerms is not installed! Mention sound toggle feature will not work.");
+            return;
+        }
 
-    public void setMentionSoundEnabled(UUID uuid, boolean enabled) {
-        this.settings.put(uuid, enabled);
-        this.save();
+        try {
+            this.luckPerms = LuckPermsProvider.get();
+        } catch (IllegalStateException e) {
+            this.logger.warning("Failed to initialize LuckPerms API: " + e.getMessage());
+        }
     }
 
-    public boolean toggleMentionSound(UUID uuid) {
-        boolean current = this.isMentionSoundEnabled(uuid);
-        this.setMentionSoundEnabled(uuid, !current);
-        return !current;
-    }
+    public boolean isMentionSoundEnabled(UUID uuid) {
+        if (this.luckPerms == null) {
+            return this.config.enabled;
+        }
 
-    private void load() {
-        if (!this.dataFile.exists()) {
-            return;
+        User user = this.luckPerms.getUserManager().getUser(uuid);
+        if (user == null) {
+            return this.config.enabled;
         }
 
-        try {
-            YamlConfiguration config = YamlConfiguration.loadConfiguration(this.dataFile);
-
-            for (String key : config.getKeys(false)) {
-                try {
-                    UUID uuid = UUID.fromString(key);
-                    boolean enabled = config.getBoolean(key, this.config.enabled);
-                    this.settings.put(uuid, enabled);
-                } catch (IllegalArgumentException e) {
-                    this.logger.warning("Invalid UUID in mention-settings.yml: " + key);
-                }
-            }
-        } catch (Exception e) {
-            this.logger.warning("Failed to load mention settings: " + e.getMessage());
+        String metaValue = user.getCachedData().getMetaData().getMetaValue(MENTION_SOUND_META_KEY);
+        if (metaValue == null) {
+            return this.config.enabled;
         }
+
+        return Boolean.parseBoolean(metaValue);
     }
 
-    private void save() {
-        try {
-            if (!this.dataFile.exists()) {
-                this.dataFile.getParentFile().mkdirs();
-                this.dataFile.createNewFile();
-            }
+    public void setMentionSoundEnabled(UUID uuid, boolean enabled) {
+        if (this.luckPerms == null) {
+            this.logger.warning("Cannot set mention sound preference - LuckPerms is not available!");
+            return;
+        }
 
-            YamlConfiguration config = new YamlConfiguration();
+        this.luckPerms.getUserManager().modifyUser(uuid, user -> {
+            user.data().clear(node ->
+                node instanceof MetaNode metaNode && metaNode.getMetaKey().equals(MENTION_SOUND_META_KEY)
+            );
 
-            for (Map.Entry<UUID, Boolean> entry : this.settings.entrySet()) {
-                config.set(entry.getKey().toString(), entry.getValue());
-            }
+            MetaNode metaNode = MetaNode.builder(MENTION_SOUND_META_KEY, Boolean.toString(enabled)).build();
+            user.data().add(metaNode);
+        });
+    }
 
-            config.save(this.dataFile);
-        } catch (IOException e) {
-            this.logger.warning("Failed to save mention settings: " + e.getMessage());
-        }
+    public boolean toggleMentionSound(UUID uuid) {
+        boolean current = this.isMentionSoundEnabled(uuid);
+        this.setMentionSoundEnabled(uuid, !current);
+        return !current;
     }
 }

chatformatter-paper-plugin/build.gradle.kts

@@ -12,7 +12,7 @@ bukkit {
     prefix = "ChatFormatter"
     author = "EternalCodeTeam"
     name = "ChatFormatter"
-    softDepend = listOf("PlaceholderAPI", "Vault")
+    softDepend = listOf("PlaceholderAPI", "Vault", "LuckPerms")
     version = "${project.version}"
 
     commands {