Modernize PluginVersions Paper build

Author: mrfloris

.gitignore

@@ -1,5 +1,8 @@
 # Created by https://www.gitignore.io/api/maven,eclipse,intellij,netbeans,osx,windows,notepadpp,windows,java
 
+# Local Paper test servers and generated runtime data
+/servers/
+
 ### Maven ###
 target/
 pom.xml.tag
@@ -11,6 +14,13 @@ dependency-reduced-pom.xml
 buildNumber.properties
 .mvn/timing.properties
 
+### Gradle ###
+.gradle/
+build/
+builds/
+out/
+!gradle/wrapper/gradle-wrapper.jar
+
 
 ### Eclipse ###
 
@@ -84,6 +94,9 @@ nbactions.xml
 
 ### OSX ###
 .DS_Store
+.ds_store
+**/.DS_Store
+**/.ds_store
 .AppleDouble
 .LSOverride
 
@@ -133,6 +146,7 @@ $RECYCLE.BIN/
 
 ### Java ###
 *.class
+*.log
 
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
@@ -142,4 +156,4 @@ $RECYCLE.BIN/
 *.ear
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
+hs_err_pid*

README.md

@@ -1,32 +1,110 @@
 # PluginVersions &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <a href="https://hangar.papermc.io/SlimeDog/PluginVersions">![download-on-hangar](https://user-images.githubusercontent.com/17748923/187102194-00e910e6-ee8e-42cb-bfe1-d2f9e657ef4b.png)</a> <a href="https://www.spigotmc.org/resources/70927/">![download-on-spigot](https://user-images.githubusercontent.com/17748923/187102011-b72e0f1d-ba74-4cb2-a69e-46f48cb364b5.png)</a>
 
-Create an alphabetically-sorted list of loaded plugins and versions.
+PluginVersions creates an alphabetically sorted list of loaded plugins and their versions. This 1MB update also keeps a human-readable plugin inventory database, lets you curate plugin URLs over time, and exports Markdown reports for GitHub, Discord, or server documentation.
 
-### Tested Environments
+## Tested Environment
 
-**PluginVersions** was originally written for Spigot 1.8.8, and has worked for every Spigot version since then.
+This Paper build targets PaperMC `26.1.2` (`paper-api:26.1.2.build.20-alpha`) and compiles with Java 25. The plugin uses `api-version: 1.21.11` and reports version `2.0.0`.
 
-All commands may be executed at the console, and in-game with appropriate permissions.
+The plugin data folder is `plugins/1MB-PluginVersions/`.
 
-### Commands
+The only root command is `/pv`. The long `/pluginversions` command is not registered; the namespaced command remains available as `pluginversions:pv`.
 
-> _pluginversions list_  
-> Create an alphabetically-sorted columnar list of plugins and versions.
->
-> _pluginversions reload_  
-> Reload configuration file.
-> At present, the only configuration option is whether to send metrics to MCStats.org.
+All commands can be executed from the console. In-game use requires the matching permission.
 
-### Command aliases
+## Build
 
-- pv :: Spigot, Paper
-- pvb :: BungeeCord, Waterfall
-- pvv :: Velocity
+```bash
+gradle clean build
+```
 
-### Permissions
+The compiled jar is written to `builds/libs/1MB-PluginVersions-v2.0.0-003-j25-26.1.2.jar`.
 
-Permissions reflect the commands they allow. All permissions default to op.
+## Commands
 
-> _pluginversions.list_
+| Command | Description |
+| --- | --- |
+| `/pv help [page\|topic]` | Shows help pages. |
+| `/pv list [page]` | Lists loaded plugins and versions. Without a page, it lists every loaded plugin. |
+| `/pv reload` | Reloads `config.yml` and the active translation file. |
+| `/pv debug [page\|topic]` | Shows status, plugin details, server details, counts, commands, permissions, placeholders, config, set, and URL pages. |
+| `/pv debug url add <plugin> <url>` | Stores a manual URL and infers the URL type. |
+| `/pv debug url add <plugin> <type> <url>` | Stores a manual URL with a custom type such as `source`, `docs`, or `download`. |
+| `/pv debug url del <plugin> [type] <url>` | Removes a stored manual URL. |
+| `/pv debug url list <plugin>` | Lists manual URLs stored for a plugin. |
+| `/pv debug url audit [page]` | Shows URL coverage for tracked plugins. |
+| `/pv config [page]` | Shows active configuration values. |
+| `/pv set <path> <value>` | Updates a known `config.yml` setting, saves it, and reloads the plugin settings. Filesystem paths are console-only. |
+| `/pv export [markdown\|discord]` | Updates the database and writes timestamped plus stable latest export files. |
 
