Cleaning up the ME GUIs (Items+Fluids) (AppliedEnergistics#5105)

Completely refactor all UI. Introduce JSON based definitions for screens (can be overridden in resource packs). Unifies fluid and item terminal UI code. Serializes item data from server->client using "share tags" (i.e. don't include the content of bags if they support that), and no longer synchronize capability data to the client. Use "serial numbers" to refer back to items on the server when a player interacts with items in terminals. This should fix AppliedEnergistics#5083 "for good" while still using less network bandwidth. It should also fix AppliedEnergistics#5199 because serialization of items into packets is rewritten and now uses a length-prefix, reducing the chance for corrupted packets due to very long item NBT data.
Rewrote crafting status / network status to use custom packets rather than reusing the inventory sync packets.

Also implements AppliedEnergistics#3787, AppliedEnergistics#3922

Also adds:
    Start using share tags / stop sending caps to clients, which should reduce bandwidth usage when opening terminals
    Consider missing items on "shift-clickicking" recipes into the crafting terminal from JEI
    Adds tooltip indicating which upgrades are compatible to the upgrade panel for various machines
    Adds information on how priority works to the priority screen
    Use standard slots for the player inventory, which should fix most inventory sorting mods moving the hotbar into the main inventory when sorting the player inventory within an AE2 screen.
    Add clickable "show recipes" areas that open the appropriate JEI category to the inscriber and grindstone

.gitignore

@@ -11,7 +11,7 @@
 !.travis.yml
 
 # include markdowns
-!README.md
+!*.md
 !LICENSE
 
 # include sourcecode except generated

build.gradle

@@ -81,6 +81,8 @@ dependencies {
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.1")
     testImplementation("org.assertj:assertj-core:3.19.0")
     testImplementation("com.google.guava:guava-testlib:21.0")
+    testImplementation("org.mockito:mockito-junit-jupiter:3.9.0")
+    testImplementation("org.mockito:mockito-inline:3.9.0")
 
     // Annotation Processors
     annotationProcessor 'org.spongepowered:mixin:0.8:processor'

src/api/java/appeng/api/config/SecurityPermissions.java

@@ -25,6 +25,9 @@
 
 import java.util.Locale;
 
+import net.minecraft.util.text.ITextComponent;
+import net.minecraft.util.text.TranslationTextComponent;
+
 /**
  * Represent the security systems basic permissions, these are not for anti-griefing, they are part of the mod as a
  * gameplay feature.
@@ -59,11 +62,15 @@ public enum SecurityPermissions {
 
     private final String translationKey = "gui.appliedenergistics2.security." + this.name().toLowerCase(Locale.ROOT);
 
-    public String getTranslatedName() {
-        return this.translationKey + ".name";
+    private final ITextComponent displayName = new TranslationTextComponent(this.translationKey + ".name");
+
+    private final ITextComponent displayHint = new TranslationTextComponent(this.translationKey + ".tip");
+
+    public ITextComponent getDisplayName() {
+        return this.displayName;
     }
 
-    public String getTranslatedTip() {
-        return this.translationKey + ".tip";
+    public ITextComponent getDisplayHint() {
+        return this.displayHint;
     }
 }

src/api/java/appeng/api/config/Upgrades.java

@@ -44,19 +44,29 @@ public enum Upgrades {
     /**
      * Gold Tier Upgrades.
      */
-    CAPACITY(0), REDSTONE(0), CRAFTING(0),
+    CAPACITY("item.appliedenergistics2.capacity_card", 0),
+    REDSTONE("item.appliedenergistics2.redstone_card", 0),
+    CRAFTING("item.appliedenergistics2.crafting_card", 0),
 
     /**
      * Diamond Tier Upgrades.
      */
-    FUZZY(1), SPEED(1), INVERTER(1);
+    FUZZY("item.appliedenergistics2.fuzzy_card", 1),
+    SPEED("item.appliedenergistics2.speed_card", 1),
+    INVERTER("item.appliedenergistics2.inverter_card", 1);
 
     private final int tier;
+    private final ITextComponent displayName;
     private final List<Supported> supported = new ArrayList<>();
     private List<ITextComponent> supportedTooltipLines;
 
-    Upgrades(final int tier) {
+    Upgrades(final String translationKey, final int tier) {
         this.tier = tier;
+        this.displayName = new TranslationTextComponent(translationKey);
+    }
+
+    public ITextComponent getDisplayName() {
+        return displayName;
     }
 
     /**

src/api/java/appeng/api/definitions/IdHelper.java

@@ -1,3 +1,26 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 TeamAppliedEnergistics
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package appeng.api.definitions;
 
 import net.minecraft.util.ResourceLocation;

src/api/java/appeng/api/features/INetworkEncodable.java

@@ -32,7 +32,7 @@ public interface INetworkEncodable {
      *
      * @param item item
      *
-     * @return string key of item
+     * @return the encoded encryption key or an empty string if none is encoded
      */
     String getEncryptionKey(ItemStack item);
 

src/api/java/appeng/api/implementations/IUpgradeableHost.java

@@ -23,7 +23,12 @@
 
 package appeng.api.implementations;
 
+import java.util.Objects;
+
+import javax.annotation.Nonnull;
+
 import net.minecraft.tileentity.TileEntity;
+import net.minecraftforge.items.IItemHandler;
 
 import appeng.api.config.Upgrades;
 import appeng.api.implementations.tiles.ISegmentedInventory;
@@ -42,4 +47,13 @@ public interface IUpgradeableHost extends IConfigurableObject, ISegmentedInvento
      * @return tile entity
      */
     TileEntity getTile();
+
+    /**
+     * @return The inventory used to store the upgrade cards.
+     */
+    @Nonnull
+    default IItemHandler getUpgradeInventory() {
+        return Objects.requireNonNull(getInventoryByName("upgrades"));
+    }
+
 }

src/api/java/appeng/api/networking/IGrid.java

@@ -41,6 +41,9 @@ public interface IGrid {
      * @param iface face
      *
      * @return the IGridCache you requested.
+     *
+     *         TODO: 1.17 breaking change: throw if iface is not a registered grid cache to fulfil contract TODO: 1.17
+     *         breaking chance: make the parameter Class<C>
      */
     @Nonnull
     <C extends IGridCache> C getCache(@Nonnull Class<? extends IGridCache> iface);
@@ -51,6 +54,8 @@ public interface IGrid {
      * @param ev - event to post
      *
      * @return returns ev back to original poster
+     *
+     *         TODO: Breaking change in 1.17: T extends MENetworkEvent and return T
      */
     @Nonnull
     MENetworkEvent postEvent(@Nonnull MENetworkEvent ev);
@@ -60,7 +65,7 @@ public interface IGrid {
      *
      * @param ev event to post
      *
-     * @return returns ev back to original poster
+     * @return returns ev back to original poster TODO: Breaking change in 1.17: T extends MENetworkEvent and return T
      */
     @Nonnull
     MENetworkEvent postEventTo(@Nonnull IGridNode node, @Nonnull MENetworkEvent ev);

src/api/java/appeng/api/parts/PartItemStack.java

@@ -24,13 +24,29 @@
 package appeng.api.parts;
 
 public enum PartItemStack {
+    /**
+     * A stack that is used when someone uses the creative mode middle click to "pick" the part.
+     */
     PICK,
 
+    /**
+     * A stack that is dropped when the part is being broken as part of the cable bus.
+     */
     BREAK,
 
+    /**
+     * A stack that is dropped when the part is being hit with a wrench.
+     */
     WRENCH,
 
+    /**
+     * A stack that uniquely identifies the part when it is sent over the network. Only the id of the item contained in
+     * the stack is sent over the network.
+     */
     NETWORK,
 
+    /**
+     * A stack that uniquely identifies the part when it is stored to disk as part of the chunk.
+     */
     WORLD
 }

src/api/java/appeng/api/storage/IStorageChannel.java

@@ -23,8 +23,6 @@
 
 package appeng.api.storage;
 
-import java.io.IOException;
-
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
@@ -43,8 +41,6 @@ public interface IStorageChannel<T extends IAEStack<T>> {
      *
      * E.g. used by IO Ports to transfer 1000 mB, not 1 mB to match the item channel transferring a full bucket per
      * operation.
-     *
-     * @return
      */
     default int transferFactor() {
         return 1;
@@ -62,8 +58,6 @@ default int getUnitsPerByte() {
 
     /**
      * Create a new {@link IItemList} of the specific type.
-     *
-     * @return
      */
     @Nonnull
     IItemList<T> createList();
@@ -82,19 +76,11 @@ default int getUnitsPerByte() {
     @Nullable
     T createStack(@Nonnull Object input);
 
-    /**
-     * @param input
-     * @return
-     * @throws IOException
-     */
     @Nullable
     T readFromPacket(@Nonnull PacketBuffer input);
 
     /**
      * create from nbt data
-     *
-     * @param nbt
-     * @return
      */
     @Nullable
     T createFromNBT(@Nonnull CompoundNBT nbt);

src/api/java/appeng/api/storage/IStorageHelper.java

@@ -60,7 +60,6 @@ public interface IStorageHelper {
      * @param channel The channel type, must be a subtype of {@link IStorageChannel}
      * @param factory An instance implementing the channel, must be be an instance of channel
      */
-    @Nonnull
     <T extends IAEStack<T>, C extends IStorageChannel<T>> void registerStorageChannel(@Nonnull Class<C> channel,
             @Nonnull C factory);
 

src/main/java/appeng/block/AEBaseTileBlock.java

@@ -262,7 +262,7 @@ public IOrientable getOrientable(final IBlockReader w, final BlockPos pos) {
 
     /**
      * Returns the BlockState based on the given BlockState while considering the state of the given TileEntity.
-     *
+     * <p>
      * If the given TileEntity is not of the right type for this block, the state is returned unchanged, this is also
      * the case if the given block state does not belong to this block.
      */
@@ -277,7 +277,7 @@ public final BlockState getTileEntityBlockState(BlockState current, TileEntity t
     /**
      * Reimplement this in subclasses to allow tile-entities to update the state of their block when their own state
      * changes.
-     *
+     * <p>
      * It is guaranteed that te is not-null and the block of the given block state is this exact block instance.
      */
     protected BlockState updateBlockStateFromTileEntity(BlockState currentState, T te) {

src/main/java/appeng/block/crafting/AbstractCraftingUnitBlock.java

@@ -36,7 +36,7 @@
 import appeng.block.AEBaseTileBlock;
 import appeng.container.ContainerLocator;
 import appeng.container.ContainerOpener;
-import appeng.container.implementations.CraftingCPUContainer;
+import appeng.container.me.crafting.CraftingCPUContainer;
 import appeng.tile.crafting.CraftingTileEntity;
 import appeng.util.InteractionUtil;
 

src/main/java/appeng/block/misc/CellWorkbenchBlock.java

@@ -31,6 +31,7 @@
 
 import appeng.block.AEBaseTileBlock;
 import appeng.container.ContainerLocator;
+import appeng.container.ContainerOpener;
 import appeng.container.implementations.CellWorkbenchContainer;
 import appeng.tile.misc.CellWorkbenchTileEntity;
 import appeng.util.InteractionUtil;
@@ -51,7 +52,7 @@ public ActionResultType onActivated(final World w, final BlockPos pos, final Pla
         final CellWorkbenchTileEntity tg = this.getTileEntity(w, pos);
         if (tg != null) {
             if (!w.isRemote()) {
-                CellWorkbenchContainer.open(p, ContainerLocator.forTileEntity(tg));
+                ContainerOpener.openContainer(CellWorkbenchContainer.TYPE, p, ContainerLocator.forTileEntity(tg));
             }
             return ActionResultType.func_233537_a_(w.isRemote());
         }

src/main/java/appeng/block/misc/ChargerBlock.java

@@ -49,7 +49,6 @@
 import appeng.core.AppEng;
 import appeng.tile.misc.ChargerTileEntity;
 import appeng.util.InteractionUtil;
-import appeng.util.Platform;
 
 public class ChargerBlock extends AEBaseTileBlock<ChargerTileEntity> {
 

src/main/java/appeng/block/misc/InscriberBlock.java

@@ -46,7 +46,7 @@ public InscriberBlock(Properties props) {
     @Override
     public int getOpacity(BlockState state, IBlockReader worldIn, BlockPos pos) {
         return 2; // FIXME validate this. a) possibly not required because of getShape b) value
-                  // range. was 2 in 1.10
+        // range. was 2 in 1.10
     }
 
     @Override

src/main/java/appeng/block/misc/TinyTNTBlock.java

@@ -21,7 +21,6 @@
 import net.minecraft.block.AbstractBlock;
 import net.minecraft.block.Block;
 import net.minecraft.block.BlockState;
-import net.minecraft.block.material.Material;
 import net.minecraft.entity.Entity;
 import net.minecraft.entity.LivingEntity;
 import net.minecraft.entity.player.PlayerEntity;
@@ -41,7 +40,6 @@
 import net.minecraft.world.Explosion;
 import net.minecraft.world.IBlockReader;
 import net.minecraft.world.World;
-import net.minecraft.world.server.ServerWorld;
 
 import appeng.block.AEBaseBlock;
 import appeng.entity.TinyTNTPrimedEntity;

src/main/java/appeng/block/misc/VibrationChamberBlock.java

@@ -73,9 +73,9 @@ public ActionResultType onActivated(final World w, final BlockPos pos, final Pla
             return ActionResultType.PASS;
         }
 
-        if (w.isRemote()) {
+        if (!w.isRemote()) {
             final VibrationChamberTileEntity tc = this.getTileEntity(w, pos);
-            if (tc != null && !InteractionUtil.isInAlternateUseMode(player)) {
+            if (tc != null) {
                 ContainerOpener.openContainer(VibrationChamberContainer.TYPE, player,
                         ContainerLocator.forTileEntitySide(tc, hit.getFace()));
             }

src/main/java/appeng/block/paint/PaintSplotchesBlock.java

@@ -38,7 +38,6 @@
 
 import appeng.block.AEBaseTileBlock;
 import appeng.tile.misc.PaintSplotchesTileEntity;
-import appeng.util.Platform;
 
 public class PaintSplotchesBlock extends AEBaseTileBlock<PaintSplotchesTileEntity> {
     public PaintSplotchesBlock() {

src/main/java/appeng/client/ClientHelper.java

@@ -40,6 +40,7 @@
 
 import appeng.api.parts.CableRenderMode;
 import appeng.block.AEBaseBlock;
+import appeng.client.gui.style.StyleManager;
 import appeng.client.render.effects.EnergyParticleData;
 import appeng.client.render.effects.LightningArcFX;
 import appeng.client.render.effects.LightningFX;
@@ -58,6 +59,13 @@ public class ClientHelper extends ServerHelper {
 
     private final EnumMap<ActionKey, KeyBinding> bindings = new EnumMap<>(ActionKey.class);
 
+    public ClientHelper() {
+        Minecraft minecraft = Minecraft.getInstance();
+        if (minecraft != null) {
+            StyleManager.initialize(minecraft.getResourceManager());
+        }
+    }
+
     public void clientInit() {
         MinecraftForge.EVENT_BUS.addListener(this::postPlayerRender);
         MinecraftForge.EVENT_BUS.addListener(this::wheelEvent);