Merge pull request #94 from Andre601/fix/81-noclassdeffoundexception-issue

Fix ProtocolLib component issue

.github/workflows/create-pr-artifact.yml

@@ -0,0 +1,100 @@
+name: Create PR Artifacts
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+      - synchronize
+    branches:
+      - master
+    paths-ignore:
+      - '.github/**'
+      - 'docs/**'
+      - '.gitignore'
+      - 'LICENSE'
+      - 'README.md'
+      - 'mkdocs.yml'
+      - 'requirements.txt'
+
+concurrency:
+  group: '${{ github.workflow }}-${{ github.head_ref }}'
+  cancel-in-progress: false
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  buildArtifacts:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+        with:
+          ref: refs/pull/${{ github.event.pull_request.number }}/merge
+      - name: Find Comment
+        uses: peter-evans/find-comment@v2
+        id: find-comment
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: '<!-- pr-build comment -->'
+      - name: Print Comment info
+        run: |
+          echo "Comment ID: ${{ steps.find-comment.outputs.comment-id }}"
+          echo "Comment Author: ${{ steps.find-comment.outputs.comment-author }}"
+          echo "Comment created at: ${{ steps.find-comment.outputs.comment-created-at }}"
+      - name: Post/Update Comment
+        uses: peter-evans/create-or-update-comment@v3
+        id: comment
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-id: ${{ steps.find-comment.outputs.comment-id }}
+          edit-mode: replace
+          body: |-
+            <!-- pr-build comment -->
+            ![badge]
+            
+            Please wait while we're building the Jar files for this Pull request...
+            
+            [badge]: https://img.shields.io/badge/Building...-0d1117?style=for-the-badge&labelColor=7a8490&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiBmaWxsPSIjZmZmZmZmIj48cGF0aCBkPSJNNC43NSAyaDE0LjVhLjc1Ljc1IDAgMCAxIDAgMS41aC0uNzV2Mi45ODJhNC43NSA0Ljc1IDAgMCAxLTIuMjE1IDQuMDE3bC0yLjA0NCAxLjI5YS4yNS4yNSAwIDAgMCAwIC40MjJsMi4wNDQgMS4yOWE0Ljc1IDQuNzUgMCAwIDEgMi4yMTUgNC4wMTdWMjAuNWguNzVhLjc1Ljc1IDAgMCAxIDAgMS41SDQuNzVhLjc1Ljc1IDAgMCAxIDAtMS41aC43NXYtMi45ODJhNC43NSA0Ljc1IDAgMCAxIDIuMjE1LTQuMDE3bDIuMDQ0LTEuMjlhLjI1LjI1IDAgMCAwIDAtLjQyMmwtMi4wNDQtMS4yOUE0Ljc1IDQuNzUgMCAwIDEgNS41IDYuNDgyVjMuNWgtLjc1YS43NS43NSAwIDAgMSAwLTEuNVpNMTcgMy41SDd2Mi45ODJBMy4yNSAzLjI1IDAgMCAwIDguNTE2IDkuMjNsMi4wNDQgMS4yOWExLjc1IDEuNzUgMCAwIDEgMCAyLjk2bC0yLjA0NCAxLjI5QTMuMjUgMy4yNSAwIDAgMCA3IDE3LjUxOFYyMC41aDEwdi0yLjk4MmEzLjI1IDMuMjUgMCAwIDAtMS41MTYtMi43NDhsLTIuMDQ0LTEuMjlhMS43NSAxLjc1IDAgMCAxIDAtMi45NmwyLjA0NC0xLjI5QTMuMjUgMy4yNSAwIDAgMCAxNyA2LjQ4MloiPjwvcGF0aD48L3N2Zz4=
+      - name: Set up JDK 1.16
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '16'
+          cache: 'maven'
+      - name: Obtain short Commit SHA
+        id: get-commit
+        run: 'echo "sha_short=$(git rev-parse --short ${{ github.event.pull_request.head.sha }})" >> $GITHUB_OUTPUT'
+      - name: Build Jar files
+        run: mvn clean install
+        env:
+          COMMIT_SHA: ${{ steps.get-commit.outputs.sha_short }}
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: AdvancedServerList-Artifacts
+          path: '*/target/AdvancedServerList-*.jar'
+          if-no-files-found: error
+      - name: Update Comment (Failure)
+        if: failure()
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-id: ${{ steps.comment.outputs.comment-id }}
+          edit-mode: replace
+          body: |-
+            <!-- pr-build comment -->
+            ![badge]
+            
+            The Build of this Pull request failed.  
+            Please check the below linked logs for a possible cause.
+            
+            | Name   | Link                                                                                |
+            | ------ | ----------------------------------------------------------------------------------- |
+            | Commit | ${{ github.event.pull_request.head.sha }}                                           |
+            | Logs   | ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} |
+            
+            [badge]: https://img.shields.io/badge/Build_Failure!-0d1117?style=for-the-badge&labelColor=f85149&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiBmaWxsPSIjZmZmZmZmIj48cGF0aCBkPSJNNS43MiA1LjcyYS43NS43NSAwIDAgMSAxLjA2IDBMMTIgMTAuOTRsNS4yMi01LjIyYS43NDkuNzQ5IDAgMCAxIDEuMjc1LjMyNi43NDkuNzQ5IDAgMCAxLS4yMTUuNzM0TDEzLjA2IDEybDUuMjIgNS4yMmEuNzQ5Ljc0OSAwIDAgMS0uMzI2IDEuMjc1Ljc0OS43NDkgMCAwIDEtLjczNC0uMjE1TDEyIDEzLjA2bC01LjIyIDUuMjJhLjc1MS43NTEgMCAwIDEtMS4wNDItLjAxOC43NTEuNzUxIDAgMCAxLS4wMTgtMS4wNDJMMTAuOTQgMTIgNS43MiA2Ljc4YS43NS43NSAwIDAgMSAwLTEuMDZaIj48L3BhdGg+PC9zdmc+

.github/workflows/pr-builds.yml.disabled