-> _pluginversions.reload_
+## Permissions
+
+All permissions except `pluginversions.help` default to op.
+
+| Permission | Description |
+| --- | --- |
+| `pluginversions.*` | Grants every PluginVersions command and URL action. |
+| `pluginversions.help` | Allows access to help pages. |
+| `pluginversions.list` | Allows listing loaded plugins. |
+| `pluginversions.reload` | Allows reloading config and translations. |
+| `pluginversions.debug` | Allows viewing debug pages. |
+| `pluginversions.config` | Allows viewing active config values. |
+| `pluginversions.set` | Allows changing known config values. |
+| `pluginversions.export` | Allows exporting plugin inventory reports. |
+| `pluginversions.url.*` | Grants all manual URL database actions. |
+| `pluginversions.url.list` | Allows listing and auditing URL entries. |
+| `pluginversions.url.add` | Allows adding manual URL entries. |
+| `pluginversions.url.del` | Allows removing manual URL entries. |
+
+## Placeholders
+
+Language phrases live in `translations/Locale_EN.yml` and use MiniMessage. Legacy ampersand color codes are migrated at runtime if older values are found, but new phrases should use MiniMessage tags.
+
+Language tokens include `{name}`, `{display-name}`, `{internal-name}`, `{version}`, `{spacing}`, `{page}`, `{pages}`, `{count}`, `{enabled}`, and `{disabled}`.
+
+If PlaceholderAPI is installed, PluginVersions registers these placeholders:
+
+| Placeholder | Result |
+| --- | --- |
+| `%pluginversions_total%` | Loaded plugin count. |
+| `%pluginversions_enabled%` | Enabled plugin count. |
+| `%pluginversions_disabled%` | Disabled plugin count. |
+| `%pluginversions_database_tracked%` | Plugins currently tracked in the inventory database. |
+| `%pluginversions_version_<plugin>%` | Version for a loaded plugin. |
+| `%pluginversions_url_<plugin>_<type>%` | First matching detected or manual URL for a plugin and type. |
+
+## Configuration
+
+`config.yml` contains only operational settings and is fully commented. Player-facing phrases, command text, colors, and placeholders are kept in `translations/Locale_EN.yml`.
+
+Anonymous metrics are disabled by default with `settings.enable-metrics: false`.
+
+Update checks are disabled by default with `check-for-updates: false`.
+
+The YAML database is stored at `plugins/1MB-PluginVersions/plugins-database.yml` by default. It tracks each plugin's display name, internal name, version, enabled state, description, authors, contributors, dependencies, provided plugins, website, detected URLs, manual URLs, and scan history.
+
+`database.file` and `exports.directory` are filesystem paths and can only be changed from the console or by editing `config.yml`.
+
+## URL Database
+
+Detected URLs come from plugin metadata such as website and description fields. Manual URLs are stored under `manual-urls` and are merged with detected URLs in exports.
+
+Known inferred URL types include `github`, `jenkins`, `modrinth`, `hangar`, `spigot`, `dev-bukkit`, `ci`, and `website`. You can also provide your own type:
+
+```text
+/pv debug url add LuckPerms source https://github.com/LuckPerms/LuckPerms
+/pv debug url add LuckPerms download https://modrinth.com/plugin/luckperms
+```
+
+## Exports
+
+Exports are written to `plugins/1MB-PluginVersions/exports/` by default.
+
+| Command | Files |
+| --- | --- |
+| `/pv export markdown` | `plugins-YYYY-MM-DD-HHMMSS.md` and `plugins-latest.md` |
+| `/pv export discord` | `plugins-discord-YYYY-MM-DD-HHMMSS.md` and `plugins-discord-latest.md` |
+
+## Credits
+
+PluginVersions credits mart-r, GabrielHD150, SlimeDog, and mrfloris as authors. Updates in this branch include implementation help from OpenAI.

build.gradle.kts

@@ -0,0 +1,59 @@
+plugins {
+    java
+}
+
+group = "com.straight8.rambeau"
+version = "2.0.0"
+description = "List installed plugins and versions alphabetically"
+
+val buildNumber = "003"
+val javaTarget = "25"
+val paperTarget = "26.1.2"
+
+repositories {
+    mavenCentral()
+    maven("https://repo.papermc.io/repository/maven-public/")
+    maven("https://repo.extendedclip.com/releases/")
+}
+
+dependencies {
+    compileOnly("io.papermc.paper:paper-api:26.1.2.build.20-alpha")
+    compileOnly("net.kyori:adventure-text-minimessage:4.26.1")
+    compileOnly("net.kyori:adventure-text-serializer-legacy:4.26.1")
+    compileOnly("me.clip:placeholderapi:2.12.2")
+}
+
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(25))
+    }
+    sourceCompatibility = JavaVersion.VERSION_25
+    targetCompatibility = JavaVersion.VERSION_25
+}
+
+tasks.withType<JavaCompile>().configureEach {
+    options.encoding = "UTF-8"
+    options.release.set(25)
+    options.compilerArgs.addAll(listOf("-Xlint:deprecation", "-Xdiags:verbose"))
+}
+
+tasks.processResources {
+    filteringCharset = "UTF-8"
+    val props = mapOf(
+        "version" to project.version,
+        "description" to project.description,
+    )
+    inputs.properties(props)
+    filesMatching("plugin.yml") {
+        expand(props)
+    }
+}
+
+tasks.jar {
+    archiveFileName.set("1MB-PluginVersions-v${project.version}-$buildNumber-j$javaTarget-$paperTarget.jar")
+    destinationDirectory.set(layout.projectDirectory.dir("builds/libs"))
+}
+
+tasks.clean {
+    delete(layout.projectDirectory.dir("builds"))
+}

