Fix ${player protocol} using the protocol of the proxy.

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

.gitea/pull_request_template.yml

@@ -0,0 +1,37 @@
+name: Pull Request
+description: Create a new Pull request
+
+body:
+  - type: markdown
+    attributes:
+      value: |-
+        Thank you for creating a Pull request!
+
+        Please be sure to fill out this template with all requested information to ensure it being valid and not being closed unmerged.
+  - type: dropdown
+    attributes:
+      label: Type
+      description: What kind of Pull request is this?
+      options:
+        - Enhancement
+        - Bugfix
+        - Documentation
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Breaking Change?
+      description: |-
+        Is this a breaking change?
+        A breaking change means that it becomes incompatible with previous server/proxy versions or plugin versions.
+      options:
+        - Yes
+        - No
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Description
+      description: Provide a detailed description of what this Pull request is doing. Link any issues this Pull request may fix/close.
+    validations:
+      required: true

.github/workflows/docs-deploy.yml

@@ -39,7 +39,7 @@ jobs:
       - name: Build docs
         run: mkdocs build
       - name: Configure GitHub Pages
-        uses: actions/configure-pages@v4
+        uses: actions/configure-pages@v5
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.woodpecker/pr_preview.yml

@@ -35,8 +35,10 @@ steps:
       - git add --all
       - git commit -m "Update Preview for PR ${CI_COMMIT_PULL_REQUEST} ($( env TZ=Europe/Zurich date +"%d.%m.%Y %Z" )) [SKIP CI]"
       - git push --set-upstream upstream pr-${CI_COMMIT_PULL_REQUEST} -f
-  writeComment:
+  commentOnSuccess:
     image: mcs94/gitea-comment
+    when:
+      - status: ['success']
     secrets:
       - bot_token
     settings:
@@ -44,9 +46,22 @@ steps:
       gitea_token:
         from_secret: BOT_TOKEN
       comment: |-
-        Build-preview created!
+        Pull request Preview ready!
 
         | Name   | Value                                                 |
         |--------|-------------------------------------------------------|
         | Commit | ${CI_COMMIT_SHA}                                      |
-        | Link   | https://asl.andre601.ch/@pr-${CI_COMMIT_PULL_REQUEST} |
+        | Link   | https://asl.andre601.ch/@pr-${CI_COMMIT_PULL_REQUEST} |
+  commentOnFailure:
+    image: mcs94/gitea-comment
+    when:
+      - status: ['failure']
+    secrets:
+      - bot_token
+    settings:
+      gitea_address: https://codeberg.org
+      gitea_token:
+        from_secret: BOT_TOKEN
+      comment: |-
+        Issue while creating Pull request preview.
+        Please check the CI logs for any reasons: ${CI_PIPELINE_URL}

.woodpecker/publish_assets.yml

@@ -39,7 +39,7 @@ steps:
     when:
       - status: ['success']
     settings:
-      server: https://blobfox.coffee
+      server_url: https://blobfox.coffee
       access_token:
         from_secret: MASTODON_TOKEN
       status: '${CI_COMMIT_TAG} of #AdvancedServerList has been released and can be found on Modrinth (https://modrinth.com/plugin/AdvancedServerList), Hangar (https://hangar.papermc.io/Andre_601/AdvancedServerList) and Codeberg (https://codeberg.org/Andre601/AdvancedServerList).'

README.md

@@ -8,11 +8,9 @@ AdvancedServerList is a plugin that allows you to customize your server's MOTD,
   <img src="https://cdn.jsdelivr.net/gh/Andre601/devins-badges@13e0142/assets/compact/available/modrinth_vector.svg" height="46" alt="modrinth" title="Available on Modrinth">
 </a>
 <br>
-<!--
 <a href="https://hangar.papermc.io/Andre_601/AdvancedServerList" target="_blank">
   <img src="https://cdn.jsdelivr.net/gh/Andre601/devins-badges@13e0142/assets/compact/available/hangar_vector.svg" height="46" alt="hangar" title="Available on Hangar">
 </a>
--->
 
 ## Supported Platforms
 

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/listeners/BungeeEventWrapper.java

@@ -142,7 +142,7 @@ public class BungeeEventWrapper implements GenericEventWrapper<Favicon, BungeePl
     
     @Override
     public int getProtocolVersion(){
-        return this.protocol.getProtocol();
+        return event.getConnection().getVersion();
     }
     
     @Override