@@ -1,88 +0,0 @@
-name: 'Build PR changes'
-
-on:
-  pull_request_target:
-    types:
-      - opened
-      - reopened
-      - synchronize
-    paths:
-      - 'bukkit/src/**'
-      - 'bungeecord/src/**'
-      - 'core/src/**'
-      - 'velocity/src/**'
-
-concurrency: 'pr-preview'
-
-jobs:
-  buildJars:
-    name: 'Build Jars from Pull request'
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'Checkout Repository'
-        uses: actions/checkout@v3
-      - name: 'Setup Java 16'
-        uses: actions/setup-java@v3
-        with:
-          distribution: temurin
-          java-version: '16'
-          cache: 'maven'
-      - name: 'Build Jar files'
-        run: mvn clean install
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v3
-        with:
-          name: asl-files
-          path: '*/target/AdvancedServerList-*.jar'
-          if-no-files-found: error
-  updateCommentSuccess:
-    name: 'Create or update Comment (On Success).'
-    needs: [buildJars]
-    if: success()
-    runs-on: ubuntu-latest
-    steps:
-      - name: Find comment
-        uses: peter-evans/find-comment@v2
-        id: find-comment
-        with:
-          issue-number: ${{ github.event.pull_request.number }}
-          comment-author: 'github-actions[bot]'
-      - name: Update Comment
-        uses: peter-evans/create-or-update-comment@v2
-        with:
-          body: |-
-            ## Build Preview
-            
-            Below is a URL to the Jar files made using this Pull request.
-            Please note that artifacts build by this GitHub Action only exist for at most 90 days since last run!
-  
-            | Name      | Link                                                                                |
-            |-----------|-------------------------------------------------------------------------------------|
-            | Commit    | ${{ github.event.pull_request.head.sha }}                                           |
-            | Logs      | ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} |
-            | Jar Files | <!-- What can I put here? -->                                                       |
-  UpdateCommentFailure:
-    name: 'Create or update Comment (On Success).'
-    needs: [buildJars]
-    if: failure()
-    runs-on: ubuntu-latest
-    steps:
-      - name: Find comment
-        uses: peter-evans/find-comment@v2
-        id: find-comment
-        with:
-          issue-number: ${{ github.event.pull_request.number }}
-          comment-author: 'github-actions[bot]'
-      - name: Update Comment
-        uses: peter-evans/create-or-update-comment@v2
-        with:
-          body: |-
-            ## Build Preview
-        
-            There was an issue generating the Jar files from your Pull request.
-            Please review the logs linked below for further information.
-            
-            | Name   | Link                                                                                |
-            |--------|-------------------------------------------------------------------------------------|
-            | Commit | ${{ github.event.pull_request.head.sha }}                                           |
-            | Logs   | ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} |

.github/workflows/pr-comment.yml

