clean

Author: s12kuma01

src/main/java/jp/s12kuma01/celeritasextra/CeleritasExtraMixinConfigPlugin.java

@@ -1,22 +1,20 @@
 package jp.s12kuma01.celeritasextra;
 
-import net.minecraftforge.fml.common.Loader;
+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 java.util.List;
-import java.util.Set;
-
 /**
- * Mixin configuration plugin for Celeritas Extra
- * Handles conditional mixin loading based on mod compatibility
+ * Mixin configuration plugin for Celeritas Extra.
+ * Currently uses default behavior for all mixins.
  */
 public class CeleritasExtraMixinConfigPlugin implements IMixinConfigPlugin {
 
     @Override
     public void onLoad(String mixinPackage) {
-        // No initialization needed
     }
 
     @Override
@@ -26,14 +24,13 @@ public String getRefMapperConfig() {
 
     @Override
     public boolean shouldApplyMixin(String targetClassName, String mixinClassName) {
-        // Add conditional mixin loading based on mod compatibility here
-        // For example, only load certain mixins if specific mods are present
+        // Currently all mixins are applied unconditionally
+        // Can add conditional loading based on mod compatibility if needed
         return true;
     }
 
     @Override
     public void acceptTargets(Set<String> myTargets, Set<String> otherTargets) {
-        // No target filtering needed
     }
 
     @Override
@@ -43,11 +40,9 @@ public List<String> getMixins() {
 
     @Override
     public void preApply(String targetClassName, ClassNode targetClass, String mixinClassName, IMixinInfo mixinInfo) {
-        // No pre-apply logic needed
     }
 
     @Override
     public void postApply(String targetClassName, ClassNode targetClass, String mixinClassName, IMixinInfo mixinInfo) {
-        // No post-apply logic needed
     }
 }

src/main/java/jp/s12kuma01/celeritasextra/CeleritasExtraMod.java

@@ -1,20 +1,19 @@
 package jp.s12kuma01.celeritasextra;
 
-import net.minecraftforge.common.MinecraftForge;
+import jp.s12kuma01.celeritasextra.client.CeleritasExtraClientMod;
+import jp.s12kuma01.celeritasextra.client.gui.CeleritasExtraOptionsListener;
+
+import net.minecraftforge.fml.common.FMLCommonHandler;
 import net.minecraftforge.fml.common.Loader;
 import net.minecraftforge.fml.common.Mod;
 import net.minecraftforge.fml.common.event.FMLConstructionEvent;
 import net.minecraftforge.fml.common.event.FMLInitializationEvent;
 import net.minecraftforge.fml.common.event.FMLPreInitializationEvent;
+
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.taumc.celeritas.api.OptionGUIConstructionEvent;
 
-/**
- * Celeritas Extra - A port of Embeddium Extra to Celeritas 1.12.2
- *
- * @author Karnatour (port), FlashyReese (original)
- */
 @Mod(modid = CeleritasExtraMod.MOD_ID, name = CeleritasExtraMod.MOD_NAME, version = CeleritasExtraMod.VERSION,
      clientSideOnly = true, acceptableRemoteVersions = "*")
 public class CeleritasExtraMod {
@@ -27,13 +26,19 @@ public class CeleritasExtraMod {
     @Mod.Instance
     public static CeleritasExtraMod INSTANCE;
 
+    /**
+     * Construction phase - registers Celeritas Extra options with Celeritas GUI.
+     * Checks for Celeritas 2.4.0+ compatibility by verifying OptionGUIConstructionEvent exists.
+     */
     @Mod.EventHandler
     public void construct(FMLConstructionEvent event) {
         if (Loader.isModLoaded("celeritas")) {
             try {
+                // Verify Celeritas version is 2.4.0 or newer by checking for API class
                 Class.forName("org.taumc.celeritas.api.OptionGUIConstructionEvent");
-                // Register option GUI construction listener
-                OptionGUIConstructionEvent.BUS.addListener(jp.s12kuma01.celeritasextra.client.gui.CeleritasExtraOptionsListener::onCeleritasOptionsConstruct);
+
+                // Register our options listener to Celeritas GUI system
+                OptionGUIConstructionEvent.BUS.addListener(CeleritasExtraOptionsListener::onCeleritasOptionsConstruct);
                 LOGGER.info("Successfully registered Celeritas Extra with Celeritas GUI");
             } catch (Throwable t) {
                 if (t instanceof NoClassDefFoundError) {
@@ -52,10 +57,14 @@ public void preInit(FMLPreInitializationEvent event) {
         LOGGER.info("Celeritas Extra pre-initialization");
     }
 
+    /**
+     * Initialization phase - initializes client-side configuration.
+     */
     @Mod.EventHandler
     public void init(FMLInitializationEvent event) {
-        if (net.minecraftforge.fml.common.FMLCommonHandler.instance().getEffectiveSide().isClient()) {
-            jp.s12kuma01.celeritasextra.client.CeleritasExtraClientMod.onClientInit();
+        // Only initialize on client side (this is a client-only mod)
+        if (FMLCommonHandler.instance().getEffectiveSide().isClient()) {
+            CeleritasExtraClientMod.onClientInit();
         }
         LOGGER.info("Celeritas Extra initialized");
     }

src/main/java/jp/s12kuma01/celeritasextra/client/CeleritasExtraClientMod.java

@@ -1,39 +1,55 @@
 package jp.s12kuma01.celeritasextra.client;
 
+import java.io.File;
+
 import jp.s12kuma01.celeritasextra.CeleritasExtraMod;
 import jp.s12kuma01.celeritasextra.client.gui.CeleritasExtraGameOptions;
-import net.minecraftforge.fml.common.FMLCommonHandler;
 
-import java.io.File;
+import net.minecraftforge.fml.common.FMLCommonHandler;
 
 /**
- * Client-side handler for Celeritas Extra
+ * Client-side initialization and configuration management for Celeritas Extra.
  */
 public class CeleritasExtraClientMod {
 
     private static CeleritasExtraGameOptions CONFIG;
 
+    /**
+     * Gets the mod configuration, loading it lazily if needed.
+     *
+     * @return The configuration instance
+     */
     public static CeleritasExtraGameOptions options() {
         if (CONFIG == null) {
             CONFIG = loadConfig();
         }
         return CONFIG;
     }
 
+    /**
+     * Loads configuration from disk.
+     * Creates config directory if it doesn't exist.
+     *
+     * @return Loaded configuration instance
+     */
     private static CeleritasExtraGameOptions loadConfig() {
         File configDir = new File("config");
         if (!configDir.exists()) {
             configDir.mkdirs();
         }
+
         File configFile = new File(configDir, "celeritas-extra-options.json");
         return CeleritasExtraGameOptions.load(configFile);
     }
 
+    /**
+     * Called during client initialization.
+     * Triggers configuration loading.
+     */
     public static void onClientInit() {
         if (FMLCommonHandler.instance().getEffectiveSide().isClient()) {
             CeleritasExtraMod.LOGGER.info("Initializing Celeritas Extra client...");
-            // Load configuration
-            options();
+            options(); // Load config
         }
     }
 }

src/main/java/jp/s12kuma01/celeritasextra/client/gui/CeleritasExtraGameOptionPages.java

@@ -15,20 +15,13 @@
 import java.util.ArrayList;
 import java.util.List;
 
-/**
- * Defines all option pages for Celeritas Extra
- */
 public class CeleritasExtraGameOptionPages {
 
     private static final CeleritasExtraOptionsStorage celeritasExtraOpts = new CeleritasExtraOptionsStorage();
 
-    /**
-     * Animation settings page
-     */
     public static OptionPage animation() {
         List<OptionGroup> groups = new ArrayList<>();
 
-        // All animations toggle
         groups.add(OptionGroup.createBuilder()
                 .add(OptionImpl.createBuilder(boolean.class, celeritasExtraOpts)
                         .setName(TextComponent.literal(I18n.format("celeritasextra.option.animations.all")))
@@ -41,7 +34,6 @@ public static OptionPage animation() {
                 )
                 .build());
 
-        // Individual animation controls
         groups.add(OptionGroup.createBuilder()
                 .add(OptionImpl.createBuilder(boolean.class, celeritasExtraOpts)
                         .setName(TextComponent.literal(I18n.format("celeritasextra.option.animations.water")))
@@ -93,13 +85,9 @@ public static OptionPage animation() {
         return new OptionPage(CeleritasExtraOptionPages.ANIMATION, TextComponent.literal(I18n.format("celeritasextra.option.page.animations")), ImmutableList.copyOf(groups));
     }
 
-    /**
-     * Particle settings page
-     */
     public static OptionPage particle() {
         List<OptionGroup> groups = new ArrayList<>();
 
-        // All particles toggle
         groups.add(OptionGroup.createBuilder()
                 .add(OptionImpl.createBuilder(boolean.class, celeritasExtraOpts)
                         .setName(TextComponent.literal(I18n.format("celeritasextra.option.particles.all")))
@@ -111,7 +99,6 @@ public static OptionPage particle() {
                 )
                 .build());
 
-        // Individual particle controls
         groups.add(OptionGroup.createBuilder()
                 .add(OptionImpl.createBuilder(boolean.class, celeritasExtraOpts)
                         .setName(TextComponent.literal(I18n.format("celeritasextra.option.particles.rain_splash")))
@@ -139,15 +126,9 @@ public static OptionPage particle() {
                 )
                 .build());
 
-        // NOTE: Individual particle type control is currently disabled due to mixin implementation issues
-        // Only basic particle controls (rain splash, block break, block breaking) are available
-
         return new OptionPage(CeleritasExtraOptionPages.PARTICLE, TextComponent.literal(I18n.format("celeritasextra.option.page.particles")), ImmutableList.copyOf(groups));
     }
 
-    /**
-     * Detail settings page
-     */
     public static OptionPage details() {
         List<OptionGroup> groups = new ArrayList<>();
 
@@ -201,9 +182,6 @@ public static OptionPage details() {
         return new OptionPage(CeleritasExtraOptionPages.DETAILS, TextComponent.literal(I18n.format("celeritasextra.option.page.details")), ImmutableList.copyOf(groups));
     }
 
-    /**
-     * Render settings page
-     */
     public static OptionPage render() {
         List<OptionGroup> groups = new ArrayList<>();
 
@@ -317,9 +295,6 @@ public static OptionPage render() {
         return new OptionPage(CeleritasExtraOptionPages.RENDER, TextComponent.literal(I18n.format("celeritasextra.option.page.render")), ImmutableList.copyOf(groups));
     }
 
-    /**
-     * Extra settings page
-     */
     public static OptionPage extra() {
         List<OptionGroup> groups = new ArrayList<>();
 

src/main/java/jp/s12kuma01/celeritasextra/client/gui/CeleritasExtraGameOptions.java

@@ -1,19 +1,22 @@
 package jp.s12kuma01.celeritasextra.client.gui;
 
-import com.google.gson.FieldNamingPolicy;
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
-import jp.s12kuma01.celeritasextra.CeleritasExtraMod;
-
 import java.io.File;
 import java.io.FileReader;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.lang.reflect.Modifier;
+import java.util.HashMap;
+import java.util.Map;
+
+import com.google.gson.FieldNamingPolicy;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+
+import jp.s12kuma01.celeritasextra.CeleritasExtraMod;
 
 /**
- * Main configuration class for Celeritas Extra
- * Stores all game options and settings
+ * Main configuration class for Celeritas Extra.
+ * Stores all game options and settings, serialized to JSON.
  */
 public class CeleritasExtraGameOptions {
 
@@ -31,6 +34,13 @@ public class CeleritasExtraGameOptions {
 
     private File file;
 
+    /**
+     * Loads configuration from the specified file.
+     * Falls back to defaults if file doesn't exist or parsing fails.
+     *
+     * @param file Configuration file path
+     * @return Loaded configuration instance
+     */
     public static CeleritasExtraGameOptions load(File file) {
         CeleritasExtraGameOptions config;
 
@@ -51,6 +61,9 @@ public static CeleritasExtraGameOptions load(File file) {
         return config;
     }
 
+    /**
+     * Writes current configuration to disk.
+     */
     public void writeChanges() {
         File dir = this.file.getParentFile();
 
@@ -69,7 +82,7 @@ public void writeChanges() {
         }
     }
 
-    // Settings classes
+    /** Animation settings for textures. */
     public static class AnimationSettings {
         public boolean animation = true;
         public boolean water = true;
@@ -80,14 +93,16 @@ public static class AnimationSettings {
         public boolean sculkSensor = true;
     }
 
+    /** Particle rendering settings. */
     public static class ParticleSettings {
         public boolean particles = true;
         public boolean rainSplash = true;
         public boolean blockBreak = true;
         public boolean blockBreaking = true;
-        public java.util.Map<String, Boolean> otherMap = new java.util.HashMap<>();
+        public Map<String, Boolean> otherMap = new HashMap<>();
     }
 
+    /** World detail settings (sky, weather, biome colors). */
     public static class DetailSettings {
         public boolean sky = true;
         public boolean stars = true;
@@ -96,6 +111,7 @@ public static class DetailSettings {
         public boolean biomeColors = true;
     }
 
+    /** Rendering optimizations and entity rendering controls. */
     public static class RenderSettings {
         public boolean fog = true;
         public int fogStart = 100;
@@ -115,6 +131,7 @@ public static class RenderSettings {
         public boolean preventShaders = false;
     }
 
+    /** Extra features (overlays, HUD, accessibility). */
     public static class ExtraSettings {
         public boolean showFps = false;
         public boolean showCoords = false;