R3944Realms/ModernFix-fix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More documentation inside config file

Browse Source
This commit is contained in:
embeddedt 2023-07-26 09:18:05 -04:00
parent 7ad09acec6
commit 0a9644a8a0
No known key found for this signature in database
GPG Key ID: A69433EC199B5613
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
common/src/main/java/org/embeddedt/modernfix/core/config/ModernFixEarlyConfig.java
View File

@ -373,9 +373,17 @@ public class ModernFixEarlyConfig {
try (Writer writer = new FileWriter(configFile)) {
writer.write("# This is the configuration file for ModernFix.\n");
writer.write("# In general, prefer using the config screen to editing this file. It can be accessed\n");
writer.write("# via the standard mod menu on your respective mod loader. Changes will, however,\n");
writer.write("# require restarting the game to take effect.\n");
writer.write("#\n");
writer.write("# The following options can be enabled or disabled if there is a compatibility issue.\n");
writer.write("# Add a line mixin.example_name=true/false without the # sign to enable/disable a rule.\n");
writer.write("# Add a line with your option name and =true or =false at the bottom of the file to enable\n");
writer.write("# or disable a rule. For example:\n");
writer.write("# mixin.perf.dynamic_resources=true\n");
writer.write("# Do not include the #. You may reset to defaults by deleting this file.\n");
writer.write("#\n");
writer.write("# Available options:\n");
List<String> keys = this.options.keySet().stream()
.filter(key -> !key.equals("mixin.core"))
.sorted()
@ -385,17 +393,20 @@ public class ModernFixEarlyConfig {
Option option = this.options.get(line);
String extraContext = "";
if(option != null) {
if(option.isModDefined())
extraContext = " # (overridden for mod compat)";
if(!option.isUserDefined())
extraContext = "=" + option.isEnabled() + " # " + (option.isModDefined() ? "(overridden for mod compat)" : "(default)");
else {
boolean defaultEnabled = DEFAULT_SETTING_OVERRIDES.getOrDefault(line, true);
extraContext = " # (default: " + defaultEnabled + ")";
extraContext = "=" + defaultEnabled + " # (default)";
}
}
writer.write("# " + line + "\n");
writer.write("# " + line + extraContext + "\n");
}
}
writer.write("#\n");
writer.write("# User overrides go here.\n");
for (String key : keys) {
Option option = this.options.get(key);
if(option.isUserDefined())