Merge branch 'mc-1.19.x' into mc-1.20.x

.reuse/dep5

@@ -48,6 +48,7 @@ License: MPL-2.0
 
 Files:
   doc/logo.png
+  doc/logo-darkmode.png
   projects/common/src/main/resources/assets/computercraft/models/*
   projects/common/src/main/resources/assets/computercraft/textures/*
   projects/common/src/main/resources/pack.mcmeta

README.md

@@ -4,7 +4,12 @@ SPDX-FileCopyrightText: 2017 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-# ![CC: Tweaked](doc/logo.png)
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./doc/logo-darkmode.png">
+  <source media="(prefers-color-scheme: light)" srcset="./doc/logo.png">
+  <img alt="CC: Tweaked" src="./doc/logo.png">
+</picture>
+
 [![Current build status](https://github.com/cc-tweaked/CC-Tweaked/workflows/Build/badge.svg)](https://github.com/cc-tweaked/CC-Tweaked/actions "Current build status")
 [![Download CC: Tweaked on CurseForge](https://img.shields.io/static/v1?label=Download&message=CC:%20Tweaked&color=E04E14&logoColor=E04E14&logo=CurseForge)][CurseForge]
 [![Download CC: Tweaked on Modrinth](https://img.shields.io/static/v1?label=Download&color=00AF5C&logoColor=00AF5C&logo=Modrinth&message=CC:%20Tweaked)][Modrinth]
@@ -44,7 +49,7 @@ repositories {
 
 dependencies {
   // Vanilla (i.e. for multi-loader systems)
-  compileOnly("cc.tweaked:cc-tweaked-$mcVersion-common-api")
+  compileOnly("cc.tweaked:cc-tweaked-$mcVersion-common-api:$cctVersion")
 
   // Forge Gradle
   compileOnly("cc.tweaked:cc-tweaked-$mcVersion-core-api:$cctVersion")
@@ -57,6 +62,19 @@ dependencies {
 }
 ```
 
+When using ForgeGradle, you may also need to add the following:
+
+```groovy
+minecraft {
+    runs {
+        configureEach {
+            property 'mixin.env.remapRefMap', 'true'
+            property 'mixin.env.refMapRemappingFile', "${buildDir}/createSrgToMcp/output.srg"
+        }
+    }
+}
+```
+
 You should also be careful to only use classes within the `dan200.computercraft.api` package. Non-API classes are
 subject to change at any point. If you depend on functionality outside the API, file an issue, and we can look into
 exposing more features.

buildSrc/src/main/kotlin/cc/tweaked/gradle/MinecraftExec.kt

@@ -4,6 +4,7 @@
 
 package cc.tweaked.gradle
 
+import net.minecraftforge.gradle.common.util.RunConfig
 import org.gradle.api.GradleException
 import org.gradle.api.file.FileSystemOperations
 import org.gradle.api.invocation.Gradle
@@ -53,6 +54,25 @@ abstract class ClientJavaExec : JavaExec() {
     @get:OutputFile
     val testResults = project.layout.buildDirectory.file("test-results/$name.xml")
 
+    private fun setTestProperties() {
+        if (!clientDebug) systemProperty("cctest.client", "")
+        if (renderdoc) environment("LD_PRELOAD", "/usr/lib/librenderdoc.so")
+        systemProperty("cctest.gametest-report", testResults.get().asFile.absoluteFile)
+        workingDir(project.buildDir.resolve("gametest").resolve(name))
+    }
+
+    init {
+        setTestProperties()
+    }
+
+    /**
+     * Set this task to run a given [RunConfig].
+     */
+    fun setRunConfig(config: RunConfig) {
+        (this as JavaExec).setRunConfig(config)
+        setTestProperties() // setRunConfig may clobber some properties, ensure everything is set.
+    }
+
     /**
      * Copy configuration from a task with the given name.
      */
