- fix: NullPointerException when the config class of mod updated

- alter: better test code in `common/src/test`, `neoforge/src/test` and `fabric/src/test`, run `Test Minecraft Client(:fabric)` or `Test Minecraft Client(:neoforge)` for testing
This commit is contained in:
Jaffe2718
2025-09-11 11:48:26 +08:00
parent 78c462dc1c
commit c775a9d221
18 changed files with 167 additions and 62 deletions

View File

@@ -1,3 +1,7 @@
plugins {
id 'java'
}
architectury {
common(rootProject.enabled_platforms.split(","))
}
@@ -21,3 +25,16 @@ publishing {
// Add repositories to publish to here.
}
}
configurations {
testOutput.extendsFrom(testImplementation)
}
tasks.register('testJar', Jar) {
from sourceSets.test.output
archiveClassifier = 'tests'
}
artifacts {
testOutput testJar
}

View File

@@ -132,7 +132,7 @@ public abstract class MidnightConfig {
entries.values().forEach(info -> {
if (info.field != null && info.entry != null) {
try {
info.value = info.field.get(null);
info.value = info.field.get(null) == null ? info.defaultValue : info.field.get(null);
info.tempValue = info.toTemporaryValue();
info.updateConditions();
} catch (IllegalAccessException ignored) {}

View File

@@ -0,0 +1,96 @@
package eu.midnightdust.test;
import com.google.common.collect.Lists;
import eu.midnightdust.lib.config.MidnightConfig;
import net.minecraft.client.MinecraftClient;
import net.minecraft.client.gui.tooltip.Tooltip;
import net.minecraft.client.gui.widget.ButtonWidget;
import net.minecraft.client.gui.widget.ClickableWidget;
import net.minecraft.client.gui.widget.TextIconButtonWidget;
import net.minecraft.client.option.KeyBinding;
import net.minecraft.client.util.InputUtil;
import net.minecraft.text.MutableText;
import net.minecraft.text.Text;
import net.minecraft.util.Formatting;
import net.minecraft.util.Identifier;
import org.jetbrains.annotations.Nullable;
import org.lwjgl.glfw.GLFW;
/*
Pre-made additional (niche) functionality that is not included in MidnightLib to keep the file size small.
Feel free to copy the parts you need :)
*/
public class MidnightLibExtras {
public static class KeybindButton extends ButtonWidget {
public static ButtonWidget focusedButton;
public static void add(KeyBinding binding, MidnightConfig.MidnightConfigListWidget list, MidnightConfig.MidnightConfigScreen screen) {
KeybindButton editButton = new KeybindButton(screen.width - 185, 0, 150, 20, binding);
TextIconButtonWidget resetButton = TextIconButtonWidget.builder(Text.translatable("controls.reset"), (button -> {
binding.setBoundKey(binding.getDefaultKey());
screen.updateList();
}), true).texture(Identifier.of("midnightlib","icon/reset"), 12, 12).dimension(20, 20).build();
resetButton.setPosition(screen.width - 205 + 150 + 25, 0);
editButton.resetButton = resetButton;
editButton.updateMessage(false);
MidnightConfig.EntryInfo info = new MidnightConfig.EntryInfo(null, screen.modid);
list.addButton(Lists.newArrayList(editButton, resetButton), Text.translatable(binding.getTranslationKey()), info);
}
private final KeyBinding binding;
private @Nullable ClickableWidget resetButton;
public KeybindButton(int x, int y, int width, int height, KeyBinding binding) {
super(x, y, width, height, binding.getBoundKeyLocalizedText(), (button) -> {
((KeybindButton) button).updateMessage(true);
focusedButton = button;
}, (textSupplier) -> binding.isUnbound() ? Text.translatable("narrator.controls.unbound", binding.getTranslationKey()) : Text.translatable("narrator.controls.bound", binding.getTranslationKey(), textSupplier.get()));
this.binding = binding;
updateMessage(false);
}
@Override
public boolean keyPressed(int keyCode, int scanCode, int modifiers) {
if (focusedButton == this) {
if (keyCode == GLFW.GLFW_KEY_ESCAPE) {
this.binding.setBoundKey(InputUtil.UNKNOWN_KEY);
} else {
this.binding.setBoundKey(InputUtil.fromKeyCode(keyCode, scanCode));
}
updateMessage(false);
focusedButton = null;
return true;
}
return super.keyPressed(keyCode, scanCode, modifiers);
}
public void updateMessage(boolean focused) {
boolean hasConflicts = false;
MutableText conflictingBindings = Text.empty();
if (focused) this.setMessage(Text.literal("> ").append(this.binding.getBoundKeyLocalizedText().copy().formatted(Formatting.WHITE, Formatting.UNDERLINE)).append(" <").formatted(Formatting.YELLOW));
else {
this.setMessage(this.binding.getBoundKeyLocalizedText());
if (!this.binding.isUnbound()) {
for(KeyBinding keyBinding : MinecraftClient.getInstance().options.allKeys) {
if (keyBinding != this.binding && this.binding.equals(keyBinding)) {
if (hasConflicts) conflictingBindings.append(", ");
hasConflicts = true;
conflictingBindings.append(Text.translatable(keyBinding.getTranslationKey()));
}
}
}
}
if (this.resetButton != null) this.resetButton.active = !this.binding.isDefault();
if (hasConflicts) {
this.setMessage(Text.literal("[ ").append(this.getMessage().copy().formatted(Formatting.WHITE)).append(" ]").formatted(Formatting.RED));
this.setTooltip(Tooltip.of(Text.translatable("controls.keybinds.duplicateKeybinds", conflictingBindings)));
} else {
this.setTooltip(null);
}
}
}
}

View File

@@ -0,0 +1,170 @@
package eu.midnightdust.test.config;
import com.google.common.collect.Lists;
import eu.midnightdust.test.MidnightLibExtras;
import eu.midnightdust.lib.config.MidnightConfig;
import net.minecraft.text.MutableText;
import net.minecraft.text.Text;
import net.minecraft.util.Formatting;
import net.minecraft.client.MinecraftClient;
import net.minecraft.util.Identifier;
import net.minecraft.util.TranslatableOption;
import javax.swing.*;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
/** 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*/
@SuppressWarnings({"unused", "DefaultAnnotationParam"})
public class MidnightConfigExample extends MidnightConfig {
public static final String TEXT = "text";
public static final String NUMBERS = "numbers";
public static final String SLIDERS = "sliders";
public static final String LISTS = "lists";
public static final String FILES = "files";
public static final String CONDITIONS = "conditions";
public static final String EXTRAS = "extras";
@Comment(category = TEXT) public static Comment text1; // Comments are rendered like an option without a button and are excluded from the config file
@Comment(category = TEXT, centered = true) public static Comment text2; // Centered comments are the same as normal ones - just centered!
@Comment(category = TEXT) public static Comment spacer1; // Comments containing the word "spacer" will just appear as a blank line
@Entry(category = TEXT) public static boolean showInfo = true; // Example for a boolean option
@Entry(category = TEXT, name="I am a (non-primitive) Boolean") public static Boolean nonPrimitive = true; // Example for a non-primative boolean option
@Entry(category = TEXT) public static String name = "Hello World!"; // Example for a string option, which is in a category!
@Entry(category = TEXT, width = 7, min = 7, isColor = true, name = "I am a color!") public static String titleColor = "#ffffff"; // The isColor property adds a color chooser for a hexadecimal color
@Entry(category = TEXT, idMode = 0) public static Identifier id = Identifier.ofVanilla("diamond"); // Example for an identifier with matching items displayed next to it!
@Entry(category = TEXT) public static ModPlatform modPlatform = ModPlatform.FABRIC; // Example for an enum option
public enum ModPlatform { // Enums allow the user to cycle through predefined options
QUILT, FABRIC, FORGE, NEOFORGE, VANILLA
}
@Entry(category = TEXT) public static GraphicsSteps graphicsSteps = GraphicsSteps.FABULOUS; // Example for an enum option with TranslatableOption
@Comment(category = TEXT, name = "§nMidnightLib Wiki", centered = true, url = "https://www.midnightdust.eu/wiki/midnightlib/") public static Comment wiki; // Example for a comment with a url
@Entry(category = NUMBERS) public static int fabric = 16777215; // Example for an int option
@Entry(category = NUMBERS) public static double world = 1.4D; // Example for a double option
@Entry(category = NUMBERS, min=69,max=420) public static int hello = 420; // - The entered number has to be larger than 69 and smaller than 420
@Entry(category = SLIDERS, 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(category = SLIDERS, 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
@Entry(category = SLIDERS, name = "I am a non-primitive double slider!", isSlider = true, min = 0d, max = 4d, precision = 10000) public static Double nonPrimitiveDoubleSlider = 3.76d; // Even works for non-primitive fields
// The name field can be used to specify a custom translation string or plain text
@Entry(category = LISTS, name = "I am a string list!") public static List<String> stringList = Lists.newArrayList("String1", "String2"); // Array String Lists are also supported
@Entry(category = LISTS, isColor = true, name = "I am a color list!") public static List<String> colorList = Lists.newArrayList("#ac5f99", "#11aa44"); // Lists also support colors
@Entry(category = LISTS, name = "I am an identifier list!", idMode = 1) public static List<Identifier> idList = Lists.newArrayList(Identifier.ofVanilla("dirt")); // A list of block identifiers
@Entry(category = LISTS, name = "I am an integer list!") public static List<Integer> intList = Lists.newArrayList(69, 420);
@Entry(category = LISTS, name = "I am a float list!") public static List<Float> floatList = Lists.newArrayList(4.1f, -1.3f, -1f);
@Entry(category = FILES,
selectionMode = JFileChooser.FILES_ONLY,
fileExtensions = {"json", "txt", "log"}, // Define valid file extensions
fileChooserType = JFileChooser.SAVE_DIALOG,
name = "I am a file!")
public static String myFile = ""; // The isFile property adds a file picker button
@Entry(category = FILES,
selectionMode = JFileChooser.DIRECTORIES_ONLY,
fileChooserType = JFileChooser.OPEN_DIALOG,
name = "I am a directory!")
public static String myDirectory = ""; // The isDirectory property adds a directory picker button
@Entry(category = FILES,
selectionMode = JFileChooser.FILES_AND_DIRECTORIES,
fileExtensions = {"png", "jpg", "jpeg"},
fileChooserType = JFileChooser.OPEN_DIALOG,
name = "I can choose both files & directories!")
public static String myFileOrDirectory = ""; // The isFileOrDirectory property adds a file or directory picker button
@Entry(category = FILES,
selectionMode = JFileChooser.FILES_AND_DIRECTORIES,
fileExtensions = {"png", "jpg", "jpeg"},
fileChooserType = JFileChooser.OPEN_DIALOG,
name = "I am a mf file/directory list!")
public static List<String> fileOrDirectoryList = new ArrayList<>(); // Yes, that's right you can even have lists of files/directories
@Condition(requiredModId = "midnightlib") // Conditional options are here!
@Entry(category = CONDITIONS, name="Turn me on!")
public static boolean turnMeOn = false;
@Condition(requiredOption = "modid:turnMeOn", visibleButLocked = true)
@Entry(category = CONDITIONS, name="Turn me off (locked)!")
public static Boolean turnMeOff = true;
@Condition(requiredOption = "turnMeOn") // You can also use multiple conditions for the same entry
@Condition(requiredOption = "modid:turnMeOff", requiredValue = "false")
@Entry(category = CONDITIONS, name="Which is the best modloader?")
public static String bestModloader = "";
@Condition(requiredOption = "turnMeOn")
@Condition(requiredOption = "turnMeOff", requiredValue = "false")
@Condition(requiredOption = "bestModloader", requiredValue = "Forge")
@Comment(category = CONDITIONS, name="❌ You have bad taste :(", centered = true) // Don't take this too seriously btw :)
public static Comment answerForge; // Comments can also be conditional!
@Condition(requiredOption = "turnMeOn")
@Condition(requiredOption = "turnMeOff", requiredValue = "false")
@Condition(requiredOption = "bestModloader", requiredValue = "NeoForge")
@Comment(category = CONDITIONS, name="⛏ Not quite, but it's alright!", centered = true)
public static Comment answerNeoforge;
@Condition(requiredOption = "turnMeOn")
@Condition(requiredOption = "turnMeOff", requiredValue = "false")
@Condition(requiredOption = "bestModloader", requiredValue = "Fabric")
@Comment(category = CONDITIONS, name="⭐ Correct! Fabric (and Quilt) are the best!", centered = true)
public static Comment answerFabric;
@Condition(requiredOption = "turnMeOn")
@Condition(requiredOption = "turnMeOff", requiredValue = "false")
@Condition(requiredOption = "bestModloader", requiredValue = "Quilt")
@Comment(category = CONDITIONS, name="⭐ Correct! Quilt (and Fabric) are the best!", centered = true)
public static Comment answerQuilt;
@Entry(category = CONDITIONS, name="Enter any prime number below 10")
public static int primeNumber = 0;
@Comment(category = CONDITIONS, name="Correct!")
@Condition(requiredOption = "primeNumber", requiredValue = {"2", "3", "5", "7"})
public static Comment answerPrime;
@Condition(requiredOption = "midnightlib:config_screen_list", requiredValue = "FALSE") // Access options of other mods that are also using MidnightLib
@Comment(category = CONDITIONS) public static Comment spaceracer;
@Condition(requiredOption = "midnightlib:config_screen_list", requiredValue = "FALSE")
@Comment(category = CONDITIONS, name="You disabled MidnightLib's config screen list. Why? :(", centered = true) public static Comment why;
public static int imposter = 16777215; // - Entries without an @Entry or @Comment annotation are ignored
public enum GraphicsSteps implements TranslatableOption {
FAST(0, "options.graphics.fast"),
FANCY(1, "options.graphics.fancy"),
FABULOUS(2, "options.graphics.fabulous");
private final int id;
private final String translationKey;
GraphicsSteps(int id, String translationKey) {
this.id = id;
this.translationKey = translationKey;
}
@Override
public Text getText() {
MutableText mutableText = Text.translatable(this.getTranslationKey());
return this == GraphicsSteps.FABULOUS ? mutableText.formatted(Formatting.ITALIC).formatted(Formatting.AQUA) : mutableText;
}
@Override
public int getId() {
return this.id;
}
@Override
public String getTranslationKey() {
return this.translationKey;
}
}
@Condition(requiredModId = "thismoddoesnotexist")
@Comment(category = EXTRAS) public static Comment iAmJustADummy; // We only have this to initialize an empty tab for the keybinds below
@Override
public void onTabInit(String tabName, MidnightConfigListWidget list, MidnightConfigScreen screen) {
if (Objects.equals(tabName, EXTRAS)) {
MidnightLibExtras.KeybindButton.add(MinecraftClient.getInstance().options.advancementsKey, list, screen);
MidnightLibExtras.KeybindButton.add(MinecraftClient.getInstance().options.dropKey, list, screen);
}
}
}

View File

@@ -0,0 +1,30 @@
{
"modid.midnightconfig.title":"I am a title",
"modid.midnightconfig.text1":"I am a comment *u*",
"modid.midnightconfig.text2":"I am a centered comment (╯°□°)╯︵ ┻━┻",
"modid.midnightconfig.name":"I am a string!",
"modid.midnightconfig.name.label.tooltip":"I am a label tooltip \nWohoo!",
"modid.midnightconfig.name.tooltip":"I am a tooltip uwu \nI am a new line",
"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.id":"I am an Item Identifier!",
"modid.midnightconfig.modPlatform":"I am an enum!",
"modid.midnightconfig.enum.ModPlatform.FORGE":"Forge",
"modid.midnightconfig.enum.ModPlatform.FABRIC":"Fabric",
"modid.midnightconfig.enum.ModPlatform.QUILT":"Quilt",
"modid.midnightconfig.enum.ModPlatform.NEOFORGE":"NeoForge",
"modid.midnightconfig.enum.ModPlatform.VANILLA":"Vanilla",
"modid.midnightconfig.graphicsSteps":"I am an enum with TranslatableOption!",
"modid.midnightconfig.myFileOrDirectory.fileChooser": "Select an image or directory",
"modid.midnightconfig.myFileOrDirectory.fileFilter": "Supported Images (.png, .jpg, .jpeg)",
"modid.midnightconfig.category.numbers": "Numbers",
"modid.midnightconfig.category.text": "Text",
"modid.midnightconfig.category.sliders": "Sliders",
"modid.midnightconfig.category.lists": "Lists",
"modid.midnightconfig.category.files": "Files",
"modid.midnightconfig.category.conditions": "Quiz",
"modid.midnightconfig.category.extras": "Extras",
"modid.midnightconfig.category.multiConditions": "Multi-Conditions"
}

View File

@@ -0,0 +1,28 @@
{
"modid.midnightconfig.title": "Soy un título",
"modid.midnightconfig.text1": "Soy un comentario *u*",
"modid.midnightconfig.text2": "Soy un comentario centrado (╯°□°)╯︵ ┻━┻",
"modid.midnightconfig.name": "¡Soy una cadena de texto!",
"modid.midnightconfig.name.label.tooltip": "Soy el tooltip de una etiqueta \n¡Wujuu!",
"modid.midnightconfig.name.tooltip": "Soy un tooltip uwu \nY una nueva línea",
"modid.midnightconfig.fabric": "Soy un entero",
"modid.midnightconfig.world": "Soy un número decimal",
"modid.midnightconfig.showInfo": "Soy un booleano",
"modid.midnightconfig.hello": "¡Soy un entero limitado!",
"modid.midnightconfig.id": "¡Soy un identificador de ítem!",
"modid.midnightconfig.modPlatform": "¡Soy un enumerador!",
"modid.midnightconfig.enum.ModPlatform.FORGE": "Forge",
"modid.midnightconfig.enum.ModPlatform.FABRIC": "Fabric",
"modid.midnightconfig.enum.ModPlatform.QUILT": "Quilt",
"modid.midnightconfig.enum.ModPlatform.NEOFORGE": "NeoForge",
"modid.midnightconfig.enum.ModPlatform.VANILLA": "Vanilla",
"modid.midnightconfig.myFileOrDirectory.fileChooser": "Seleccioná una imagen o carpeta",
"modid.midnightconfig.myFileOrDirectory.fileFilter": "Imágenes compatibles (.png, .jpg, .jpeg)",
"modid.midnightconfig.category.numbers": "Números",
"modid.midnightconfig.category.text": "Texto",
"modid.midnightconfig.category.sliders": "Deslizadores",
"modid.midnightconfig.category.lists": "Listas",
"modid.midnightconfig.category.files": "Archivos",
"modid.midnightconfig.category.conditions": "Cuestionario",
"modid.midnightconfig.category.multiConditions": "Condiciones múltiples"
}