docs/api/index.md

@@ -361,18 +361,22 @@ Your plugin should now hook into AdvancedServerList and register its own custom
 
 ## Listening for events
 
-<!-- admo:info This requires the platform specific dependencies -->
+<!-- admo:info These events require the platform-specific APIs -->
 
-AdvancedServerList provides an Event that your plugin can listen for.  
-The event is called `PreServerListSetEvent` and provides the following methods to use:
+AdvancedServerList provides Events that your plugin can listen for specific situations.
+
+### PreServerListSetEvent
+
+This event is called **before** AdvancedServerList starts handling the PingEvent of the Server/Proxy.  
+It allows you to get and alter the [ProfileEntry][profileentry] used in the PingEvent, or even outright cancel the event itself.
+
+The event offers the following methods:
 
 - [`getEntry()`][getentry] - Gets the currently set [`ProfileEntry`][profileentry].
 - [`setEntry(ProfileEntry)`][setentry] - Sets a new [`ProfileEntry`][profileentry] to use.
 - [`isCancelled()`][iscancelled] - Gets the current cancelled state of the event.
 - [`setCancelled(boolean)`][setcancelled] - Sets the current cancelled state.
 
-Setting the event's cancelled state to true will result in AdvancedServerList not altering the Server list.
-
 Please check the server/proxy's documentation on how to listen for events with your plugin.
 
 [getentry]: reference/api/ch.andre601.advancedserverlist.api/events/genericserverlistevent.md#getentry()
@@ -380,6 +384,13 @@ Please check the server/proxy's documentation on how to listen for events with y
 [iscancelled]: reference/api/ch.andre601.advancedserverlist.api/events/genericserverlistevent.md#iscancelled()
 [setcancelled]: reference/api/ch.andre601.advancedserverlist.api/events/genericserverlistevent.md#setcancelled(boolean)
 
+### PostServerListSetEvent
+
+This event is called **after** AdvancedServerList has completed its handling of the Server's/Proxy's PingEvent.
+
+It provides a method to retrieve the [ProfileEntry][profileentry] used during the PingEvent.  
+Do note that this ProfileEntry is **not** a representation of what is actually displayed in the server list, but rather what has been used by AdvancedServerList. It may also be `null` should the event handling get cancelled for any reason.
+
 [profileentry]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/index.md
 
 ### ProfileEntry
@@ -387,8 +398,9 @@ Please check the server/proxy's documentation on how to listen for events with y
 The ProfileEntry record is the core class used within the `PreServerListSetEvent`. It sets what values (MOTD, Favicon, Players, etc.) should be displayed.  
 Note that the record is - by nature - immutable and that the [`Builder`][builder] class should be used to create a new ProfileEntry instance to use.
 
-A convenience method exists to create a `Builder` instance from an existing `ProfileEntry` in case you only want to alter certain options while everything else unchanged.
+A convenience method ([`builder()`][builder()]) exists to create a `Builder` instance from an existing `ProfileEntry` in case you only want to alter certain options while everything else should remain unchanged.
 
 This allows you to customize the Server list using your plugin. Just keep in mind that other plugins may also do the same, overriding your changes.
 
-[builder]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md
+[builder]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md
+[builder()]: reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/index.md#builder()

docs/commands/index.md

@@ -21,18 +21,24 @@ The following subcommands are available (Subcommands are case-insensitive):
 
 ### help
 
