feat: updated to 1.18.2, fixed block store issues, much better performance

Author: MichaelHillcox

CHANGELOG.md

@@ -1,3 +1,17 @@
 # Changelog
 
-Updated to Minecraft 1.18
+## Added
+
+- New render logic (from Forge version) that greatly improves performance!
+- Auto-populate block list with Ores
+  - This only happens when the list is empty and opened for the first time. 
+
+## Changed
+
+- Updated to 1.18.2!
+- We no longer store if `XRay` is on in a file so upon a game restart, it will now always be off by default.
+- Use a different radius number. It's now calculated by chunks around the player. 1 = 1x1, 3 = 3x3 chunks, etc.
+
+## Fixed
+
+- Fixed `Show lava` not rendering working when the blocks to find is empty. 

build.gradle

@@ -8,8 +8,8 @@ sourceCompatibility = JavaVersion.VERSION_17
 targetCompatibility = JavaVersion.VERSION_17
 
 def ENV = System.getenv();
-archivesBaseName = "${project.archives_base_name}-${project.minecraft_version}"
-version = "${project.mod_version}-build.${ENV.GITHUB_RUN_NUMBER ?: 9999}"
+archivesBaseName = "${project.archives_base_name}"
+version = "${project.minecraft_version}-${project.mod_version}-build.${ENV.GITHUB_RUN_NUMBER ?: 9999}"
 group = project.maven_group
 
 dependencies {
@@ -29,7 +29,6 @@ processResources {
 }
 
 tasks.withType(JavaCompile).configureEach {
-    it.options.encoding = "UTF-8"
     it.options.release = 17
 }
 
@@ -73,7 +72,7 @@ if (ENV.CURSE_DEPLOY_TOKEN) {
             releaseType = "release"
             addGameVersion "Fabric"
             addGameVersion "$minecraft_version"
-            changelog = "See [Commit history](https://github.com/MichaelHillcox/XRay-Fabric/commits/main)"
+            changelog = file('CHANGELOG.md')
             changelogType = 'markdown'
             mainArtifact(remapJar)
         }

gradle.properties

@@ -2,13 +2,13 @@
 org.gradle.jvmargs=-Xmx4G
 # Fabric Properties
 # check these on https://fabricmc.net/use
-minecraft_version=1.18
-yarn_mappings=1.18+build.1
-loader_version=0.12.8
+minecraft_version=1.18.2
+yarn_mappings=1.18.2+build.2
+loader_version=0.13.3
 # Mod Properties
-mod_version=0.7.0
-maven_group=pro.mikey.fabric
+mod_version=1.0.0
+maven_group=pro.mikey
 archives_base_name=advanced-xray-fabric
 # Dependencies
 # currently not on the main fabric site, check on the maven: https://maven.fabricmc.net/net/fabricmc/fabric-api/fabric-api
-fabric_version=0.43.1+1.18
+fabric_version=0.48.0+1.18.2

src/main/java/pro/mikey/fabric/xray/ScanController.java

@@ -26,12 +26,15 @@ public class ScanController {
      * No point even running if the player is still in the same chunk.
      */
     private static boolean playerLocationChanged() {
-        ClientPlayerEntity player = MinecraftClient.getInstance().player;
-        if (player == null) {
+        if (MinecraftClient.getInstance().player == null)
             return false;
-        }
 
-        return playerLastChunk == null || !playerLastChunk.equals(player.getChunkPos());
+        ChunkPos plyChunkPos = MinecraftClient.getInstance().player.getChunkPos();
+        int range = StateSettings.getHalfRange();
+
+        return playerLastChunk == null ||
+                plyChunkPos.x > playerLastChunk.x + range || plyChunkPos.x < playerLastChunk.x - range ||
+                plyChunkPos.z > playerLastChunk.z + range || plyChunkPos.z < playerLastChunk.z - range;
     }
 
     /**
@@ -59,7 +62,7 @@ public static synchronized void runTask(boolean forceRerun) {
     public static void blockBroken(World world, PlayerEntity playerEntity, BlockPos blockPos, BlockState blockState, BlockEntity blockEntity) {
         if (!Stores.SETTINGS.get().isActive()) return;
 
-        if (renderQueue.stream().anyMatch(e -> e.getPos().equals(blockPos))) {
+        if (renderQueue.stream().anyMatch(e -> e.pos().equals(blockPos))) {
             runTask(true);
         }
     }

src/main/java/pro/mikey/fabric/xray/ScanTask.java

@@ -11,11 +11,15 @@
 import pro.mikey.fabric.xray.cache.BlockSearchEntry;
 import pro.mikey.fabric.xray.records.BasicColor;
 import pro.mikey.fabric.xray.records.BlockPosWithColor;
+import pro.mikey.fabric.xray.render.RenderOutlines;
 import pro.mikey.fabric.xray.storage.Stores;
 
 import java.util.*;
+import java.util.concurrent.atomic.AtomicBoolean;
 
 public class ScanTask implements Runnable {
+    private static AtomicBoolean isScanning = new AtomicBoolean(false);
+
     ScanTask() {
     }
 
@@ -29,29 +33,31 @@ public static BasicColor isValidBlock(BlockPos pos, World world, Set<BlockSearch
             return null;
         }
 
-        if (Stores.SETTINGS.get().isShowLava()
-                && state.getFluidState().getFluid() instanceof LavaFluid) {
+        if (Stores.SETTINGS.get().isShowLava() && state.getFluidState().getFluid() instanceof LavaFluid) {
             return new BasicColor(210, 10, 10);
         }
 
         BlockState defaultState = state.getBlock().getDefaultState();
 
-        Optional<BlockSearchEntry> contains =
-                blocks.stream()
-                        .filter(
-                                localState ->
-                                        localState.isDefault() && defaultState == localState.getState()
-                                                || !localState.isDefault() && state == localState.getState())
-                        .findFirst();
-
-        return contains.map(BlockSearchEntry::getColor).orElse(null);
+        return blocks.stream()
+                .filter(localState -> localState.isDefault() && defaultState == localState.getState() || !localState.isDefault() && state == localState.getState())
+                .findFirst()
+                .map(BlockSearchEntry::getColor)
+                .orElse(null);
     }
 
     @Override
     public void run() {
+        if (isScanning.get()) {
+            return;
+        }
+
+        isScanning.set(true);
         Set<BlockPosWithColor> c = this.collectBlocks();
         ScanController.renderQueue.clear();
         ScanController.renderQueue.addAll(c);
+        isScanning.set(false);
+        RenderOutlines.requestedRefresh.set(true);
     }
 
     /**
@@ -67,7 +73,7 @@ private Set<BlockPosWithColor> collectBlocks() {
         Set<BlockSearchEntry> blocks = Stores.BLOCKS.getCache().get();
 
         // If we're not looking for blocks, don't run.
-        if (blocks.isEmpty()) {
+        if (blocks.isEmpty() && !Stores.SETTINGS.get().isShowLava()) {
             if (!ScanController.renderQueue.isEmpty()) {
                 ScanController.renderQueue.clear();
             }
@@ -89,19 +95,18 @@ private Set<BlockPosWithColor> collectBlocks() {
         int cX = player.getChunkPos().x;
         int cZ = player.getChunkPos().z;
 
-        int range = StateSettings.DISTANCE_STEPS[Stores.SETTINGS.get().getRange()] / 2;
+        int range = StateSettings.getHalfRange();
 
         for (int i = cX - range; i <= cX + range; i++) {
             int chunkStartX = i << 4;
             for (int j = cZ - range; j <= cZ + range; j++) {
                 int chunkStartZ = j << 4;
 
-                int height =
-                        Arrays.stream(world.getChunk(i, j).getSectionArray())
-                                .filter(Objects::nonNull)
-                                .mapToInt(ChunkSection::getYOffset)
-                                .max()
-                                .orElse(0);
+                int height = Arrays.stream(world.getChunk(i, j).getSectionArray())
+                        .filter(Objects::nonNull)
+                        .mapToInt(ChunkSection::getYOffset)
+                        .max()
+                        .orElse(0);
 
                 for (int k = chunkStartX; k < chunkStartX + 16; k++) {
                     for (int l = chunkStartZ; l < chunkStartZ + 16; l++) {

src/main/java/pro/mikey/fabric/xray/StateSettings.java

@@ -1,61 +1,70 @@
 package pro.mikey.fabric.xray;
 
+import net.minecraft.util.math.MathHelper;
+import pro.mikey.fabric.xray.storage.Stores;
+
 public class StateSettings {
-  public static final int[] DISTANCE_STEPS = new int[] {2, 4, 8, 16, 32, 64, 128, 256};
-  private boolean isActive;
-  private boolean showLava;
-  private int range;
-  private boolean showOverlay;
-
-  public StateSettings() {
-    this.isActive = false;
-    this.showLava = false;
-    this.showOverlay = true;
-    this.range = 3;
-  }
-
-  public boolean isActive() {
-    return this.isActive;
-  }
-
-  void setActive(boolean active) {
-    this.isActive = active;
-  }
-
-  public boolean isShowLava() {
-    return this.showLava;
-  }
-
-  public void setShowLava(boolean showLava) {
-    this.showLava = showLava;
-  }
-
-  // Fail softly if the index is out of bounds
-  public int getRange() {
-    return Math.max(0, Math.min(DISTANCE_STEPS.length - 1, this.range));
-  }
-
-  public void increaseRange() {
-    if (this.range < DISTANCE_STEPS.length - 1) {
-      this.range += 1;
-    } else {
-      this.range = 0;
-    }
-  }
-
-  public void decreaseRange() {
-    if (this.range > 0) {
-      this.range -= 1;
-    } else {
-      this.range = DISTANCE_STEPS.length - 1;
-    }
-  }
-
-  public boolean showOverlay() {
-    return this.showOverlay;
-  }
-
-  public void setShowOverlay(boolean showOverlay) {
-    this.showOverlay = showOverlay;
-  }
+    private static final int maxStepsToScan = 5;
+
+    private transient boolean isActive;
+    private boolean showLava;
+    private int range;
+    private boolean showOverlay;
+
+    public StateSettings() {
+        this.isActive = false;
+        this.showLava = false;
+        this.showOverlay = true;
+        this.range = 3;
+    }
+
+    public boolean isActive() {
+        return this.isActive;
+    }
+
+    void setActive(boolean active) {
+        this.isActive = active;
+    }
+
+    public boolean isShowLava() {
+        return this.showLava;
+    }
+
+    public void setShowLava(boolean showLava) {
+        this.showLava = showLava;
+    }
+
+    public static int getRadius() {
+        return MathHelper.clamp(Stores.SETTINGS.get().range, 0, maxStepsToScan) * 3;
+    }
+
+    public static int getHalfRange() {
+        return Math.max(0, getRadius() / 2);
+    }
+
+    public static int getVisualRadius() {
+        return Math.max(1, getRadius());
+    }
+
+    public void increaseRange() {
+        if (Stores.SETTINGS.get().range < maxStepsToScan)
+            Stores.SETTINGS.get().range = Stores.SETTINGS.get().range + 1;
+        else
+            Stores.SETTINGS.get().range = 0;
+    }
+
+    public void decreaseRange() {
+        if (Stores.SETTINGS.get().range > 0)
+            Stores.SETTINGS.get().range = Stores.SETTINGS.get().range - 1;
+        else
+            Stores.SETTINGS.get().range = maxStepsToScan;
+    }
+
+    public boolean showOverlay() {
+        return this.showOverlay;
+    }
+
+    public void setShowOverlay(boolean showOverlay) {
+        this.showOverlay = showOverlay;
+    }
 }

src/main/java/pro/mikey/fabric/xray/XRay.java

@@ -7,28 +7,41 @@
 import net.fabricmc.fabric.api.client.rendering.v1.HudRenderCallback;
 import net.fabricmc.fabric.api.client.rendering.v1.WorldRenderEvents;
 import net.fabricmc.fabric.api.event.player.PlayerBlockBreakEvents;
+import net.minecraft.block.Block;
+import net.minecraft.block.Blocks;
 import net.minecraft.client.MinecraftClient;
 import net.minecraft.client.option.KeyBinding;
+import net.minecraft.item.Item;
+import net.minecraft.tag.BlockTags;
+import net.minecraft.tag.ItemTags;
+import net.minecraft.tag.TagKey;
 import net.minecraft.text.TranslatableText;
 import net.minecraft.util.Formatting;
+import net.minecraft.util.registry.Registry;
+import net.minecraft.util.registry.RegistryEntryList;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.lwjgl.glfw.GLFW;
+import pro.mikey.fabric.xray.records.BasicColor;
+import pro.mikey.fabric.xray.records.BlockEntry;
+import pro.mikey.fabric.xray.records.BlockGroup;
 import pro.mikey.fabric.xray.render.RenderOutlines;
 import pro.mikey.fabric.xray.screens.forge.GuiOverlay;
 import pro.mikey.fabric.xray.screens.forge.GuiSelectionScreen;
 import pro.mikey.fabric.xray.storage.Stores;
 
+import java.util.*;
+import java.util.concurrent.atomic.AtomicInteger;
+
 public class XRay implements ModInitializer {
 
     public static final String MOD_ID = "advanced-xray-fabric";
     public static final String PREFIX_GUI = String.format("%s:textures/gui/", MOD_ID);
     public static final Logger LOGGER = LogManager.getLogger(MOD_ID);
 
-    private final KeyBinding xrayButton =
-            new KeyBinding("keybinding.enable_xray", GLFW.GLFW_KEY_BACKSLASH, "category.xray");
-    private final KeyBinding guiButton =
-            new KeyBinding("keybinding.open_gui", GLFW.GLFW_KEY_G, "category.xray");
+    private final KeyBinding xrayButton = new KeyBinding("keybinding.enable_xray", GLFW.GLFW_KEY_BACKSLASH, "category.xray");
+
+    private final KeyBinding guiButton = new KeyBinding("keybinding.open_gui", GLFW.GLFW_KEY_G, "category.xray");
 
     @Override
     public void onInitialize() {
@@ -42,7 +55,6 @@ public void onInitialize() {
 
         WorldRenderEvents.LAST.register(RenderOutlines::render);
         PlayerBlockBreakEvents.AFTER.register(ScanController::blockBroken);
-//        Interaction
 
         KeyBindingHelper.registerKeyBinding(this.xrayButton);
         KeyBindingHelper.registerKeyBinding(this.guiButton);
@@ -80,16 +92,7 @@ private void clientTickEvent(MinecraftClient mc) {
 
             ScanController.runTask(true);
 
-            mc.player.sendMessage(
-                    new TranslatableText(
-                            "message.xray_" + (!stateSettings.isActive()
-                                    ? "deactivate"
-                                    : "active"))
-                            .formatted(stateSettings.isActive()
-                                    ? Formatting.GREEN
-                                    : Formatting.RED),
-                    true
-            );
+            mc.player.sendMessage(new TranslatableText("message.xray_" + (!stateSettings.isActive() ? "deactivate" : "active")).formatted(stateSettings.isActive() ? Formatting.GREEN : Formatting.RED), true);
         }
     }
 }