feature: add a miniplaceholders expansion

Bukkit/build.gradle.kts

@@ -41,6 +41,7 @@ dependencies {
     compileOnly(libs.luckperms)
     compileOnly(libs.essentialsx)
     compileOnly(libs.mvdwapi) { isTransitive = false }
+    compileOnly(libs.miniplaceholders) { isTransitive = false }
 
     // Other libraries
     implementation(libs.squirrelid) { isTransitive = false }

Bukkit/src/main/java/com/plotsquared/bukkit/listener/PlayerEventListener.java

@@ -252,8 +252,7 @@ public class PlayerEventListener implements Listener {
                 }
                 Plot plot = location.getOwnedPlot();
                 if (plot == null) {
-                    if (PlotFlagUtil.isAreaRoadFlagsAndFlagEquals(area, EditSignFlag.class, false)
-                            && !event.getPlayer().hasPermission(Permission.PERMISSION_ADMIN_INTERACT_ROAD.toString())) {
+                    if (PlotFlagUtil.isAreaRoadFlagsAndFlagEquals(area, EditSignFlag.class, false)) {
                         event.setCancelled(true);
                     }
                     return;
@@ -261,8 +260,7 @@ public class PlayerEventListener implements Listener {
                 if (plot.isAdded(event.getPlayer().getUniqueId())) {
                     return; // allow for added players
                 }
-                if (!plot.getFlag(EditSignFlag.class)
-                        && !event.getPlayer().hasPermission(Permission.PERMISSION_ADMIN_INTERACT_OTHER.toString())) {
+                if (!plot.getFlag(EditSignFlag.class)) {
                     plot.debug(event.getPlayer().getName() + " could not color the sign because of edit-sign = false");
                     event.setCancelled(true);
                 }

Bukkit/src/main/java/com/plotsquared/bukkit/listener/PlayerEventListener1201.java

@@ -20,7 +20,6 @@ package com.plotsquared.bukkit.listener;
 
 import com.plotsquared.bukkit.util.BukkitUtil;
 import com.plotsquared.core.location.Location;
-import com.plotsquared.core.permissions.Permission;
 import com.plotsquared.core.plot.Plot;
 import com.plotsquared.core.plot.PlotArea;
 import com.plotsquared.core.plot.flag.implementations.EditSignFlag;
@@ -47,8 +46,7 @@ public class PlayerEventListener1201 implements Listener {
         }
         Plot plot = location.getOwnedPlot();
         if (plot == null) {
-            if (PlotFlagUtil.isAreaRoadFlagsAndFlagEquals(area, EditSignFlag.class, false)
-                    && !event.getPlayer().hasPermission(Permission.PERMISSION_ADMIN_INTERACT_ROAD.toString())) {
+            if (PlotFlagUtil.isAreaRoadFlagsAndFlagEquals(area, EditSignFlag.class, false)) {
                 event.setCancelled(true);
             }
             return;
@@ -56,8 +54,7 @@ public class PlayerEventListener1201 implements Listener {
         if (plot.isAdded(event.getPlayer().getUniqueId())) {
             return; // allow for added players
         }
-        if (!plot.getFlag(EditSignFlag.class)
-                && !event.getPlayer().hasPermission(Permission.PERMISSION_ADMIN_INTERACT_OTHER.toString())) {
+        if (!plot.getFlag(EditSignFlag.class)) {
             plot.debug(event.getPlayer().getName() + " could not edit the sign because of edit-sign = false");
             event.setCancelled(true);
         }

Bukkit/src/main/java/com/plotsquared/bukkit/listener/ServerListener.java

@@ -21,6 +21,7 @@ package com.plotsquared.bukkit.listener;
 import com.google.inject.Inject;
 import com.plotsquared.bukkit.BukkitPlatform;
 import com.plotsquared.bukkit.placeholder.MVdWPlaceholders;
+import com.plotsquared.bukkit.placeholder.MiniPlaceholders;
 import com.plotsquared.bukkit.util.BukkitEconHandler;
 import com.plotsquared.core.PlotSquared;
 import com.plotsquared.core.configuration.Settings;
@@ -52,6 +53,11 @@ public class ServerListener implements Listener {
             new MVdWPlaceholders(this.plugin, this.plugin.placeholderRegistry());
             ConsolePlayer.getConsole().sendMessage(TranslatableCaption.of("placeholder.hooked"));
         }
+        if (Bukkit.getPluginManager().getPlugin("MiniPlaceholders") != null
+                && Settings.Enabled_Components.USE_MINIPLACEHOLDERS) {
+            new MiniPlaceholders(this.plugin.placeholderRegistry());
+            ConsolePlayer.getConsole().sendMessage(TranslatableCaption.of("placeholder.miniplaceholders.hooked"));
+        }
         if (Settings.Enabled_Components.ECONOMY && Bukkit.getPluginManager().isPluginEnabled("Vault")) {
             EconHandler econHandler = new BukkitEconHandler();
             try {

Bukkit/src/main/java/com/plotsquared/bukkit/placeholder/MiniPlaceholders.java

@@ -0,0 +1,69 @@
+/*
+ * PlotSquared, a land and world management plugin for Minecraft.
+ * Copyright (C) IntellectualSites <https://intellectualsites.com>
+ * Copyright (C) IntellectualSites team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.plotsquared.bukkit.placeholder;
+
+import com.google.common.eventbus.Subscribe;
+import com.plotsquared.bukkit.util.BukkitUtil;
+import com.plotsquared.core.PlotSquared;
+import com.plotsquared.core.player.ConsolePlayer;
+import com.plotsquared.core.player.PlotPlayer;
+import com.plotsquared.core.util.placeholders.Placeholder;
+import com.plotsquared.core.util.placeholders.PlaceholderRegistry;
+import io.github.miniplaceholders.api.Expansion;
+import io.github.miniplaceholders.api.utils.TagsUtils;
+import org.bukkit.entity.Player;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+public final class MiniPlaceholders {
+
+    private Expansion expansion = null;
+    private final PlaceholderRegistry registry;
+
+    public MiniPlaceholders(final @NonNull PlaceholderRegistry registry) {
+        this.registry = registry;
+        this.createExpansion();
+        PlotSquared.get().getEventDispatcher().registerListener(this);
+    }
+
+    @Subscribe
+    public void onNewPlaceholder(final PlaceholderRegistry.@NonNull PlaceholderAddedEvent event) {
+        // We cannot register placeholders on the fly, so we have to replace the expansion.
+        this.createExpansion();
+    }
+
+    private synchronized void createExpansion() {
+        if (this.expansion != null && this.expansion.registered()) {
+            this.expansion.unregister();
+        }
+        final Expansion.Builder builder = Expansion.builder("plotsquared");
+        for (final Placeholder placeholder : this.registry.getPlaceholders()) {
+            builder.audiencePlaceholder(placeholder.getKey(), (audience, argumentQueue, context) -> {
+                final PlotPlayer<?> plotPlayer;
+                if (audience instanceof Player player) {
+                    plotPlayer = BukkitUtil.adapt(player);
+                } else {
+                    plotPlayer = ConsolePlayer.getConsole();
+                }
+                return TagsUtils.staticTag(placeholder.getValue(plotPlayer));
+            });
+        }
+        this.expansion = builder.build();
+        this.expansion.register();
+    }
+}

Bukkit/src/main/java/com/plotsquared/bukkit/util/TranslationUpdateManager.java

@@ -55,14 +55,6 @@ public class TranslationUpdateManager {
         String userMove = "userMove";
         String userMoveReplacement = "user_move";
 
-        // tag opening / closing characters are important, as the locale keys exist as well, which should not be replaced
-        String listInfoUnknown = "<info.unknown>";
-        String listInfoUnknownReplacement = "<unknown>";
-        String listInfoServer = "<info.server>";
-        String listInfoServerReplacement = "<server>";
-        String listInfoEveryone = "<info.everyone>";
-        String listInfoEveryoneReplacement = "<everyone>";
-
         try (Stream<Path> paths = Files.walk(Paths.get(PlotSquared.platform().getDirectory().toPath().resolve("lang").toUri()))) {
             paths
                     .filter(Files::isRegularFile)
@@ -76,9 +68,6 @@ public class TranslationUpdateManager {
                         replaceInFile(p, minimumRadius, minimumRadiusReplacement);
                         replaceInFile(p, maximumMoves, maximumMovesReplacement);
                         replaceInFile(p, userMove, userMoveReplacement);
-                        replaceInFile(p, listInfoUnknown, listInfoUnknownReplacement);
-                        replaceInFile(p, listInfoServer, listInfoServerReplacement);
-                        replaceInFile(p, listInfoEveryone, listInfoEveryoneReplacement);
                     });
         }
     }

Core/src/main/java/com/plotsquared/core/command/ListCmd.java

@@ -465,7 +465,7 @@ public class ListCmd extends SubCommand {
                 TextComponent.Builder builder = Component.text();
                 if (plot.getFlag(ServerPlotFlag.class)) {
                     TagResolver serverResolver = TagResolver.resolver(
-                            "server",
+                            "info.server",
                             Tag.inserting(TranslatableCaption.of("info.server").toComponent(player))
                     );
                     builder.append(MINI_MESSAGE.deserialize(server, serverResolver));
@@ -483,13 +483,13 @@ public class ListCmd extends SubCommand {
                                 builder.append(MINI_MESSAGE.deserialize(online, resolver));
                             } else if (uuidMapping.username().equalsIgnoreCase("unknown")) {
                                 TagResolver unknownResolver = TagResolver.resolver(
-                                        "unknown",
+                                        "info.unknown",
                                         Tag.inserting(TranslatableCaption.of("info.unknown").toComponent(player))
                                 );
                                 builder.append(MINI_MESSAGE.deserialize(unknown, unknownResolver));
                             } else if (uuidMapping.uuid().equals(DBFunc.EVERYONE)) {
                                 TagResolver everyoneResolver = TagResolver.resolver(
-                                        "everyone",
+                                        "info.everyone",
                                         Tag.inserting(TranslatableCaption.of("info.everyone").toComponent(player))
                                 );
                                 builder.append(MINI_MESSAGE.deserialize(everyone, everyoneResolver));

Core/src/main/java/com/plotsquared/core/configuration/Settings.java

@@ -810,6 +810,10 @@ public class Settings extends Config {
         );
         @Comment("Whether PlotSquared should hook into MvDWPlaceholderAPI or not")
         public static boolean USE_MVDWAPI = true;
+
+        @Comment("Whether PlotSquared should hook into MiniPlaceholders")
+        public static boolean USE_MINIPLACEHOLDERS = true;
+
         @Comment("Prevent cross plot beacon effects")
         public static boolean DISABLE_BEACON_EFFECT_OVERFLOW = true;
 

Core/src/main/java/com/plotsquared/core/permissions/Permission.java

@@ -59,9 +59,6 @@ public enum Permission implements ComponentLike {
     PERMISSION_ADMIN_DESTROY_VEHICLE_UNOWNED("plots.admin.vehicle.break.unowned"),
     PERMISSION_ADMIN_DESTROY_VEHICLE_OTHER("plots.admin.vehicle.break.other"),
     PERMISSION_ADMIN_PVE("plots.admin.pve"),
-    PERMISSION_ADMIN_PLACE_VEHICLE_ROAD("plots.admin.vehicle.place.road"),
-    PERMISSION_ADMIN_PLACE_VEHICLE_UNOWNED("plots.admin.vehicle.place.unowned"),
-    PERMISSION_ADMIN_PLACE_VEHICLE_OTHER("plots.admin.vehicle.place.other"),
     PERMISSION_ADMIN_PVP("plots.admin.pvp"),
     PERMISSION_ADMIN_BUILD_ROAD("plots.admin.build.road"),
     PERMISSION_ADMIN_PROJECTILE_ROAD("plots.admin.projectile.road"),

Core/src/main/java/com/plotsquared/core/util/EventDispatcher.java

@@ -382,10 +382,14 @@ public class EventDispatcher {
                             return true;
                         }
                     }
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_ROAD, notifyPerms);
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_ROAD.toString(), notifyPerms
+                    );
                 }
                 if (!plot.hasOwner()) {
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_UNOWNED, notifyPerms);
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_UNOWNED.toString(), notifyPerms
+                    );
                 }
                 final List<BlockTypeWrapper> use = plot.getFlag(UseFlag.class);
                 for (final BlockTypeWrapper blockTypeWrapper : use) {
@@ -394,7 +398,7 @@ public class EventDispatcher {
                         return true;
                     }
                 }
-                if (player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_OTHER, false)) {
+                if (player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_OTHER.toString(), false)) {
                     return true;
                 }
                 // we check for the EditSignFlag in the PlayerSignOpenEvent again, but we must not cancel the interact event
@@ -419,10 +423,14 @@ public class EventDispatcher {
                             return true;
                         }
                     }
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_ROAD, false);
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_ROAD.toString(), false
+                    );
                 }
                 if (!plot.hasOwner()) {
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_UNOWNED, false);
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_UNOWNED.toString(), false
+                    );
                 }
                 if (plot.getFlag(DeviceInteractFlag.class)) {
                     return true;
@@ -434,14 +442,21 @@ public class EventDispatcher {
                         return true;
                     }
                 }
-                return player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_OTHER, false);
+                return player.hasPermission(
+                        Permission.PERMISSION_ADMIN_INTERACT_OTHER.toString(),
+                        false
+                );
             }
             case SPAWN_MOB -> {
                 if (plot == null) {
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_ROAD, notifyPerms);
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_ROAD.toString(), notifyPerms
+                    );
                 }
                 if (!plot.hasOwner()) {
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_UNOWNED, notifyPerms);
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_UNOWNED.toString(), notifyPerms
+                    );
                 }
                 if (plot.getFlag(MobPlaceFlag.class)) {
                     return true;
@@ -453,7 +468,10 @@ public class EventDispatcher {
                         return true;
                     }
                 }
-                if (player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_OTHER, false)) {
+                if (player.hasPermission(
+                        Permission.PERMISSION_ADMIN_INTERACT_OTHER.toString(),
+                        false
+                )) {
                     return true;
                 }
                 if (notifyPerms) {
@@ -473,10 +491,14 @@ public class EventDispatcher {
             }
             case PLACE_MISC -> {
                 if (plot == null) {
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_ROAD, notifyPerms);
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_ROAD.toString(), notifyPerms
+                    );
                 }
                 if (!plot.hasOwner()) {
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_UNOWNED, notifyPerms);
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_UNOWNED.toString(), notifyPerms
+                    );
                 }
                 if (plot.getFlag(MiscPlaceFlag.class)) {
                     return true;
@@ -488,7 +510,10 @@ public class EventDispatcher {
                         return true;
                     }
                 }
-                if (player.hasPermission(Permission.PERMISSION_ADMIN_INTERACT_OTHER, false)) {
+                if (player.hasPermission(
+                        Permission.PERMISSION_ADMIN_INTERACT_OTHER.toString(),
+                        false
+                )) {
                     return true;
                 }
                 if (notifyPerms) {
@@ -508,28 +533,16 @@ public class EventDispatcher {
             }
             case PLACE_VEHICLE -> {
                 if (plot == null) {
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_PLACE_VEHICLE_ROAD, notifyPerms);
-                }
-                if (!plot.hasOwner()) {
-                    return player.hasPermission(Permission.PERMISSION_ADMIN_PLACE_VEHICLE_UNOWNED, notifyPerms);
-                }
-                if (plot.getFlag(VehiclePlaceFlag.class)) {
-                    return true;
-                }
-                if (player.hasPermission(Permission.PERMISSION_ADMIN_PLACE_VEHICLE_OTHER, false)) {
-                    return true;
-                }
-                if (notifyPerms) {
-                    player.sendMessage(
-                            TranslatableCaption.of("commandconfig.flag_tutorial_usage"),
-                            TagResolver.resolver(
-                                    "flag",
-                                    Tag.inserting(
-                                            PlotFlag.getFlagNameComponent(VehiclePlaceFlag.class)
-                                    )
-                            )
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_ROAD.toString(), notifyPerms
                     );
                 }
+                if (!plot.hasOwner()) {
+                    return player.hasPermission(
+                            Permission.PERMISSION_ADMIN_INTERACT_UNOWNED.toString(), notifyPerms
+                    );
+                }
+                return plot.getFlag(VehiclePlaceFlag.class);
             }
             default -> {
             }

Core/src/main/resources/lang/messages_en.json

@@ -190,6 +190,7 @@
   "core.prefix": "<dark_gray>[</dark_gray><gold>P2</gold><dark_gray>] </dark_gray>",
   "core.enabled": "<prefix><gold><value> is now enabled.</gold>",
   "placeholder.hooked": "<prefix><gold>PlotSquared hooked into MVdWPlaceholderAPI</gold>",
+  "placeholder.miniplaceholders.hooked": "<prefix><gold>PlotSquared hooked into MiniPlaceholders</gold>",
   "placeholder.nan": "Not a number",
   "reload.reloaded_configs": "<prefix><gold>Translations and world settings have been reloaded successfully.</gold>",
   "reload.reload_failed": "<prefix><red>Failed to reload file configurations.</red>",
@@ -381,9 +382,9 @@
   "info.plot_list_default": "<gold><plot></gold>",
   "info.plot_list_player_online": "<dark_aqua><prefix></dark_aqua><hover:show_text:'<dark_aqua>Online</dark_aqua>'><gold><player></gold></hover>",
   "info.plot_list_player_offline": "<dark_aqua><prefix></dark_aqua><hover:show_text:'<dark_gray>Offline</dark_gray>'><gold><player></gold></hover>",
-  "info.plot_list_player_unknown": "<hover:show_text:'<red>The owner of this plot is unknown</red>'><white><unknown></white></hover>",
-  "info.plot_list_player_server": "<hover:show_text:'<red>The plot is owned by the server</red>'><white><server></white></hover>",
-  "info.plot_list_player_everyone": "<hover:show_text:'<blue>The plot is owned by everyone</blue>'><white><everyone></white></hover>",
+  "info.plot_list_player_unknown": "<hover:show_text:'<red>The owner of this plot is unknown</red>'><white><info.unknown></white></hover>",
+  "info.plot_list_player_server": "<hover:show_text:'<red>The plot is owned by the server</red>'><white><info.server></white></hover>",
+  "info.plot_list_player_everyone": "<hover:show_text:'<blue>The plot is owned by everyone</blue>'><white><info.everyone></white></hover>",
   "info.area_info_format": "<header>\n<reset><gold>Name: </gold><gray><name></gray>\n<gold>Type: </gold><gray><type></gray>\n<gold>Terrain: </gold><gray><terrain></gray>\n<gold>Usage: </gold><gray><usage>%</gray>\n<gold>Claimed: </gold><gray><claimed></gray>\n<gold>Clusters: </gold><gray><clusters></gray>\n<gold>Region: </gold><gray><region></gray>\n<gold>Generator: </gold><gray><generator></gray>\n<footer>",
   "info.area_list_tooltip": "<gold>Claimed=</gold><gray><claimed></gray>\n<gold>Usage=</gold><gray><usage></gray>\n<gold>Clusters=</gold><gray><clusters></gray>\n<gold>Region=</gold><gray><region></gray>\n<gold>Generator=</gold><gray><generator></gray>",
   "info.area_list_item": "<click:run_command:'<command_tp>'><hover:show_text:'<command_tp>'><dark_gray>[</dark_gray><gold><number></gold><dark_gray>]</dark_gray></hover></click> <click:run_command:'<command_info>'><hover:show_text:'<hover_info>'><gold><area_name></gold></hover></click><gray> - </gray><gray><area_type>:<area_terrain></gray>",

gradle/libs.versions.toml

@@ -18,6 +18,7 @@ placeholderapi = "2.11.5"
 luckperms = "5.4"
 essentialsx = "2.20.1"
 mvdwapi = "3.1.1"
+miniplaceholders = "2.2.3"
 
 # Third party
 prtree = "2.0.1"
@@ -68,6 +69,7 @@ prtree = { group = "com.intellectualsites.prtree", name = "PRTree", version.ref
 aopalliance = { group = "aopalliance", name = "aopalliance", version.ref = "aopalliance" }
 cloudServices = { group = "cloud.commandframework", name = "cloud-services", version.ref = "cloud-services" }
 mvdwapi = { group = "com.intellectualsites.mvdwplaceholderapi", name = "MVdWPlaceholderAPI", version.ref = "mvdwapi" }
+miniplaceholders = { group = "io.github.miniplaceholders", name = "miniplaceholders-api", version.ref = "miniplaceholders" }
 squirrelid = { group = "org.enginehub", name = "squirrelid", version.ref = "squirrelid" }
 arkitektonika = { group = "com.intellectualsites.arkitektonika", name = "Arkitektonika-Client", version.ref = "arkitektonika" }
 paster = { group = "com.intellectualsites.paster", name = "Paster", version.ref = "paster" }