diff options
13 files changed, 216 insertions, 26 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 183bb52..bb8b9e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +#### **\[Build MC1.21.11-v1.1.0\]:** + +- Implemented config file (`/config/NoChatRestrictions.json`) allowing users to re-enable telemetry and profanity filter, if desired ([#20](https://github.com/Aizistral-Studios/No-Chat-Restrictions/issues/20), [#25](https://github.com/Aizistral-Studios/No-Chat-Restrictions/issues/25)). +- Added `enableMod` option to the config file, allowing users to disable the mod without removing it. +- Fixed config debug log message missing the file name. +- Redesigned mod logo. + #### **\[Build MC1.21.11-v1.0.3\]:** - Fixed incompatibility with [In-Game Account Switcher](https://modrinth.com/mod/in-game-account-switcher) on Forge and NeoForge ([thanks to Sw3ys, #28](https://github.com/Aizistral-Studios/No-Chat-Restrictions/pull/28)). diff --git a/Fabric/gradle.properties b/Fabric/gradle.properties index 3b971a4..536447e 100644 --- a/Fabric/gradle.properties +++ b/Fabric/gradle.properties @@ -12,7 +12,7 @@ loader_version=0.18.4 loom_version=1.13-SNAPSHOT # Mod Properties -mod_version=Fabric-MC1.21.11-v1.0.3 +mod_version=Fabric-MC1.21.11-v1.1.0 maven_group=com.aizistral.nochatrestrictions archives_base_name=NoChatRestrictions diff --git a/Fabric/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java b/Fabric/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java index ee04b0b..860a6c6 100644 --- a/Fabric/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java +++ b/Fabric/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java @@ -4,6 +4,7 @@ import java.io.BufferedReader; import java.io.BufferedWriter; import java.nio.file.Files; import java.nio.file.Path; +import java.util.Map; import java.util.Optional; import org.jetbrains.annotations.Nullable; @@ -11,15 +12,18 @@ import org.jetbrains.annotations.Nullable; import com.aizistral.nochatrestrictions.core.NCRCore; import com.google.gson.Gson; import com.google.gson.GsonBuilder; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; -import net.minecraft.client.Minecraft; +import net.fabricmc.loader.api.FabricLoader; -public record NCRConfig(boolean allowTelemetry, boolean allowProfanityFilter) { +public record NCRConfig(boolean enableMod, boolean allowTelemetry, boolean allowProfanityFilter) { private static final Gson GSON = new GsonBuilder().setPrettyPrinting().create(); private static @Nullable NCRConfig instance = null; private static NCRConfig getDefault() { - return new NCRConfig(false, false); + return new NCRConfig(true, false, false); } public static NCRConfig getInstance() { @@ -34,23 +38,34 @@ public record NCRConfig(boolean allowTelemetry, boolean allowProfanityFilter) { NCRCore.LOGGER.debug("Reading config file {}...", fileName); NCRConfig config = readFile(fileName).orElseGet(NCRConfig::getDefault); + NCRCore.LOGGER.info("Mod Enabled: {}", config.enableMod()); NCRCore.LOGGER.info("Telemetry Allowed: {}", config.allowTelemetry()); NCRCore.LOGGER.info("Profanity Filter Allowed: {}", config.allowProfanityFilter()); - NCRCore.LOGGER.debug("Writing config file {} back to disk..."); + NCRCore.LOGGER.debug("Writing config file {} back to disk...", fileName); writeFile(fileName, config); return config; } + private static Path getConfigFile(String fileName) { + return FabricLoader.getInstance().getConfigDir().resolve(fileName); + } + private static Optional<NCRConfig> readFile(String fileName) { - Path file = Minecraft.getInstance().gameDirectory.toPath().resolve("config").resolve(fileName); + Path file = getConfigFile(fileName); if (!Files.isRegularFile(file)) return Optional.empty(); try (BufferedReader reader = Files.newBufferedReader(file)) { - return Optional.of(GSON.fromJson(reader, NCRConfig.class)); + JsonObject json = GSON.toJsonTree(getDefault()).getAsJsonObject(); + + for (Map.Entry<String, JsonElement> entry : JsonParser.parseReader(reader).getAsJsonObject().entrySet()) { + json.add(entry.getKey(), entry.getValue()); + } + + return Optional.of(GSON.fromJson(json, NCRConfig.class)); } catch (Exception ex) { NCRCore.LOGGER.fatal("Could not read config file: {}", file); NCRCore.LOGGER.fatal("This likely indicates the file is corrupted. " @@ -61,7 +76,7 @@ public record NCRConfig(boolean allowTelemetry, boolean allowProfanityFilter) { } private static void writeFile(String fileName, NCRConfig config) { - Path file = Minecraft.getInstance().gameDirectory.toPath().resolve("config").resolve(fileName); + Path file = getConfigFile(fileName); try { Files.createDirectories(file.getParent()); diff --git a/Fabric/src/main/java/com/aizistral/nochatrestrictions/core/NCRMixinPlugin.java b/Fabric/src/main/java/com/aizistral/nochatrestrictions/core/NCRMixinPlugin.java new file mode 100644 index 0000000..cac9d7f --- /dev/null +++ b/Fabric/src/main/java/com/aizistral/nochatrestrictions/core/NCRMixinPlugin.java @@ -0,0 +1,45 @@ +package com.aizistral.nochatrestrictions.core; + +import java.util.List; +import java.util.Set; + +import org.objectweb.asm.tree.ClassNode; +import org.spongepowered.asm.mixin.extensibility.IMixinConfigPlugin; +import org.spongepowered.asm.mixin.extensibility.IMixinInfo; + +import com.aizistral.nochatrestrictions.config.NCRConfig; + +public class NCRMixinPlugin implements IMixinConfigPlugin { + + @Override + public void onLoad(String mixinPackage) { + } + + @Override + public String getRefMapperConfig() { + return null; + } + + @Override + public boolean shouldApplyMixin(String targetClassName, String mixinClassName) { + return NCRConfig.getInstance().enableMod(); + } + + @Override + public void acceptTargets(Set<String> myTargets, Set<String> otherTargets) { + } + + @Override + public List<String> getMixins() { + return null; + } + + @Override + public void preApply(String targetClassName, ClassNode targetClass, String mixinClassName, IMixinInfo mixinInfo) { + } + + @Override + public void postApply(String targetClassName, ClassNode targetClass, String mixinClassName, IMixinInfo mixinInfo) { + } + +} diff --git a/Fabric/src/main/resources/nochatrestrictions.mixins.json b/Fabric/src/main/resources/nochatrestrictions.mixins.json index fca6bc9..35a7c2e 100644 --- a/Fabric/src/main/resources/nochatrestrictions.mixins.json +++ b/Fabric/src/main/resources/nochatrestrictions.mixins.json @@ -1,6 +1,7 @@ { "required": true, "package": "com.aizistral.nochatrestrictions.mixins", + "plugin": "com.aizistral.nochatrestrictions.core.NCRMixinPlugin", "compatibilityLevel": "JAVA_21", "minVersion": "0.8", "mixins": [], diff --git a/Forge/gradle.properties b/Forge/gradle.properties index 3ffde4c..5666034 100644 --- a/Forge/gradle.properties +++ b/Forge/gradle.properties @@ -8,5 +8,5 @@ forge_version=61.0.8 mapping_channel=official mapping_version=1.21.11 -modVersion=Forge-MC1.21.11-v1.0.3 -manifestVersion=1.21.11-v1.0.3
\ No newline at end of file +modVersion=Forge-MC1.21.11-v1.1.0 +manifestVersion=1.21.11-v1.1.0
\ No newline at end of file diff --git a/Forge/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java b/Forge/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java index ee04b0b..590e4ab 100644 --- a/Forge/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java +++ b/Forge/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java @@ -4,6 +4,7 @@ import java.io.BufferedReader; import java.io.BufferedWriter; import java.nio.file.Files; import java.nio.file.Path; +import java.util.Map; import java.util.Optional; import org.jetbrains.annotations.Nullable; @@ -11,15 +12,18 @@ import org.jetbrains.annotations.Nullable; import com.aizistral.nochatrestrictions.core.NCRCore; import com.google.gson.Gson; import com.google.gson.GsonBuilder; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; -import net.minecraft.client.Minecraft; +import net.minecraftforge.fml.loading.FMLPaths; -public record NCRConfig(boolean allowTelemetry, boolean allowProfanityFilter) { +public record NCRConfig(boolean enableMod, boolean allowTelemetry, boolean allowProfanityFilter) { private static final Gson GSON = new GsonBuilder().setPrettyPrinting().create(); private static @Nullable NCRConfig instance = null; private static NCRConfig getDefault() { - return new NCRConfig(false, false); + return new NCRConfig(true, false, false); } public static NCRConfig getInstance() { @@ -34,23 +38,34 @@ public record NCRConfig(boolean allowTelemetry, boolean allowProfanityFilter) { NCRCore.LOGGER.debug("Reading config file {}...", fileName); NCRConfig config = readFile(fileName).orElseGet(NCRConfig::getDefault); + NCRCore.LOGGER.info("Mod Enabled: {}", config.enableMod()); NCRCore.LOGGER.info("Telemetry Allowed: {}", config.allowTelemetry()); NCRCore.LOGGER.info("Profanity Filter Allowed: {}", config.allowProfanityFilter()); - NCRCore.LOGGER.debug("Writing config file {} back to disk..."); + NCRCore.LOGGER.debug("Writing config file {} back to disk...", fileName); writeFile(fileName, config); return config; } + private static Path getConfigFile(String fileName) { + return FMLPaths.CONFIGDIR.get().resolve(fileName); + } + private static Optional<NCRConfig> readFile(String fileName) { - Path file = Minecraft.getInstance().gameDirectory.toPath().resolve("config").resolve(fileName); + Path file = getConfigFile(fileName); if (!Files.isRegularFile(file)) return Optional.empty(); try (BufferedReader reader = Files.newBufferedReader(file)) { - return Optional.of(GSON.fromJson(reader, NCRConfig.class)); + JsonObject json = GSON.toJsonTree(getDefault()).getAsJsonObject(); + + for (Map.Entry<String, JsonElement> entry : JsonParser.parseReader(reader).getAsJsonObject().entrySet()) { + json.add(entry.getKey(), entry.getValue()); + } + + return Optional.of(GSON.fromJson(json, NCRConfig.class)); } catch (Exception ex) { NCRCore.LOGGER.fatal("Could not read config file: {}", file); NCRCore.LOGGER.fatal("This likely indicates the file is corrupted. " @@ -61,7 +76,7 @@ public record NCRConfig(boolean allowTelemetry, boolean allowProfanityFilter) { } private static void writeFile(String fileName, NCRConfig config) { - Path file = Minecraft.getInstance().gameDirectory.toPath().resolve("config").resolve(fileName); + Path file = getConfigFile(fileName); try { Files.createDirectories(file.getParent()); diff --git a/Forge/src/main/java/com/aizistral/nochatrestrictions/core/NCRMixinPlugin.java b/Forge/src/main/java/com/aizistral/nochatrestrictions/core/NCRMixinPlugin.java new file mode 100644 index 0000000..cac9d7f --- /dev/null +++ b/Forge/src/main/java/com/aizistral/nochatrestrictions/core/NCRMixinPlugin.java @@ -0,0 +1,45 @@ +package com.aizistral.nochatrestrictions.core; + +import java.util.List; +import java.util.Set; + +import org.objectweb.asm.tree.ClassNode; +import org.spongepowered.asm.mixin.extensibility.IMixinConfigPlugin; +import org.spongepowered.asm.mixin.extensibility.IMixinInfo; + +import com.aizistral.nochatrestrictions.config.NCRConfig; + +public class NCRMixinPlugin implements IMixinConfigPlugin { + + @Override + public void onLoad(String mixinPackage) { + } + + @Override + public String getRefMapperConfig() { + return null; + } + + @Override + public boolean shouldApplyMixin(String targetClassName, String mixinClassName) { + return NCRConfig.getInstance().enableMod(); + } + + @Override + public void acceptTargets(Set<String> myTargets, Set<String> otherTargets) { + } + + @Override + public List<String> getMixins() { + return null; + } + + @Override + public void preApply(String targetClassName, ClassNode targetClass, String mixinClassName, IMixinInfo mixinInfo) { + } + + @Override + public void postApply(String targetClassName, ClassNode targetClass, String mixinClassName, IMixinInfo mixinInfo) { + } + +} diff --git a/Forge/src/main/resources/nochatrestrictions.mixins.json b/Forge/src/main/resources/nochatrestrictions.mixins.json index c9e96c5..508cb57 100644 --- a/Forge/src/main/resources/nochatrestrictions.mixins.json +++ b/Forge/src/main/resources/nochatrestrictions.mixins.json @@ -1,6 +1,7 @@ { "required": true, "package": "com.aizistral.nochatrestrictions.mixins", + "plugin": "com.aizistral.nochatrestrictions.core.NCRMixinPlugin", "minVersion": "0.8", "refmap": "nochatrestrictions.refmap.json", "mixins": [], diff --git a/NeoForge/gradle.properties b/NeoForge/gradle.properties index 06cc6f1..0d4c4c5 100644 --- a/NeoForge/gradle.properties +++ b/NeoForge/gradle.properties @@ -6,5 +6,5 @@ org.gradle.debug=false ## Environment Properties minecraft_version=1.21.11 neo_version=21.11.37-beta -mod_version=NeoForge-MC1.21.11-v1.0.3 -manifest_version=1.21.11-v1.0.3 +mod_version=NeoForge-MC1.21.11-v1.1.0 +manifest_version=1.21.11-v1.1.0 diff --git a/NeoForge/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java b/NeoForge/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java index ee04b0b..5b21b53 100644 --- a/NeoForge/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java +++ b/NeoForge/src/main/java/com/aizistral/nochatrestrictions/config/NCRConfig.java @@ -4,6 +4,7 @@ import java.io.BufferedReader; import java.io.BufferedWriter; import java.nio.file.Files; import java.nio.file.Path; +import java.util.Map; import java.util.Optional; import org.jetbrains.annotations.Nullable; @@ -11,15 +12,18 @@ import org.jetbrains.annotations.Nullable; import com.aizistral.nochatrestrictions.core.NCRCore; import com.google.gson.Gson; import com.google.gson.GsonBuilder; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; -import net.minecraft.client.Minecraft; +import net.neoforged.fml.loading.FMLPaths; -public record NCRConfig(boolean allowTelemetry, boolean allowProfanityFilter) { +public record NCRConfig(boolean enableMod, boolean allowTelemetry, boolean allowProfanityFilter) { private static final Gson GSON = new GsonBuilder().setPrettyPrinting().create(); private static @Nullable NCRConfig instance = null; private static NCRConfig getDefault() { - return new NCRConfig(false, false); + return new NCRConfig(true, false, false); } public static NCRConfig getInstance() { @@ -34,23 +38,34 @@ public record NCRConfig(boolean allowTelemetry, boolean allowProfanityFilter) { NCRCore.LOGGER.debug("Reading config file {}...", fileName); NCRConfig config = readFile(fileName).orElseGet(NCRConfig::getDefault); + NCRCore.LOGGER.info("Mod Enabled: {}", config.enableMod()); NCRCore.LOGGER.info("Telemetry Allowed: {}", config.allowTelemetry()); NCRCore.LOGGER.info("Profanity Filter Allowed: {}", config.allowProfanityFilter()); - NCRCore.LOGGER.debug("Writing config file {} back to disk..."); + NCRCore.LOGGER.debug("Writing config file {} back to disk...", fileName); writeFile(fileName, config); return config; } + private static Path getConfigFile(String fileName) { + return FMLPaths.CONFIGDIR.get().resolve(fileName); + } + private static Optional<NCRConfig> readFile(String fileName) { - Path file = Minecraft.getInstance().gameDirectory.toPath().resolve("config").resolve(fileName); + Path file = getConfigFile(fileName); if (!Files.isRegularFile(file)) return Optional.empty(); try (BufferedReader reader = Files.newBufferedReader(file)) { - return Optional.of(GSON.fromJson(reader, NCRConfig.class)); + JsonObject json = GSON.toJsonTree(getDefault()).getAsJsonObject(); + + for (Map.Entry<String, JsonElement> entry : JsonParser.parseReader(reader).getAsJsonObject().entrySet()) { + json.add(entry.getKey(), entry.getValue()); + } + + return Optional.of(GSON.fromJson(json, NCRConfig.class)); } catch (Exception ex) { NCRCore.LOGGER.fatal("Could not read config file: {}", file); NCRCore.LOGGER.fatal("This likely indicates the file is corrupted. " @@ -61,7 +76,7 @@ public record NCRConfig(boolean allowTelemetry, boolean allowProfanityFilter) { } private static void writeFile(String fileName, NCRConfig config) { - Path file = Minecraft.getInstance().gameDirectory.toPath().resolve("config").resolve(fileName); + Path file = getConfigFile(fileName); try { Files.createDirectories(file.getParent()); diff --git a/NeoForge/src/main/java/com/aizistral/nochatrestrictions/core/NCRMixinPlugin.java b/NeoForge/src/main/java/com/aizistral/nochatrestrictions/core/NCRMixinPlugin.java new file mode 100644 index 0000000..cac9d7f --- /dev/null +++ b/NeoForge/src/main/java/com/aizistral/nochatrestrictions/core/NCRMixinPlugin.java @@ -0,0 +1,45 @@ +package com.aizistral.nochatrestrictions.core; + +import java.util.List; +import java.util.Set; + +import org.objectweb.asm.tree.ClassNode; +import org.spongepowered.asm.mixin.extensibility.IMixinConfigPlugin; +import org.spongepowered.asm.mixin.extensibility.IMixinInfo; + +import com.aizistral.nochatrestrictions.config.NCRConfig; + +public class NCRMixinPlugin implements IMixinConfigPlugin { + + @Override + public void onLoad(String mixinPackage) { + } + + @Override + public String getRefMapperConfig() { + return null; + } + + @Override + public boolean shouldApplyMixin(String targetClassName, String mixinClassName) { + return NCRConfig.getInstance().enableMod(); + } + + @Override + public void acceptTargets(Set<String> myTargets, Set<String> otherTargets) { + } + + @Override + public List<String> getMixins() { + return null; + } + + @Override + public void preApply(String targetClassName, ClassNode targetClass, String mixinClassName, IMixinInfo mixinInfo) { + } + + @Override + public void postApply(String targetClassName, ClassNode targetClass, String mixinClassName, IMixinInfo mixinInfo) { + } + +} diff --git a/NeoForge/src/main/resources/nochatrestrictions.mixins.json b/NeoForge/src/main/resources/nochatrestrictions.mixins.json index 8cdf752..9bdcf4b 100644 --- a/NeoForge/src/main/resources/nochatrestrictions.mixins.json +++ b/NeoForge/src/main/resources/nochatrestrictions.mixins.json @@ -1,6 +1,7 @@ { "required": true, "package": "com.aizistral.nochatrestrictions.mixins", + "plugin": "com.aizistral.nochatrestrictions.core.NCRMixinPlugin", "compatibilityLevel": "JAVA_21", "minVersion": "0.8", "refmap": "nochatrestrictions.refmap.json", |
