From 05bfbcccf43db187979c363522e6c03579e2c4e7 Mon Sep 17 00:00:00 2001
From: Jonas_Jones <91549607+J-onasJones@users.noreply.github.com>
Date: Tue, 13 Dec 2022 22:06:19 +0100
Subject: [PATCH] Initial project files
---
.gitignore | 1 +
BetterSimpleConfig.iml | 11 ++
README.md | 2 +-
config/ModConfigProvider.java | 28 ++++
config/ModConfigs.java | 36 +++++
config/SimpleConfig.java | 253 ++++++++++++++++++++++++++++++++++
6 files changed, 330 insertions(+), 1 deletion(-)
create mode 100644 .gitignore
create mode 100644 BetterSimpleConfig.iml
create mode 100644 config/ModConfigProvider.java
create mode 100644 config/ModConfigs.java
create mode 100644 config/SimpleConfig.java
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..85e7c1d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+/.idea/
diff --git a/BetterSimpleConfig.iml b/BetterSimpleConfig.iml
new file mode 100644
index 0000000..dfafe75
--- /dev/null
+++ b/BetterSimpleConfig.iml
@@ -0,0 +1,11 @@
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/README.md b/README.md
index d16e51f..42c8c47 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,2 @@
# BetterSimpleConfig
-An upgrade of magistermaks's fabric-simplelibs simple-config system
+An upgrade of magistermaks's fabric-simplelibs simple-config system with MC Mod integration
diff --git a/config/ModConfigProvider.java b/config/ModConfigProvider.java
new file mode 100644
index 0000000..6893210
--- /dev/null
+++ b/config/ModConfigProvider.java
@@ -0,0 +1,28 @@
+package net.fabric.examplemod.config;
+
+import com.mojang.datafixers.util.Pair;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class ModConfigProvider implements SimpleConfig.DefaultConfig {
+
+ private String configContents = "";
+
+ public List getConfigsList() {
+ return configsList;
+ }
+
+ private final List configsList = new ArrayList<>();
+
+ public void addKeyValuePair(Pair keyValuePair, String comment) {
+ configsList.add(keyValuePair);
+ configContents += keyValuePair.getFirst() + "=" + keyValuePair.getSecond() + " #"
+ + comment + " | default: " + keyValuePair.getSecond() + "\n";
+ }
+
+ @Override
+ public String get(String namespace) {
+ return configContents;
+ }
+}
diff --git a/config/ModConfigs.java b/config/ModConfigs.java
new file mode 100644
index 0000000..acbd9a7
--- /dev/null
+++ b/config/ModConfigs.java
@@ -0,0 +1,36 @@
+package net.fabric.examplemod.config;
+
+import com.mojang.datafixers.util.Pair;
+import me.jonasjones.consolemc.ConsoleMC;
+
+public class ModConfigs {
+ public static SimpleConfig CONFIG;
+ private static ModConfigProvider configs;
+
+ public static boolean IS_ENABLED;
+ public static boolean REUQIRE_OP;
+ public static boolean ALLOW_CMD_BLOCKS;
+
+ public static void registerConfigs() {
+ configs = new ModConfigProvider();
+ createConfigs();
+
+ CONFIG = SimpleConfig.of(ConsoleMC.MOD_ID + "config").provider(configs).request();
+
+ assignConfigs();
+ }
+
+ private static void createConfigs() {
+ configs.addKeyValuePair(new Pair<>("cmd.enable", true), "whether or not to allow chat command execution.");
+ configs.addKeyValuePair(new Pair<>("cmd.requireOp", true), "whether or not operator level is required in order to run commands.");
+ configs.addKeyValuePair(new Pair<>("cmd.allowCmdBlocks", false), "whether or not commands can be run through command blocks");
+ }
+
+ private static void assignConfigs() {
+ IS_ENABLED = CONFIG.getOrDefault("cmd.enable", true);
+ REUQIRE_OP = CONFIG.getOrDefault("cmd.requireOp", true);
+ ALLOW_CMD_BLOCKS = CONFIG.getOrDefault("cmd.allowCmdBlocks", false);
+
+ System.out.println("All " + configs.getConfigsList().size() + " have been set properly");
+ }
+}
diff --git a/config/SimpleConfig.java b/config/SimpleConfig.java
new file mode 100644
index 0000000..c73d914
--- /dev/null
+++ b/config/SimpleConfig.java
@@ -0,0 +1,253 @@
+package net.fabric.examplemod.config;
+/*
+ * Copyright (c) 2021 magistermaks
+ * Modified by Jonas_Jones 2022
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+import net.fabricmc.loader.api.FabricLoader;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.HashMap;
+import java.util.Scanner;
+
+public class SimpleConfig {
+
+ private static final Logger LOGGER = LogManager.getLogger("BetterSimpleConfig");
+ private final HashMap config = new HashMap<>();
+ private final ConfigRequest request;
+ private boolean broken = false;
+
+ public interface DefaultConfig {
+ String get( String namespace );
+
+ static String empty( String namespace ) {
+ return "";
+ }
+ }
+
+ public static class ConfigRequest {
+
+ private final File file;
+ private final String filename;
+ private DefaultConfig provider;
+
+ private ConfigRequest(File file, String filename ) {
+ this.file = file;
+ this.filename = filename;
+ this.provider = DefaultConfig::empty;
+ }
+
+ /**
+ * Sets the default config provider, used to generate the
+ * config if it's missing.
+ *
+ * @param provider default config provider
+ * @return current config request object
+ * @see DefaultConfig
+ */
+ public ConfigRequest provider( DefaultConfig provider ) {
+ this.provider = provider;
+ return this;
+ }
+
+ /**
+ * Loads the config from the filesystem.
+ *
+ * @return config object
+ * @see SimpleConfig
+ */
+ public SimpleConfig request() {
+ return new SimpleConfig( this );
+ }
+
+ private String getConfig() {
+ return provider.get( filename ) + "\n";
+ }
+
+ }
+
+ /**
+ * Creates new config request object, ideally `namespace`
+ * should be the name of the mod id of the requesting mod
+ *
+ * @param filename - name of the config file
+ * @return new config request object
+ */
+ public static ConfigRequest of( String filename ) {
+ Path path = FabricLoader.getInstance().getConfigDir();
+ return new ConfigRequest( path.resolve( filename + ".properties" ).toFile(), filename );
+ }
+
+ private void createConfig() throws IOException {
+
+ // try creating missing files
+ request.file.getParentFile().mkdirs();
+ Files.createFile( request.file.toPath() );
+
+ // write default config data
+ PrintWriter writer = new PrintWriter(request.file, "UTF-8");
+ writer.write( request.getConfig() );
+ writer.close();
+
+ }
+
+ private void loadConfig() throws IOException {
+ Scanner reader = new Scanner( request.file );
+ for( int line = 1; reader.hasNextLine(); line ++ ) {
+ parseConfigEntry( reader.nextLine(), line );
+ }
+ }
+
+ private void parseConfigEntry( String entry, int line ) {
+ if( !entry.isEmpty() && !entry.startsWith( "#" ) ) {
+ String[] parts = entry.split("=", 2);
+ if( parts.length == 2 ) {
+ //Recognise comments after a value
+ String temp = parts[1].split(" #")[0];
+ config.put( parts[0], temp);
+ }else{
+ throw new RuntimeException("Syntax error in config file on line " + line + "!");
+ }
+ }
+ }
+
+ private SimpleConfig( ConfigRequest request ) {
+ this.request = request;
+ String identifier = "Config '" + request.filename + "'";
+
+ if( !request.file.exists() ) {
+ LOGGER.info( identifier + " is missing, generating default one..." );
+
+ try {
+ createConfig();
+ } catch (IOException e) {
+ LOGGER.error( identifier + " failed to generate!" );
+ LOGGER.trace( e );
+ broken = true;
+ }
+ }
+
+ if( !broken ) {
+ try {
+ loadConfig();
+ } catch (Exception e) {
+ LOGGER.error( identifier + " failed to load!" );
+ LOGGER.trace( e );
+ broken = true;
+ }
+ }
+
+ }
+
+ /**
+ * Queries a value from config, returns `null` if the
+ * key does not exist.
+ *
+ * @return value corresponding to the given key
+ * @see SimpleConfig#getOrDefault
+ */
+ @Deprecated
+ public String get( String key ) {
+ return config.get( key );
+ }
+
+ /**
+ * Returns string value from config corresponding to the given
+ * key, or the default string if the key is missing.
+ *
+ * @return value corresponding to the given key, or the default value
+ */
+ public String getOrDefault( String key, String def ) {
+ String val = get(key);
+ return val == null ? def : val;
+ }
+
+ /**
+ * Returns integer value from config corresponding to the given
+ * key, or the default integer if the key is missing or invalid.
+ *
+ * @return value corresponding to the given key, or the default value
+ */
+ public int getOrDefault( String key, int def ) {
+ try {
+ return Integer.parseInt( get(key) );
+ } catch (Exception e) {
+ return def;
+ }
+ }
+
+ /**
+ * Returns boolean value from config corresponding to the given
+ * key, or the default boolean if the key is missing.
+ *
+ * @return value corresponding to the given key, or the default value
+ */
+ public boolean getOrDefault( String key, boolean def ) {
+ String val = get(key);
+ if( val != null ) {
+ return val.equalsIgnoreCase("true");
+ }
+
+ return def;
+ }
+
+ /**
+ * Returns double value from config corresponding to the given
+ * key, or the default string if the key is missing or invalid.
+ *
+ * @return value corresponding to the given key, or the default value
+ */
+ public double getOrDefault( String key, double def ) {
+ try {
+ return Double.parseDouble( get(key) );
+ } catch (Exception e) {
+ return def;
+ }
+ }
+
+ /**
+ * If any error occurred during loading or reading from the config
+ * a 'broken' flag is set, indicating that the config's state
+ * is undefined and should be discarded using `delete()`
+ *
+ * @return the 'broken' flag of the configuration
+ */
+ public boolean isBroken() {
+ return broken;
+ }
+
+ /**
+ * deletes the config file from the filesystem
+ *
+ * @return true if the operation was successful
+ */
+ public boolean delete() {
+ LOGGER.warn( "Config '" + request.filename + "' was removed from existence! Restart the game to regenerate it." );
+ return request.file.delete();
+ }
+
+}