Add LiteBans support for BanPlugins addon

Reviewed-on: https://codeberg.org/Andre601/AdvancedServerList/pulls/285

addons/banplugins/pom.xml

@@ -102,6 +102,12 @@
             <version>1.1.0-RC1</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.gitlab.ruany</groupId>
+            <artifactId>LiteBansAPI</artifactId>
+            <version>0.5.0</version>
+            <scope>provided</scope>
+        </dependency>
         <dependency>
             <groupId>ch.andre601.asl-api</groupId>
             <artifactId>api</artifactId>

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/BanPluginsList.java

@@ -23,35 +23,48 @@
  *
  */
 
-package ch.andre601.advancedserverlist.banplugins.bungeecord;
+package ch.andre601.advancedserverlist.banplugins;
 
 import ch.andre601.advancedserverlist.api.PlaceholderProvider;
 import ch.andre601.advancedserverlist.banplugins.placeholders.AdvancedBanPlaceholders;
 import ch.andre601.advancedserverlist.banplugins.placeholders.LibertyBansPlaceholders;
+import ch.andre601.advancedserverlist.banplugins.placeholders.LiteBansPlaceholders;
 
-import java.util.HashMap;
-import java.util.Map;
-
-public enum BungeeCordBanPlugins{
+public enum BanPluginsList{
     
-    ADVANCED_BAN("AdvancedBan", new AdvancedBanPlaceholders()),
-    LIBERTY_BANS("LibertyBans", new LibertyBansPlaceholders());
+    ADVANCED_BAN("AdvancedBan", new AdvancedBanPlaceholders(), true, true, false),
+    LIBERTY_BANS("LibertyBans", new LibertyBansPlaceholders(), true, true, true),
+    LITE_BANS("LiteBans", new LiteBansPlaceholders(), true, true, true);
     
-    private final String plugin;
+    private final String name;
     private final PlaceholderProvider placeholderProvider;
+    private final boolean paper, bungeecord, velocity;
     
-    BungeeCordBanPlugins(String plugin, PlaceholderProvider placeholderProvider){
-        this.plugin = plugin;
+    BanPluginsList(String name, PlaceholderProvider placeholderProvider, boolean paper, boolean bungeecord, boolean velocity){
+        this.name = name;
         this.placeholderProvider = placeholderProvider;
+        this.paper = paper;
+        this.bungeecord = bungeecord;
+        this.velocity = velocity;
     }
     
-    public static Map<String, PlaceholderProvider> getBanPlugins(){
-        Map<String, PlaceholderProvider> content = new HashMap<>();
-        
-        for(BungeeCordBanPlugins bungeeCordBanPlugins : BungeeCordBanPlugins.values()){
-            content.put(bungeeCordBanPlugins.plugin, bungeeCordBanPlugins.placeholderProvider);
-        }
-        
-        return content;
+    public String getName(){
+        return name;
+    }
+    
+    public PlaceholderProvider getPlaceholderProvider(){
+        return placeholderProvider;
+    }
+    
+    public boolean supportsPaper(){
+        return paper;
+    }
+    
+    public boolean supportsBungeeCord(){
+        return bungeecord;
+    }
+    
+    public boolean supportsVelocity(){
+        return velocity;
     }
 }

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/bungeecord/BungeeCordBanPluginsAddon.java

@@ -26,11 +26,9 @@
 package ch.andre601.advancedserverlist.banplugins.bungeecord;
 
 import ch.andre601.advancedserverlist.api.AdvancedServerListAPI;
-import ch.andre601.advancedserverlist.api.PlaceholderProvider;
+import ch.andre601.advancedserverlist.banplugins.BanPluginsList;
 import net.md_5.bungee.api.plugin.Plugin;
 
-import java.util.Map;
-
 public class BungeeCordBanPluginsAddon extends Plugin{
     
     @Override
@@ -50,14 +48,16 @@ public class BungeeCordBanPluginsAddon extends Plugin{
     
     private int loadPlaceholderProviders(){
         int loaded = 0;
-        Map<String, PlaceholderProvider> banPlugins = BungeeCordBanPlugins.getBanPlugins();
         AdvancedServerListAPI api = AdvancedServerListAPI.get();
         
-        for(Map.Entry<String, PlaceholderProvider> entry : banPlugins.entrySet()){
-            if(getProxy().getPluginManager().getPlugin(entry.getKey()) != null){
-                getLogger().info("Registering Placeholders for " + entry.getKey() + "...");
-                api.addPlaceholderProvider(entry.getValue());
-                getLogger().info("Placeholder successfully registered!");
+        for(BanPluginsList entry : BanPluginsList.values()){
+            if(!entry.supportsBungeeCord())
+                continue;
+            
+            if(getProxy().getPluginManager().getPlugin(entry.getName()) != null){
+                getLogger().info("Registering Placeholders for " + entry.getName() + "...");
+                api.addPlaceholderProvider(entry.getPlaceholderProvider());
+                getLogger().info("Placeholders successfully registered!");
                 
                 loaded++;
             }

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/paper/PaperBanPlugins.java

@@ -1,57 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2022-2024 Andre_601
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- */
-
-package ch.andre601.advancedserverlist.banplugins.paper;
-
-import ch.andre601.advancedserverlist.api.PlaceholderProvider;
-import ch.andre601.advancedserverlist.banplugins.placeholders.AdvancedBanPlaceholders;
-import ch.andre601.advancedserverlist.banplugins.placeholders.LibertyBansPlaceholders;
-
-import java.util.HashMap;
-import java.util.Map;
-
-public enum PaperBanPlugins{
-    
-    ADVANCED_BAN("AdvancedBan", new AdvancedBanPlaceholders()),
-    LIBERTY_BANS("LibertyBans", new LibertyBansPlaceholders());
-    
-    private final String plugin;
-    private final PlaceholderProvider placeholderProvider;
-    
-    PaperBanPlugins(String plugin, PlaceholderProvider placeholderProvider){
-        this.plugin = plugin;
-        this.placeholderProvider = placeholderProvider;
-    }
-    
-    public static Map<String, PlaceholderProvider> getBanPlugins(){
-        Map<String, PlaceholderProvider> content = new HashMap<>();
-        
-        for(PaperBanPlugins paperBanPlugins : PaperBanPlugins.values()){
-            content.put(paperBanPlugins.plugin, paperBanPlugins.placeholderProvider);
-        }
-        
-        return content;
-    }
-}

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/paper/PaperBanPluginsAddon.java

@@ -26,11 +26,9 @@
 package ch.andre601.advancedserverlist.banplugins.paper;
 
 import ch.andre601.advancedserverlist.api.AdvancedServerListAPI;
-import ch.andre601.advancedserverlist.api.PlaceholderProvider;
+import ch.andre601.advancedserverlist.banplugins.BanPluginsList;
 import org.bukkit.plugin.java.JavaPlugin;
 
-import java.util.Map;
-
 public class PaperBanPluginsAddon extends JavaPlugin{
     
     @Override
@@ -53,14 +51,16 @@ public class PaperBanPluginsAddon extends JavaPlugin{
     
     private int loadPlaceholderProviders(){
         int loaded = 0;
-        Map<String, PlaceholderProvider> banPlugins = PaperBanPlugins.getBanPlugins();
         AdvancedServerListAPI api = AdvancedServerListAPI.get();
         
-        for(Map.Entry<String, PlaceholderProvider> entry : banPlugins.entrySet()){
-            if(getServer().getPluginManager().isPluginEnabled(entry.getKey())){
-                getLogger().info("Registering Placeholders for " + entry.getKey() + "...");
-                api.addPlaceholderProvider(entry.getValue());
-                getLogger().info("Placeholder successfully registered!");
+        for(BanPluginsList entry : BanPluginsList.values()){
+            if(!entry.supportsPaper())
+                continue;
+            
+            if(getServer().getPluginManager().isPluginEnabled(entry.getName())){
+                getLogger().info("Registering Placeholders for " + entry.getName() + "...");
+                api.addPlaceholderProvider(entry.getPlaceholderProvider());
+                getLogger().info("Placeholders successfully registered!");
                 
                 loaded++;
             }

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/placeholders/AdvancedBanPlaceholders.java

@@ -32,7 +32,7 @@ import ch.andre601.advancedserverlist.banplugins.providers.AdvancedBanProvider;
 
 public class AdvancedBanPlaceholders extends PlaceholderProvider{
     
-    private final AdvancedBanProvider provider = new AdvancedBanProvider();
+    private AdvancedBanProvider provider = null;
     
     public AdvancedBanPlaceholders(){
         super("advancedban");
@@ -40,6 +40,9 @@ public class AdvancedBanPlaceholders extends PlaceholderProvider{
     
     @Override
     public String parsePlaceholder(String placeholder, GenericPlayer player, GenericServer server){
+        if(provider == null)
+            provider = new AdvancedBanProvider();
+        
         String[] args = placeholder.split("\\s", 2);
         
         return switch(args[0]) {

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/placeholders/LibertyBansPlaceholders.java

@@ -32,7 +32,7 @@ import ch.andre601.advancedserverlist.banplugins.providers.LibertyBansProvider;
 
 public class LibertyBansPlaceholders extends PlaceholderProvider{
     
-    private final LibertyBansProvider provider = LibertyBansProvider.create();
+    private LibertyBansProvider provider = null;
     
     public LibertyBansPlaceholders(){
         super("libertybans");
@@ -40,6 +40,9 @@ public class LibertyBansPlaceholders extends PlaceholderProvider{
     
     @Override
     public String parsePlaceholder(String placeholder, GenericPlayer player, GenericServer server){
+        if(provider == null)
+            provider = LibertyBansProvider.create();
+        
         String[] args = placeholder.split("\\s", 2);
         
         return switch(args[0]){

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/placeholders/LiteBansPlaceholders.java

@@ -0,0 +1,85 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022-2024 Andre_601
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+package ch.andre601.advancedserverlist.banplugins.placeholders;
+
+import ch.andre601.advancedserverlist.api.PlaceholderProvider;
+import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
+import ch.andre601.advancedserverlist.api.objects.GenericServer;
+import ch.andre601.advancedserverlist.banplugins.providers.LiteBansProvider;
+
+import java.util.concurrent.CancellationException;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionException;
+
+public class LiteBansPlaceholders extends PlaceholderProvider{
+    
+    private LiteBansProvider provider = null;
+    
+    public LiteBansPlaceholders(){
+        super("litebans");
+    }
+    
+    @Override
+    public String parsePlaceholder(String placeholder, GenericPlayer player, GenericServer server){
+        if(provider == null)
+            provider = new LiteBansProvider();
+        
+        String[] args = placeholder.split("\\s", 2);
+        
+        CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> 
+            switch(args[0]){
+                // Mute-related placeholders
+                case "isMuted" -> String.valueOf(provider.muted(player));
+                case "muteReason" -> provider.muteReason(player);
+                case "muteExpiration" -> {
+                    if(args.length == 1)
+                        yield provider.muteExpirationDate(player);
+                    
+                    yield provider.muteExpirationDate(player, args[1]);
+                }
+                
+                // Ban-related placeholders
+                case "isBanned" -> String.valueOf(provider.banned(player));
+                case "banReason" -> provider.banReason(player);
+                case "banExpiration" -> {
+                    if(args.length == 1)
+                        yield provider.banExpirationDate(player);
+                    
+                    yield provider.banExpirationDate(player, args[1]);
+                }
+                
+                //Unknown/Invalid placeholder
+                default -> null;
+            }
+        );
+        
+        try{
+            return future.join();
+        }catch(CancellationException | CompletionException ex){
+            return null;
+        }
+    }
+}

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/providers/LiteBansProvider.java

@@ -0,0 +1,103 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022-2024 Andre_601
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+package ch.andre601.advancedserverlist.banplugins.providers;
+
+import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
+import litebans.api.Database;
+import litebans.api.Entry;
+
+public class LiteBansProvider implements PunishmentProvider{
+    
+    @Override
+    public boolean muted(GenericPlayer player){
+        return Database.get().isPlayerMuted(player.getUUID(), null);
+    }
+    
+    @Override
+    public boolean banned(GenericPlayer player){
+        return Database.get().isPlayerBanned(player.getUUID(), null);
+    }
+    
+    @Override
+    public String muteReason(GenericPlayer player){
+        Entry mute = Database.get().getMute(player.getUUID(), null, null);
+        if(mute == null)
+            return null;
+        
+        return mute.getReason();
+    }
+    
+    @Override
+    public String banReason(GenericPlayer player){
+        Entry ban = Database.get().getBan(player.getUUID(), null, null);
+        if(ban == null)
+            return null;
+        
+        return ban.getReason();
+    }
+    
+    @Override
+    public String muteDuration(GenericPlayer player){
+        Entry mute = Database.get().getMute(player.getUUID(), null, null);
+        if(mute == null)
+            return null;
+        
+        return mute.getDurationString();
+    }
+    
+    @Override
+    public String banDuration(GenericPlayer player){
+        Entry ban = Database.get().getBan(player.getUUID(), null, null);
+        if(ban == null)
+            return null;
+        
+        return ban.getDurationString();
+    }
+    
+    @Override
+    public String muteExpirationDate(GenericPlayer player, String pattern){
+        Entry mute = Database.get().getMute(player.getUUID(), null, null);
+        if(mute == null)
+            return null;
+        
+        if(mute.isPermanent())
+            return "never";
+        
+        return this.returnDate(pattern, mute.getDateEnd());
+    }
+    
+    @Override
+    public String banExpirationDate(GenericPlayer player, String pattern){
+        Entry ban = Database.get().getBan(player.getUUID(), null, null);
+        if(ban == null)
+            return null;
+        
+        if(ban.isPermanent())
+            return "never";
+        
+        return this.returnDate(pattern, ban.getDateEnd());
+    }
+}

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/velocity/VelocityBanPlugins.java

@@ -1,56 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2022-2024 Andre_601
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- */
-
-package ch.andre601.advancedserverlist.banplugins.velocity;
-
-import ch.andre601.advancedserverlist.api.PlaceholderProvider;
-import ch.andre601.advancedserverlist.banplugins.paper.PaperBanPlugins;
-import ch.andre601.advancedserverlist.banplugins.placeholders.LibertyBansPlaceholders;
-
-import java.util.HashMap;
-import java.util.Map;
-
-public enum VelocityBanPlugins{
-    
-    LIBERTY_BANS("libertybans", new LibertyBansPlaceholders());
-    
-    private final String plugin;
-    private final PlaceholderProvider placeholderProvider;
-    
-    VelocityBanPlugins(String plugin, PlaceholderProvider placeholderProvider){
-        this.plugin = plugin;
-        this.placeholderProvider = placeholderProvider;
-    }
-    
-    public static Map<String, PlaceholderProvider> getBanPlugins(){
-        Map<String, PlaceholderProvider> content = new HashMap<>();
-        
-        for(VelocityBanPlugins velocityBanPlugins : VelocityBanPlugins.values()){
-            content.put(velocityBanPlugins.plugin, velocityBanPlugins.placeholderProvider);
-        }
-        
-        return content;
-    }
-}

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/velocity/VelocityBanPluginsAddon.java

@@ -26,15 +26,15 @@
 package ch.andre601.advancedserverlist.banplugins.velocity;
 
 import ch.andre601.advancedserverlist.api.AdvancedServerListAPI;
-import ch.andre601.advancedserverlist.api.PlaceholderProvider;
+import ch.andre601.advancedserverlist.banplugins.BanPluginsList;
 import com.google.inject.Inject;
 import com.velocitypowered.api.event.Subscribe;
 import com.velocitypowered.api.event.proxy.ProxyInitializeEvent;
-import net.md_5.bungee.api.ProxyServer;
+import com.velocitypowered.api.proxy.ProxyServer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.Map;
+import java.util.Locale;
 
 public class VelocityBanPluginsAddon{
     
@@ -49,7 +49,7 @@ public class VelocityBanPluginsAddon{
     
     @Subscribe
     public void init(ProxyInitializeEvent event){
-        if(proxy.getPluginManager().getPlugin("advancedserverlist") == null){
+        if(!proxy.getPluginManager().isLoaded("advancedserverlist")){
             logger.warn("AdvancedServerList is not enabled. This plugin requires it to function!");
             return;
         }
@@ -64,14 +64,16 @@ public class VelocityBanPluginsAddon{
     
     private int loadPlaceholderProviders(){
         int loaded = 0;
-        Map<String, PlaceholderProvider> banPlugins = VelocityBanPlugins.getBanPlugins();
         AdvancedServerListAPI api = AdvancedServerListAPI.get();
         
-        for(Map.Entry<String, PlaceholderProvider> entry : banPlugins.entrySet()){
-            if(proxy.getPluginManager().getPlugin(entry.getKey()) != null){
-                logger.info("Registering placeholders for {}...", entry.getKey());
-                api.addPlaceholderProvider(entry.getValue());
-                logger.info("Placeholder successfully registered!");
+        for(BanPluginsList entry : BanPluginsList.values()){
+            if(!entry.supportsVelocity())
+                continue;
+            
+            if(proxy.getPluginManager().isLoaded(entry.getName().toLowerCase(Locale.ROOT))){
+                logger.info("Registering Placeholders for " + entry.getName() + "...");
+                api.addPlaceholderProvider(entry.getPlaceholderProvider());
+                logger.info("Placeholders successfully registered!");
                 
                 loaded++;
             }

addons/banplugins/src/main/resources/bungee.yml

@@ -7,5 +7,6 @@ softDepends:
   - AdvancedServerList
   - AdvancedBan
   - LibertyBans
+  - LiteBans
 
 main: 'ch.andre601.advancedserverlist.banplugins.bungeecord.BungeeCordBanPluginsAddon'

addons/banplugins/src/main/resources/paper-plugin.yml

@@ -15,5 +15,8 @@ dependencies:
       required: false
       load: BEFORE
     LibertyBans:
+      required: false
+      load: BEFORE
+    LiteBans:
       required: false
       load: BEFORE

addons/banplugins/src/main/resources/velocity-plugin.json

@@ -14,6 +14,10 @@
     {
       "id": "libertybans",
       "optional": true
+    },
+    {
+      "id": "litebans",
+      "optional": true
     }
   ],
   "main": "ch.andre601.advancedserverlist.banplugins.velocity.VelocityBanPluginsAddon"

docs/addons/banplugins.md

@@ -4,55 +4,34 @@ The BanPlugins Addon was made to provide placeholders for different punishment p
 
 ## Placeholders
 
-### AdvancedBan
+/// tab | AdvancedBan
+[Plugin Page](https://www.spigotmc.org/resources/8695/){ target="_blank" rel="nofollow" }
 
-Placeholders for the plugin [AdvancedBan](https://www.spigotmc.org/resources/8695/){ target="_blank" rel="nofollow" } are available to use.
+**Supported Platforms:**
 
-| Placeholder                     | Description                                                                               |
-|---------------------------------|-------------------------------------------------------------------------------------------|
-| `${advancedban isMuted}`        | Whether the player is muted or not.                                                       |
-| `${advancedban muteReason}`     | The reason for why the player was muted. Returns invalid placeholder if no mute was set.  |
-| `${advancedban muteDuration}`   | Relative time until the mute expires.[^1] Returns invalid placeholder if no mute was set. |
-| `${advancedban muteExpiration}` | Date on when the mute will expire.[^2]                                                    |
-| `${advancedban isBanned}`       | Whether the player is banned or not.                                                      |
-| `${advancedban banReason}`      | The reason for why the player was banned. Returns invalid placeholder if no ban was set.  |
-| `${advancedban banDuration}`    | Relative time until the ban expires.[^3] Returns invalid placeholder if no ban was set.   |
-| `${advancedban banExpiration}`  | Date on when the ban will expire.[^4]                                                     |
-
-[^1]:
-    An optional boolean can be added to set whether the duration should be from the start or not. `false` is the default.  
-    Example: `${advancedban muteDuration true}`
-[^2]:
-    An optional Date and time Pattern can be set to change the displayed output. The default is `dd, MMM yyyy HH:mm:ss`.  
-    Example: `${advancedban muteExpiration yyyy-MM-dd HH:mm:ss}`
-[^3]:
-    An optional boolean can be added to set whether the duration should be from the start or not. `false` is the default.  
-    Example: `${advancedban banDuration true}`
-[^4]:
-    An optional Date and time Pattern can be set to change the displayed output. The default is `dd, MMM yyyy HH:mm:ss`.  
-    Example: `${advancedban banExpiration yyyy-MM-dd HH:mm:ss}`
-
-### LibertyBans
-
-Placeholders for the plugin [LibertyBans](https://modrinth.com/plugin/libertybans/){ target="_blank" rel="nofollow" } are available to use.
+- :fontawesome-solid-paper-plane: Paper
+- :simple-spigotmc: BungeeCord
 
 | Placeholder                     | Description                                                                              |
 |---------------------------------|------------------------------------------------------------------------------------------|
-| `${libertybans isMuted}`        | Whether the player is muted or not.                                                      |
-| `${libertybans muteReason}`     | The reason for why the player was muted. Returns invalid placeholder if no mute was set. |
-| `${libertybans muteExpiration}` | Date on when the mute will expire.[^5]                                                   |
-| `${libertybans isBanned}`       | Whether the player is banned or not.                                                     |
-| `${libertybans banReason}`      | The reason for why the player was banned. Returns invalid placeholder if no ban was set. |
-| `${libertybans banExpiration}`  | Date on when the ban will expire.[^6]                                                    |
+| `${advancedban isMuted}`        | Whether the player is muted or not.                                                      |
+| `${advancedban muteReason}`     | The reason for why the player was muted. Returns invalid placeholder if no mute was set. |
+| `${advancedban muteDuration}`   | Relative time until the mute expires. Returns invalid placeholder if no mute was set.    |
+| `${advancedban muteExpiration}` | Date on when the mute will expire-                                                       |
+| `${advancedban isBanned}`       | Whether the player is banned or not.                                                     |
+| `${advancedban banReason}`      | The reason for why the player was banned. Returns invalid placeholder if no ban was set. |
+| `${advancedban banDuration}`    | Relative time until the ban expires. Returns invalid placeholder if no ban was set.      |
+| `${advancedban banExpiration}`  | Date on when the ban will expire.                                                        |
 
-[^5]:
-    An optional Date and time Pattern can be set to change the displayed output. The default is `dd, MMM yyyy HH:mm:ss`.  
-    Example: `${libertybans muteExpiration yyyy-MM-dd HH:mm:ss}`
-[^6]:
-    An optional Date and time Pattern can be set to change the displayed output. The default is `dd, MMM yyyy HH:mm:ss`.  
-    Example: `${libertybans banExpiration yyyy-MM-dd HH:mm:ss}`
+//// note | Notes
+-   `${advancedban muteDuration}` and `${advancedban banDuration}` accept an optional boolean to set, whether the mute/ban duration should be from the start.  
+    Default is `false`.
+-   `${advancedban muteExpiration}` and `${advancedban banExpiration}` accept an optional Date and Time pattern to format the time into.  
+    Default is `dd, MMM yyyy HH:mm:ss`.
+////
 
-## Example
+//// details | Example
+    type: example
 
 ```yaml title="banned.yml"
 priority: 1
@@ -61,4 +40,84 @@ condition: '${advancedban isBanned}'
 motd:
   - '<red>You were <bold>BANNED</bold>!'
   - '<red>Expires: <grey>${advancedban banExpiration}'
-```
+```
+////
+
+///
+
+/// tab | LibertyBans
+[Plugin Page](https://modrinth.com/plugin/libertybans/){ target="_blank" rel="nofollow" }
+
+**Supported Platforms:**
+
+- :fontawesome-solid-paper-plane: Paper
+- :simple-spigotmc: BungeeCord
+- :fontawesome-solid-paper-plane: Velocity
+
+| Placeholder                     | Description                                                                              |
+|---------------------------------|------------------------------------------------------------------------------------------|
+| `${libertybans isMuted}`        | Whether the player is muted or not.                                                      |
+| `${libertybans muteReason}`     | The reason for why the player was muted. Returns invalid placeholder if no mute was set. |
+| `${libertybans muteExpiration}` | Date on when the mute will expire.                                                       |
+| `${libertybans isBanned}`       | Whether the player is banned or not.                                                     |
+| `${libertybans banReason}`      | The reason for why the player was banned. Returns invalid placeholder if no ban was set. |
+| `${libertybans banExpiration}`  | Date on when the ban will expire.                                                        |
+
+//// note | Notes
+- `${libertybans muteExpiration}` and `${libertybans banExpiration}` accept an optional Date and Time pattern to format the time into.  
+  Default is `dd, MMM yyyy HH:mm:ss`.
+////
+
+//// details | Example
+    type: example
+
+```yaml title="banned.yml"
+priority: 1
+condition: '${libertybans isBanned}'
+
+motd:
+  - '<red>You were <bold>BANNED</bold>!'
+  - '<red>Expires: <grey>${libertybans banExpiration}'
+```
+////
+
+///
+
+/// tab | LiteBans
+[Plugin Page](https://www.spigotmc.org/resources/3715/){ target="_blank" rel="nofollow" }
+
+**Supported Platforms:**
+
+- :fontawesome-solid-paper-plane: Paper
+- :simple-spigotmc: BungeeCord
+- :fontawesome-solid-paper-plane: Velocity
+
+| Placeholder                  | Description                                                                              |
+|------------------------------|------------------------------------------------------------------------------------------|
+| `${litebans isMuted}`        | Whether the player is muted or not.                                                      |
+| `${litebans muteReason}`     | The reason for why the player was muted. Returns invalid placeholder if no mute was set. |
+| `${litebans muteDuration}`   | Relative time until the mute expires. Returns invalid placeholder if no mute was set.    |
+| `${litebans muteExpiration}` | Date on when the mute will expire-                                                       |
+| `${litebans isBanned}`       | Whether the player is banned or not.                                                     |
+| `${litebans banReason}`      | The reason for why the player was banned. Returns invalid placeholder if no ban was set. |
+| `${litebans banDuration}`    | Relative time until the ban expires. Returns invalid placeholder if no ban was set.      |
+| `${litebans banExpiration}`  | Date on when the ban will expire.                                                        |
+
+//// note | Notes
+-   `${litebans muteExpiration}` and `${litebans banExpiration}` accept an optional Date and Time pattern to format the time into.  
+    Default is `dd, MMM yyyy HH:mm:ss`.
+////
+
+//// details | Example
+    type: example
+
+```yaml title="banned.yml"
+priority: 1
+condition: '${litebans isBanned}'
+
+motd:
+  - '<red>You were <bold>BANNED</bold>!'
+  - '<red>Expires: <grey>${litebans banExpiration}'
+```
+////
+///

docs/migration/serverlistplus.md

@@ -13,7 +13,7 @@ This is due to AdvancedServerList using the internal API of ServerListPlus to re
 
 ## Conversions
 
-Specific values within the ServerListPlus configuration will be converted into equivalents supported by AdvancedServerListPlus.
+Specific values within the ServerListPlus configuration will be converted into equivalents supported by AdvancedServerList.
 
 ### Placeholders
 

pom.xml

@@ -37,7 +37,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         
-        <plugin.version>4.8.0</plugin.version>
+        <plugin.version>4.9.0</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
         <api.version>3.3.0</api.version>

requirements.txt

@@ -1,3 +1,3 @@
-mkdocs-material==9.5.21
+mkdocs-material==9.5.22
 mkdocs-glightbox==0.4.0
 git+https://github.com/Andre601/mkdocs-pagenav-generator