@@ -0,0 +1,99 @@
+name: Comment on Pull request
+
+on:
+  workflow_run:
+    types:
+      - completed
+    workflows:
+      - 'Create PR Artifacts'
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  comment:
+    if: github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get Artifact and Pull request info
+        env:
+          GITHUB_TOKEN: ${{ github.token }} # No idea why this is set here when ${{ secrets.GITHUB_TOKEN }} is a thing...
+          WORKFLOW_RUN_EVENT_OBJ: ${{ toJSON(github.event.workflow_run) }}
+          OWNER: ${{ github.repository_owner }}
+          REPO: ${{ github.event.repository.name }}
+        run: |
+          PREVIOUS_JOB_ID=$(jq -r '.id' <<< "$WORKFLOW_RUN_EVENT_OBJ")
+          echo "Previous Job ID: $PREVIOUS_JOB_ID"
+          echo "PREVIOUS_JOB_ID=$PREVIOUS_JOB_ID" >> "$GITHUB_ENV"
+          
+          SUITE_ID=$(jq -r '.check_suite_id' <<< "$WORKFLOW_RUN_EVENT_OBJ")
+          echo "Previous Suite ID: $SUITE_ID"
+          echo "SUITE_ID=$SUITE_ID" >> "$GITHUB_ENV"
+          
+          ARTIFACT_ID=$(gh api "/repos/$OWNER/$REPO/actions/artifacts" \
+            --jq ".artifacts.[] |
+            select(.workflow_run.id==${PREVIOUS_JOB_ID}) |
+            select(.expired==false) |
+            .id")
+          
+          echo "Artifact ID: $ARTIFACT_ID"
+          echo "ARTIFACT_ID=$ARTIFACT_ID" >> "$GITHUB_ENV"
+          
+          ARTIFACT_EXPIRE_DATE=$(gh api "/repos/$OWNER/$REPO/actions/artifacts" \
+            --jq ".artifacts.[] |
+            select(.workflow_run.id==${PREVIOUS_JOB_ID}) |
+            select(.expired==false) |
+            .expires_at")
+          
+          echo "Artifact Expire Date: $ARTIFACT_EXPIRE_DATE"
+          echo "ARTIFACT_EXPIRE_DATE=$ARTIFACT_EXPIRE_DATE" >> "$GITHUB_ENV"
+          
+          PR_NUMBER=$(jq -r '.pull_requests[0].number' \
+            <<< "$WORKFLOW_RUN_EVENT_OBJ")
+          
+          echo "Pull request Number: $PR_NUMBER"
+          echo "PR_NUMBER=$PR_NUMBER" >> "$GITHUB_ENV"
+          
+          HEAD_SHA=$(jq -r '.pull_requests[0].head.sha' \
+            <<< "$WORKFLOW_RUN_EVENT_OBJ")
+          
+          echo "Head SHA: $HEAD_SHA"
+          echo "HEAD_SHA=$HEAD_SHA" >> "$GITHUB_ENV"
+      - name: Find Comment
+        uses: peter-evans/find-comment@v2
+        id: find-comment
+        with:
+          issue-number: ${{ env.PR_NUMBER }}
+          comment-author: 'github-actions[bot]'
+          body-includes: '<!-- pr-build comment -->'
+      - name: Print Comment info
+        run: |
+          echo "Comment ID: ${{ steps.find-comment.outputs.comment-id }}"
+          echo "Comment Author: ${{ steps.find-comment.outputs.comment-author }}"
+          echo "Comment created at: ${{ steps.find-comment.outputs.comment-created-at }}"
+      - name: Update Comment
+        env:
+          JOB_PATH: "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ env.PREVIOUS_JOB_ID }}"
+          ARTIFACT_URL: "${{ github.server_url }}/${{ github.repository }}/suites/${{ env.SUITE_ID }}/artifacts/${{ env.ARTIFACT_ID }}"
+          ARTIFACT_EXPIRE_DATE: "${{ env.ARTIFACT_EXPIRE_DATE }}"
+          HEAD_SHA: "${{ env.HEAD_SHA }}"
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          issue-number: ${{ env.PR_NUMBER }}
+          comment-id: ${{ steps.find-comment.outputs.comment-id }}
+          edit-mode: replace
+          body: |-
+            <!-- pr-build comment -->
+            ![badge]
+            
+            Build Successful! You can find a link to the downloadable artifact below.  
+            Expire Date: `${{ env.ARTIFACT_EXPIRE_DATE }}`
+            
+            | Name     | Link                    |
+            | -------- | ----------------------- |
+            | Commit   | ${{ env.HEAD_SHA }}     |
+            | Logs     | ${{ env.JOB_PATH }}     |
+            | Download | ${{ env.ARTIFACT_URL }} |
+            
+            [badge]: https://img.shields.io/badge/Build_Success!-0d1117?style=for-the-badge&labelColor=3fb950&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiBmaWxsPSIjZmZmZmZmIj48cGF0aCBkPSJNMjEuMDMgNS43MmEuNzUuNzUgMCAwIDEgMCAxLjA2bC0xMS41IDExLjVhLjc0Ny43NDcgMCAwIDEtMS4wNzItLjAxMmwtNS41LTUuNzVhLjc1Ljc1IDAgMSAxIDEuMDg0LTEuMDM2bDQuOTcgNS4xOTVMMTkuOTcgNS43MmEuNzUuNzUgMCAwIDEgMS4wNiAwWiI+PC9wYXRoPjwvc3ZnPg==

bukkit/pom.xml

@@ -124,7 +124,7 @@
     </dependencies>
 
     <build>
-        <finalName>AdvancedServerList-Bukkit-${plugin.version}</finalName>
+        <finalName>AdvancedServerList-Bukkit-${plugin.version}${project.build.commit}</finalName>
         <resources>
             <resource>
                 <filtering>true</filtering>

bukkit/src/main/java/ch/andre601/advancedserverlist/bukkit/BukkitCore.java

@@ -0,0 +1,36 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022-2023 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.bukkit;
+
+import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
+import org.bukkit.plugin.java.JavaPlugin;
+
+/* 
+ * Small convenience class to "merge" the PluginCore and JavaPlugin classes.
+ * Allows me to have BukkitCore<?> for whenever I also need a JavaPlugin (i.e. registering events).
+ * See JoinEvent class for an example.
+*/
+public abstract class BukkitCore<F> extends JavaPlugin implements PluginCore<F>{}

bukkit/src/main/java/ch/andre601/advancedserverlist/bukkit/commands/CmdAdvancedServerList.java

@@ -50,7 +50,7 @@ public class CmdAdvancedServerList extends Command implements CommandExecutor{
         super(
             "advancedserverlist",
             "Main command of the plugin",
-            "/asl [reload|help]",
+            "/asl [reload|help|clearCache]",
             Collections.singletonList("asl")
         );
         

bukkit/src/main/java/ch/andre601/advancedserverlist/bukkit/events/JoinEvent.java

@@ -25,7 +25,9 @@
 
 package ch.andre601.advancedserverlist.bukkit.events;
 
+import ch.andre601.advancedserverlist.bukkit.BukkitCore;
 import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
+import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
@@ -33,12 +35,17 @@ import org.bukkit.event.player.PlayerJoinEvent;
 
 import java.net.InetSocketAddress;
 
-public class JoinEvent implements Listener{
+public class JoinEvent<F> implements Listener{
     
-    private final PluginCore<?> plugin;
+    private final BukkitCore<F> plugin;
     
-    public JoinEvent(PluginCore<?> plugin){
+    private JoinEvent(BukkitCore<F> plugin){
         this.plugin = plugin;
+        Bukkit.getPluginManager().registerEvents(this, plugin);
+    }
+    
+    public static <F> void init(BukkitCore<F> plugin){
+        new JoinEvent<>(plugin);
     }
     
     @EventHandler

bukkit/src/main/java/ch/andre601/advancedserverlist/bukkit/objects/BukkitPlayerPlaceholders.java

@@ -32,10 +32,14 @@ import ch.andre601.advancedserverlist.spigot.objects.SpigotPlayer;
 
 public class BukkitPlayerPlaceholders extends PlaceholderProvider{
     
-    public BukkitPlayerPlaceholders(){
+    private BukkitPlayerPlaceholders(){
         super("player");
     }
     
+    public static BukkitPlayerPlaceholders init(){
+        return new BukkitPlayerPlaceholders();
+    }
+    
     @Override
     public String parsePlaceholder(String placeholder, GenericPlayer player, GenericServer server){
         SpigotPlayer bukkitPlayer = (SpigotPlayer)player;

bukkit/src/main/java/ch/andre601/advancedserverlist/bukkit/objects/PAPIPlaceholders.java

@@ -28,7 +28,7 @@ package ch.andre601.advancedserverlist.bukkit.objects;
 import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
 import ch.andre601.advancedserverlist.api.profiles.ProfileEntry;
-import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
+import ch.andre601.advancedserverlist.bukkit.BukkitCore;
 import ch.andre601.advancedserverlist.core.objects.CachedPlayer;
 import ch.andre601.advancedserverlist.core.objects.GenericServerImpl;
 import ch.andre601.advancedserverlist.core.parsing.ComponentParser;
@@ -46,17 +46,21 @@ import org.bukkit.entity.Player;
 import org.jetbrains.annotations.NotNull;
 
 import java.net.InetSocketAddress;
-import java.util.Locale;
+import java.util.*;
 
-public class PAPIPlaceholders extends PlaceholderExpansion{
+public class PAPIPlaceholders<F> extends PlaceholderExpansion{
     
-    private final PluginCore<?> plugin;
+    private final BukkitCore<F> plugin;
     
-    public PAPIPlaceholders(PluginCore<?> plugin){
+    private PAPIPlaceholders(BukkitCore<F> plugin){
         this.plugin = plugin;
         this.register();
     }
     
+    public static <F> PAPIPlaceholders<F> init(BukkitCore<F> plugin){
+        return new PAPIPlaceholders<>(plugin);
+    }
+    
     @Override
     public @NotNull String getIdentifier(){
         return "asl";
@@ -72,6 +76,11 @@ public class PAPIPlaceholders extends PlaceholderExpansion{
         return plugin.getCore().getVersion();
     }
     
+    @Override
+    public boolean persist(){
+        return true;
+    }
+    
     @Override
     public String onPlaceholderRequest(Player pl, @NotNull String identifier){
         InetSocketAddress address = pl.getAddress();
@@ -97,27 +106,26 @@ public class PAPIPlaceholders extends PlaceholderExpansion{
         GenericServer finalServer = new GenericServerImpl(online, max, host);
         
         return switch(identifier.toLowerCase(Locale.ROOT)){
-            case "motd" -> ComponentParser.list(entry.motd())
-                .modifyText(text -> PlaceholderAPI.setPlaceholders(pl, text))
-                .modifyText(text -> StringReplacer.replace(text, player, finalServer))
-                .toString();
-            case "favicon" -> ComponentParser.text(entry.favicon())
-                .modifyText(text -> PlaceholderAPI.setPlaceholders(pl, text))
-                .modifyText(text -> StringReplacer.replace(text, player, finalServer))
-                .toString();
-            case "playercount_hover" -> ComponentParser.list(entry.players())
-                .modifyText(text -> PlaceholderAPI.setPlaceholders(pl, text))
-                .modifyText(text -> StringReplacer.replace(text, player, finalServer))
-                .toString();
-            case "playercount_text" -> ComponentParser.text(entry.playerCountText())
-                .modifyText(text -> PlaceholderAPI.setPlaceholders(pl, text))
-                .modifyText(text -> StringReplacer.replace(text, player, finalServer))
-                .toString();
+            case "motd" -> getOption(entry.motd(), pl, player, finalServer);
+            case "favicon" -> getOption(entry.favicon(), pl, player, finalServer);
+            case "playercount_hover" -> getOption(entry.players(), pl, player, finalServer);
+            case "playercount_text" -> getOption(entry.playerCountText(), pl, player, finalServer);
             case "extra_players_max" -> String.valueOf(max);
             default -> null;
         };
     }
     
+    private String getOption(String str, Player pl, GenericPlayer player, GenericServer server){
+        return getOption(Collections.singletonList(str), pl, player, server);
+    }
+    
+    private String getOption(List<String> list, Player pl, GenericPlayer player, GenericServer server){
+        return ComponentParser.list(list)
+            .modifyText(text -> PlaceholderAPI.setPlaceholders(pl, text))
+            .modifyText(text -> StringReplacer.replace(text, player, server))
+            .toString();
+    }
+    
     private int resolveProtocol(Player player){
         if(Bukkit.getPluginManager().isPluginEnabled("ViaVersion"))
             return Via.getAPI().getPlayerVersion(player.getUniqueId());

bukkit/src/main/java/ch/andre601/advancedserverlist/paper/PaperCore.java

@@ -25,6 +25,7 @@
 
 package ch.andre601.advancedserverlist.paper;
 
+import ch.andre601.advancedserverlist.bukkit.BukkitCore;
 import ch.andre601.advancedserverlist.bukkit.commands.CmdAdvancedServerList;
 import ch.andre601.advancedserverlist.bukkit.events.JoinEvent;
 import ch.andre601.advancedserverlist.bukkit.logging.BukkitLogger;
@@ -32,33 +33,37 @@ import ch.andre601.advancedserverlist.bukkit.objects.BukkitPlayerPlaceholders;
 import ch.andre601.advancedserverlist.bukkit.objects.PAPIPlaceholders;
 import ch.andre601.advancedserverlist.core.AdvancedServerList;
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
-import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.profiles.favicon.FaviconHandler;
 import ch.andre601.advancedserverlist.paper.events.PaperPingEvent;
 import org.bstats.bukkit.Metrics;
 import org.bstats.charts.SimplePie;
-import org.bukkit.plugin.java.JavaPlugin;
 import org.bukkit.util.CachedServerIcon;
 
 import java.nio.file.Path;
 
-public class PaperCore extends JavaPlugin implements PluginCore<CachedServerIcon>{
+public class PaperCore extends BukkitCore<CachedServerIcon>{
     
     private final PluginLogger logger = new BukkitLogger(getLogger());
     
-    private AdvancedServerList core;
+    private AdvancedServerList<CachedServerIcon> core;
     private FaviconHandler<CachedServerIcon> faviconHandler;
+    private PAPIPlaceholders<CachedServerIcon> papiPlaceholders = null;
     
     @Override
     public void onEnable(){
-        this.core = new AdvancedServerList(this, new BukkitPlayerPlaceholders());
+        this.core = AdvancedServerList.init(this, BukkitPlayerPlaceholders.init());
         
         if(getServer().getPluginManager().isPluginEnabled("PlaceholderAPI"))
-            new PAPIPlaceholders(this);
+            papiPlaceholders = PAPIPlaceholders.init(this);
     }
     
     @Override
     public void onDisable(){
+        if(papiPlaceholders != null){
+            papiPlaceholders.unregister();
+            papiPlaceholders = null;
+        }
+        
         getCore().disable();
     }
     
@@ -73,8 +78,8 @@ public class PaperCore extends JavaPlugin implements PluginCore<CachedServerIcon
     
     @Override
     public void loadEvents(){
-        new JoinEvent(this);
-        new PaperPingEvent(this);
+        JoinEvent.init(this);
+        PaperPingEvent.init(this);
     }
     
     @Override
@@ -93,7 +98,7 @@ public class PaperCore extends JavaPlugin implements PluginCore<CachedServerIcon
     }
     
     @Override
-    public AdvancedServerList getCore(){
+    public AdvancedServerList<CachedServerIcon> getCore(){
         return core;
     }
     

bukkit/src/main/java/ch/andre601/advancedserverlist/paper/events/PaperEventWrapper.java

@@ -28,9 +28,9 @@ package ch.andre601.advancedserverlist.paper.events;
 import ch.andre601.advancedserverlist.api.events.GenericServerListEvent;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
 import ch.andre601.advancedserverlist.api.profiles.ProfileEntry;
+import ch.andre601.advancedserverlist.bukkit.BukkitCore;
 import ch.andre601.advancedserverlist.bukkit.events.PreServerListSetEventImpl;
 import ch.andre601.advancedserverlist.bukkit.objects.SpigotPlayerImpl;
-import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.interfaces.events.GenericEventWrapper;
 import ch.andre601.advancedserverlist.core.objects.CachedPlayer;
 import ch.andre601.advancedserverlist.core.parsing.ComponentParser;
@@ -164,7 +164,7 @@ public class PaperEventWrapper implements GenericEventWrapper<CachedServerIcon,
     }
     
     @Override
-    public PluginCore<CachedServerIcon> getPlugin(){
+    public BukkitCore<CachedServerIcon> getPlugin(){
         return plugin;
     }
     

bukkit/src/main/java/ch/andre601/advancedserverlist/paper/events/PaperPingEvent.java

@@ -35,11 +35,15 @@ public class PaperPingEvent implements Listener{
     
     private final PaperCore plugin;
     
-    public PaperPingEvent(PaperCore plugin){
+    private PaperPingEvent(PaperCore plugin){
         this.plugin = plugin;
         plugin.getServer().getPluginManager().registerEvents(this, plugin);
     }
     
+    public static void init(PaperCore plugin){
+        new PaperPingEvent(plugin);
+    }
+    
     @EventHandler
     public void onPaperServerListPing(PaperServerListPingEvent event){
         PingEventHandler.handleEvent(new PaperEventWrapper(plugin, event));

bukkit/src/main/java/ch/andre601/advancedserverlist/spigot/SpigotCore.java

@@ -25,12 +25,13 @@
 
 package ch.andre601.advancedserverlist.spigot;
 
+import ch.andre601.advancedserverlist.bukkit.BukkitCore;
 import ch.andre601.advancedserverlist.bukkit.commands.CmdAdvancedServerList;
 import ch.andre601.advancedserverlist.bukkit.logging.BukkitLogger;
 import ch.andre601.advancedserverlist.bukkit.objects.BukkitPlayerPlaceholders;
+import ch.andre601.advancedserverlist.bukkit.objects.PAPIPlaceholders;
 import ch.andre601.advancedserverlist.core.AdvancedServerList;
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
-import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.profiles.favicon.FaviconHandler;
 import ch.andre601.advancedserverlist.spigot.events.LoadEvent;
 import com.comphenix.protocol.wrappers.WrappedServerPing;
@@ -38,16 +39,16 @@ import net.kyori.adventure.platform.bukkit.BukkitAudiences;
 import org.bstats.bukkit.Metrics;
 import org.bstats.charts.SimplePie;
 import org.bukkit.command.PluginCommand;
-import org.bukkit.plugin.java.JavaPlugin;
 
 import java.nio.file.Path;
 
-public class SpigotCore extends JavaPlugin implements PluginCore<WrappedServerPing.CompressedImage>{
+public class SpigotCore extends BukkitCore<WrappedServerPing.CompressedImage>{
     
     private final PluginLogger logger = new BukkitLogger(getLogger());
     
-    private AdvancedServerList core;
-    FaviconHandler<WrappedServerPing.CompressedImage> faviconHandler = null;
+    private AdvancedServerList<WrappedServerPing.CompressedImage> core;
+    private FaviconHandler<WrappedServerPing.CompressedImage> faviconHandler = null;
+    private PAPIPlaceholders<WrappedServerPing.CompressedImage> papiPlaceholders = null;
     
     @Override
     public void onEnable(){
@@ -64,11 +65,16 @@ public class SpigotCore extends JavaPlugin implements PluginCore<WrappedServerPi
             }catch(ClassNotFoundException ignored){}
         }
         
-        this.core = new AdvancedServerList(this, new BukkitPlayerPlaceholders());
+        this.core = AdvancedServerList.init(this, BukkitPlayerPlaceholders.init());
     }
     
     @Override
     public void onDisable(){
+        if(papiPlaceholders != null){
+            papiPlaceholders.unregister();
+            papiPlaceholders = null;
+        }
+        
         getCore().disable();
     }
     
@@ -103,7 +109,7 @@ public class SpigotCore extends JavaPlugin implements PluginCore<WrappedServerPi
     }
     
     @Override
-    public AdvancedServerList getCore(){
+    public AdvancedServerList<WrappedServerPing.CompressedImage> getCore(){
         return core;
     }
     
@@ -140,12 +146,16 @@ public class SpigotCore extends JavaPlugin implements PluginCore<WrappedServerPi
         return "spigot";
     }
     
+    public void setPapiPlaceholders(PAPIPlaceholders<WrappedServerPing.CompressedImage> papiPlaceholders){
+        this.papiPlaceholders = papiPlaceholders;
+    }
+    
     private void printPaperInfo(){
         getPluginLogger().warn("======================================================================================");
         getPluginLogger().warn("You are using the Spigot version of AdvancedServerList on a Paper server.");
         getPluginLogger().warn("It is recommended to use the dedicated Paper version, to benefit from the");
         getPluginLogger().warn("following improvements:");
-        getPluginLogger().warn(" - No need to download external libraries already provided by PaperMC.");
+        getPluginLogger().warn(" - No downloading of external Libraries already provided by Paper (i.e. Adventure).");
         getPluginLogger().warn(" - No dependency on ProtocolLib thanks to provided Events.");
         getPluginLogger().warn("");
         getPluginLogger().warn("AdvancedServerList may work as normal, but consider using the PaperMC version instead!");

bukkit/src/main/java/ch/andre601/advancedserverlist/spigot/events/LoadEvent.java

@@ -54,10 +54,10 @@ public class LoadEvent implements Listener{
             return;
         }
         
-        manager.registerEvents(new JoinEvent(plugin), plugin);
-        manager.registerEvents(new ProtocolLibEvents(plugin, ProtocolLibrary.getProtocolManager()), plugin);
+        JoinEvent.init(plugin);
+        ProtocolLibEvents.init(plugin, ProtocolLibrary.getProtocolManager());
         
         if(manager.isPluginEnabled("PlaceholderAPI"))
-            new PAPIPlaceholders(plugin);
+            plugin.setPapiPlaceholders(PAPIPlaceholders.init(plugin));
     }
 }

bukkit/src/main/java/ch/andre601/advancedserverlist/spigot/events/ProtocolLibEventWrapper.java

@@ -28,8 +28,8 @@ package ch.andre601.advancedserverlist.spigot.events;
 import ch.andre601.advancedserverlist.api.events.GenericServerListEvent;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
 import ch.andre601.advancedserverlist.api.profiles.ProfileEntry;
+import ch.andre601.advancedserverlist.bukkit.BukkitCore;
 import ch.andre601.advancedserverlist.bukkit.events.PreServerListSetEventImpl;
-import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.interfaces.events.GenericEventWrapper;
 import ch.andre601.advancedserverlist.core.objects.CachedPlayer;
 import ch.andre601.advancedserverlist.core.parsing.ComponentParser;
@@ -37,11 +37,12 @@ import ch.andre601.advancedserverlist.core.profiles.replacer.StringReplacer;
 import ch.andre601.advancedserverlist.spigot.SpigotCore;
 import ch.andre601.advancedserverlist.bukkit.objects.SpigotPlayerImpl;
 import com.comphenix.protocol.events.PacketEvent;
-import com.comphenix.protocol.wrappers.AdventureComponentConverter;
+import com.comphenix.protocol.wrappers.WrappedChatComponent;
 import com.comphenix.protocol.wrappers.WrappedGameProfile;
 import com.comphenix.protocol.wrappers.WrappedServerPing;
 import me.clip.placeholderapi.PlaceholderAPI;
 import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.serializer.gson.GsonComponentSerializer;
 import org.bukkit.Bukkit;
 import org.bukkit.OfflinePlayer;
 
@@ -77,7 +78,7 @@ public class ProtocolLibEventWrapper implements GenericEventWrapper<WrappedServe
     
     @Override
     public void setMotd(Component component){
-        ping.setMotD(AdventureComponentConverter.fromComponent(component));
+        ping.setMotD(WrappedChatComponent.fromJson(GsonComponentSerializer.gson().serialize(component)));
     }
     
     @Override
@@ -171,7 +172,7 @@ public class ProtocolLibEventWrapper implements GenericEventWrapper<WrappedServe
     }
     
     @Override
-    public PluginCore<WrappedServerPing.CompressedImage> getPlugin(){
+    public BukkitCore<WrappedServerPing.CompressedImage> getPlugin(){
         return plugin;
     }
     

bukkit/src/main/java/ch/andre601/advancedserverlist/spigot/events/ProtocolLibEvents.java

@@ -32,6 +32,7 @@ import com.comphenix.protocol.ProtocolManager;
 import com.comphenix.protocol.events.ListenerPriority;
 import com.comphenix.protocol.events.PacketAdapter;
 import com.comphenix.protocol.events.PacketEvent;
+import org.bukkit.Bukkit;
 import org.bukkit.event.Listener;
 
 import java.net.InetSocketAddress;
@@ -44,10 +45,15 @@ public class ProtocolLibEvents implements Listener{
     
     private static final Map<String, String> hostAddresses = new HashMap<>();
     
-    public ProtocolLibEvents(SpigotCore plugin, ProtocolManager protocolManager){
+    private ProtocolLibEvents(SpigotCore plugin, ProtocolManager protocolManager){
         this.protocolManager = protocolManager;
         
         loadPacketListener(plugin);
+        Bukkit.getPluginManager().registerEvents(this, plugin);
+    }
+    
+    public static void init(SpigotCore plugin, ProtocolManager protocolManager){
+        new ProtocolLibEvents(plugin, protocolManager);
     }
     
     public static Map<String, String> getHostAddresses(){

bukkit/src/main/resources/paper-plugin.yml

@@ -31,6 +31,7 @@ commands:
       - 'asl'
     permission: 'advancedserverlist.admin'
 
+# This is actually supported(?)
 permissions:
   advancedserverlist.*:
     description: 'Grants access to all permissions'

bukkit/src/main/resources/plugin.yml

@@ -24,7 +24,7 @@ softdepend:
 commands:
   advancedserverlist:
     description: 'Main command of AdvancedServerList'
-    usage: '/<command> [help|reload]'
+    usage: '/<command> [help|reload|clearCache]'
     aliases:
       - 'asl'
     permission: 'advancedserverlist.admin'
@@ -51,4 +51,7 @@ permissions:
     default: op
   advancedserverlist.command.reload:
     description: 'Grants access to /asl reload'
+    default: op
+  advancedserverlist.command.clearcache:
+    description: 'Clears the Player and Favicon cache'
     default: op

bungeecord/pom.xml

@@ -117,7 +117,7 @@
     </dependencies>
 
     <build>
-        <finalName>AdvancedServerList-BungeeCord-${plugin.version}</finalName>
+        <finalName>AdvancedServerList-BungeeCord-${plugin.version}${project.build.commit}</finalName>
         <resources>
             <resource>
                 <filtering>true</filtering>

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/BungeeCordCore.java

@@ -43,13 +43,13 @@ import java.nio.file.Path;
 
 public class BungeeCordCore extends Plugin implements PluginCore<Favicon>{
     
-    private AdvancedServerList core;
+    private AdvancedServerList<Favicon> core;
     private FaviconHandler<Favicon> faviconHandler = null;
     private final PluginLogger logger = new BungeeLogger(getLogger());
     
     @Override
     public void onEnable(){
-        this.core = new AdvancedServerList(this, new BungeePlayerPlaceholders());
+        this.core = AdvancedServerList.init(this, BungeePlayerPlaceholders.init());
     }
     
     @Override
@@ -85,7 +85,7 @@ public class BungeeCordCore extends Plugin implements PluginCore<Favicon>{
     }
     
     @Override
-    public AdvancedServerList getCore(){
+    public AdvancedServerList<Favicon> getCore(){
         return core;
     }
     

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/objects/BungeePlayerPlaceholders.java

@@ -33,10 +33,14 @@ import java.util.Locale;
 
 public class BungeePlayerPlaceholders extends PlaceholderProvider{
     
-    public BungeePlayerPlaceholders(){
+    private BungeePlayerPlaceholders(){
         super("player");
     }
     
+    public static BungeePlayerPlaceholders init(){
+        return new BungeePlayerPlaceholders();
+    }
+    
     @Override
     public String parsePlaceholder(String placeholder, GenericPlayer player, GenericServer server){
         return switch(placeholder.toLowerCase(Locale.ROOT)){

core/pom.xml

@@ -66,19 +66,19 @@
         <dependency>
             <groupId>net.kyori</groupId>
             <artifactId>adventure-api</artifactId>
-            <version>4.13.0</version>
+            <version>4.13.1</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>net.kyori</groupId>
             <artifactId>adventure-text-minimessage</artifactId>
-            <version>4.13.0</version>
+            <version>4.13.1</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>net.kyori</groupId>
             <artifactId>adventure-text-serializer-legacy</artifactId>
-            <version>4.13.0</version>
+            <version>4.13.1</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
@@ -90,7 +90,7 @@
         <dependency>
             <groupId>com.squareup.okhttp3</groupId>
             <artifactId>okhttp</artifactId>
-            <version>4.10.0</version>
+            <version>4.11.0</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
@@ -116,7 +116,7 @@
     </dependencies>
 
     <build>
-        <finalName>AdvancedServerList-Core-${plugin.version}</finalName>
+        <finalName>AdvancedServerList-Core-${plugin.version}${project.build.commit}</finalName>
         <resources>
             <resource>
                 <filtering>true</filtering>

core/src/main/java/ch/andre601/advancedserverlist/core/AdvancedServerList.java

@@ -39,9 +39,9 @@ import java.io.InputStream;
 import java.nio.file.Path;
 import java.util.Properties;
 
-public class AdvancedServerList{
+public class AdvancedServerList<F>{
     
-    private final PluginCore<?> plugin;
+    private final PluginCore<F> plugin;
     private final FileHandler fileHandler;
     private final CommandHandler commandHandler;
     private final PlayerHandler playerHandler;
@@ -51,19 +51,23 @@ public class AdvancedServerList{
     
     private String version;
     
-    public AdvancedServerList(PluginCore<?> plugin, PlaceholderProvider player){
+    private AdvancedServerList(PluginCore<F> plugin, PlaceholderProvider placeholders){
         this.plugin = plugin;
         this.fileHandler = new FileHandler(this);
         this.commandHandler = new CommandHandler(this);
         this.playerHandler = new PlayerHandler(this);
         
-        this.api.addPlaceholderProvider(player);
+        this.api.addPlaceholderProvider(placeholders);
         this.api.addPlaceholderProvider(new ServerPlaceholders());
         
         load();
     }
     
-    public PluginCore<?> getPlugin(){
+    public static <F> AdvancedServerList<F> init(PluginCore<F> plugin, PlaceholderProvider placeholders){
+        return new AdvancedServerList<>(plugin, placeholders);
+    }
+    
+    public PluginCore<F> getPlugin(){
         return plugin;
     }
     

core/src/main/java/ch/andre601/advancedserverlist/core/interfaces/commands/PluginCommand.java

@@ -25,6 +25,8 @@
 
 package ch.andre601.advancedserverlist.core.interfaces.commands;
 
+import java.util.Locale;
+
 public abstract class PluginCommand{
     
     private final String argument;
@@ -38,7 +40,7 @@ public abstract class PluginCommand{
     }
     
     public String getPermission(){
-        return "advancedserverlist.command." + getArgument();
+        return "advancedserverlist.command." + getArgument().toLowerCase(Locale.ROOT);
     }
     
     public abstract void handle(CmdSender sender);

docs/api/index.md

@@ -11,7 +11,7 @@ Add the following to your `build.gradle` or `pom.xml` file to use the API:
     
     Make sure to replace `{version}` with the latest version available in the [GitHub Repository][api-repo].
     
-    ```groovy
+    ```groovy title="build.gradle"
     repositorories {
         maven { url = 'https://jitpack.io/' }
     }
@@ -30,7 +30,7 @@ Add the following to your `build.gradle` or `pom.xml` file to use the API:
     
     Make sure to replace `{version}` with the latest version available in the [GitHub Repository][api-repo].
     
-    ```xml
+    ```xml title="pom.xml"
     <repositories>
       <repository>
         <id>jitpack</id>
@@ -78,8 +78,9 @@ It will be needed at a later point.
 ### 2) Create a Placeholder class
 
 Make a new class that you want to use for the placeholders and let it extend the `PlaceholderProvider` class of AdvancedServerList.  
-Your IDE should now tell you to implement/override some methods. Confirm this action and your class should look something alongside this:  
-```java
+Your IDE should now tell you to implement/override some methods. Confirm this action and your class should look something alongside this:
+
+```java title="PlaceholderProvider example"
 public class MyPlaceholders extends PlaceholderProvider {
     
     public MyPlaceholders(String identifier) {
@@ -94,7 +95,8 @@ public class MyPlaceholders extends PlaceholderProvider {
 ```
 
 It's recommended to replace your generated constructor with a no-args one and set the identifier directly in the `super()`.  
-For example:  
+For example:
+
 ```java
 public MyPlaceholders() {
     super("myplaceholders");
@@ -106,8 +108,9 @@ The `placeholder` String is whatever value was provided after the identifier in
 
 Something to note is, that when returning `null` will AdvancedServerList understand it as an invalid placeholder and return it unchanged.
 
-Here is a small example of the final class:  
-```java
+Here is a small example of the final class:
+
+```java title="PlaceholderProvider example"
 public class MyPlaceholders extends PlaceholderProvider {
     
     public MyPlaceholders() {
@@ -128,8 +131,7 @@ public class MyPlaceholders extends PlaceholderProvider {
 
 All that is left to do now is to register your class as a new PlaceholderProvider instance. To do this, get the API instance you retrieved earlier and use `addPlaceholderProvider` with a new instance of your class.
 
-Example:  
-```java
+```java title="Registering PlaceholderProvider class"
 AdvancedServerListAPI api = AdvancedServerListAPI.get();
 
 api.addPlaceholderProvider(new MyPlaceholders());

docs/assets/stylesheets/custom.css

@@ -27,6 +27,16 @@
     color: #d29922;
 }
 
+.result {
+    border: .05rem solid var(--md-code-bg-color);
+    border-bottom-left-radius: .1rem;
+    border-bottom-right-radius: .1rem;
+    border-top-width: .1rem;
+    margin-top: -1.125em;
+    overflow: visible;
+    padding: 0 1em;
+}
+
 /* Override mkdocs-material styling */
 .md-banner--warning {
     background: rgba(187,128,9,0.15);

docs/examples.md

@@ -28,7 +28,7 @@ Some examples about version-related things.
 You may want to display a separate MOTD or text for incompatible client versions.  
 This example here shows a separate MOTD and player count message for when the player's client version is older than what the server supports.
 
-```yaml
+```yaml title="outdated-client.yml"
 priority: 1
 
 # Display this profile, if the version of the player is below 760 (1.19.1)
@@ -47,7 +47,7 @@ playerCount:
 
 This profile would display a MOTD without HEX colours if the player's version is below 735 (1.16).
 
-```yaml
+```yaml title="pre-1_16.yml"
 priority: 1
 
 # Display this profile, if the version of the player is below 735 (1.16)
@@ -70,7 +70,7 @@ Examples that can be used with the Spigot or PaperMC version.
 
 Displays a separate profile for when the player has been banned from the server.
 
-```yaml
+```yaml title="banned.yml"
 priority: 1
 
 conditions:
@@ -94,7 +94,7 @@ Some misc examples.
 
 Display a different profile when the playing pings a specific domain/IP.
 
-```yaml
+```yaml title="specific-host.yml"
 priority: 1
 
 conditions:
@@ -109,7 +109,7 @@ motd:
 
 Display a different profile, if the player pinging the server is "known" by AdvancedServerList (Has joined before with the same IP).
 
-```yaml
+```yaml title="personalized.yml"
 priority: 1
 
 conditions:
@@ -132,7 +132,8 @@ playerCount:
 v1.10.0 of AdvancedServerList introduced an option called `profiles`. It allows you to create multiple variants of an MOTD, playercount, etc. while also supporting the normal (global) options as a fallback.
 
 The following example will create a profile that has a randomized MOTD, but the same hover for both:
-```yaml
+
+```yaml title="random-motd.yml"
 priority: 1
 
 profiles:

docs/profiles/formatting.md

@@ -2,6 +2,22 @@
 
 All text options with exception of [`Conditions`](../#conditions) allow the usage of formatting options using [MiniMessage].
 
+!!! warning "IMPORTANT"
+    Whenever your text starts with a colour or formatting code (`<aqua>`, `<blue>`, `<bold>`, `<italic>`, etc.) should it be surrounded with single or double quotes.  
+    Not doing so will cause the YAML parses used - Configurate - to not see the value as a String, but something else, causing exceptions to appear.
+    
+    ```yaml title="Wrong formatting"
+    motd:
+      - <red>This will cause
+      - <red>Errors
+    ```
+
+    ```yaml title="Right formatting"
+    motd:
+      - '<green>This will be formatted'
+      - '<green>properly.'
+    ```
+
 ## Unsupported options
 
 The following options are **not** supported, no matter what option they are used in:

docs/profiles/index.md

@@ -54,27 +54,29 @@ The profiles option allows you to add multiple combinations of all the other opt
 
 If an option is not present in an entry will AdvancedServerList try to use one defined in the file or use whatever default value would be for that option.
 
-As an example:  
-```yaml
-priority: 0
+??? example "Example"
+    ```yaml title="YAML file"
+    priority: 0
+    
+    profiles:
+      - motd:
+          - '<rainbow>Line 1</rainbow>'
+          - '<rainbow:!>Line 2</rainbow>'
+        playerCount:
+          text: '<green><bold>Awesome!'
+      - playerCount:
+          text: '<yellow><bold>Also Awesome!'
+    
+    motd:
+      - '<rainbow:2>Line A</rainbow>'
+      - '<rainbow:!2>Line B</rainbow>'
+    ```
+    <div class="result">
+    
+    ![profiles-example-1](../assets/images/examples/profiles-example-1.jpg)  
+    ![profiles-example-2](../assets/images/examples/profiles-example-2.jpg)
 
-profiles:
-  - motd:
-      - '<rainbow>Line 1</rainbow>'
-      - '<rainbow:!>Line 2</rainbow>'
-    playerCount:
-      text: '<green><bold>Awesome!'
-  - playerCount:
-      text: '<yellow><bold>Also Awesome!'
-
-motd:
-  - '<rainbow:2>Line A</rainbow>'
-  - '<rainbow:!2>Line B</rainbow>'
-```
-...the above example would randomly select between the following combinations of MOTD and Player count text:
-
-![motd-example-1](../assets/images/examples/motd-example-1.jpg)  
-![motd-example-2](../assets/images/examples/motd-example-2.jpg)
+    </div>
 
 ## Motd
 
@@ -83,6 +85,21 @@ Normal colour and formatting codes such as `<aqua>` or `<bold>` are supported. O
 
 If you want to display multiple MOTDs will you need to use the [`Profiles` option](#profiles)
 
+??? example "Example"
+    ```yaml title="YAML file"
+    priority: 0
+    
+    motd:
+      - '<rainbow:2>Rainbow Gradients</rainbow>'
+      - '<rainbow:!2>|||||||||||||||||||||||||||||||||||||</rainbow>'
+    ```
+    <div class="result">
+
+    ![motd-example](../assets/images/examples/motd-example.jpg)
+
+    </div>
+
+
 ## Favicon
 
 The favicon option allows you to customize the favicon and display one or multiple different images.
@@ -95,6 +112,24 @@ This option currently supports the following values:
 
 Please note that AdvancedServerList will rescale the image to be 64x64 pixels, so be sure to provide images at that particular scale.
 
+??? example "Example"
+    ```yaml title="YAML file"
+    priority: 0
+    
+    # We use just colour to hide the MOTD
+    motd:
+      - '<grey>'
+      - '<grey>'
+    
+    # Player is Andre_601
+    favicon: ${player uuid}
+    ```
+    <div class="result">
+
+    ![hideplayers-example](../assets/images/examples/favicon-example.jpg)
+
+    </div>
+
 ## PlayerCount
 
 The `playerCount` option contains multiple different options all about the Player count itself.
@@ -104,12 +139,51 @@ The `playerCount` option contains multiple different options all about the Playe
 Boolean option to set whether AdvancedServerList should hide the player count or not. When set to `true` will the player count be replaced with `???`.  
 Additionally will the [`Text`](#text) and [`Hover`](#hover) option be ignored.
 
+??? example "Example"
+    ```yaml title="YAML file"
+    priority: 0
+    
+    # We use just colour to hide the MOTD
+    motd:
+      - '<grey>'
+      - '<grey>'
+    
+    playerCount:
+      hidePlayers: true
+    ```
+    <div class="result">
+
+    ![hideplayers-example](../assets/images/examples/hideplayers-example.jpg)
+
+    </div>
+
 ### Hover
 
 This option allows to override the hover text usually displaying the players on the server when hovering over the player count.
 
 You can either remove this option or set to an empty list (`hover: []`) to not override the hover.
 
+??? example "Example"
+    ```yaml title="YAML file"
+    priority: 0
+    
+    # We use just colour to hide the MOTD
+    motd:
+      - '<grey>'
+      - '<grey>'
+    
+    playerCount:
+      hover:
+        - '<grey>Line 1'
+        - '<aqua>Line 2'
+        - '<gold>Line 3'
+    ```
+    <div class="result">
+
+    ![hover-example](../assets/images/examples/hover-example.jpg)
+
+    </div>
+
 ### Text
 
 This option allows to override the text usually displaying the online players and total players that can join.  
@@ -121,6 +195,24 @@ Note that AdvancedServerList will not add the `<online>/<max>` text to the playe
 
 To not override the player count, remove this option or set it to an empty String (`text: ''`).
 
+??? example "Example"
+    ```yaml title="YAML file"
+    priority: 0
+    
+    # We use just colour to hide the MOTD
+    motd:
+      - '<grey>'
+      - '<grey>'
+    
+    playerCount:
+      text: '<yellow><bold>Cool text!'
+    ```
+    <div class="result">
+
+    ![hover-example](../assets/images/examples/text-example.jpg)
+
+    </div>
+
 ### ExtraPlayers
 
 Contains options to modify how the `<max>` number in the player count should look like.
@@ -136,4 +228,24 @@ When set to `true` will the max amount of players be modified by taking the curr
 
 Sets the number to add to the current online players to then use as the new max players count.
 
-As an example, setting this to `1` while `10` players are online will display `11`, while `-1` would display `9`.
+As an example, setting this to `1` while `10` players are online will display `11`, while `-1` would display `9`.
+
+??? example "Example"
+    ```yaml title="YAML file"
+    priority: 0
+    
+    # We use just colour to hide the MOTD
+    motd:
+      - '<grey>'
+      - '<grey>'
+    
+    playerCount:
+      extraPlayers:
+        enabled: true
+        amount: 1
+    ```
+    <div class="result">
+
+    ![hover-example](../assets/images/examples/extraplayers-example.jpg)
+
+    </div>

mkdocs.yml

@@ -35,6 +35,7 @@ theme:
   - navigation.indexes
   - navigation.tabs
   - navigation.tabs.sticky
+  - content.code.copy
 
   icon:
     repo: 'octicons/mark-github-16'
@@ -78,3 +79,4 @@ markdown_extensions:
   - pymdownx.superfences:
   - pymdownx.tabbed:
       alternate_style: true
+  - pymdownx.details:

pom.xml

@@ -36,8 +36,9 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.build.commit/>
         
-        <plugin.version>3.0.0</plugin.version>
+        <plugin.version>3.0.2</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
         <api.version>v2.1.0</api.version>
@@ -46,6 +47,20 @@
         <maven.compiler.target>16</maven.compiler.target>
     </properties>
     
+    <profiles>
+        <profile>
+            <id>gh-actions</id>
+            <activation>
+                <property>
+                    <name>env.COMMIT_SHA</name>
+                </property>
+            </activation>
+            <properties>
+                <project.build.commit>_${env.COMMIT_SHA}</project.build.commit>
+            </properties>
+        </profile>
+    </profiles>
+    
     <repositories>
         <repository>
             <id>jitpack</id>

requirements.txt

@@ -1 +1 @@
-mkdocs-material==9.1.5
+mkdocs-material==9.1.9

velocity/pom.xml

@@ -84,13 +84,13 @@
         <dependency>
             <groupId>com.squareup.okhttp3</groupId>
             <artifactId>okhttp</artifactId>
-            <version>4.10.0</version>
+            <version>4.11.0</version>
             <scope>compile</scope>
         </dependency>
     </dependencies>
     
     <build>
-        <finalName>AdvancedServerList-Velocity-${plugin.version}</finalName>
+        <finalName>AdvancedServerList-Velocity-${plugin.version}${project.build.commit}</finalName>
         <resources>
             <resource>
                 <filtering>true</filtering>

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/VelocityCore.java

@@ -55,7 +55,7 @@ public class VelocityCore implements PluginCore<Favicon>{
     private final Path path;
     private final Metrics.Factory metrics;
     
-    private AdvancedServerList core;
+    private AdvancedServerList<Favicon> core;
     private FaviconHandler<Favicon> faviconHandler = null;
     
     @Inject
@@ -69,7 +69,7 @@ public class VelocityCore implements PluginCore<Favicon>{
     
     @Subscribe
     public void init(ProxyInitializeEvent event){
-        this.core = new AdvancedServerList(this, new VelocityPlayerPlaceholders());
+        this.core = AdvancedServerList.init(this, VelocityPlayerPlaceholders.init());
     }
     
     @Subscribe
@@ -109,7 +109,7 @@ public class VelocityCore implements PluginCore<Favicon>{
     }
     
     @Override
-    public AdvancedServerList getCore(){
+    public AdvancedServerList<Favicon> getCore(){
         return core;
     }
     

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/objects/VelocityPlayerPlaceholders.java

@@ -31,10 +31,14 @@ import ch.andre601.advancedserverlist.api.objects.GenericServer;
 
 public class VelocityPlayerPlaceholders extends PlaceholderProvider{
     
-    public VelocityPlayerPlaceholders(){
+    private VelocityPlayerPlaceholders(){
         super("player");
     }
     
+    public static VelocityPlayerPlaceholders init(){
+        return new VelocityPlayerPlaceholders();
+    }
+    
     @Override
     public String parsePlaceholder(String placeholder, GenericPlayer player, GenericServer server){
         return switch(placeholder){