Add better user feedback with NHS

Author: Aedial

CHANGELOG.md

@@ -8,6 +8,14 @@ The format is based on Keep a Changelog and this project adheres to Semantic Ver
 - Semantic Versioning: https://semver.org/spec/v2.0.0.html
 
 
+## [1.3.2] - 2026-02-10
+### Added
+- Add scan finished message to the player when a network scan is completed, showing the number of issues found in each category.
+
+### Fixed
+- Fix localization for ME Network part names in the Network Health Scanner GUI.
+
+
 ## [1.3.1] - 2026-02-07
 ### Added
 - Add multi-session support for Network Health Scanner to allow using multiple scanners on different networks simultaneously.

build.gradle

@@ -14,7 +14,7 @@ buildscript {
 
 apply plugin: 'net.minecraftforge.gradle.forge'
 
-version = "1.3.0"
+version = "1.3.2"
 group = "com.ae2powertools"
 archivesBaseName = "ae2-powertools"
 

src/main/java/com/ae2powertools/Tags.java

@@ -6,5 +6,5 @@
 public class Tags {
     public static final String MODID = "ae2powertools";
     public static final String MODNAME = "AE2 PowerTools";
-    public static final String VERSION = "1.3.0";
+    public static final String VERSION = "1.3.2";
 }

src/main/java/com/ae2powertools/features/scanner/ChannelScanner.java

@@ -380,7 +380,7 @@ private void identifyChokepoints() {
             World nodeWorld = getNodeWorld(bfsNode.gridNode);
             IBlockState blockState = (nodeWorld != null && nodeWorld.isBlockLoaded(pos))
                 ? nodeWorld.getBlockState(pos) : Blocks.AIR.getDefaultState();
-            String description = getNodeDescription(bfsNode.gridNode.getMachine());
+            String description = getNodeDescription(bfsNode.gridNode);
 
             ChannelChokepoint chokepoint = new ChannelChokepoint(
                 pos, dimension, dimName, blockState, description,
@@ -423,7 +423,7 @@ private void identifyMissingChannelDevices() {
                 // Fall back to empty stack
             }
 
-            String description = getNodeDescription(node.getMachine());
+            String description = getNodeDescription(node);
             MissingChannelDevice device = new MissingChannelDevice(
                 pos, dimension, dimName, itemStack, description
             );
@@ -439,7 +439,7 @@ private void addConnectionFlows(ChannelChokepoint chokepoint, BfsNode bfsNode) {
         if (bfsNode.parent != null) {
             BlockPos parentPos = getNodePosition(bfsNode.parent.gridNode);
             EnumFacing direction = getConnectionDirection(bfsNode.gridNode, bfsNode.connectionFromParent);
-            String parentDesc = getNodeDescription(bfsNode.parent.gridNode.getMachine());
+            String parentDesc = getNodeDescription(bfsNode.parent.gridNode);
 
             // Parent carries all the demand (toward controller)
             int parentChannels = bfsNode.connectionFromParent != null
@@ -457,7 +457,7 @@ private void addConnectionFlows(ChannelChokepoint chokepoint, BfsNode bfsNode) {
         for (BfsNode child : bfsNode.children) {
             BlockPos childPos = getNodePosition(child.gridNode);
             EnumFacing direction = getConnectionDirection(bfsNode.gridNode, child.connectionFromParent);
-            String childDesc = getNodeDescription(child.gridNode.getMachine());
+            String childDesc = getNodeDescription(child.gridNode);
 
             int childChannels = child.connectionFromParent != null
                 ? child.connectionFromParent.getUsedChannels() : 0;
@@ -513,8 +513,22 @@ private BlockPos getNodePosition(IGridNode node) {
 
     /**
      * Get a human-readable description of a grid node.
+     * Uses the machine representation's display name for localized output.
      */
-    private String getNodeDescription(IGridHost host) {
+    private String getNodeDescription(IGridNode node) {
+        if (node == null) return I18n.translateToLocal("ae2powertools.common.unknown");
+
+        // Try to get the localized name from the machine representation
+        try {
+            ItemStack representation = node.getGridBlock().getMachineRepresentation();
+
+            if (!representation.isEmpty()) return representation.getDisplayName();
+        } catch (Exception e) {
+            // Fall through to class name fallback
+        }
+
+        // Fallback: clean up class name
+        IGridHost host = node.getMachine();
         if (host == null) return I18n.translateToLocal("ae2powertools.common.unknown");
 
         String className = host.getClass().getSimpleName();

src/main/java/com/ae2powertools/features/scanner/GuiNetworkHealthScanner.java

@@ -88,6 +88,8 @@ public class GuiNetworkHealthScanner extends GuiScreen {
     private GuiButton deselectAllButton;
     private GuiButton cancelButton;
 
+    // TODO: add sort button (distance/A-Z/Z-A)
+
     /**
      * Represents a row in the display list.
      */
@@ -309,6 +311,8 @@ private void rebuildDisplayRows() {
     }
 
     private void rebuildLoopRows() {
+        // TODO: Add a message telling loops are not a "hard" issue and can be ignored as long as nothing looks wrong in the network.
+
         List<LoopLocationClient> sorted = ScannerClientState.getSortedLoopLocations();
         List<LoopLocationClient> original = ScannerClientState.getLoopLocations();
         if (sorted.isEmpty()) return;

src/main/java/com/ae2powertools/features/scanner/NetworkScanner.java

@@ -9,6 +9,7 @@
 
 import net.minecraft.block.state.IBlockState;
 import net.minecraft.init.Blocks;
+import net.minecraft.item.ItemStack;
 import net.minecraft.tileentity.TileEntity;
 import net.minecraft.util.math.BlockPos;
 import net.minecraft.util.math.ChunkPos;
@@ -319,7 +320,7 @@ private void addLoopLocation(IGridConnection connection, PathNode current, PathN
         boolean isLoaded = nodeWorld != null && nodeWorld.isBlockLoaded(pos);
         IBlockState blockState = isLoaded ? nodeWorld.getBlockState(pos) : Blocks.AIR.getDefaultState();
 
-        String description = getNodeDescription(host);
+        String description = getNodeDescription(node);
         IssueLocation loopLoc = new IssueLocation(pos, dimension, dimName, blockState, isLoaded, description);
         detectedLoops.add(loopLoc);
     }
@@ -340,7 +341,7 @@ private void addClusterLoopLocation(BlockPos pos, IGridHost host, IGridNode node
 
         if (isLoaded) blockState = nodeWorld.getBlockState(pos);
 
-        String description = getNodeDescription(host);
+        String description = getNodeDescription(node);
         IssueLocation loopLoc = new IssueLocation(pos, dimension, dimName, blockState, isLoaded, description);
         detectedLoops.add(loopLoc);
     }
@@ -405,15 +406,26 @@ private BlockPos getNodePosition(IGridNode node) {
 
     /**
      * Get a human-readable description of a grid node.
+     * Uses the machine representation's display name for localized output.
      */
-    private String getNodeDescription(IGridHost host) {
+    private String getNodeDescription(IGridNode node) {
+        if (node == null) return I18n.translateToLocal("ae2powertools.common.unknown");
+
+        // Try to get the localized name from the machine representation
+        try {
+            ItemStack representation = node.getGridBlock().getMachineRepresentation();
+
+            if (!representation.isEmpty()) return representation.getDisplayName();
+        } catch (Exception e) {
+            // Fall through to class name fallback
+        }
+
+        // Fallback: clean up class name
+        IGridHost host = node.getMachine();
         if (host == null) return I18n.translateToLocal("ae2powertools.common.unknown");
 
         String className = host.getClass().getSimpleName();
 
-        // TODO: should we try to localize some common AE2 part names here?
-        //       Or maybe we can get the part name from the host if it's a part?
-        // Clean up common names
         if (className.startsWith("Tile")) {
             className = className.substring(4);
         } else if (className.startsWith("Part")) {

src/main/java/com/ae2powertools/features/scanner/ScanSessionManager.java

@@ -9,6 +9,8 @@
 
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.util.math.BlockPos;
+import net.minecraft.util.text.ITextComponent;
+import net.minecraft.util.text.TextComponentTranslation;
 import net.minecraft.util.text.translation.I18n;
 
 import appeng.api.networking.IGrid;
@@ -57,6 +59,7 @@ public int hashCode() {
     }
 
     private static final Map<SessionKey, ScanSession> sessions = new HashMap<>();
+    private static final List<SessionKey> completedThisTick = new ArrayList<>();
 
     /**
      * Represents an active scan session for a player.
@@ -248,8 +251,47 @@ public static Iterable<Map.Entry<SessionKey, ScanSession>> getSessionEntries() {
      * Call this from server tick handler.
      */
     public static void tickSessions() {
-        for (ScanSession session : sessions.values()) {
-            if (!session.getScanner().isComplete()) session.getScanner().processBatch();
+        completedThisTick.clear();
+
+        for (Map.Entry<SessionKey, ScanSession> entry : sessions.entrySet()) {
+            ScanSession session = entry.getValue();
+            if (session.getScanner().isComplete()) continue;
+
+            session.getScanner().processBatch();
+
+            // Track if this session just completed
+            if (session.getScanner().isComplete()) {
+                completedThisTick.add(entry.getKey());
+            }
         }
     }
+
+    /**
+     * Get the list of session keys that completed during the last tick.
+     */
+    public static List<SessionKey> getCompletedThisTick() {
+        return completedThisTick;
+    }
+
+    /**
+     * Build the completion message for a scan session.
+     */
+    public static ITextComponent buildCompletionMessage(ScanSession session) {
+        NetworkScanner scanner = session.getScanner();
+        int nodes = scanner.getNodesProcessed();
+        int loops = scanner.getDetectedLoops().size();
+        int chunks = scanner.getUnloadedChunks().size();
+        int chokepoints = scanner.getChokepoints().size();
+        int missing = scanner.getMissingDevices().size();
+
+        // Build the message as a single component with newlines
+        StringBuilder messageBuilder = new StringBuilder();
+        messageBuilder.append(I18n.translateToLocalFormatted("ae2powertools.scanner.complete.summary.top", nodes)).append("\n");
+        messageBuilder.append(I18n.translateToLocalFormatted("ae2powertools.scanner.complete.summary.line1", loops)).append("\n");
+        messageBuilder.append(I18n.translateToLocalFormatted("ae2powertools.scanner.complete.summary.line2", chunks)).append("\n");
+        messageBuilder.append(I18n.translateToLocalFormatted("ae2powertools.scanner.complete.summary.line3", chokepoints)).append("\n");
+        messageBuilder.append(I18n.translateToLocalFormatted("ae2powertools.scanner.complete.summary.line4", missing));
+
+        return new TextComponentTranslation(messageBuilder.toString());
+    }
 }

src/main/java/com/ae2powertools/features/scanner/ScannerRenderer.java

@@ -49,6 +49,7 @@ public class ScannerRenderer {
     private static final int LINE_SPACING = 2;
 
     // ========== Arrow Rendering Constants ==========
+    // TODO: Adapt these values to the screen resolution for better visibility
     private static final float ARROW_BASE_DISTANCE = 0.6f;
     private static final float ARROW_SPREAD_RADIUS = 0.12f;
     private static final float ARROW_LENGTH = 0.05f;

src/main/java/com/ae2powertools/features/scanner/ScannerTickHandler.java

@@ -34,6 +34,18 @@ public void onServerTick(TickEvent.ServerTickEvent event) {
         // Process all active scan sessions
         ScanSessionManager.tickSessions();
 
+        // Send completion messages for sessions that just finished
+        for (ScanSessionManager.SessionKey key : ScanSessionManager.getCompletedThisTick()) {
+            EntityPlayerMP player = findPlayer(server, key.getPlayerId());
+
+            if (player != null) {
+                ScanSessionManager.ScanSession session = ScanSessionManager.getSession(key.getPlayerId(), key.getDeviceId());
+                if (session != null) {
+                    player.sendMessage(ScanSessionManager.buildCompletionMessage(session));
+                }
+            }
+        }
+
         // Sync to clients periodically
         Set<ScanSessionManager.SessionKey> toRemove = new HashSet<>();
 

src/main/resources/assets/ae2powertools/lang/en_US.lang

@@ -74,5 +74,12 @@ ae2powertools.scanner.channel.found=Found %d chokepoints, %d missing devices.
 ae2powertools.scanner.channel.calculating_progress=Analyzing channels... %d/%d nodes.
 ae2powertools.scanner.channel.to_controller=(→Controller)
 
+# Scan Completion Messages
+ae2powertools.scanner.complete.summary.top=Scanned %d nodes:
+ae2powertools.scanner.complete.summary.line1=- Found %d loop(s)
+ae2powertools.scanner.complete.summary.line2=- Found %d non-chunkloaded chunk(s)
+ae2powertools.scanner.complete.summary.line3=- Found %d chokepoint(s)
+ae2powertools.scanner.complete.summary.line4=- Found %d device(s) without channels
+
 # Common strings
 ae2powertools.common.unknown=Unknown