+/// info |
 **Permission:** `advancedserverlist.command.help`
 
 Shows a list of all available [subcommands](#subcommands) for AdvancedServerList.
+///
 
 ### reload
 
+/// info |
 **Permission:** `advancedserverlist.command.reload`
 
 Reloads the plugin's `config.yml` and all available YAML files in the `profiles` folder.
+///
 
 ### clearCache
 
+/// info |
 **Permission:** `advancedserverlist.command.clearcache`
 
-Clears the currently cached favicons and players.
+Clears the currently cached favicons and players.
+///

docs/getting-started/index.md

@@ -88,8 +88,8 @@ The plugin also supports these additional plugins. They are all optional.
 -   [**Maintenance**][maintenance]{ target="_blank" rel="nofollow" }
     
     ----
-    
-    AdvancedServerList will disable any modification of the server list entry should Maintenance mode be enabled.
+
+    AdvancedServerList will disable any modification of the server list entry should Maintenance mode be enabled, unless you change this in the config.yml file.
     
     ----
 
@@ -117,7 +117,7 @@ The plugin also supports these additional plugins. They are all optional.
 
 ## 2. Installation { #installation }
 
-Installing the plugin is as simple as moving the jar file into the plugins folder. Just make sure to download the right version of AdvancedServerList for the right platform.  
+Installing the plugin is as simple as moving the jar file into the `plugins` folder. Just make sure to download the right version of AdvancedServerList for the right platform.  
 Here is a quick table showing the jar file name with the platforms it is made for:
 
 | Jar file name                                 | Platforms             |
@@ -133,7 +133,7 @@ If everything goes well should AdvancedServerList create a folder named `Advance
 
 When you install AdvancedServerList for the first time should it have created the following file structure inside the plugins folder of your Server or Proxy:
 ```
-AdvancedServerList/
+AdvancedServerList/ # advancedserverlist/ on Velocity
 ├── favicons/
 ├── profiles/
 │   └── default.yml
@@ -337,10 +337,11 @@ These functions include, but aren't limited to:
 - Disabling/Enabling checking for updates.
 - Disabling/Enabling debug mode.
 - Setting how long favicons should be cached for.
+- Disabling/Enabling features of the plugin while the plugin Maintenance is active.
 - The config version used for migration. Don't touch this, or it may reset your config.
 
 Similar to the default.yml is this file containing comments to try and explain the settings in questions.  
-Do note that if the config gets migrated from an older version, that the comments will be discarded in the process, unfortunately.
+Note that the config can get migrated to newer versions, adding missing options in the process. However, comments will get lost during that process.
 
 /// details | default config.yml content
     type: file
@@ -444,13 +445,13 @@ config-version: 5
 ```
 ///
 
-#### Additionally created files and folders
+#### Additional created files and folders
 
 There are certain files and folders that get created when certain events happen:
 
 - A `playercache.json` file will be created on plugin shutdown containing a collection of IPs, UUIDs and Player names for every player that joined the server while AdvancedServerList was running.  
     This file is used to identify a player through their last used IP, to replace placeholders such as `${player name}` or `${player uuid}` with their respective values using the cached data.  
-    This file is not created, used nor updated when `disableCache` is set to `true` in the config.yml
+    This file is not created, used, nor updated when `disableCache` is set to `true` in the config.yml
 - A `backups` folder containing old config.yml files.  
     This folder is created when AdvancedServerList migrates your old config to a new version. This allows you to transfer settings over in case the migration didn't work properly.  
     Each backup will have the name pattern `config-<date>.yml` with `<date>` being the date and time of when this file has been created.
@@ -463,7 +464,7 @@ It's best to open the `default.yml` file located inside `profiles` with the file
 This file should contain all available options that you can set and alter.
 
 Edit the options to whatever you like. All text-based options, except [`condition`](../profiles/index.md#condition), support [MiniMessage formatting](../profiles/formatting.md).  
-The [`motd`](../profiles/index.md#motd) option also supports Hexadecimal colors, assuming the server/proxy runs at least MC 1.16.
+Hexadecimal (RGB) colors are supported, however, only the [`motd` option](../profiles/index.md#motd) may display them and only for MC 1.16+ clients. Any other option will have the color down-sampled to the nearest supported color code.
 
 If you're unsure how a specific option should look like, head over to the [Profiles page](../profiles/index.md) for more information about the general structure.  
 All you need to know is, that a bare-bones server list profile requires a valid [priority](../profiles/index.md#priority) and at least one of the settings to be present.
@@ -479,16 +480,16 @@ motd:
 
 ### Additional profiles
 
-To add additional profiles, create a new YAML file inside the `profiles` folder. The name doesn't matter, but it is recommended to keep it lowercase, use alphanumeric characters (`a-z, 0-9`), hyphens (`-`), underscores (`_`) and avoid spaces. You should also name it after what it is for, to have it more easily organized.
+To add additional profiles, create a new YAML file inside the `profiles` folder. The name can be whatever you like, but it is recommended to keep it simple and only use alphanumeric characters (`a-z` and `0-9`), underlines and hyphens.
 
 Inside the file, add a priority and at least one setting, similar to the above shown example.  
 This would already be enough to have a valid profile, but depending on the priority and file name may the file not be used, or used over other profiles.
 
 If you want to only show this file under specific situations can you use the [`condition`](../profiles/index.md#condition) option to apply conditions that need to be met to show the profile.  
-The condition option would have a single String containing one or muliple [Expressions](../profiles/expressions.md). Only if the condition would return true, would the profile be displayed, granted that it has a higher priority than any other valid file with a true condition output.
+The condition option would have a single String containing one or multiple [Expressions](../profiles/expressions.md). Only if the condition would return true, would the profile be displayed, granted that it has a higher priority than any other valid file with a true condition output.
 
 /// info | Note
-Profiles which do not have any conditions, or have an empty condition, will always be considered to have a true condition, meaning that a profile with higher priority and no condition will be selected over a profile with lower priority and a condition, even if said condition returns true.
+Files without a condition or an empty condition will be treated as always having a true condition.
 ///
 
 Here is another example profile using conditions to show it when the player was banned on the server:

docs/index.md

@@ -7,7 +7,7 @@ icon: octicons/home-24
 Welcome to the Wiki of AdvancedServerList!
 
 On this site can you find the latest documentation for the plugin, including some useful examples.  
-If you're new to the plugin is it recommended to check out the [Profiles page](profiles/index.md) for a quick start on how to use this plugin.
+If you're new to the plugin, check out [:octicons-milestone-24: **Getting Started**](getting-started/index.md) for a quick Start Guide.
 
 ## Downloads
 

docs/placeholderapi/index.md

@@ -16,7 +16,6 @@ Note that the values depend on the player it is used for, as AdvancedServerList
 | Placeholder                      | Description                                                                                            |
 |----------------------------------|--------------------------------------------------------------------------------------------------------|
 | `%asl_favicon%`                  | Gives the value of `favicon` from a matching Profile.                                                  |
-| `%asl_extra_players_max%`        | Gives the value of `playerCount -> extraPlayers -> amount` from a matching Profile. Can return `null`. |
 | `%asl_motd%`                     | Gives the value of `motd` in the matching Profile as a single String.                                  |
 | `%asl_playercount_extraplayers%` | Gives the value of `playerCount -> extraPlayers -> amount` from a matching Profile. Can return `null`. |
 | `%asl_playercount_hover%`        | Gives the value of `playerCount -> hover` from a matching Profile as a single String.                  |

docs/profiles/expressions.md

@@ -126,9 +126,11 @@ Parenthesis can be used to prevent ambiguities.
 
 `!` can be used to negate boolean expressions.
 
+/// example | Examples
 ```shell
 !${player isWhitelisted}
 ```
+///
 
 ## Credits
 

docs/profiles/formatting.md

@@ -4,7 +4,7 @@ icon: octicons/pencil-24
 
 # Formatting
 
-All text options, with exception of [`Conditions`](../index.md#conditions), allow the usage of formatting options using [MiniMessage].
+All text options, with exception of [`Conditions`](index.md#condition), allow the usage of formatting options using [MiniMessage].
 
 /// info | Online Tool
 The devs of the Adventure library provide a handy online tool to create the right formatting codes to display the text properly.  

docs/profiles/index.md

@@ -40,6 +40,20 @@ Not setting this option, or setting it to an empty String (`condition: ''`), wil
 
 The condition option can hold one or multiple expressions. The Expression system is explained on the [Expressions page](expressions.md).
 
+/// details | Example
+    type: example
+
+```yaml title="YAML file"
+priority: 0
+
+condition: '${player isWhitelisted}'
+
+motd:
+  - '<grey>Hello ${player name}!'
+  - '<grey>Nice to see you.'
+```
+///
+
 ## Profiles
 
 The `profile` option allows you to define a list of all other options, with the exception of [`priority`](#priority), [`condition`](#condition) or itself.

pom.xml

@@ -37,7 +37,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         
-        <plugin.version>4.6.1</plugin.version>
+        <plugin.version>4.6.2</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.14
+mkdocs-material==9.5.17
 mkdocs-glightbox==0.3.7
 git+https://github.com/Andre601/mkdocs-pagenav-generator

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/listeners/VelocityEventWrapper.java

@@ -138,7 +138,7 @@ public class VelocityEventWrapper implements GenericEventWrapper<Favicon, Veloci
     
     @Override
     public int getProtocolVersion(){
-        return protocol.getProtocol();
+        return event.getConnection().getProtocolVersion().getProtocol();
     }
     
     @Override

version-uploader/pom.xml

@@ -52,7 +52,7 @@
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
-            <version>1.5.3</version>
+            <version>1.5.4</version>
             <scope>compile</scope>
         </dependency>
         <dependency>