From 0cb16cbf3ff1425bd116cf4973b81134d8cadc17 Mon Sep 17 00:00:00 2001 From: Motschen Date: Mon, 31 Oct 2022 11:56:53 +0100 Subject: [PATCH] Update the example config class --- MidnightConfigExample.java | 63 ++++++++++++++++++++++++++++++++++++++ fabric/build.gradle | 2 +- forge/build.gradle | 1 + quilt/build.gradle | 2 +- 4 files changed, 66 insertions(+), 2 deletions(-) create mode 100644 MidnightConfigExample.java diff --git a/MidnightConfigExample.java b/MidnightConfigExample.java new file mode 100644 index 0000000..1f4ce51 --- /dev/null +++ b/MidnightConfigExample.java @@ -0,0 +1,63 @@ +package eu.midnightdust.core.config; + +import eu.midnightdust.lib.config.MidnightConfig; + +import java.util.List; + +/** MidnightConfig documentation & examples: + * Thanks for choosing MidnightConfig - the fancy, tiny and lightweight config library. + * If you want to use the lib in your mod, here are some examples and hints: + * Every option in a MidnightConfig class has to be public and static, so we can access it from other classes. + * The config class also has to extend MidnightConfig*/ + +public class MidnightConfigExample extends MidnightConfig { + + @Comment public static Comment text1; // Comments are rendered like an option without a button and are excluded from the config file + @Comment(centered = true) public static Comment text2; // Centered comments are the same as normal ones - just centered! + @Entry public static int fabric = 16777215; // Example for an int option + @Entry public static double world = 1.4D; // Example for a double option + @Entry public static boolean showInfo = true; // Example for a boolean option + @Entry public static String name = "Hello World!"; // Example for a string option + @Entry public static TestEnum testEnum = TestEnum.FABRIC; // Example for an enum option + public enum TestEnum { // Enums allow the user to cycle through predefined options + QUILT, FABRIC, FORGE + } + @Entry(min=69,max=420) public static int hello = 420; // - The entered number has to be larger than 69 and smaller than 420 + @Entry(width = 7, min = 7, isColor = true, name = "I am a color!") public static String titleColor = "#ffffff"; // The isColor property adds a preview box for a hexadecimal color + @Entry(name = "I am an array list!") public static List arrayList = List.of("String1", "String2"); // Array String Lists are also supported + @Entry(name = "I am an int slider.",isSlider = true, min = 0, max = 100) public static int intSlider = 35; // Int fields can also be displayed as a Slider + @Entry(name = "I am a float slider!", isSlider = true, min = 0f, max = 1f, precision = 1000) public static float floatSlider = 0.24f; // And so can floats! Precision defines the amount of decimal places + // The name field can be used to specify a custom translation string or plain text + + public static int imposter = 16777215; // - Entries without an @Entry or @Comment annotation are ignored + + /* + The .json language file for your config class could look similar to this: + { + "modid.midnightconfig.title":"I am a title", // "*.midnightconfig.title" defines the title of the screen + "modid.midnightconfig.text1":"I am a comment *u*", // Translation for the comment "text1" defined in the example config + "modid.midnightconfig.text2":"I am a centered comment (╯°□°）╯︵ ┻━┻", + "modid.midnightconfig.name":"I am a string!", // Translation for the field "name" defined in the example config + "modid.midnightconfig.name.tooltip":"I am a tooltip uwu \nI am a new line", + // When hovering over the option "showInfo", + // this text will appear as a tooltip. + // "\n" inserts a line break. + "modid.midnightconfig.fabric":"I am an int", + "modid.midnightconfig.world":"I am a double", + "modid.midnightconfig.showInfo":"I am a boolean", + "modid.midnightconfig.hello":"I am a limited int!", + "modid.midnightconfig.testEnum":"I am an enum!", + "modid.midnightconfig.enum.TestEnum.FORGE":"Slow", + "modid.midnightconfig.enum.TestEnum.FABRIC":"Fancy", + "modid.midnightconfig.enum.TestEnum.QUILT":"Fabulous" + } + To initialize the config you have to call "MidnightConfig.init("modid", MidnightConfigExample.class)" in your ModInitializer + To get an instance of the config screen you have to call "MidnightConfig.getScreen(parent, "modid");" + + If you don't use the whole library and therefore not the automatic ModMenu integration, the code in your ModMenu integration class would look something like this: + @Override + public ConfigScreenFactory getModConfigScreenFactory() { + return parent -> MidnightConfig.getScreen(parent, "modid"); + } + */ +} \ No newline at end of file diff --git a/fabric/build.gradle b/fabric/build.gradle index c282345..3cc4036 100644 --- a/fabric/build.gradle +++ b/fabric/build.gradle @@ -16,6 +16,7 @@ configurations { compileClasspath.extendsFrom common runtimeClasspath.extendsFrom common developmentFabric.extendsFrom common + archivesBaseName = rootProject.archives_base_name + "-fabric" } dependencies { @@ -44,7 +45,6 @@ shadowJar { } remapJar { - injectAccessWidener = true input.set shadowJar.archiveFile dependsOn shadowJar classifier null diff --git a/forge/build.gradle b/forge/build.gradle index 2bc05c3..f80b84f 100644 --- a/forge/build.gradle +++ b/forge/build.gradle @@ -19,6 +19,7 @@ configurations { compileClasspath.extendsFrom common runtimeClasspath.extendsFrom common developmentForge.extendsFrom common + archivesBaseName = rootProject.archives_base_name + "-forge" } dependencies { diff --git a/quilt/build.gradle b/quilt/build.gradle index fc809fb..ff7a780 100644 --- a/quilt/build.gradle +++ b/quilt/build.gradle @@ -20,6 +20,7 @@ configurations { compileClasspath.extendsFrom common runtimeClasspath.extendsFrom common developmentQuilt.extendsFrom common + archivesBaseName = rootProject.archives_base_name + "-quilt" } dependencies { @@ -51,7 +52,6 @@ shadowJar { } remapJar { - injectAccessWidener = true input.set shadowJar.archiveFile dependsOn shadowJar classifier null