pom.xml

@@ -1,16 +1,21 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
+
     <groupId>com.straight8.rambeau</groupId>
-    <artifactId>PluginVersions</artifactId>
-    <version>1.3.6</version>
-    <name>PluginVersions</name>
+    <artifactId>1MB-PluginVersions</artifactId>
+    <version>2.0.0</version>
+    <name>1MB-PluginVersions</name>
     <description>List installed plugins and versions alphabetically</description>
 
     <properties>
-        <maven.compiler.source>25</maven.compiler.source>
-        <maven.compiler.target>25</maven.compiler.target>
+        <maven.compiler.release>25</maven.compiler.release>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <paper.api.version>26.1.2.build.20-alpha</paper.api.version>
+        <adventure.version>4.26.1</adventure.version>
+        <placeholderapi.version>2.12.2</placeholderapi.version>
+        <build.number>003</build.number>
     </properties>
 
     <repositories>
@@ -19,113 +24,59 @@
             <url>https://repo.papermc.io/repository/maven-public/</url>
         </repository>
         <repository>
-            <id>jitpack.io</id>
-            <url>https://jitpack.io</url>
+            <id>extendedclip</id>
+            <url>https://repo.extendedclip.com/releases/</url>
         </repository>
     </repositories>
 
     <dependencies>
         <dependency>
             <groupId>io.papermc.paper</groupId>
             <artifactId>paper-api</artifactId>
-            <version>1.21.11-R0.1-SNAPSHOT</version>
+            <version>${paper.api.version}</version>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>com.github.SlimeDog</groupId>
-            <artifactId>SlimeDogCore</artifactId>
-            <version>1.0.10</version>
-        </dependency>
         <dependency>
             <groupId>net.kyori</groupId>
-            <artifactId>adventure-text-serializer-legacy</artifactId>
-            <version>4.26.1</version>
+            <artifactId>adventure-text-minimessage</artifactId>
+            <version>${adventure.version}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>net.kyori</groupId>
-            <artifactId>adventure-api</artifactId>
-            <version>4.26.1</version>
+            <artifactId>adventure-text-serializer-legacy</artifactId>
+            <version>${adventure.version}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
-            <groupId>org.jspecify</groupId>
-            <artifactId>jspecify</artifactId>
-            <version>1.0.0</version>
+            <groupId>me.clip</groupId>
+            <artifactId>placeholderapi</artifactId>
+            <version>${placeholderapi.version}</version>
+            <scope>provided</scope>
         </dependency>
     </dependencies>
 
     <build>
-        <finalName>PluginVersions-${project.version}</finalName>
+        <finalName>1MB-PluginVersions-v${project.version}-${build.number}-j25-26.1.2</finalName>
         <resources>
             <resource>
                 <directory>src/main/resources</directory>
                 <filtering>true</filtering>
             </resource>
         </resources>
         <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-dependency-plugin</artifactId>
-                <version>3.9.0</version>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.14.1</version>
                 <configuration>
+                    <release>${maven.compiler.release}</release>
                     <compilerArgs>
                         <arg>-Xlint:deprecation</arg>
-                        <arg>-Xlint:-options</arg>
                         <arg>-Xdiags:verbose</arg>
                     </compilerArgs>
                 </configuration>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-shade-plugin</artifactId>
-                <version>3.6.1</version>
-                <executions>
-                    <execution>
-                        <phase>package</phase>
-                        <goals>
-                            <goal>shade</goal>
-                        </goals>
-                        <configuration>
-                            <createDependencyReducedPom>false</createDependencyReducedPom>
-                            <minimizeJar>true</minimizeJar>
-                            <transformers>
-                                <transformer
-                                        implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer">
-                                </transformer>
-                            </transformers>
-                            <filters>
-                                <filter>
-                                    <artifact>*:*</artifact>
-                                    <excludes>
-                                        <exclude>META-INF/maven/**</exclude>
-                                        <exclude>META-INF/*.MF</exclude>
-                                        <exclude>META-INF/*.SF</exclude>
-                                        <exclude>META-INF/*.DSA</exclude>
-                                        <exclude>META-INF/*.RSA</exclude>
-                                        <exclude>META-INF/services/**</exclude>
-                                        <exclude>META-INF/versions/**</exclude>
-                                        <exclude>org/jetbrains/**</exclude>
-                                        <exclude>org/intellij/**</exclude>
-                                        <exclude>org/jspecify/**</exclude>
-                                    </excludes>
-                                </filter>
-                            </filters>
-                            <relocations>
-                                <relocation>
-                                    <pattern>dev.ratas.slimedogcore</pattern>
-                                    <shadedPattern>${project.groupId}.${project.artifactId}.core</shadedPattern>
-                                </relocation>
-                            </relocations>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
         </plugins>
     </build>
 </project>

settings.gradle.kts

@@ -0,0 +1 @@
+rootProject.name = "1MB-PluginVersions"