Paper support

README.md

@@ -12,33 +12,47 @@ public class Configs {
     public static String exampleString = "default";
 }
 ```
-Finally, in your mod's `onInitialize(Client)` method, register the `Configs` class. Replace `<mod id>` with your mod's
-id.
-```java
-new ModConfigBuilder(<mod id>, Configs.class).build();
-```
-That's it! Now you can access `exampleString` through `Configs.exampleString`. You can edit `exampleString` by executing
-the following command.
-```
-/(c)config <mod id> exampleString set <string>
-```
+Finally, register your `Configs` class.
+- For Fabric users, register the `Configs` class in your mod's `onInitialize(Client)` method. Replace `<mod id>` with your 
+mod's id. Sometimes you may omit the generics and just do `<>` instead.
+  - On clients:
+    ```java
+    new ModConfigBuilder<FabricClientCommandSource, CommandBuildContext>(<mod id>, Configs.class).build();
+    ```
+  - On servers:
+    ```java
+    new ModConfigBuilder<CommandSourceStack, CommandBuildContext>(<mod id>, Configs.class).build();
+    ```
+- For Paper users, register the `Configs` class in your plugin's `onEnable` method. Replace `<plugin name>` with your
+plugin's name.
+  ```java
+  new ModConfigBuilder<>(<plugin name>, Configs.class).build();
+  ```
+That's it! Now you can access `exampleString` through `Configs.exampleString`. You can edit `exampleString` by using the
+config command.
+- On Fabric there are different commands for the client and server.  For both, replace `<mod id>` with your mod's id.
+  - On clients, execute `/cconfig <mod id> exampleString set <string>`.
+  - On servers, execute `/config <mod id> exampleString set <string>`.
+- On Paper servers, execute `/config <plugin name> exampleString set <string>`. Replace `<plugin name>` with your
+plugin's name.
 
 ## That's not all!
-This mod also supports the use of `Collection`s and `Map`s as variable types. These configurations will have the options
-`add`, `put` and `remove` available. Moreover, you can define your own (de)serialisers to create configurations with 
-arbitrary types. To do this, all you have to do is register the (de)serialiser when you build your config. For instance,
-to create a variable with type `Block` you can do
+This mod also natively supports the use of `Collection`s and `Map`s as variable types. These configurations will have
+the options `add`, `put` and `remove` available. Moreover, you can define your own (de)serialisers to create
+configurations with arbitrary types. To do this, all you have to do is register the (de)serialiser when you build your
+config. For instance, to create configurations with type `Block` you can do
 ```java
-new ModConfigBuilder(<mod id>, Configs.class)
+new ModConfigBuilder<>(<mod id>, Configs.class)
     .registerTypeHierarchy(Block.class, new BlockAdapter(), BlockArgumentType::block)
     .build();
 ```
-where `BlockAdapter` extends `TypeAdapter<Block>` and `BlockArgumentType` implements `ArgumentType<Block>`. See 
-[these tests](src/testmod/java/dev/xpple/betterconfig) for a complete picture.
+where `BlockAdapter` extends `TypeAdapter<Block>` and `BlockArgumentType` implements `ArgumentType<Block>`. See
+[these tests](fabric/src/testmod/java/dev/xpple/betterconfig) for a complete picture. An identical setup for Paper can
+be found [here](paper/src/testplugin/java/dev/xpple/betterconfig).
 
 Furthermore, you can completely change the behaviour of updating your config values by creating your own methods. Simply
 add one or more of `setter`, `adder`, `putter` or `remover` as attribute to your `@Config` annotation. A great use for
-this would be adding key-pair entries to a `Map` based on a single value. Consider the following configuration.
+this would be adding key-value entries to a `Map` based on a single value. Consider the following configuration.
 ```java
 @Config(putter = @Config.Putter("none"), adder = @Config.Adder("customMapAdder"))
 public static Map<String, String> exampleMapAdder = new HashMap<>(Map.of("a", "A", "b", "B"));
@@ -48,7 +62,7 @@ public static void customMapAdder(String string) {
 ```
 The value of `"none"` for the putter indicates that no putter will be available. This way, you can use this `Map` in your
 code like usual, and add values to it using `/(c)config <mod id> exampleMapAdder add <string>`. For more details, see
-[the JavaDocs for `@Config`](src/main/java/dev/xpple/betterconfig/api/Config.java).
+[the JavaDocs for `@Config`](common/src/main/java/dev/xpple/betterconfig/api/Config.java).
 
 The parameters of the update method can also be customised.
 ```java
@@ -60,8 +74,13 @@ public static void customTypeAdder(int codepoint) {
 ```
 For putters, there are separate key and value type attributes.
 
+And many more things! For some illustrative examples, see the `Configs` class for both
+[Fabric](fabric/src/testmod/java/dev/xpple/betterconfig/Configs.java) and
+[Paper](paper/src/testplugin/java/dev/xpple/betterconfig/Configs.java).
+
 ## Installation
-Replace `${version}` with the artifact version.
+Replace `${version}` with the artifact version. Append `-fabric` for Fabric and `-paper` for Paper to the base artifact
+name.
 
 You may choose between my own maven repository and GitHub's package repository.
 ### My own
@@ -87,6 +106,9 @@ repositories {
 Import it:
 ```gradle
 dependencies {
-    include modImplementation('dev.xpple:betterconfig:${betterconfig_version}')
+    // Fabric
+    include modImplementation('dev.xpple:betterconfig-fabric:${betterconfig-version}')
+    // Paper (also include the JAR in the plugins folder)
+    compileOnly 'dev.xpple:betterconfig-paper:${betterconfig_version}'
 }
 ```

common/build.gradle

@@ -0,0 +1,40 @@
+plugins {
+    id 'fabric-loom' version '1.7-SNAPSHOT'
+}
+
+base {
+    archivesName = project.archives_base_name
+    version = project.mod_version
+    group = project.maven_group
+}
+
+repositories {
+    maven {
+        url = 'https://maven.parchmentmc.org'
+    }
+}
+
+dependencies {
+    minecraft "com.mojang:minecraft:${project.minecraft_version}"
+    mappings loom.layered {
+        officialMojangMappings {
+            nameSyntheticMembers = true
+        }
+        parchment "org.parchmentmc.data:${project.parchment_mappings}"
+    }
+}
+
+tasks.withType(JavaCompile).configureEach {
+    it.options.release = 21
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_21
+    targetCompatibility = JavaVersion.VERSION_21
+}
+
+jar {
+    from("LICENSE") {
+        rename {"${it}_${project.base.archivesName.get()}"}
+    }
+}

common/src/main/java/dev/xpple/betterconfig/BetterConfigCommon.java

@@ -0,0 +1,11 @@
+package dev.xpple.betterconfig;
+
+import org.jetbrains.annotations.ApiStatus;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@ApiStatus.Internal
+public class BetterConfigCommon {
+    public static final String MOD_ID = "betterconfig";
+    public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID);
+}

src/main/java/dev/xpple/betterconfig/api/BetterConfigAPI.java → common/src/main/java/dev/xpple/betterconfig/api/BetterConfigAPI.java

@@ -3,7 +3,6 @@
 import dev.xpple.betterconfig.impl.BetterConfigImpl;
 
 public interface BetterConfigAPI {
-
     static BetterConfigAPI getInstance() {
         return BetterConfigImpl.INSTANCE;
     }