Merge remote-tracking branch 'ReignOfFROZE/master' into dev

Add channel desc and channel indicator item. Its meaning and development
examples has been added to overview page in javadoc.
Also removes gt_no_hatch and show_error special button from GUI as they
are now a candidate in the dropdown menu.

one day we will move this to MUI2, but for now let's stick to existing
infra that is known to work



https://github.com/user-attachments/assets/814edbb6-c4b4-4309-8798-787d9ed1aeef

Note: channels in demo video are from GT5. if you boot the pack without
the modified gt5 you won't see most of the channels.

---------

Signed-off-by: Glease <4586901+Glease@users.noreply.github.com>

.gitignore

@@ -27,3 +27,4 @@ whitelist.json
 *.iws
 src/main/resources/mixins.*.json
 *.bat
+layout.json

addon.gradle

@@ -1,7 +1,7 @@
 javadoc {
     javadocTool = javaToolchains.javadocToolFor {
         // Last version with frames, but it also has search
-        languageVersion = JavaLanguageVersion.of(11)
+        languageVersion = JavaLanguageVersion.of(21)
         vendor = JvmVendorSpec.ADOPTIUM
     }
 
@@ -20,7 +20,6 @@ javadoc {
         overview "src/main/javadoc/overview.html"
         links 'https://docs.oracle.com/javase/8/docs/api/'
         links 'https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/'
-        addBooleanOption("-frames", true)
     }
 }
 

dependencies.gradle

@@ -1,9 +1,13 @@
 // Add your dependencies here
 
 dependencies {
-    api("com.github.GTNewHorizons:GTNHLib:0.4.2:dev")
-    runtimeOnly("com.github.GTNewHorizons:NotEnoughItems:2.6.19-GTNH:dev")
+    api("com.github.GTNewHorizons:GTNHLib:0.6.31:dev")
+    implementation("com.github.GTNewHorizons:NotEnoughItems:2.7.56-GTNH:dev")
 
     testImplementation(platform('org.junit:junit-bom:5.9.2'))
     testImplementation('org.junit.jupiter:junit-jupiter')
+
+//    runtimeOnlyNonPublishable("com.github.GTNewHorizons:GT5-Unofficial:5.09.51.261:dev") {
+//        exclude group: "com.github.GTNewHorizons", module: "StructureLib"
+//    }
 }

gradle.properties

@@ -14,7 +14,7 @@ modId = structurelib
 modGroup = com.gtnewhorizon.structurelib
 
 # Whether to use modGroup as the maven publishing group.
-# Due to a history of using JitPack, the default is com.github.GTNewHorizons for all mods.
+# When false, com.github.GTNewHorizons is used.
 useModGroupForPublishing = false
 
 # Updates your build.gradle and settings.gradle automatically whenever an update is available.
@@ -37,7 +37,7 @@ remoteMappings = https\://raw.githubusercontent.com/MinecraftForge/FML/1.7.10/co
 
 # Select a default username for testing your mod. You can always override this per-run by running
 # `./gradlew runClient --username=AnotherPlayer`, or configuring this command in your IDE.
-developmentEnvironmentUserName = "Developer"
+developmentEnvironmentUserName = Developer
 
 # Enables using modern Java syntax (up to version 17) via Jabel, while still targeting JVM 8.
 # See https://github.com/bsideup/jabel for details on how this works.
@@ -50,10 +50,10 @@ enableGenericInjection = true
 # Generate a class with a String field for the mod version named as defined below.
 # If generateGradleTokenClass is empty or not missing, no such class will be generated.
 # If gradleTokenVersion is empty or missing, the field will not be present in the class.
-generateGradleTokenClass =
+generateGradleTokenClass = com.gtnewhorizon.structurelib.Tags
 
 # Name of the token containing the project's current version to generate/replace.
-gradleTokenVersion = GRADLETOKEN_VERSION
+gradleTokenVersion = VERSION
 
 # [DEPRECATED] Mod ID replacement token.
 gradleTokenModId =
@@ -70,7 +70,7 @@ gradleTokenGroupName =
 # The string's content will be replaced with your mod's version when compiled. You should use this to specify your mod's
 # version in @Mod([...], version = VERSION, [...]).
 # Leave these properties empty to skip individual token replacements.
-replaceGradleTokenInFile = StructureLib.java
+replaceGradleTokenInFile =
 
 # In case your mod provides an API for other mods to implement you may declare its package here. Otherwise, you can
 # leave this property empty.

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -86,8 +86,7 @@ done
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
 # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
-APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
-' "$PWD" ) || exit
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -206,7 +205,7 @@ fi
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Collect all arguments for the java command:
-#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
 #     and any embedded shellness will be escaped.
 #   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
 #     treated as '${Hostname}' itself on the command line.

repositories.gradle

@@ -1,4 +1,5 @@
 // Add any additional repositiroes for your dependencies here
 
 repositories {
+    mavenLocal()
 }

settings.gradle

@@ -17,7 +17,7 @@ pluginManagement {
 }
 
 plugins {
-    id 'com.gtnewhorizons.gtnhsettingsconvention' version '1.0.26'
+    id 'com.gtnewhorizons.gtnhsettingsconvention' version '1.0.38'
 }
 
 

src/main/java/com/gtnewhorizon/structurelib/ChannelDescription.java

@@ -0,0 +1,94 @@
+package com.gtnewhorizon.structurelib;
+
+import java.util.AbstractMap;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import net.minecraft.item.ItemStack;
+
+import com.gtnewhorizon.gtnhlib.util.map.ItemStackMap;
+
+import cpw.mods.fml.common.Loader;
+
+// this is not an API! go check StructureLibAPI instead!
+public class ChannelDescription {
+
+    private static final ItemStackMap<Set<ChannelDescription>> itemToChannels = new ItemStackMap<>(true);
+    private static final Map<String, ChannelDescription> registry = new HashMap<>();
+    private final String channel;
+    private final Map<String, String> descriptions = new HashMap<>();
+    private final ItemStackMap<Integer> items = new ItemStackMap<>(true);
+
+    public static ChannelDescription get(final String channel) {
+        if (StructureLibAPI.isDebugEnabled() && !channel.toLowerCase(Locale.ROOT).equals(channel))
+            throw new IllegalArgumentException("Channel name can be lower case ONLY");
+        return registry.computeIfAbsent(channel, ChannelDescription::new);
+    }
+
+    public static boolean has(final String channel) {
+        if (StructureLibAPI.isDebugEnabled() && !channel.toLowerCase(Locale.ROOT).equals(channel))
+            throw new IllegalArgumentException("Channel name can be lower case ONLY");
+        return registry.containsKey(channel);
+    }
+
+    public static Collection<Map.Entry<String, Integer>> iterate(final ItemStack block) {
+        Set<ChannelDescription> channels = itemToChannels.get(block);
+        if (channels == null) return Collections.emptySet();
+        return channels.stream().map(d -> new AbstractMap.SimpleImmutableEntry<>(d.channel, d.items.get(block)))
+                .collect(Collectors.toList());
+    }
+
+    public static void set(final String channel, final String modid, final String description) {
+        if (StructureLibAPI.isDebugEnabled() && !channel.toLowerCase(Locale.ROOT).equals(channel))
+            throw new IllegalArgumentException("Channel name can be lower case ONLY");
+        registry.computeIfAbsent(channel, ChannelDescription::new).add(modid, description);
+    }
+
+    public static void item(final String channel, int channelValue, ItemStack stack) {
+        if (StructureLibAPI.isDebugEnabled()) {
+            if (!channel.toLowerCase(Locale.ROOT).equals(channel)) {
+                throw new IllegalArgumentException("Channel name can be lower case ONLY");
+            }
+            if (channelValue <= 0) {
+                throw new IllegalArgumentException("Channel value must be greater than 0");
+            }
+        }
+        ChannelDescription inst = registry.computeIfAbsent(channel, ChannelDescription::new);
+        inst.items.put(stack, channelValue);
+        itemToChannels.computeIfAbsent(stack, s -> new HashSet<>()).add(inst);
+    }
+
+    public static Map<String, ChannelDescription> getAll() {
+        return Collections.unmodifiableMap(registry);
+    }
+
+    private ChannelDescription(String channel) {
+        this.channel = channel;
+    }
+
+    public String getChannel() {
+        return channel;
+    }
+
+    public ChannelDescription add(String modid, String description) {
+        if (Loader.instance().getIndexedModList().get(modid) == null) {
+            throw new IllegalArgumentException("Mod not found: " + modid);
+        }
+        descriptions.put(modid, description);
+        return this;
+    }
+
+    public Map<String, String> getDescriptions() {
+        return Collections.unmodifiableMap(descriptions);
+    }
+
+    public Map<ItemStack, Integer> getItems() {
+        return Collections.unmodifiableMap(items);
+    }
+}

src/main/java/com/gtnewhorizon/structurelib/ClientProxy.java

@@ -46,6 +46,7 @@ import com.gtnewhorizon.structurelib.net.SetChannelDataMessage;
 import cpw.mods.fml.client.config.GuiConfig;
 import cpw.mods.fml.client.event.ConfigChangedEvent;
 import cpw.mods.fml.common.FMLCommonHandler;
+import cpw.mods.fml.common.event.FMLInitializationEvent;
 import cpw.mods.fml.common.event.FMLLoadCompleteEvent;
 import cpw.mods.fml.common.event.FMLPreInitializationEvent;
 import cpw.mods.fml.common.eventhandler.EventPriority;

src/main/java/com/gtnewhorizon/structurelib/CommonProxy.java

@@ -14,9 +14,12 @@ import net.minecraft.util.IIcon;
 import net.minecraft.world.World;
 import net.minecraftforge.common.MinecraftForge;
 
