move hardcoded strings to build constants

Author: rfresh2

README.md

@@ -61,13 +61,15 @@ This will run ZenithProxy with your plugin loaded in the `run` directory.
 ### New Plugin Checklist
 
 1. Edit `gradle.properties`:
-   - `plugin_name` - Name of your plugin, used in the plugin jar name (e.g. `ExamplePlugin`)
+   - `plugin_name` - Name of your plugin, shown to users and in the plugin jar file name (e.g. `ExamplePlugin`)
+   - `plugin_id` - Unique identifier for your plugin (e.g. `example-plugin`)
+     - Must start with a lowercase letter and contain only lowercase letters, numbers, or dashes (`-`)
+   - `mc` - MC version of ZenithProxy your plugin is compiled for (e.g. `1.21.4`)
    - `maven_group` - Java package for your project (e.g. `com.github.rfresh2`)
 1. Move files to your new corresponding package / maven group:
    - Example: `src/main/java/org/example` -> `src/main/java/com/github/rfresh2`
    - First create the new package in `src/main/java`. Then click and drag original subpackages/classes to your new one
    - Do this with Intellij to avoid manually editing all the source files
-   - You must also move folders/package for the `src/main/templates` folder
-   - Also make sure to update the package import at the very top of `BuiltConstants.java`, it will not be done automatically
+   - You must also create and move package folders for the `src/main/templates` folder
 1. Edit `ExamplePlugin.java`, or remove it and create a new main class
    - Make sure to update the `@Plugin` annotation

build.gradle.kts

@@ -5,21 +5,25 @@ plugins {
 group = properties["maven_group"] as String
 version = properties["plugin_version"] as String
 val mc = properties["mc"] as String
+val pluginId = properties["plugin_id"] as String
 
 java { toolchain { languageVersion = JavaLanguageVersion.of(25) } }
 
 zenithProxyPlugin {
     templateProperties = mapOf(
         // variables in your BuildConstants.java template class
-        "version" to project.version
+        "version" to project.version,
+        "mc_version" to mc,
+        "plugin_id" to pluginId,
+        "maven_group" to group as String,
     )
     // the minimum supported java version for users of your plugin
     javaReleaseVersion = JavaLanguageVersion.of(21)
 }
 
 repositories {
     maven("https://maven.2b2t.vc/releases") {
-        description = "ZenithProxy Releases and Dependencies"
+        description = "ZenithProxy Releases"
     }
     maven("https://maven.2b2t.vc/remote") {
         description = "Dependencies used by ZenithProxy"

gradle.properties

@@ -1,5 +1,7 @@
 plugin_version=1.0.0
 plugin_name=ZenithProxyExamplePlugin
+plugin_id=example-plugin
+# More info about MC Version support: https://wiki.2b2t.vc/Setup/#release-channels
 mc=1.21.4
 maven_group=org.example
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

src/main/java/org/example/ExampleConfig.java

@@ -3,7 +3,9 @@
 /**
  * Example configuration POJO.
  *
- * Configurations are saved and loaded to JSON files
+ * Configurations are saved and loaded to JSON files.
+ *
+ * Save and load is handled automatically, happens on every command execution, proxy start/stop, etc.
  *
  * All fields should be public and mutable.
  *

src/main/java/org/example/ExamplePlugin.java

@@ -12,13 +12,12 @@
 import org.example.module.ExampleWanderModule;
 
 @Plugin(
-    id = "example-plugin",
+    id = BuildConstants.PLUGIN_ID,
     version = BuildConstants.VERSION,
     description = "ZenithProxy Example Plugin",
     url = "https://github.com/rfresh2/ZenithProxyExamplePlugin",
     authors = {"rfresh2"},
-    mcVersions = {"1.21.4"} // to indicate any MC version: @Plugin(mcVersions = "*")
-                            // if you touch packet classes, you almost certainly need to pin to a single mc version
+    mcVersions = {BuildConstants.MC_VERSION} // to indicate any MC version: @Plugin(mcVersions = "*")
 )
 public class ExamplePlugin implements ZenithProxyPlugin {
     // public static for simple access from modules and commands
@@ -31,7 +30,7 @@ public void onLoad(PluginAPI pluginAPI) {
         LOG = pluginAPI.getLogger();
         LOG.info("Example Plugin loading...");
         // initialize any configurations before modules or commands might need to read them
-        PLUGIN_CONFIG = pluginAPI.registerConfig("example-plugin", ExampleConfig.class);
+        PLUGIN_CONFIG = pluginAPI.registerConfig(BuildConstants.PLUGIN_ID, ExampleConfig.class);
         pluginAPI.registerModule(new ExampleModule());
         pluginAPI.registerModule(new ExampleESPModule());
         pluginAPI.registerModule(new ExampleWanderModule());

src/main/java/org/example/module/ExampleESPModule.java

@@ -20,6 +20,7 @@ public boolean enabledSetting() {
         return ExamplePlugin.PLUGIN_CONFIG.esp;
     }
 
+    // packets from player to zenith
     @Override
     public PacketHandlerCodec registerServerPacketHandlerCodec() {
         return PacketHandlerCodec.serverBuilder()
@@ -40,6 +41,14 @@ public PacketHandlerCodec registerServerPacketHandlerCodec() {
             .build();
     }
 
+    // to handle packets from zenith to server
+//    @Override
+//    public PacketHandlerCodec registerClientPacketHandlerCodec() {
+//        return PacketHandlerCodec.clientBuilder()
+//            ...
+//            .build();
+//    }
+
 
     // this can also be moved to a separate class file
     public static class GlowingEntityMetadataPacketHandler implements PacketHandler<ClientboundSetEntityDataPacket, ServerSession> {

src/main/templates/org/example/BuildConstants.java

@@ -1,7 +1,11 @@
-package org.example;
+package ${maven_group};
 
 // The constants are replaced before compilation
 public class BuildConstants {
 
     public static final String VERSION = "${version}";
+
+    public static final String MC_VERSION = "${mc_version}";
+
+    public static final String PLUGIN_ID = "${plugin_id}";
 }