@@ -64,11 +84,7 @@ abstract class ClientJavaExec : JavaExec() {
     fun copyFrom(task: JavaExec) {
         for (dep in task.dependsOn) dependsOn(dep)
         task.copyToFull(this)
-
-        if (!clientDebug) systemProperty("cctest.client", "")
-        if (renderdoc) environment("LD_PRELOAD", "/usr/lib/librenderdoc.so")
-        systemProperty("cctest.gametest-report", testResults.get().asFile.absoluteFile)
-        workingDir(project.buildDir.resolve("gametest").resolve(name))
+        setTestProperties() // copyToFull may clobber some properties, ensure everything is set.
     }
 
     /**

gradle/libs.versions.toml

@@ -7,13 +7,13 @@
 # Minecraft
 # MC version is specified in gradle.properties, as we need that in settings.gradle.
 # Remember to update corresponding versions in fabric.mod.json/mods.toml
-fabric-api = "0.83.1+1.20.1"
+fabric-api = "0.86.1+1.20.1"
 fabric-loader = "0.14.21"
 forge = "47.1.0"
 forgeSpi = "6.0.0"
 mixin = "0.8.5"
-parchment = "2023.03.12"
-parchmentMc = "1.19.3"
+parchment = "2023.06.26"
+parchmentMc = "1.19.4"
 
 # Normal dependencies
 asm = "9.3"

projects/common-api/src/client/java/dan200/computercraft/api/client/turtle/TurtleUpgradeModeller.java

@@ -11,10 +11,13 @@
 import dan200.computercraft.api.turtle.TurtleSide;
 import dan200.computercraft.api.turtle.TurtleUpgradeSerialiser;
 import net.minecraft.client.resources.model.ModelResourceLocation;
+import net.minecraft.client.resources.model.UnbakedModel;
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.resources.ResourceLocation;
 
 import javax.annotation.Nullable;
+import java.util.Collection;
+import java.util.List;
 
 /**
  * Provides models for a {@link ITurtleUpgrade}.
@@ -50,9 +53,24 @@ default TransformedModel getModel(T upgrade, CompoundTag data, TurtleSide side)
         return getModel(upgrade, (ITurtleAccess) null, side);
     }
 
+
+    /**
+     * Get a list of models that this turtle modeller depends on.
+     * <p>
+     * Models included in this list will be loaded and baked alongside item and block models, and so may be referenced
+     * by {@link TransformedModel#of(ResourceLocation)}. You do not need to override this method if you will load models
+     * by other means.
+     *
+     * @return A list of models that this modeller depends on.
+     * @see UnbakedModel#getDependencies()
+     */
+    default Collection<ResourceLocation> getDependencies() {
+        return List.of();
+    }
+
     /**
-     * A basic {@link TurtleUpgradeModeller} which renders using the upgrade's {@linkplain ITurtleUpgrade#getCraftingItem()
-     * crafting item}.
+     * A basic {@link TurtleUpgradeModeller} which renders using the upgrade's {@linkplain ITurtleUpgrade#getUpgradeItem(CompoundTag)}
+     * upgrade item}.
      * <p>
      * This uses appropriate transformations for "flat" items, namely those extending the {@literal minecraft:item/generated}
      * model type. It will not appear correct for 3D models with additional depth, such as blocks.
@@ -62,7 +80,7 @@ default TransformedModel getModel(T upgrade, CompoundTag data, TurtleSide side)
      */
     @SuppressWarnings("unchecked")
     static <T extends ITurtleUpgrade> TurtleUpgradeModeller<T> flatItem() {
-        return (TurtleUpgradeModeller<T>) TurtleUpgradeModellers.FLAT_ITEM;
+        return (TurtleUpgradeModeller<T>) TurtleUpgradeModellers.UPGRADE_ITEM;
     }
 
     /**
@@ -74,7 +92,8 @@ static <T extends ITurtleUpgrade> TurtleUpgradeModeller<T> flatItem() {
      * @return The constructed modeller.
      */
     static <T extends ITurtleUpgrade> TurtleUpgradeModeller<T> sided(ModelResourceLocation left, ModelResourceLocation right) {
-        return (upgrade, turtle, side) -> TransformedModel.of(side == TurtleSide.LEFT ? left : right);
+        // TODO(1.21.0): Remove this.
+        return sided((ResourceLocation) left, right);
     }
 
     /**
@@ -86,6 +105,16 @@ static <T extends ITurtleUpgrade> TurtleUpgradeModeller<T> sided(ModelResourceLo
      * @return The constructed modeller.
      */
     static <T extends ITurtleUpgrade> TurtleUpgradeModeller<T> sided(ResourceLocation left, ResourceLocation right) {
-        return (upgrade, turtle, side) -> TransformedModel.of(side == TurtleSide.LEFT ? left : right);
+        return new TurtleUpgradeModeller<>() {
+            @Override
+            public TransformedModel getModel(T upgrade, @Nullable ITurtleAccess turtle, TurtleSide side) {
+                return TransformedModel.of(side == TurtleSide.LEFT ? left : right);
+            }
+
+            @Override
+            public Collection<ResourceLocation> getDependencies() {
+                return List.of(left, right);
+            }
+        };
     }
 }