+import com.gtnewhorizon.gtnhlib.keybind.SyncedKeybind;
+import com.gtnewhorizon.structurelib.item.ItemConstructableTrigger;
 import com.gtnewhorizon.structurelib.net.ErrorHintParticleMessage;
 import com.gtnewhorizon.structurelib.net.UpdateHintParticleMessage;
 
+import cpw.mods.fml.common.event.FMLInitializationEvent;
 import cpw.mods.fml.common.event.FMLLoadCompleteEvent;
 import cpw.mods.fml.common.event.FMLPreInitializationEvent;
 import cpw.mods.fml.common.eventhandler.SubscribeEvent;
@@ -108,6 +111,16 @@ public class CommonProxy {
         }
     }
 
+    private static final SyncedKeybind MODE_SWAP_KEY = SyncedKeybind.createConfigurable(
+            "item.structurelib.constructableTrigger.keys.cycleMode",
+            "item.structurelib.constructableTrigger.keyCategory",
+            0).registerGlobalListener((entityPlayerMP, syncedKeybind) -> {
+                final ItemStack held = entityPlayerMP.getHeldItem();
+                if (held != null && held.getItem() instanceof ItemConstructableTrigger) {
+                    ItemConstructableTrigger.cycleMode(held);
+                }
+            });
+
     public void displayConfigGUI(String category) {}
 
     public static class ForgeEventHandler {

src/main/java/com/gtnewhorizon/structurelib/DevelopHelper.java

@@ -0,0 +1,48 @@
+package com.gtnewhorizon.structurelib;
+
+import net.minecraft.init.Blocks;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.nbt.NBTTagList;
+
+import cpw.mods.fml.common.event.FMLInterModComms;
+
+public class DevelopHelper {
+
+    private static final boolean DEBUG = Boolean.getBoolean("structurelib.develop_helper");
+
+    public static void onPreInit() {
+        if (!DEBUG) return;
+        StructureLib.LOGGER.info("Running develop helper");
+        StructureLibAPI.registerChannelDescription("sandstone", StructureLibAPI.MOD_ID, "variants of Sandstone");
+        StructureLibAPI.registerChannelItem("sandstone", StructureLibAPI.MOD_ID, 1, new ItemStack(Blocks.sandstone));
+        StructureLibAPI
+                .registerChannelItem("sandstone", StructureLibAPI.MOD_ID, 2, new ItemStack(Blocks.sandstone, 1, 1));
+        StructureLibAPI
+                .registerChannelItem("sandstone", StructureLibAPI.MOD_ID, 3, new ItemStack(Blocks.sandstone, 1, 2));
+        StructureLibAPI.registerChannelDescription("sandbricks", StructureLibAPI.MOD_ID, "variants of Sandbricks");
+        StructureLibAPI.registerChannelDescription("apple", StructureLibAPI.MOD_ID, "apple");
+        StructureLibAPI.registerChannelDescription("bright", StructureLibAPI.MOD_ID, "bright");
+        StructureLibAPI.registerChannelDescription("apple_blight", StructureLibAPI.MOD_ID, "apple_blight");
+        StructureLibAPI.registerChannelDescription("app_eagle", StructureLibAPI.MOD_ID, "app_eagle");
+    }
+
+    public void x() {
+        NBTTagCompound command = new NBTTagCompound();
+        NBTTagList items = new NBTTagList();
+        int[] metas = { 0, 1, 2 };
+        for (int meta : metas) {
+            NBTTagCompound tag = new NBTTagCompound();
+            tag.setTag("Item", new ItemStack(Blocks.sandstone, 1, meta).writeToNBT(new NBTTagCompound()));
+            NBTTagList channels = new NBTTagList();
+            NBTTagCompound channel = new NBTTagCompound();
+            channel.setString("Channel", "sandstone");
+            channel.setInteger("Value", meta + 1);
+            channels.appendTag(channel);
+            tag.setTag("Channels", channels);
+            items.appendTag(tag);
+        }
+        command.setTag("Items", items);
+        FMLInterModComms.sendMessage("structurelib", "register_channel_item", command);
+    }
+}

src/main/java/com/gtnewhorizon/structurelib/GuiHandler.java

@@ -3,6 +3,7 @@ package com.gtnewhorizon.structurelib;
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.world.World;
 
+import com.gtnewhorizon.structurelib.gui.EmptyContainer;
 import com.gtnewhorizon.structurelib.gui.GuiScreenConfigureChannels;
 
 import cpw.mods.fml.common.network.IGuiHandler;
@@ -11,14 +12,19 @@ public class GuiHandler implements IGuiHandler {
 
     @Override
     public Object getServerGuiElement(int ID, EntityPlayer player, World world, int x, int y, int z) {
-        return null;
+        switch (ID) {
+            case 0:
+                return new EmptyContainer(player);
+            default:
+                return null;
+        }
     }
 
     @Override
     public Object getClientGuiElement(int ID, EntityPlayer player, World world, int x, int y, int z) {
         switch (ID) {
             case 0:
-                return new GuiScreenConfigureChannels(player.inventory.getStackInSlot(x));
+                return new GuiScreenConfigureChannels(new EmptyContainer(player), player.inventory.getStackInSlot(x));
             default:
                 return null;
         }

src/main/java/com/gtnewhorizon/structurelib/IStructureCompat.java

@@ -1,8 +1,11 @@
 package com.gtnewhorizon.structurelib;
 
+import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.util.IIcon;
+import net.minecraft.world.World;
 
 public interface IStructureCompat {
 
     void markTextureUsed(IIcon o);
+    boolean checkServerUtilitiesPermission(World world, EntityPlayer actor, int x, int z);
 }

src/main/java/com/gtnewhorizon/structurelib/StructureLib.java

@@ -1,11 +1,18 @@
 package com.gtnewhorizon.structurelib;
 
+import static com.gtnewhorizon.structurelib.StructureLibAPI.CHANNEL_SHOW_ERROR;
+import static com.gtnewhorizon.structurelib.StructureLibAPI.MOD_ID;
+
 import net.minecraft.block.Block;
 import net.minecraft.creativetab.CreativeTabs;
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.item.Item;
 import net.minecraft.item.ItemBlock;
+import net.minecraft.item.ItemStack;
 import net.minecraft.launchwrapper.Launch;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.nbt.NBTTagList;
+import net.minecraftforge.common.util.Constants;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -24,9 +31,10 @@ import com.gtnewhorizon.structurelib.net.UpdateHintParticleMessage;
 import com.gtnewhorizon.structurelib.util.InventoryUtility;
 import com.gtnewhorizon.structurelib.util.XSTR;
 
-import cpw.mods.fml.common.Loader;
 import cpw.mods.fml.common.Mod;
 import cpw.mods.fml.common.SidedProxy;
+import cpw.mods.fml.common.event.FMLInitializationEvent;
+import cpw.mods.fml.common.event.FMLInterModComms;
 import cpw.mods.fml.common.event.FMLLoadCompleteEvent;
 import cpw.mods.fml.common.event.FMLPreInitializationEvent;
 import cpw.mods.fml.common.event.FMLServerStartingEvent;
@@ -40,9 +48,9 @@ import cpw.mods.fml.relauncher.SideOnly;
  * This class does not contain a stable API. Refrain from using this class.
  */
 @Mod(
-        modid = StructureLibAPI.MOD_ID,
+        modid = MOD_ID,
         name = "StructureLib",
-        version = "GRADLETOKEN_VERSION",
+        version = Tags.VERSION,
         acceptableRemoteVersions = "*",
         guiFactory = "com.gtnewhorizon.structurelib.GuiFactory")
 public class StructureLib {
@@ -57,7 +65,7 @@ public class StructureLib {
             clientSide = "com.gtnewhorizon.structurelib.ClientProxy")
     static CommonProxy proxy;
 
-    static final SimpleNetworkWrapper net = NetworkRegistry.INSTANCE.newSimpleChannel(StructureLibAPI.MOD_ID);
+    static final SimpleNetworkWrapper net = NetworkRegistry.INSTANCE.newSimpleChannel(MOD_ID);
 
     static {
         net.registerMessage(
@@ -84,8 +92,8 @@ public class StructureLib {
 
     @Mod.Instance
     static StructureLib INSTANCE;
-
-    static Object COMPAT;
+    @Mod.Instance(STRUCTURECOMPAT_MODID)
+    public static Object COMPAT;
 
     static Block blockHint;
     static Item itemBlockHint;
@@ -115,9 +123,10 @@ public class StructureLib {
         NetworkRegistry.INSTANCE.registerGuiHandler(instance(), new GuiHandler());
 
         InventoryUtility.init();
-        if (Loader.isModLoaded(STRUCTURECOMPAT_MODID)) {
-            COMPAT = Loader.instance().getIndexedModList().get(STRUCTURECOMPAT_MODID).getMod();
-        }
+
+        ChannelDescription.set(CHANNEL_SHOW_ERROR, MOD_ID, "channels.structurelib.show_errors");
+
+        DevelopHelper.onPreInit();
     }
 
     @Mod.EventHandler
@@ -131,6 +140,48 @@ public class StructureLib {
         e.registerServerCommand(new CommandRegistryDebug());
     }
 
+    @Mod.EventHandler
+    public void handleIMC(FMLInterModComms.IMCEvent event) {
+        for (FMLInterModComms.IMCMessage message : event.getMessages()) {
+            switch (message.key) {
+                case "register_channel":
+                    processRegisterChannel(message);
+                    break;
+                case "register_channel_item":
+                    processRegisterChannelItem(message);
+                    break;
+            }
+        }
+    }
+
+    private void processRegisterChannel(FMLInterModComms.IMCMessage message) {
+        NBTTagList tags = message.getNBTValue().getTagList("Channels", Constants.NBT.TAG_COMPOUND);
+        for (int i = 0; i < tags.tagCount(); i++) {
+            NBTTagCompound tag = tags.getCompoundTagAt(i);
+            StructureLibAPI.registerChannelDescription(
+                    tag.getString("Channel"),
+                    message.getSender(),
+                    tag.getString("Description"));
+        }
+    }
+
+    private void processRegisterChannelItem(FMLInterModComms.IMCMessage message) {
+        NBTTagList items = message.getNBTValue().getTagList("Items", Constants.NBT.TAG_COMPOUND);
+        for (int i = 0; i < items.tagCount(); i++) {
+            NBTTagCompound itemTag = items.getCompoundTagAt(i);
+            ItemStack item = ItemStack.loadItemStackFromNBT(itemTag.getCompoundTag("Item"));
+            NBTTagList tags = itemTag.getTagList("Channels", Constants.NBT.TAG_COMPOUND);
+            for (int j = 0; j < tags.tagCount(); j++) {
+                NBTTagCompound tag = tags.getCompoundTagAt(j);
+                StructureLibAPI.registerChannelItem(
+                        tag.getString("Channel"),
+                        message.getSender(),
+                        tag.getInteger("Value"),
+                        item);
+            }
+        }
+    }
+
     public static void addClientSideChatMessages(String... messages) {
         proxy.addClientSideChatMessages(messages);
     }

src/main/java/com/gtnewhorizon/structurelib/StructureLibAPI.java

@@ -11,6 +11,7 @@ import net.minecraft.util.IChatComponent;
 import net.minecraft.util.IIcon;
 import net.minecraft.world.World;
 
+import com.gtnewhorizon.gtnhlib.util.AnimatedTooltipHandler;
 import com.gtnewhorizon.structurelib.alignment.IAlignment;
 import com.gtnewhorizon.structurelib.alignment.IAlignmentProvider;
 import com.gtnewhorizon.structurelib.alignment.enumerable.ExtendedFacing;
@@ -43,6 +44,7 @@ public class StructureLibAPI {
     public static final int HINT_BLOCK_META_AIR = 13;
     public static final int HINT_BLOCK_META_NOT_AIR = 14;
     public static final int HINT_BLOCK_META_ERROR = 15;
+    public static final String CHANNEL_SHOW_ERROR = "show_error";
     static final ThreadLocal<Object> instrument = new ThreadLocal<>();
 
     /**
@@ -72,7 +74,7 @@ public class StructureLibAPI {
      */
     public static void enableInstrument(Object identifier) {
         if (isInstrumentEnabled()) throw new IllegalStateException();
-        instrument.set(instrument);
+        instrument.set(identifier);
     }
 
     /**
@@ -350,4 +352,37 @@ public class StructureLibAPI {
             short intervalRequired, boolean forceUpdateLastSend) {
         proxy.addThrottledChat(throttleKey, player, text, intervalRequired, forceUpdateLastSend);
     }
+
+    /**
+     * Register a channel description here. The description should describe how a channel will be used inside your mod.
+     *
+     * @param channel     channel key
+     * @param modid       your modid
+     * @param description localization key for your description
+     */
+    public static void registerChannelDescription(final String channel, final String modid, final String description) {
+        ChannelDescription.set(channel, modid, description);
+    }
+
+    /**
+     * Register an item stack as an indicator for a (channel, value) pair.
+     *
+     * @param channel      channel key
+     * @param modid        your modid
+     * @param channelValue value
+     * @param stack        item stack. having a metadata of
+     *                     {@link net.minecraftforge.oredict.OreDictionary#WILDCARD_VALUE} will match without comparing
+     *                     NBT or metadata value. having a tag with {@code tag.getBoolean("*") == true} will match
+     *                     without comparing NBT.
+     */
+    public static void registerChannelItem(final String channel, final String modid, final int channelValue,
+            final ItemStack stack) {
+        ChannelDescription.item(channel, channelValue, stack);
+        AnimatedTooltipHandler.addItemTooltip(
+                stack,
+                AnimatedTooltipHandler.translatedText("structurelib.tooltip.channelvalue", channelValue, channel));
+        AnimatedTooltipHandler.addItemTooltip(
+                stack,
+                AnimatedTooltipHandler.translatedText("structurelib.tooltip.indicator_dnd", channelValue, channel));
+    }
 }

src/main/java/com/gtnewhorizon/structurelib/alignment/constructable/ConstructableUtility.java

@@ -57,12 +57,12 @@ public class ConstructableUtility {
         }
 
         IConstructable constructable = null;
-        if (tTileEntity instanceof IConstructableProvider)
-            constructable = ((IConstructableProvider) tTileEntity).getConstructable();
-        else if (tTileEntity instanceof IConstructable) {
-            constructable = (IConstructable) tTileEntity;
+        if (tTileEntity instanceof IConstructableProvider aConstructableProvider)
+            constructable = aConstructableProvider.getConstructable();
+        else if (tTileEntity instanceof IConstructable aConstructable) {
+            constructable = aConstructable;
         } else if (IMultiblockInfoContainer.contains(tTileEntity.getClass())) {
-            ExtendedFacing facing = tTileEntity instanceof IAlignment ? ((IAlignment) tTileEntity).getExtendedFacing()
+            ExtendedFacing facing = tTileEntity instanceof IAlignment alignment ? alignment.getExtendedFacing()
                     : ExtendedFacing.of(ForgeDirection.getOrientation(aSide));
             constructable = IMultiblockInfoContainer.<TileEntity>get(tTileEntity.getClass())
                     .toConstructable(tTileEntity, facing);
@@ -70,14 +70,13 @@ public class ConstructableUtility {
 
         if (constructable == null) return false;
 
-        if (aPlayer instanceof EntityPlayerMP) {
-            EntityPlayerMP playerMP = (EntityPlayerMP) aPlayer;
+        if (aPlayer instanceof EntityPlayerMP playerMP) {
             // server side and sneaking (already checked above)
             // do construct
             if (aPlayer.capabilities.isCreativeMode) {
                 constructable.construct(aStack, false);
-            } else if (constructable instanceof ISurvivalConstructable) {
-                int built = ((ISurvivalConstructable) constructable).survivalConstruct(
+            } else if (constructable instanceof ISurvivalConstructable aConstructable) {
+                int built = aConstructable.survivalConstruct(
                         aStack,
                         ConfigurationHandler.INSTANCE.getAutoPlaceBudget(),
                         ISurvivalBuildEnvironment.create(IItemSource.fromPlayer(playerMP), playerMP));

src/main/java/com/gtnewhorizon/structurelib/gui/EmptyContainer.java

@@ -0,0 +1,18 @@
+package com.gtnewhorizon.structurelib.gui;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.inventory.Container;
+
+public class EmptyContainer extends Container {
+
+    private final EntityPlayer player;
+
+    public EmptyContainer(EntityPlayer player) {
+        this.player = player;
+    }
+
+    @Override
+    public boolean canInteractWith(EntityPlayer player) {
+        return player == this.player;
+    }
+}

src/main/java/com/gtnewhorizon/structurelib/gui/GuiScreenConfigureChannels.java

@@ -1,45 +1,82 @@
 package com.gtnewhorizon.structurelib.gui;
 
+import java.util.AbstractMap;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map;
 import java.util.Map.Entry;
+import java.util.Set;
 import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
 
 import net.minecraft.client.gui.GuiButton;
-import net.minecraft.client.gui.GuiScreen;
 import net.minecraft.client.gui.GuiTextField;
+import net.minecraft.client.gui.inventory.GuiContainer;
 import net.minecraft.client.renderer.Tessellator;
 import net.minecraft.client.resources.I18n;
+import net.minecraft.inventory.Container;
 import net.minecraft.item.ItemStack;
 import net.minecraft.util.EnumChatFormatting;
 import net.minecraft.util.ResourceLocation;
+import net.minecraft.util.StatCollector;
 
 import org.apache.commons.lang3.StringUtils;
 import org.lwjgl.input.Keyboard;
 import org.lwjgl.input.Mouse;
 import org.lwjgl.opengl.GL11;
 
+import com.google.common.base.Splitter;
+import com.gtnewhorizon.structurelib.ChannelDescription;
 import com.gtnewhorizon.structurelib.StructureLib;
 import com.gtnewhorizon.structurelib.alignment.constructable.ChannelDataAccessor;
 import com.gtnewhorizon.structurelib.gui.GuiScrollableList.IGuiScreen;
 
-public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen {
+import codechicken.nei.VisiblityData;
+import codechicken.nei.api.INEIGuiHandler;
+import codechicken.nei.api.TaggedInventoryArea;
+import cpw.mods.fml.common.Loader;
+import cpw.mods.fml.common.Optional;
+import gnu.trove.map.TIntObjectMap;
+import gnu.trove.map.hash.TIntObjectHashMap;
+
+@Optional.Interface(iface = "codechicken.nei.api.INEIGuiHandler", modid = "NotEnoughItems")
+public class GuiScreenConfigureChannels extends GuiContainer implements IGuiScreen, INEIGuiHandler {
+
+    private static final String I18N_PREFIX = "item.structurelib.constructableTrigger.gui.";
+
+    private static final int ADD_BTN = 0;
+    private static final int UNSET_BTN = 1;
+    private static final int WIPE_BTN = 2;
 
     private static final int KEY_MAX_WIDTH = 50;
+    private static final int INFO_BOX_SIZE = 11;
     private final ItemStack trigger;
     private final GuiChannelsList list;
+    private final GuiAutoCompleteList autoCompleteList;
+    private final Map<String, List<String>> tooltipSplitCache = new HashMap<>();
+    private final TIntObjectMap<Map<String, String>> trimCache = new TIntObjectHashMap<>();
     private GuiTextField key, value;
     protected int guiTop, guiLeft;
+    private List<String> info;
+
+    public GuiScreenConfigureChannels(Container container, ItemStack trigger) {
+        super(container);
 
-    public GuiScreenConfigureChannels(ItemStack trigger) {
         this.trigger = trigger;
-        list = new GuiChannelsList(152, 100, 12, 12, 14);
+        list = new GuiChannelsList(152, 91, 12, 21, 14);
         list.addSelectionListener((list, selectedIndex) -> {
             Entry<String, Integer> e = list.getElementAt(selectedIndex);
             key.setText(e.getKey());
             value.setText(e.getValue().toString());
             updateButtons();
         });
+        autoCompleteList = new GuiAutoCompleteList(151 + 12 - 45 - 2, 50, 45, 119 + 12, 14);
     }
 
     @Override
@@ -125,10 +162,11 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
         };
 
         list.onGuiInit(this);
+        autoCompleteList.onGuiInit(this);
 
         addButton(
                 new GuiButton(
-                        0,
+                        ADD_BTN,
                         guiLeft + 12,
                         guiTop + 157,
                         47,
@@ -136,7 +174,7 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
                         I18n.format("item.structurelib.constructableTrigger.gui.add")));
         addButton(
                 new GuiButton(
-                        1,
+                        UNSET_BTN,
                         guiLeft + 65,
                         guiTop + 157,
                         47,
@@ -144,7 +182,7 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
                         I18n.format("item.structurelib.constructableTrigger.gui.unset")));
         addButton(
                 new GuiButton(
-                        2,
+                        WIPE_BTN,
                         guiLeft + 118,
                         guiTop + 157,
                         47,
@@ -152,6 +190,15 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
                         I18n.format("item.structurelib.constructableTrigger.gui.wipe")));
 
         updateButtons();
+        tooltipSplitCache.clear();
+        info = StreamSupport
+                .stream(
+                        Splitter.on("\\n").split(
+                                StatCollector.translateToLocal("item.structurelib.constructableTrigger.gui.info"))
+                                .spliterator(),
+                        false)
+                .flatMap(line -> fontRendererObj.listFormattedStringToWidth(line, width * 3 / 5).stream())
+                .collect(Collectors.toList());
     }
 
     @Override
@@ -199,22 +246,42 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
         return buttonList;
     }
 
+    private boolean isMouseOverValue() {
+        int mx = Mouse.getEventX() * this.width / this.mc.displayWidth;
+        int my = this.height - Mouse.getEventY() * this.height / this.mc.displayHeight - 1;
+        return mx >= value.xPosition && mx < value.xPosition + value.width
+                && my >= value.yPosition
+                && my < value.yPosition + value.height;
+
+    }
+
     @Override
     public void handleMouseInput() {
         int delta = Mouse.getEventDWheel();
-        if (delta != 0) list.handleDWheel(delta);
+        if (delta != 0) {
+            if (isMouseOverValue()) {
+                if (delta > 0) {
+                    value.setText(String.valueOf(getValue() + 1));
+                } else {
+                    value.setText(String.valueOf(Math.max(getValue() - 1, 1)));
+                }
+            } else {
+                list.handleDWheel(delta);
+            }
+        }
         super.handleMouseInput();
     }
 
     @Override
     protected void mouseClicked(int mX, int mY, int button) {
+        super.mouseClicked(mX, mY, button);
         key.mouseClicked(mX, mY, button);
         value.mouseClicked(mX, mY, button);
-        super.mouseClicked(mX, mY, button);
     }
 
     @Override
     protected void keyTyped(char aChar, int aKey) {
+        GuiScrollableList<?> l = key.isFocused() ? autoCompleteList : list;
         switch (aKey) {
             case Keyboard.KEY_TAB:
                 if (key.isFocused()) {
@@ -227,15 +294,33 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
                 return;
             case Keyboard.KEY_RETURN:
             case Keyboard.KEY_NUMPADENTER:
-                GuiButton add = getButtonList().get(0);
+                if (key.isFocused() && autoCompleteList.getSelectedElement() != null) {
+                    key.setText(autoCompleteList.getSelectedElement());
+                    key.setFocused(false);
+                    value.setFocused(true);
+                    value.setText("1");
+                    value.setSelectionPos(0);
+                    return;
+                }
+                GuiButton add = getButtonList().get(ADD_BTN);
                 if (add.enabled) doActionPerformed(add);
                 return;
             case Keyboard.KEY_UP:
-                if (list.selectedIndex > 0) list.setSelection(list.selectedIndex - 1);
+                if (l.selectedIndex > 0) l.setSelection(l.selectedIndex - 1);
                 return;
             case Keyboard.KEY_DOWN:
-                if (list.selectedIndex < list.getNumElements() - 1) list.setSelection(list.selectedIndex + 1);
+                if (l.selectedIndex < l.getNumElements() - 1) l.setSelection(l.selectedIndex + 1);
                 return;
+            case Keyboard.KEY_ESCAPE:
+                if (key.isFocused()) {
+                    if (autoCompleteList.getSelectedElement() != null) {
+                        autoCompleteList.reset();
+                    } else {
+                        key.setFocused(false);
+                    }
+                    return;
+                }
+                break;
         }
         if (key.textboxKeyTyped(aChar, aKey)) {
             updateButtons();
@@ -250,10 +335,13 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
         // STACKOVERFLOW!
         String keyText = key.getText();
         boolean existing = !StringUtils.isEmpty(keyText) && ChannelDataAccessor.hasSubChannel(trigger, keyText);
-        getButtonList().get(0).displayString = existing ? I18n.format("item.structurelib.constructableTrigger.gui.set")
-                : I18n.format("item.structurelib.constructableTrigger.gui.add");
-        getButtonList().get(0).enabled = !StringUtils.isBlank(value.getText());
-        getButtonList().get(1).enabled = existing && !StringUtils.isBlank(value.getText());
+        getButtonList().get(ADD_BTN).displayString = existing ? I18n.format(I18N_PREFIX + "set")
+                : I18n.format(I18N_PREFIX + "add");
+        getButtonList().get(ADD_BTN).enabled = !StringUtils.isBlank(value.getText())
+                && Integer.parseInt(value.getText()) > 0;
+        getButtonList().get(UNSET_BTN).enabled = existing && !StringUtils.isBlank(value.getText());
+
+        autoCompleteList.reset();
     }
 
     private int getValue() {
@@ -268,18 +356,23 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
     protected void actionPerformed(GuiButton btn) {
         if (btn == null) return;
         switch (btn.id) {
-            case 0:
+            case ADD_BTN:
                 int value = getValue();
                 if (value <= 0) return;
                 ChannelDataAccessor.setChannelData(trigger, key.getText(), value);
                 break;
-            case 1:
+            case UNSET_BTN:
                 ChannelDataAccessor.unsetChannelData(trigger, key.getText());
                 break;
-            case 2:
+            case WIPE_BTN:
                 ChannelDataAccessor.wipeChannelData(trigger);
+                key.setText("");
+                this.value.setText("");
                 break;
         }
+
+        updateButtons();
+
         super.actionPerformed(btn);
     }
 
@@ -298,18 +391,17 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
     }
 
     @Override
-    public boolean doesGuiPauseGame() {
-        return false;
-    }
-
-    @Override
-    public void drawScreen(int mX, int mY, float partialTick) {
+    public void drawGuiContainerBackgroundLayer(float partialTick, int mX, int mY) {
         mc.renderEngine.bindTexture(new ResourceLocation("structurelib", "textures/gui/channels.png"));
         int topLeftX = (this.width - this.getXSize()) / 2;
         int topLeftY = (this.height - this.getYSize()) / 2;
         drawTexturedModalRect(topLeftX, topLeftY, 0, 0, getXSize(), getYSize());
-        super.drawScreen(mX, mY, partialTick);
         list.drawScreen(mX, mY, partialTick);
+        fontRendererObj.drawString(
+                I18n.format("item.structurelib.constructableTrigger.gui.title"),
+                guiLeft + 12,
+                guiTop + 9,
+                0);
         fontRendererObj.drawString(
                 I18n.format("item.structurelib.constructableTrigger.gui.key"),
                 guiLeft + 12,
@@ -324,6 +416,221 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
         value.drawTextBox();
     }
 
+    @Override
+    protected void drawGuiContainerForegroundLayer(int mouseX, int mouseY) {
+        if (key.isFocused() && autoCompleteList.getNumElements() > 0) {
+            autoCompleteList.drawScreen(mouseX, mouseY, 0);
+        }
+    }
+
+    @Override
+    public void drawScreen(int mouseX, int mouseY, float partialTicks) {
+        super.drawScreen(mouseX, mouseY, partialTicks);
+        String highlight = null;
+        if (key.isFocused() && autoCompleteList.getNumElements() > 0) {
+            highlight = autoCompleteList.getSelectedElement();
+        }
+        if (highlight == null && ChannelDescription.has(key.getText())) {
+            highlight = key.getText();
+        }
+        if (highlight != null) {
+            drawChannelDescriptionTooltip(highlight);
+        }
+        if (mouseX > xSize + guiLeft - INFO_BOX_SIZE - 12 && mouseX < xSize + guiLeft - 12
+                && mouseY > guiTop + 7
+                && mouseY < guiTop + INFO_BOX_SIZE + 7) {
+            drawHoveringText(info, mouseX, mouseY, fontRendererObj);
+        }
+    }
+
+    private void drawChannelDescriptionTooltip(String candidate) {
+        List<String> tooltip = tooltipSplitCache.computeIfAbsent(candidate, this::getChannelDescriptionTooltip);
+        drawHoveringText(tooltip, guiLeft + 151 + 12, guiTop + 122, fontRendererObj);
+    }
+
+    private List<String> getChannelDescriptionTooltip(String candidate) {
+        List<String> tooltip = new ArrayList<>();
+        int maxLine = width - (guiLeft + 151 + 12) - 12;
+        for (Entry<String, String> e : ChannelDescription.get(candidate).getDescriptions().entrySet()) {
+            tooltip.addAll(
+                    fontRendererObj.listFormattedStringToWidth(
+                            StatCollector.translateToLocalFormatted(
+                                    "item.structurelib.constructableTrigger.gui.channels.from",
+                                    Loader.instance().getIndexedModList().get(e.getKey()).getName()),
+                            maxLine));
+            tooltip.addAll(
+                    fontRendererObj.listFormattedStringToWidth(StatCollector.translateToLocal(e.getValue()), maxLine));
+        }
+        return tooltip;
+    }
+
+    public String trim(String str, int keyMaxWidth) {
+        Map<String, String> cache = trimCache.get(keyMaxWidth);
+        if (cache == null) {
+            trimCache.put(keyMaxWidth, cache = new HashMap<>());
+        }
+        return cache.computeIfAbsent(str, e -> {
+            String s = fontRendererObj.trimStringToWidth(e, keyMaxWidth);
+            if (s.length() != e.length()) {
+                StringBuilder buffer = new StringBuilder(s).deleteCharAt(s.length() - 1).append("...");
+                while ((s = fontRendererObj.trimStringToWidth(buffer.toString(), keyMaxWidth)).length()
+                        != buffer.length())
+                    // drop last original char
+                    buffer.deleteCharAt(s.length() - 4);
+                do {
+                    buffer.append('.');
+                } while (fontRendererObj.getStringWidth(buffer.toString()) <= keyMaxWidth);
+                s = buffer.deleteCharAt(s.length() - 1).insert(s.length() - 3, EnumChatFormatting.GRAY).toString();
+            }
+            return s;
+        });
+    }
+
+    @Override
+    @Optional.Method(modid = "NotEnoughItems")
+    public VisiblityData modifyVisiblity(GuiContainer gui, VisiblityData currentVisibility) {
+        return null;
+    }
+
+    @Override
+    public Iterable<Integer> getItemSpawnSlots(GuiContainer gui, ItemStack item) {
+        return Collections.emptyList();
+    }
+
+    @Override
+    public List<TaggedInventoryArea> getInventoryAreas(GuiContainer gui) {
+        return Collections.emptyList();
+    }
+
+    @Override
+    public boolean handleDragNDrop(GuiContainer gui, int mousex, int mousey, ItemStack draggedStack, int button) {
+        if (button != 0 || mousex <= guiLeft
+                || mousey <= guiTop
+                || mousex >= guiLeft + getXSize()
+                || mousey >= guiTop + getYSize()) {
+            return false;
+        }
+        Collection<Entry<String, Integer>> channels = ChannelDescription.iterate(draggedStack);
+        switch (channels.size()) {
+            case 0:
+                return false;
+            case 1:
+            default: // TODO implement a GUI to select which pair to use, instead of blindly using the first
+                Entry<String, Integer> e = channels.iterator().next();
+                ChannelDataAccessor.setChannelData(trigger, e.getKey(), e.getValue());
+                key.setText(e.getKey());
+                value.setText(e.getValue().toString());
+                draggedStack.stackSize = 0;
+                return true;
+        }
+    }
+
+    @Override
+    public boolean hideItemPanelSlot(GuiContainer gui, int x, int y, int w, int h) {
+        return false;
+    }
+
+    private class GuiAutoCompleteList extends GuiScrollableList<String> {
+
+        private List<Entry<String, String>> cache; // <key, display string>
+
+        public GuiAutoCompleteList(int width, int height, int originX, int originY, int slotHeight) {
+            super(width, height, originX, originY, slotHeight);
+            margin = 2;
+        }
+
+        private List<Entry<String, String>> getOptions() {
+            if (cache == null) {
+                cache = search();
+            }
+            return cache;
+        }
+
+        private List<Entry<String, String>> search() {
+            List<Entry<String, String>> cache = new ArrayList<>();
+            Set<String> added = new HashSet<>();
+            String term = key.getText();
+            String[] subjects = ChannelDescription.getAll().keySet().toArray(new String[0]);
+            Arrays.sort(subjects);
+            if (StringUtils.isBlank(term)) {
+                // nothing. just gives out everything
+                for (String subject : subjects) {
+                    cache.add(new AbstractMap.SimpleImmutableEntry<>(subject, EnumChatFormatting.GRAY + subject));
+                }
+                return cache;
+            }
+            // prefix match
+            for (String s : subjects) {
+                if (s.startsWith(term)) {
+                    cache.add(
+                            new AbstractMap.SimpleImmutableEntry<>(
+                                    s,
+                                    term + EnumChatFormatting.GRAY + s.substring(term.length())));
+                    added.add(s);
+                }
+            }
+            // subsequence match
+            for (String subject : subjects) {
+                if (!added.contains(subject) && subject.length() > term.length()) {
+                    int i = 0, j = 0;
+                    StringBuilder sb = new StringBuilder();
+                    boolean mode = true;
+                    sb.append(EnumChatFormatting.WHITE);
+                    while (i < term.length() && j < subject.length()) {
+                        if (term.codePointAt(i) == subject.codePointAt(j)) {
+                            if (!mode) {
+                                sb.append(EnumChatFormatting.WHITE);
+                                mode = true;
+                            }
+                            sb.appendCodePoint(term.codePointAt(i));
+                            i++;
+                            j++;
+                        } else {
+                            if (mode) {
+                                sb.append(EnumChatFormatting.GRAY);
+                                mode = false;
+                            }
+                            sb.appendCodePoint(subject.codePointAt(j));
+                            j++;
+                        }
+                    }
+                    if (i == term.length()) {
+                        if (j < subject.length()) {
+                            sb.append(EnumChatFormatting.GRAY);
+                            sb.append(subject, j, subject.length());
+                        }
+                        cache.add(new AbstractMap.SimpleImmutableEntry<>(subject, sb.toString()));
+                        added.add(subject);
+                    }
+                }
+            }
+            return cache;
+        }
+
+        public void reset() {
+            cache = search();
+            selectedIndex = cache.isEmpty() ? -1 : 0;
+            resetScroll();
+        }
+
+        @Override
+        public String getElementAt(int index) {
+            return index >= 0 && index < cache.size() ? getOptions().get(index).getKey() : null;
+        }
+
+        @Override
+        public int getNumElements() {
+            return getOptions().size();
+        }
+
+        @Override
+        protected void drawElement(int elementIndex, int x, int y, int height, Tessellator tessellator,
+                boolean isHovering) {
+            int color = elementIndex == selectedIndex ? 0xffffff : 0xcccccc;
+            fontRendererObj.drawString(getOptions().get(elementIndex).getValue(), x + margin, y + margin / 2, color);
+        }
+    }
+
     private class GuiChannelsList extends GuiScrollableList<Entry<String, Integer>> {
 
         private List<Entry<String, Integer>> cache;
@@ -350,6 +657,7 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
                 Entry<String, Integer> e = getElementAt(elementIndex);
                 if (e != null) {
                     ChannelDataAccessor.unsetChannelData(trigger, e.getKey());
+                    updateButtons();
                     return false;
                 }
             }
@@ -390,22 +698,5 @@ public class GuiScreenConfigureChannels extends GuiScreen implements IGuiScreen
             // args x1, y1, y2, color
             drawVerticalLine(minX + margin + margin / 2 + KEY_MAX_WIDTH * 2, minY + 1, maxY - 1, 0xffaaaaaa);
         }
-
-        public String trim(String e, int keyMaxWidth) {
-            // TODO optimize this to not create a billion string, or maybe cache this
-            String s = fontRendererObj.trimStringToWidth(e, keyMaxWidth);
-            if (s.length() != e.length()) {
-                StringBuilder buffer = new StringBuilder(s).deleteCharAt(s.length() - 1).append("...");
-                while ((s = fontRendererObj.trimStringToWidth(buffer.toString(), keyMaxWidth)).length()
-                        != buffer.length())
-                    // drop last original char
-                    buffer.deleteCharAt(s.length() - 4);
-                do {
-                    buffer.append('.');
-                } while (fontRendererObj.getStringWidth(buffer.toString()) <= keyMaxWidth);
-                s = buffer.deleteCharAt(s.length() - 1).insert(s.length() - 3, EnumChatFormatting.GRAY).toString();
-            }
-            return s;
-        }
     }
 }

src/main/java/com/gtnewhorizon/structurelib/gui/GuiScrollableList.java

@@ -16,7 +16,7 @@ import org.lwjgl.opengl.GL11;
  * <p>
  * As the code has been released into public domain, it is now LGPL as part of this library as a whole. You can go to
  * EnderCore's repository to obtain a public domain copy though
- *
+ * <p>
  * Major edits
  * <ul>
  * <li>Separate dwheel handling to handleDWheel. The next event calls often cause the mouse click event to not fire on
@@ -167,10 +167,17 @@ public abstract class GuiScrollableList<T> {
         }
     }
 
+    protected void resetScroll() {
+        amountScrolled = 0;
+    }
+
     /**
      * draws the slot to the screen, pass in mouse's current x and y and partial ticks
      */
     public void drawScreen(int mX, int mY, float partialTick) {
+        GL11.glPushMatrix();
+        GL11.glLoadIdentity();
+        GL11.glTranslatef(0.0F, 0.0F, -2000.0F);
         this.mouseX = mX;
         this.mouseY = mY;
 
@@ -199,13 +206,26 @@ public abstract class GuiScrollableList<T> {
         int contentYOffset = this.minY + margin - amountScrolled;
 
         boolean hoveringPrecondition = mX >= minX && mX <= maxX && mY >= minY && mY <= maxY;
+        int slotHeight = this.slotHeight - margin;
+
+        if (selectedIndex != -1) {
+            int elementY = contentYOffset + selectedIndex * this.slotHeight;
+            if (elementY + slotHeight > maxY) {
+                this.amountScrolled = (selectedIndex + 1) * this.slotHeight - this.height + margin;
+                amountScrolled = (int) this.amountScrolled;
+                contentYOffset = this.minY + margin - amountScrolled;
+            } else if (elementY < minY) {
+                this.amountScrolled = selectedIndex * this.slotHeight;
+                amountScrolled = (int) this.amountScrolled;
+                contentYOffset = this.minY + margin - amountScrolled;
+            }
+        }
 
         prepareDrawElements();
 
         for (int i = 0; i < getNumElements(); ++i) {
 
             int elementY = contentYOffset + i * this.slotHeight;
-            int slotHeight = this.slotHeight - margin;
 
             if (elementY <= maxY && elementY + slotHeight >= minY) {
 
@@ -264,6 +284,7 @@ public abstract class GuiScrollableList<T> {
         GL11.glShadeModel(GL11.GL_FLAT);
         GL11.glEnable(GL11.GL_ALPHA_TEST);
         GL11.glDisable(GL11.GL_BLEND);
+        GL11.glPopMatrix();
     }
 
     protected void prepareDrawElements() {}
@@ -412,7 +433,7 @@ public abstract class GuiScrollableList<T> {
         GL11.glColor4f(1.0F, 1.0F, 1.0F, 1.0F);
         GL11.glDisable(GL11.GL_TEXTURE_2D);
         tess.startDrawingQuads();
-        tess.setColorOpaque_I(2105376);
+        tess.setColorOpaque_I(0x202020);
         tess.addVertex(minX, maxY, 0.0D);
         tess.addVertex(maxX, maxY, 0.0D);
         tess.addVertex(maxX, minY, 0.0D);

src/main/java/com/gtnewhorizon/structurelib/item/ItemConstructableTrigger.java

@@ -7,9 +7,14 @@ import static net.minecraft.util.StatCollector.translateToLocalFormatted;
 
 import java.util.List;
 
+import net.minecraft.client.renderer.texture.IIconRegister;
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.item.Item;
 import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.nbt.NBTTagInt;
+import net.minecraft.util.IIcon;
+import net.minecraft.util.StatCollector;
 import net.minecraft.world.World;
 
 import org.lwjgl.input.Keyboard;
@@ -18,17 +23,61 @@ import com.gtnewhorizon.structurelib.StructureLib;
 import com.gtnewhorizon.structurelib.alignment.constructable.ChannelDataAccessor;
 import com.gtnewhorizon.structurelib.alignment.constructable.ConstructableUtility;
 
-public class ItemConstructableTrigger extends Item {
+public class ItemConstructableTrigger extends ModeToggleableItem {
+
+    private static final IIcon[] textures = new IIcon[3];
 
     public ItemConstructableTrigger() {
         setUnlocalizedName("structurelib.constructableTrigger");
-        setTextureName(MOD_ID + ":itemConstructableTrigger");
         setCreativeTab(StructureLib.creativeTab);
     }
 
+    @Override
+    public void registerIcons(IIconRegister register) {
+        textures[0] = register.registerIcon(MOD_ID + ":constructableTrigger/BUILDING");
+        textures[1] = register.registerIcon(MOD_ID + ":constructableTrigger/UPDATING");
+        textures[2] = register.registerIcon(MOD_ID + ":constructableTrigger/REMOVING");
+    }
+
+    @Override
+    public IIcon getIcon(ItemStack stack, int renderPass, EntityPlayer player, ItemStack usingItem, int useRemaining) {
+        return getIcon(stack, renderPass);
+    }
+
+    @Override
+    public IIcon getIcon(ItemStack stack, int pass) {
+        if (!stack.hasTagCompound() || !stack.getTagCompound().hasKey(TAG_MODE)) {
+            return textures[0];
+        }
+        return textures[stack.getTagCompound().getInteger(TAG_MODE)];
+    }
+
+    @Override
+    public String getItemStackDisplayName(ItemStack stack) {
+        if (!stack.hasTagCompound() || !stack.getTagCompound().hasKey(TAG_MODE)) {
+            return getDisplayName(0);
+        }
+        return getDisplayName(stack.getTagCompound().getInteger(TAG_MODE));
+    }
+
+    @Override
+    public IIcon getIconIndex(ItemStack stack) {
+        return getIcon(stack, 0);
+    }
+
+    @Override
+    public IIcon getIconFromDamage(int damage) {
+        return textures[damage];
+    }
+
+    private String getDisplayName(int mode) {
+        return StatCollector.translateToLocal("item.structurelib.constructableTrigger.name") + " - "
+                + StatCollector.translateToLocal("item.structurelib.constructableTrigger.modes." + mode);
+    }
+
     @Override
     public ItemStack onItemRightClick(ItemStack stack, World world, EntityPlayer player) {
-        if (world.isRemote && getMovingObjectPositionFromPlayer(world, player, true) == null) {
+        if (!world.isRemote && getMovingObjectPositionFromPlayer(world, player, true) == null) {
             if (player.isSneaking()) {
                 StructureLib.instance().proxy().displayConfigGUI("registries");
             } else {

src/main/java/com/gtnewhorizon/structurelib/item/ModeToggleableItem.java

@@ -0,0 +1,32 @@
+package com.gtnewhorizon.structurelib.item;
+
+import net.minecraft.item.Item;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.nbt.NBTTagInt;
+
+public class ModeToggleableItem extends Item {
+
+    public enum TriggerMode {
+        BUILDING,
+        UPDATING,
+        REMOVING
+    }
+
+    public static TriggerMode getMode(ItemStack held) {
+        if (held == null || !held.hasTagCompound() || !held.getTagCompound().hasKey(TAG_MODE)) {
+            // default behavior
+            return TriggerMode.BUILDING;
+        }
+        // get user-defined mode
+        return TriggerMode.values()[held.getTagCompound().getInteger(TAG_MODE)];
+    }
+
+    public static void cycleMode(ItemStack held) {
+        if (held.getTagCompound() == null) held.setTagCompound(new NBTTagCompound());
+        if (!held.getTagCompound().hasKey(TAG_MODE)) held.getTagCompound().setTag(TAG_MODE, new NBTTagInt(0));
+        held.getTagCompound().setInteger(TAG_MODE, (held.getTagCompound().getInteger(TAG_MODE) + 1) % 3);
+    }
+
+    protected static final String TAG_MODE = "mode";
+}

src/main/java/com/gtnewhorizon/structurelib/structure/IStructureDefinition.java

@@ -12,6 +12,7 @@ import net.minecraft.world.World;
 
 import com.gtnewhorizon.structurelib.StructureLib;
 import com.gtnewhorizon.structurelib.StructureLibAPI;
+import com.gtnewhorizon.structurelib.alignment.constructable.ChannelDataAccessor;
 import com.gtnewhorizon.structurelib.alignment.constructable.ISurvivalConstructable;
 import com.gtnewhorizon.structurelib.alignment.enumerable.ExtendedFacing;
 
@@ -50,7 +51,7 @@ import com.gtnewhorizon.structurelib.alignment.enumerable.ExtendedFacing;
  * itself.</li>
  * <li>The "C" position would be the number of blocks between you and controller, not counting controller itself.</li>
  * </ul>
- * 
+ *
  * @param <T> Type of the context object. Usually this will be the multiblock controller.
  */
 public interface IStructureDefinition<T> {
@@ -72,7 +73,7 @@ public interface IStructureDefinition<T> {
 
     /**
      * Run a structure check.
-     * 
+     *
      * @param object              context object. usually multiblock controller.
      * @param piece               the structure piece's string identifier.
      * @param world               the world object this check takes place in.
@@ -107,7 +108,7 @@ public interface IStructureDefinition<T> {
 
     /**
      * Spawn hint particles. Should not be called on server side.
-     * 
+     *
      * @param object         context object. usually multiblock controller.
      * @param piece          the structure piece's string identifier.
      * @param world          the world object this check takes place in.
@@ -320,7 +321,7 @@ public interface IStructureDefinition<T> {
 
     /**
      * Low level utility.
-     * 
+     *
      * @param object                                  context object. usually multiblock controller.
      * @param trigger                                 The trigger item that contains channel data.
      * @param elements                                the structure piece
@@ -347,80 +348,54 @@ public interface IStructureDefinition<T> {
         }
 
         if (checkBlocksIfNotNullForceCheckAllIfTrue != null) {
-            boolean success;
-            if (checkBlocksIfNotNullForceCheckAllIfTrue) {
-                success = StructureUtility.iterateV2(
-                        elements,
-                        world,
-                        extendedFacing,
-                        basePositionX,
-                        basePositionY,
-                        basePositionZ,
-                        basePositionA,
-                        basePositionB,
-                        basePositionC,
-                        (e, w, x, y, z, a, b, c) -> e.check(object, w, x, y, z),
-                        "check");
-            } else {
-                success = StructureUtility.iterateV2(
-                        elements,
-                        world,
-                        extendedFacing,
-                        basePositionX,
-                        basePositionY,
-                        basePositionZ,
-                        basePositionA,
-                        basePositionB,
-                        basePositionC,
-                        skipBlockUnloaded((e, w, x, y, z, a, b, c) -> e.check(object, w, x, y, z)),
-                        "check force");
-            }
+            boolean success = StructureUtility.iterateV2(
+                    elements,
+                    world,
+                    extendedFacing,
+                    basePositionX,
+                    basePositionY,
+                    basePositionZ,
+                    basePositionA,
+                    basePositionB,
+                    basePositionC,
+                    checkBlocksIfNotNullForceCheckAllIfTrue ? (e, w, x, y, z, a, b, c) -> e.check(object, w, x, y, z)
+                            : skipBlockUnloaded((e, w, x, y, z, a, b, c) -> e.check(object, w, x, y, z)),
+                    checkBlocksIfNotNullForceCheckAllIfTrue ? "check" : "check force");
             if (StructureLibAPI.isDebugEnabled() && success) {
                 StructureLib.LOGGER
                         .info("Multi [" + basePositionX + ", " + basePositionY + ", " + basePositionZ + "] pass");
             }
             return success;
         } else {
-            if (hintsOnly) {
-                StructureUtility.iterateV2(
-                        elements,
-                        world,
-                        extendedFacing,
-                        basePositionX,
-                        basePositionY,
-                        basePositionZ,
-                        basePositionA,
-                        basePositionB,
-                        basePositionC,
-                        ignoreBlockUnloaded((e, w, x, y, z, a, b, c) -> {
-                            e.spawnHint(object, world, x, y, z, trigger);
-                            return true;
-                        }),
-                        "spawnHint");
-            } else {
-                StructureUtility.iterateV2(
-                        elements,
-                        world,
-                        extendedFacing,
-                        basePositionX,
-                        basePositionY,
-                        basePositionZ,
-                        basePositionA,
-                        basePositionB,
-                        basePositionC,
-                        ignoreBlockUnloaded((e, w, x, y, z, a, b, c) -> {
-                            e.placeBlock(object, world, x, y, z, trigger);
-                            return true;
-                        }),
-                        "placeBlock");
-            }
+            StructureUtility.iterateV2(
+                    elements,
+                    world,
+                    extendedFacing,
+                    basePositionX,
+                    basePositionY,
+                    basePositionZ,
+                    basePositionA,
+                    basePositionB,
+                    basePositionC,
+                    hintsOnly ? ignoreBlockUnloaded((e, w, x, y, z, a, b, c) -> {
+                        e.spawnHint(object, world, x, y, z, trigger);
+                        if (ChannelDataAccessor.hasSubChannel(trigger, "show_error")
+                                && !e.couldBeValid(object, world, x, y, z, trigger)) {
+                            StructureLibAPI.markHintParticleError(StructureLib.getCurrentPlayer(), world, x, y, z);
+                        }
+                        return true;
+                    }) : ignoreBlockUnloaded((e, w, x, y, z, a, b, c) -> {
+                        e.placeBlock(object, world, x, y, z, trigger);
+                        return true;
+                    }),
+                    hintsOnly ? "spawnHint" : "placeBlock");
         }
         return true;
     }
 
     /**
      * Create a new instance of builder.
-     * 
+     *
      * @param <T> type of context object
      */
     static <T> StructureDefinition.Builder<T> builder() {

src/main/java/com/gtnewhorizon/structurelib/structure/IStructureElement.java

@@ -2,6 +2,8 @@ package com.gtnewhorizon.structurelib.structure;
 
 import static com.gtnewhorizon.structurelib.StructureLib.LOGGER;
 import static com.gtnewhorizon.structurelib.StructureLib.PANIC_MODE;
+import static com.gtnewhorizon.structurelib.item.ModeToggleableItem.TriggerMode.REMOVING;
+import static com.gtnewhorizon.structurelib.structure.StructureUtility.checkForRemoving;
 
 import java.util.Arrays;
 import java.util.Collections;
@@ -21,6 +23,7 @@ import net.minecraft.util.IChatComponent;
 import net.minecraft.world.World;
 
 import com.gtnewhorizon.structurelib.StructureLibAPI;
+import com.gtnewhorizon.structurelib.item.ItemConstructableTrigger;
 import com.gtnewhorizon.structurelib.util.ItemStackPredicate;
 import com.gtnewhorizon.structurelib.util.ItemStackPredicate.NBTMode;
 
@@ -32,6 +35,16 @@ public interface IStructureElement<T> {
 
     boolean check(T t, World world, int x, int y, int z);
 
+    /**
+     * Pure (stateless and side effect free) function to test if current block could be valid. Used to give user hints
+     * about incorrectly placed blocks given a controller and trigger item. If couldBeValid(...) == false for a set of
+     * channels, with those same tiers, check(...) == false. Not required, defaults to true which is always safe but
+     * won't give the user error hints.
+     */
+    default boolean couldBeValid(T t, World world, int x, int y, int z, ItemStack trigger) {
+        return true;
+    }
+
     boolean spawnHint(T t, World world, int x, int y, int z, ItemStack trigger);
 
     boolean placeBlock(T t, World world, int x, int y, int z, ItemStack trigger);
@@ -127,12 +140,14 @@ public interface IStructureElement<T> {
      */
     default PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger,
             AutoPlaceEnvironment env) {
+        ItemConstructableTrigger.TriggerMode mode = ItemConstructableTrigger.getMode(trigger);
         BlocksToPlace e = getBlocksToPlace(t, world, x, y, z, trigger, env);
         IItemSource source = env.getSource();
         EntityPlayer actor = env.getActor();
         Consumer<IChatComponent> chatter = env.getChatter();
         if (e != null) {
-            if (check(t, world, x, y, z)) return PlaceResult.SKIP;
+            PlaceResult skipOrRejectBasedOnCheck = checkForRemoving(mode, check(t, world, x, y, z), world, x, y, z);
+            if (skipOrRejectBasedOnCheck != PlaceResult.ACCEPT) return skipOrRejectBasedOnCheck;
             if (e.getStacks() == null) {
                 ItemStack taken = source.takeOne(e.getPredicate(), true);
                 return StructureUtility.survivalPlaceBlock(
@@ -149,7 +164,7 @@ public interface IStructureElement<T> {
                         chatter);
             }
             for (ItemStack stack : e.getStacks()) {
-                if (!source.takeOne(stack, true)) continue;
+                if (mode != REMOVING && !source.takeOne(stack, true)) continue;
                 return StructureUtility.survivalPlaceBlock(
                         stack,
                         NBTMode.EXACT,
@@ -185,6 +200,11 @@ public interface IStructureElement<T> {
                 return IStructureElement.this.check(t, world, x, y, z);
             }
 
+            @Override
+            public boolean couldBeValid(T t, World world, int x, int y, int z, ItemStack trigger) {
+                return IStructureElement.this.couldBeValid(t, world, x, y, z, trigger);
+            }
+
             @Override
             public boolean spawnHint(T t, World world, int x, int y, int z, ItemStack trigger) {
                 return IStructureElement.this.spawnHint(t, world, x, y, z, trigger);

src/main/java/com/gtnewhorizon/structurelib/structure/IStructureElementChain.java

@@ -31,6 +31,16 @@ public interface IStructureElementChain<T> extends IStructureElement<T> {
         return false;
     }
 
+    @Override
+    default boolean couldBeValid(T t, World world, int x, int y, int z, ItemStack trigger) {
+        for (IStructureElement<T> fallback : fallbacks()) {
+            if (fallback.couldBeValid(t, world, x, y, z, trigger)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     @Override
     default boolean spawnHint(T t, World world, int x, int y, int z, ItemStack trigger) {
         for (IStructureElement<T> fallback : fallbacks()) {
@@ -62,7 +72,8 @@ public interface IStructureElementChain<T> extends IStructureElement<T> {
             if (e == null) continue;
             if (predicate == null) predicate = e.getPredicate();
             else predicate = predicate.or(e.getPredicate());
-            is.add(e.getStacks());
+            Iterable<ItemStack> stacks = e.getStacks();
+            if (stacks != null) is.add(stacks);
         }
         if (predicate == null) return null;
         return new BlocksToPlace(predicate, Iterables.concat(is));

src/main/java/com/gtnewhorizon/structurelib/structure/IStructureElementCheckOnly.java

@@ -14,6 +14,11 @@ public interface IStructureElementCheckOnly<T> extends IStructureElement<T> {
         return false;
     }
 
+    @Override
+    default boolean couldBeValid(T t, World world, int x, int y, int z, ItemStack trigger) {
+        return true;
+    }
+
     @Override
     default boolean spawnHint(T t, World world, int x, int y, int z, ItemStack trigger) {
         return false;

src/main/java/com/gtnewhorizon/structurelib/structure/IStructureNavigate.java

@@ -17,6 +17,11 @@ interface IStructureNavigate<T> extends IStructureElement<T> {
         return true;
     }
 
+    @Override
+    default boolean couldBeValid(T t, World world, int x, int y, int z, ItemStack trigger) {
+        return true;
+    }
+
     @Override
     default boolean spawnHint(T t, World world, int x, int y, int z, ItemStack trigger) {
         return true;

src/main/java/com/gtnewhorizon/structurelib/structure/LazyStructureElement.java

@@ -32,6 +32,11 @@ class LazyStructureElement<T> implements IStructureElementDeferred<T> {
         return get(t).check(t, world, x, y, z);
     }
 
+    @Override
+    public boolean couldBeValid(T t, World world, int x, int y, int z, ItemStack trigger) {
+        return get(t).couldBeValid(t, world, x, y, z, trigger);
+    }
+
     @Override
     public boolean placeBlock(T t, World world, int x, int y, int z, ItemStack trigger) {
         return get(t).placeBlock(t, world, x, y, z, trigger);

src/main/javadoc/overview.html

@@ -133,6 +133,16 @@ StructureLib API documentation.
     Usually there is no reason to reimplement this on your own.
 </p>
 
+<h2>{@link com.gtnewhorizon.structurelib.item.ModeToggleableItem}</h2>
+<p>
+    This class is the base class for {@link com.gtnewhorizon.structurelib.item.ItemConstructableTrigger} that defines
+    the <code>TriggerMode</code>s for the {@link com.gtnewhorizon.structurelib.item.ItemConstructableTrigger}. There are
+    3 modes, <code>BUILDING</code>, <code>UPDATING</code>, and <code>REMOVING</code>. Each of these modes does as they
+    say, where building will build a new multi from scratch, updating will remove existing an existing structure and
+    replace it with new components (think upgrading glass on a multi, changing from a tier 1 to tier 2 of a multi, etc),
+    and removing will just straight up remove the multi.
+</p>
+
 <h2><a href="#channels" id="channels">Channels</a></h2>
 
 <p>
@@ -178,6 +188,80 @@ StructureLib API documentation.
 
 Just give me a better name and I'd do the renaming.
 
+<h3>Channel Descriptions</h3>
+<p>
+    Each channel can have one description associated with it per mod.
+    Channel description should briefly describe how a specific channel is used for inside a specific mod.
+    They will be displayed to player in channel editor GUI that comes with StructureLib.
+    The registration process can be done either via direct method call to {@link com.gtnewhorizon.structurelib.StructureLibAPI#registerChannelDescription(String, String, String)},
+    or by sending an IMC message.
+    After registration, the channel will also show up as autocomplete options when players are editing channels.
+</p>
+
+<p>
+    Here is an example of sending an IMC message to register two channels and their description.
+    In this example, we assume your modid is <code>my_mod</code> and your mod will ship with localization entries for
+    localization key <code>channels.my_mod.channel_1</code> and <code>channels.my_mod.channel_2</code>
+</p>
+
+<pre>
+        NBTTagCompound command = new NBTTagCompound();
+        NBTTagList tags = new NBTTagList();
+        String[] channels = {"channel_1", "channel_2"};
+        for (String channel : channels) {
+            NBTTagCompound tag = new NBTTagCompound();
+            tag.setString("Channel", channel);
+            tag.setString("Description", "channels.my_mod." + channel);
+            tags.appendTag(tag);
+        }
+        command.setTag("Channels", tags);
+        FMLInterModComms.sendMessage("structurelib", "register_channel", command);
+</pre>
+
+<p>
+    There is no strict rules over whether you should do direct API method call or send IMC messages.
+    You can choose whichever you prefer.
+</p>
+
+<h3>Channel Indicator Items</h3>
+<p>
+    You can associate an ItemStack with a given (channel, value) pair.
+    It is usually (but not required to be) the ItemBlock for the blocks to be placed by this (channel, value) pair.
+    Player will be able to drag and drop this item to the builtin channel configuration GUI.
+    The registration process can be done either via direct method call to {@link com.gtnewhorizon.structurelib.StructureLibAPI#registerChannelItem(String, String, int, net.minecraft.item.ItemStack)},
+    or by sending an IMC message.
+    After registration, the channel will also show up as autocomplete options when players are editing channels.
+</p>
+
+<p>
+    Here is an example of sending an IMC message to register 3 vanilla sandstone as different indicator for channel "sandstone", with block metadata plus 1 as channel value.
+    In this example, we assume your modid is <code>my_mod</code>.
+</p>
+
+<pre>
+        NBTTagCompound command = new NBTTagCompound();
+        NBTTagList items = new NBTTagList();
+        int[] metas = {0, 1, 2};
+        for (int meta : metas) {
+            NBTTagCompound tag = new NBTTagCompound();
+            tag.setTag("Item", new ItemStack(Blocks.sandstone, 1, meta).writeToNBT(new NBTTagCompound()));
+            NBTTagList channels = new NBTTagList();
+            NBTTagCompound channel = new NBTTagCompound();
+            channel.setString("Channel", "sandstone");
+            channel.setInteger("Value", meta + 1);
+            channels.appendTag(channel);
+            tag.setTag("Channels", channels);
+            items.appendTag(tag);
+        }
+        command.setTag("Items", items);
+        FMLInterModComms.sendMessage("structurelib", "register_channel_item", command);
+</pre>
+
+<p>
+    There is no strict rules over whether you should do direct API method call or send IMC messages.
+    You can choose whichever you prefer.
+</p>
+
 <h3>Examples</h3>
 
 <h4>For Structure Definition Author</h4>

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

@@ -1,3 +1,4 @@
+tile.structurelib.blockhint.name=Hint
 tile.structurelib.blockhint.0.name=Hint 1 dot
 tile.structurelib.blockhint.1.name=Hint 2 dots
 tile.structurelib.blockhint.2.name=Hint 3 dots
@@ -21,6 +22,9 @@ item.structurelib.frontRotationTool.desc.1=Rotates only the front panel,
 item.structurelib.frontRotationTool.desc.2=which allows structure rotation.
 
 item.structurelib.constructableTrigger.name=Multiblock Structure Hologram Projector
+item.structurelib.constructableTrigger.modes.0=Building Mode
+item.structurelib.constructableTrigger.modes.1=Updating Mode
+item.structurelib.constructableTrigger.modes.2=Removing Mode
 item.structurelib.constructableTrigger.desc.0=Triggers Constructable Interface
 item.structurelib.constructableTrigger.desc.1=Shows multiblock construction schematic,
 item.structurelib.constructableTrigger.desc.2=use on the multiblock controller.
@@ -29,12 +33,26 @@ item.structurelib.constructableTrigger.desc.4=Quantity of schematics in item sta
 item.structurelib.constructableTrigger.desc.5=Hold §l[LSHIFT]§r to display channel data
 item.structurelib.constructableTrigger.desc.lshift.0=Contain %d sub channel.
 item.structurelib.constructableTrigger.too_fast=Please wait %d milliseconds before another autoplace...
+item.structurelib.constructableTrigger.gui.title=Sub Channels
 item.structurelib.constructableTrigger.gui.key=Key:
 item.structurelib.constructableTrigger.gui.value=Value:
 item.structurelib.constructableTrigger.gui.add=Add
 item.structurelib.constructableTrigger.gui.set=Set
 item.structurelib.constructableTrigger.gui.unset=Unset
 item.structurelib.constructableTrigger.gui.wipe=§4Wipe
+item.structurelib.constructableTrigger.gui.error.show=Show Errors
+item.structurelib.constructableTrigger.gui.error.hide=Hide Errors
+item.structurelib.constructableTrigger.gui.gt_no_hatch.enable=No Hatch
+item.structurelib.constructableTrigger.gui.gt_no_hatch.disable=Hatches
+item.structurelib.constructableTrigger.keyCategory=Multiblock Structure Hologram Projector Keys
+item.structurelib.constructableTrigger.keys.cycleMode=Cycle Projector Mode
+item.structurelib.constructableTrigger.gui.channels.from=§rMod: §9§o%s
+item.structurelib.constructableTrigger.gui.info=Many multiblocks support some degree of variation in its structure and use sub channels to indicate which variant to use.\n Sub channels are has a sequence of lower case characters as key and a positive integer as value. Most known sub channels should be available as typeahead completions.\nYou can also drag and drop items from NEI to set the corresponding sub channel value. These items all have a tooltip of §oIndicates value X for sub channel Y§r.
+
+channels.structurelib.show_errors=When set, will highlight parts of the multiblock that is definitely wrong
+
+structurelib.tooltip.channelvalue=§7Indicates value §6%d§r§7 for sub channel §6%s
+structurelib.tooltip.indicator_dnd=Drop into GUI to select this value for this channel
 
 structurelib.autoplace.built_stat=Built %s blocks
 structurelib.autoplace.complete=§aThis multiblock has completed!

src/main/resources/assets/structurelib/lang/zh_CN.lang

@@ -1,3 +1,4 @@
+tile.structurelib.blockhint.name=提示方块
 tile.structurelib.blockhint.0.name=提示方块：1号
 tile.structurelib.blockhint.1.name=提示方块：2号
 tile.structurelib.blockhint.2.name=提示方块：3号
@@ -29,12 +30,20 @@ item.structurelib.constructableTrigger.desc.4=此物品堆叠数量会影响显
 item.structurelib.constructableTrigger.desc.5=按下 §l[左SHIFT]§r 以显示子信道
 item.structurelib.constructableTrigger.desc.lshift.0=包含 %d 个子信道
 item.structurelib.constructableTrigger.too_fast=请在下一次自动搭建前等待 %d 毫秒...
+item.structurelib.constructableTrigger.gui.title=子信道
 item.structurelib.constructableTrigger.gui.key=信道名:
 item.structurelib.constructableTrigger.gui.value=值:
 item.structurelib.constructableTrigger.gui.add=添加
 item.structurelib.constructableTrigger.gui.set=替换
 item.structurelib.constructableTrigger.gui.unset=删除
 item.structurelib.constructableTrigger.gui.wipe=§4全部清空
+item.structurelib.constructableTrigger.gui.channels.from=§r模组: §9§o%s
+item.structurelib.constructableTrigger.gui.info=许多多方块的结构都是可变的，在自动放置时，可以使用子信道来向多方块指明该使用哪一个变体。\n子信道由一个字符串标识、并拥有一个正整数作为值。这个GUI中的信道名支持自动补全到绝大多数已知的子信道。\n你也可以将部分物品从NEI中拖拽至GUI内来设置子信道值为该物品表示的值。这些物品的物品说明中都带有§o表示子信道 X 为 Y§r。
+
+channels.structurelib.show_errors=添加后，在投影时会高亮标出必然错误的部分
+
+structurelib.tooltip.channelvalue=§7表示子信道 §6%2$s§r§7 为 §6%d§r
+structurelib.tooltip.indicator_dnd=拖入GUI中来选择该值
 
 structurelib.autoplace.built_stat=已放置 %s 个方块
 structurelib.autoplace.complete=§a这个多方块结构已经完成自动搭建！