projects/common-api/src/client/java/dan200/computercraft/api/client/turtle/TurtleUpgradeModellers.java

@@ -6,13 +6,20 @@
 
 import com.mojang.math.Transformation;
 import dan200.computercraft.api.client.TransformedModel;
+import dan200.computercraft.api.turtle.ITurtleAccess;
 import dan200.computercraft.api.turtle.ITurtleUpgrade;
 import dan200.computercraft.api.turtle.TurtleSide;
+import dan200.computercraft.impl.client.ClientPlatformHelper;
+import net.minecraft.client.Minecraft;
+import net.minecraft.nbt.CompoundTag;
+import net.minecraft.world.item.ItemStack;
 import org.joml.Matrix4f;
 
+import javax.annotation.Nullable;
+
 class TurtleUpgradeModellers {
-    private static final Transformation leftTransform = getMatrixFor(-0.40625f);
-    private static final Transformation rightTransform = getMatrixFor(0.40625f);
+    private static final Transformation leftTransform = getMatrixFor(-0.4065f);
+    private static final Transformation rightTransform = getMatrixFor(0.4065f);
 
     private static Transformation getMatrixFor(float offset) {
         var matrix = new Matrix4f();
@@ -26,6 +33,23 @@ private static Transformation getMatrixFor(float offset) {
         return new Transformation(matrix);
     }
 
-    static final TurtleUpgradeModeller<ITurtleUpgrade> FLAT_ITEM = (upgrade, turtle, side) ->
-        TransformedModel.of(upgrade.getCraftingItem(), side == TurtleSide.LEFT ? leftTransform : rightTransform);
+    static final TurtleUpgradeModeller<ITurtleUpgrade> UPGRADE_ITEM = new UpgradeItemModeller();
+
+    private static class UpgradeItemModeller implements TurtleUpgradeModeller<ITurtleUpgrade> {
+        @Override
+        public TransformedModel getModel(ITurtleUpgrade upgrade, @Nullable ITurtleAccess turtle, TurtleSide side) {
+            return getModel(turtle == null ? upgrade.getCraftingItem() : upgrade.getUpgradeItem(turtle.getUpgradeNBTData(side)), side);
+        }
+
+        @Override
+        public TransformedModel getModel(ITurtleUpgrade upgrade, CompoundTag data, TurtleSide side) {
+            return getModel(upgrade.getUpgradeItem(data), side);
+        }
+
+        private TransformedModel getModel(ItemStack stack, TurtleSide side) {
+            var model = Minecraft.getInstance().getItemRenderer().getItemModelShaper().getItemModel(stack);
+            if (stack.hasFoil()) model = ClientPlatformHelper.get().createdFoiledModel(model);
+            return new TransformedModel(model, side == TurtleSide.LEFT ? leftTransform : rightTransform);
+        }
+    }
 }

projects/common-api/src/client/java/dan200/computercraft/impl/client/ClientPlatformHelper.java

@@ -5,6 +5,7 @@
 package dan200.computercraft.impl.client;
 
 import dan200.computercraft.impl.Services;
+import net.minecraft.client.renderer.RenderType;
 import net.minecraft.client.resources.model.BakedModel;
 import net.minecraft.client.resources.model.ModelManager;
 import net.minecraft.client.resources.model.ModelResourceLocation;
@@ -24,6 +25,15 @@ public interface ClientPlatformHelper {
      */
     BakedModel getModel(ModelManager manager, ResourceLocation location);
 
+    /**
+     * Wrap this model in a version which renders a foil/enchantment glint.
+     *
+     * @param model The model to wrap.
+     * @return The wrapped model.
+     * @see RenderType#glint()
+     */
+    BakedModel createdFoiledModel(BakedModel model);
+
     static ClientPlatformHelper get() {
         var instance = Instance.INSTANCE;
         return instance == null ? Services.raise(ClientPlatformHelper.class, Instance.ERROR) : instance;

projects/common-api/src/main/java/dan200/computercraft/api/turtle/TurtleToolDurability.java

@@ -35,6 +35,7 @@ public enum TurtleToolDurability implements StringRepresentable {
     /**
      * The codec which may be used for serialising/deserialising {@link TurtleToolDurability}s.
      */
+    @SuppressWarnings("deprecation")
     public static final StringRepresentable.EnumCodec<TurtleToolDurability> CODEC = StringRepresentable.fromEnum(TurtleToolDurability::values);
 
     TurtleToolDurability(String serialisedName) {

projects/common/src/client/java/dan200/computercraft/client/ClientRegistry.java

@@ -13,6 +13,7 @@
 import dan200.computercraft.client.render.TurtleBlockEntityRenderer;
 import dan200.computercraft.client.render.monitor.MonitorBlockEntityRenderer;
 import dan200.computercraft.client.turtle.TurtleModemModeller;
+import dan200.computercraft.client.turtle.TurtleUpgradeModellers;
 import dan200.computercraft.core.util.Colour;
 import dan200.computercraft.shared.ModRegistry;
 import dan200.computercraft.shared.common.IColouredItem;
@@ -107,24 +108,6 @@ private static void registerItemProperty(String name, ClampedItemPropertyFunctio
     }
 
     private static final String[] EXTRA_MODELS = new String[]{
-        // Turtle upgrades
-        "block/turtle_modem_normal_off_left",
-        "block/turtle_modem_normal_on_left",
-        "block/turtle_modem_normal_off_right",
-        "block/turtle_modem_normal_on_right",
-
-        "block/turtle_modem_advanced_off_left",
-        "block/turtle_modem_advanced_on_left",
-        "block/turtle_modem_advanced_off_right",
-        "block/turtle_modem_advanced_on_right",
-
-        "block/turtle_crafting_table_left",
-        "block/turtle_crafting_table_right",
-
-        "block/turtle_speaker_left",
-        "block/turtle_speaker_right",
-
-        // Turtle block renderer
         "block/turtle_colour",
         "block/turtle_elf_overlay",
         "block/turtle_rainbow_overlay",
@@ -133,6 +116,7 @@ private static void registerItemProperty(String name, ClampedItemPropertyFunctio
 
     public static void registerExtraModels(Consumer<ResourceLocation> register) {
         for (var model : EXTRA_MODELS) register.accept(new ResourceLocation(ComputerCraftAPI.MOD_ID, model));
+        TurtleUpgradeModellers.getDependencies().forEach(register);
     }
 
     public static void registerItemColours(BiConsumer<ItemColor, ItemLike> register) {

projects/common/src/client/java/dan200/computercraft/client/gui/widgets/DynamicImageButton.java

@@ -67,14 +67,11 @@ public void renderWidget(GuiGraphics graphics, int mouseX, int mouseY, float par
         graphics.blit(texture, getX(), getY(), xTexStart.getAsInt(), yTex, width, height, textureWidth, textureHeight);
     }
 
-    @Override
-    public Component getMessage() {
-        return message.get().message;
-    }
-
     @Override
     public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTicks) {
-        setTooltip(message.get().tooltip());
+        var message = this.message.get();
+        setMessage(message.message());
+        setTooltip(message.tooltip());
         super.render(graphics, mouseX, mouseY, partialTicks);
     }
 

projects/common/src/client/java/dan200/computercraft/client/integration/emi/EMIComputerCraft.java

@@ -12,7 +12,6 @@
 import dev.emi.emi.api.EmiPlugin;
 import dev.emi.emi.api.EmiRegistry;
 import dev.emi.emi.api.stack.Comparison;
-import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
 
 import java.util.function.BiPredicate;
@@ -36,7 +35,7 @@ public void register(EmiRegistry registry) {
     private static final Comparison pocketComparison = compareStacks((left, right) ->
         left.getItem() instanceof PocketComputerItem && PocketComputerItem.getUpgrade(left) == PocketComputerItem.getUpgrade(right));
 
-    private static <T extends Item> Comparison compareStacks(BiPredicate<ItemStack, ItemStack> test) {
+    private static Comparison compareStacks(BiPredicate<ItemStack, ItemStack> test) {
         return Comparison.of((left, right) -> {
             ItemStack leftStack = left.getItemStack(), rightStack = right.getItemStack();
             return leftStack.getItem() == rightStack.getItem() && test.test(leftStack, rightStack);

projects/common/src/client/java/dan200/computercraft/client/model/turtle/ModelTransformer.java

@@ -26,13 +26,14 @@
  * <p>
  * This is typically used with a {@link BakedModel} subclass - see the loader-specific projects.
  */
-public final class ModelTransformer {
-    public static final int[] ORDER = new int[]{ 3, 2, 1, 0 };
-    public static final int STRIDE = DefaultVertexFormat.BLOCK.getIntegerSize();
+public class ModelTransformer {
+    private static final int[] INVERSE_ORDER = new int[]{ 3, 2, 1, 0 };
+
+    private static final int STRIDE = DefaultVertexFormat.BLOCK.getIntegerSize();
     private static final int POS_OFFSET = findOffset(DefaultVertexFormat.BLOCK, DefaultVertexFormat.ELEMENT_POSITION);
 
-    private final Matrix4f transformation;
-    private final boolean invert;
+    protected final Matrix4f transformation;
+    protected final boolean invert;
     private @Nullable TransformedQuads cache;
 
     public ModelTransformer(Transformation transformation) {
@@ -60,7 +61,7 @@ private BakedQuad transformQuad(BakedQuad quad) {
         for (var i = 0; i < 4; i++) {
             var inStart = STRIDE * i;
             // Reverse the order of the quads if we're inverting
-            var outStart = STRIDE * (invert ? ORDER[i] : i);
+            var outStart = getVertexOffset(i, invert);
             System.arraycopy(inputData, inStart, outputData, outStart, STRIDE);
 
             // Apply the matrix to our position
@@ -84,6 +85,10 @@ private BakedQuad transformQuad(BakedQuad quad) {
         return new BakedQuad(outputData, quad.getTintIndex(), direction, quad.getSprite(), quad.isShade());
     }
 
+    public static int getVertexOffset(int vertex, boolean invert) {
+        return (invert ? ModelTransformer.INVERSE_ORDER[vertex] : vertex) * ModelTransformer.STRIDE;
+    }
+
     private record TransformedQuads(List<BakedQuad> original, List<BakedQuad> transformed) {
     }