From 7846d25606704157da89750d294f580ae248466a Mon Sep 17 00:00:00 2001
From: LexManos
Date: Sun, 12 Apr 2026 12:53:34 -0700
Subject: [PATCH] Copy fluid and lava still textures to Item atlas for
DynamicFluidContainerModel. Fixes #10809
---
.../assets/minecraft/atlases/items.json | 14 ++++++
.../client/ForgeAtlasProvider.java | 49 +++++++++++++++++++
.../model/DynamicFluidContainerModel.java | 17 +++++--
.../model/geometry/UnbakedGeometryHelper.java | 16 +++---
.../net/minecraftforge/common/ForgeMod.java | 8 ++-
.../data/ForgeSpriteSourceProvider.java | 4 ++
.../common/data/SpriteSourceProvider.java | 3 ++
.../resources/META-INF/accesstransformer.cfg | 15 ++++++
.../debug/client/FluidBucketModelTest.java | 49 +++++++++++++++++++
.../fluid_bucket_model/items/bucket.json | 6 +++
.../models/item/bucket.json | 6 +++
11 files changed, 176 insertions(+), 11 deletions(-)
create mode 100644 src/main/generated/assets/minecraft/atlases/items.json
create mode 100644 src/main/java/net/minecraftforge/client/ForgeAtlasProvider.java
create mode 100644 src/test/java/net/minecraftforge/debug/client/FluidBucketModelTest.java
create mode 100644 src/test/resources/fluid_bucket_model/assets/fluid_bucket_model/items/bucket.json
create mode 100644 src/test/resources/fluid_bucket_model/assets/fluid_bucket_model/models/item/bucket.json
diff --git a/src/main/generated/assets/minecraft/atlases/items.json b/src/main/generated/assets/minecraft/atlases/items.json
new file mode 100644
index 0000000000..6dd66854ab
--- /dev/null
+++ b/src/main/generated/assets/minecraft/atlases/items.json
@@ -0,0 +1,14 @@
+{
+ "sources": [
+ {
+ "type": "minecraft:single",
+ "resource": "minecraft:block/lava_still",
+ "sprite": "minecraft:item/lava_still"
+ },
+ {
+ "type": "minecraft:single",
+ "resource": "minecraft:block/water_still",
+ "sprite": "minecraft:item/water_still"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/src/main/java/net/minecraftforge/client/ForgeAtlasProvider.java b/src/main/java/net/minecraftforge/client/ForgeAtlasProvider.java
new file mode 100644
index 0000000000..0824241177
--- /dev/null
+++ b/src/main/java/net/minecraftforge/client/ForgeAtlasProvider.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) Forge Development LLC and contributors
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
+
+package net.minecraftforge.client;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+
+import net.minecraft.client.data.AtlasProvider;
+import net.minecraft.client.renderer.texture.atlas.SpriteSource;
+import net.minecraft.client.renderer.texture.atlas.sources.SingleFile;
+import net.minecraft.data.AtlasIds;
+import net.minecraft.data.CachedOutput;
+import net.minecraft.data.PackOutput;
+import net.minecraft.resources.Identifier;
+
+public class ForgeAtlasProvider extends AtlasProvider {
+ public ForgeAtlasProvider(PackOutput output) {
+ super(output);
+ }
+
+ @Override
+ public CompletableFuture> run(final CachedOutput cache) {
+ return CompletableFuture.allOf(
+ this.storeAtlas(cache, AtlasIds.BLOCKS, List.of(
+ single("white")
+ )),
+ this.storeAtlas(cache, AtlasIds.ITEMS, List.of(
+ fromBlock("block/lava_still"),
+ fromBlock("block/water_still")
+ ))
+ );
+ }
+
+ private static SpriteSource single(String path) {
+ return new SingleFile(Identifier.fromNamespaceAndPath("forge", path));
+ }
+
+ private static SpriteSource fromBlock(String name) {
+ var resource = Identifier.withDefaultNamespace(name);
+ var id = resource;
+ if (resource.getPath().startsWith("block/"))
+ id = resource.withPath(path -> "item/" + path.substring(6));
+ return new SingleFile(resource, Optional.of(id));
+ }
+}
diff --git a/src/main/java/net/minecraftforge/client/model/DynamicFluidContainerModel.java b/src/main/java/net/minecraftforge/client/model/DynamicFluidContainerModel.java
index c2f18abdcf..da48569e79 100644
--- a/src/main/java/net/minecraftforge/client/model/DynamicFluidContainerModel.java
+++ b/src/main/java/net/minecraftforge/client/model/DynamicFluidContainerModel.java
@@ -8,7 +8,6 @@ package net.minecraftforge.client.model;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonObject;
import com.mojang.math.Transformation;
-
import net.minecraft.client.renderer.block.dispatch.ModelState;
import net.minecraft.client.renderer.chunk.ChunkSectionLayer;
import net.minecraft.client.resources.model.ModelBaker;
@@ -31,6 +30,7 @@ import net.minecraftforge.client.model.geometry.IGeometryLoader;
import net.minecraftforge.client.model.geometry.StandaloneGeometryBakingContext;
import net.minecraftforge.client.model.geometry.UnbakedGeometryHelper;
import net.minecraftforge.registries.ForgeRegistries;
+
import org.joml.Quaternionf;
import org.joml.Vector3f;
@@ -81,17 +81,26 @@ public class DynamicFluidContainerModel implements UnbakedGeometry {
@Override
public QuadCollection bake(TextureSlots textures, ModelBaker baker, ModelState state, ModelDebugName name, IGeometryBakingContext context) {
Material fluidMaskLocation = textures.getMaterial("fluid");
+ Material coverLocation = textures.getMaterial("cover");
Material stillMaterial = null;
if (fluid != Fluids.EMPTY) {
var stillTexture = IClientFluidTypeExtensions.of(fluid).getStillTexture();
- stillMaterial = new Material(stillTexture);
+ if (stillTexture != null) {
+ // Models can no longer have textures across atlases, so redirect to the item model of the same name.
+ // Modders may need to make clones of their textures in the item atlas, or provide a custom atlas alias
+ if (stillTexture.getPath().startsWith("block/"))
+ stillTexture = stillTexture.withPath(path -> "item/" + path.substring(6));
+ stillMaterial = new Material(stillTexture);
+ }
}
+
var materials = baker.materials();
var baseMaterial = materials.resolveSlot(textures, "base", name);
var fluidMaterial = stillMaterial == null ? null : materials.get(stillMaterial, name);
- var coverMaterial = materials.resolveSlot(textures, "cover", name);
+ var coverMaterial = coverLocation == null ? null : materials.get(coverLocation, name);
+
/*
var particleSprite = sprites.resolveSlot(textures, "particle", name);
@@ -117,7 +126,7 @@ public class DynamicFluidContainerModel implements UnbakedGeometry {
var templateMaterial = materials.get(fluidMaskLocation, name);
if (templateMaterial != null) {
var transformedState = new SimpleModelState(transformation.compose(FLUID_TRANSFORM));
- UnbakedGeometryHelper.bakeMaskedSprite(buf, baker.interner(), transformedState, info(baker, templateMaterial, 1), info(baker, fluidMaterial, 1));
+ UnbakedGeometryHelper.bakeMaskedSprite(buf, baker.interner(), transformedState, info(baker, fluidMaterial, 1), info(baker, templateMaterial, 1));
}
}
diff --git a/src/main/java/net/minecraftforge/client/model/geometry/UnbakedGeometryHelper.java b/src/main/java/net/minecraftforge/client/model/geometry/UnbakedGeometryHelper.java
index bd80bcb1aa..4cb1468bb8 100644
--- a/src/main/java/net/minecraftforge/client/model/geometry/UnbakedGeometryHelper.java
+++ b/src/main/java/net/minecraftforge/client/model/geometry/UnbakedGeometryHelper.java
@@ -11,6 +11,7 @@ import net.minecraft.client.renderer.block.dispatch.ModelState;
import net.minecraft.client.renderer.texture.MissingTextureAtlasSprite;
import net.minecraft.client.renderer.texture.TextureAtlas;
import net.minecraft.client.resources.model.ModelBaker;
+import net.minecraft.client.resources.model.cuboid.CuboidFace;
import net.minecraft.client.resources.model.cuboid.FaceBakery;
import net.minecraft.client.resources.model.cuboid.ItemModelGenerator;
import net.minecraft.client.resources.model.geometry.BakedQuad;
@@ -91,15 +92,16 @@ public class UnbakedGeometryHelper {
final BakedQuad.MaterialInfo texture,
final BakedQuad.MaterialInfo template
) {
- var spriteContents = template.sprite().contents();
- int width = spriteContents.width(), height = spriteContents.height();
+ var sprite = template.sprite().contents();
+ int width = sprite.width();
+ int height = sprite.height();
var bits = new BitSet(width * height);
// For every frame in the texture, mark all the opaque pixels (this is what vanilla does too)
- spriteContents.getUniqueFrames().forEach(frame -> {
+ sprite.getUniqueFrames().forEach(frame -> {
for (int x = 0; x < width; x++)
for (int y = 0; y < height; y++)
- if (!spriteContents.isTransparent(frame, x, y))
+ if (!sprite.isTransparent(frame, x, y))
bits.set(x + y * width);
});
@@ -132,8 +134,10 @@ public class UnbakedGeometryHelper {
var to = new Vector3f(16 * x / (float) width, 16 - 16 * y / (float) height, 8.5F);
// Create element
- builder.addUnculledFace(FaceBakery.bakeQuad(interner, from, to, ItemModelGenerator.SOUTH_FACE_UVS, Quadrant.R0, texture, Direction.SOUTH, state, null));
- builder.addUnculledFace(FaceBakery.bakeQuad(interner, from, to, ItemModelGenerator.NORTH_FACE_UVS, Quadrant.R0, texture, Direction.NORTH, state, null));
+ var southUvs = new CuboidFace.UVs(from.x, from.y, to.x, to.y);
+ var northUvs = new CuboidFace.UVs(to.x, from.y, from.x, to.y);
+ builder.addUnculledFace(FaceBakery.bakeQuad(interner, from, to, southUvs, Quadrant.R0, texture, Direction.SOUTH, state, null));
+ builder.addUnculledFace(FaceBakery.bakeQuad(interner, from, to, northUvs, Quadrant.R0, texture, Direction.NORTH, state, null));
// Reset xStart
xStart = -1;
diff --git a/src/main/java/net/minecraftforge/common/ForgeMod.java b/src/main/java/net/minecraftforge/common/ForgeMod.java
index 6888b9102b..fe1b61d363 100644
--- a/src/main/java/net/minecraftforge/common/ForgeMod.java
+++ b/src/main/java/net/minecraftforge/common/ForgeMod.java
@@ -37,6 +37,8 @@ import net.minecraft.world.level.material.FluidState;
import net.minecraft.world.level.pathfinder.PathType;
import net.minecraft.world.level.storage.loot.predicates.LootItemCondition;
import net.minecraft.world.phys.Vec3;
+import net.minecraftforge.api.distmarker.Dist;
+import net.minecraftforge.client.ForgeAtlasProvider;
import net.minecraftforge.client.extensions.common.IClientFluidTypeExtensions;
import net.minecraftforge.common.data.ExistingFileHelper;
import net.minecraftforge.common.data.ForgeBiomeTagsProvider;
@@ -69,6 +71,7 @@ import net.minecraftforge.fml.config.ModConfig;
import net.minecraftforge.fml.event.config.ModConfigEvent;
import net.minecraftforge.fml.event.lifecycle.*;
import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
+import net.minecraftforge.fml.loading.FMLLoader;
import net.minecraftforge.registries.*;
import net.minecraftforge.registries.holdersets.AndHolderSet;
import net.minecraftforge.registries.holdersets.AnyHolderSet;
@@ -444,8 +447,11 @@ public class ForgeMod {
gen.addProvider(event.includeServer(), new ForgeBiomeTagsProvider(packOutput, lookupProvider, existingFileHelper));
gen.addProvider(event.includeServer(), new ForgeStructureTagsProvider(packOutput, lookupProvider, existingFileHelper));
- gen.addProvider(event.includeClient(), new ForgeSpriteSourceProvider(packOutput, existingFileHelper));
gen.addProvider(event.includeClient(), new VanillaSoundDefinitionsProvider(packOutput, existingFileHelper));
+ // The provider uses Client only classes, so put a side guard on it.
+ if (FMLLoader.getDist() == Dist.CLIENT) {
+ gen.addProvider(event.includeClient(), new ForgeAtlasProvider(packOutput));
+ }
}
// done in an event instead of deferred to only enable if a mod requests it
diff --git a/src/main/java/net/minecraftforge/common/data/ForgeSpriteSourceProvider.java b/src/main/java/net/minecraftforge/common/data/ForgeSpriteSourceProvider.java
index 15a5fa84b1..2990d98cad 100644
--- a/src/main/java/net/minecraftforge/common/data/ForgeSpriteSourceProvider.java
+++ b/src/main/java/net/minecraftforge/common/data/ForgeSpriteSourceProvider.java
@@ -11,6 +11,10 @@ import net.minecraft.resources.Identifier;
import java.util.Optional;
+/**
+* @deprecated Use Vanilla's {@link net.minecraft.client.data.AtlasProvider AtlasProvider}
+*/
+@Deprecated(forRemoval = true, since = "26.1.2")
public class ForgeSpriteSourceProvider extends SpriteSourceProvider
{
public ForgeSpriteSourceProvider(PackOutput output, ExistingFileHelper fileHelper)
diff --git a/src/main/java/net/minecraftforge/common/data/SpriteSourceProvider.java b/src/main/java/net/minecraftforge/common/data/SpriteSourceProvider.java
index 9d3cbc21e5..42998af099 100644
--- a/src/main/java/net/minecraftforge/common/data/SpriteSourceProvider.java
+++ b/src/main/java/net/minecraftforge/common/data/SpriteSourceProvider.java
@@ -24,7 +24,10 @@ import java.util.function.BiConsumer;
* allows adding additional textures to the atlas by adding {@link SpriteSource}s to the configuration.
* See {@link SpriteSources} for the available sources and the constants in this class for the
* atlases used in vanilla Minecraft
+ *
+ * @deprecated Use Vanilla's {@link net.minecraft.client.data.AtlasProvider AtlasProvider}
*/
+@Deprecated(forRemoval = true, since = "26.1.2")
public abstract class SpriteSourceProvider extends JsonCodecProvider>
{
protected static final Identifier BLOCKS_ATLAS = Identifier.withDefaultNamespace("blocks");
diff --git a/src/main/resources/META-INF/accesstransformer.cfg b/src/main/resources/META-INF/accesstransformer.cfg
index 581a13239b..d71939bda1 100644
--- a/src/main/resources/META-INF/accesstransformer.cfg
+++ b/src/main/resources/META-INF/accesstransformer.cfg
@@ -4,6 +4,21 @@ public net.minecraft.client.Minecraft textureManager
public-f net.minecraft.client.Options keyMappings
public net.minecraft.client.Options$FieldAccess
public net.minecraft.client.color.item.ItemTintSources ID_MAPPER
+#group protected net.minecraft.client.data.AtlasProvider *()
+protected net.minecraft.client.data.AtlasProvider armorTrims()Ljava/util/List;
+protected net.minecraft.client.data.AtlasProvider bannerPatterns()Ljava/util/List;
+protected net.minecraft.client.data.AtlasProvider blocksList()Ljava/util/List;
+protected net.minecraft.client.data.AtlasProvider extractAllMaterialAssets()Ljava/util/stream/Stream;
+protected net.minecraft.client.data.AtlasProvider forMapper(Lnet/minecraft/client/renderer/SpriteMapper;)Lnet/minecraft/client/renderer/texture/atlas/SpriteSource;
+protected net.minecraft.client.data.AtlasProvider forMaterial(Lnet/minecraft/client/resources/model/sprite/SpriteId;)Lnet/minecraft/client/renderer/texture/atlas/SpriteSource;
+protected net.minecraft.client.data.AtlasProvider guiSprites()Ljava/util/List;
+protected net.minecraft.client.data.AtlasProvider itemsList()Ljava/util/List;
+protected net.minecraft.client.data.AtlasProvider noPrefixMapper(Ljava/lang/String;)Ljava/util/List;
+protected net.minecraft.client.data.AtlasProvider patternTextures()Ljava/util/List;
+protected net.minecraft.client.data.AtlasProvider shieldPatterns()Ljava/util/List;
+protected net.minecraft.client.data.AtlasProvider simpleMapper(Lnet/minecraft/client/renderer/SpriteMapper;)Ljava/util/List;
+protected net.minecraft.client.data.AtlasProvider storeAtlas(Lnet/minecraft/data/CachedOutput;Lnet/minecraft/resources/Identifier;Ljava/util/List;)Ljava/util/concurrent/CompletableFuture;
+#endgroup
#group protected net.minecraft.client.data.models.BlockModelGenerators *()
protected net.minecraft.client.data.models.BlockModelGenerators addBookSlotModel(Lnet/minecraft/client/data/models/blockstates/MultiPartGenerator;Lnet/minecraft/client/renderer/block/dispatch/multipart/Condition;Lnet/minecraft/client/renderer/block/dispatch/VariantMutator;Lnet/minecraft/world/level/block/state/properties/BooleanProperty;Lnet/minecraft/client/data/models/model/ModelTemplate;Z)V
protected net.minecraft.client.data.models.BlockModelGenerators addShelfPart(Lnet/minecraft/world/level/block/Block;Lnet/minecraft/client/data/models/model/TextureMapping;Lnet/minecraft/client/data/models/blockstates/MultiPartGenerator;Lnet/minecraft/client/data/models/model/ModelTemplate;Ljava/lang/Boolean;Lnet/minecraft/world/level/block/state/properties/SideChainPart;)V
diff --git a/src/test/java/net/minecraftforge/debug/client/FluidBucketModelTest.java b/src/test/java/net/minecraftforge/debug/client/FluidBucketModelTest.java
new file mode 100644
index 0000000000..9eba0c5487
--- /dev/null
+++ b/src/test/java/net/minecraftforge/debug/client/FluidBucketModelTest.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) Forge Development LLC and contributors
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
+
+package net.minecraftforge.debug.client;
+
+import net.minecraft.client.Minecraft;
+import net.minecraft.core.registries.Registries;
+import net.minecraft.gametest.framework.GameTestHelper;
+import net.minecraft.world.item.BucketItem;
+import net.minecraft.world.item.Item;
+import net.minecraft.world.level.material.Fluids;
+import net.minecraftforge.fml.common.Mod;
+import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
+import net.minecraftforge.gametest.GameTest;
+import net.minecraftforge.gametest.GameTestNamespace;
+import net.minecraftforge.registries.DeferredRegister;
+import net.minecraftforge.registries.RegistryObject;
+import net.minecraftforge.test.BaseTestMod;
+
+@GameTestNamespace("forge")
+@Mod(FluidBucketModelTest.MODID)
+public class FluidBucketModelTest extends BaseTestMod {
+ public static final String MODID = "fluid_bucket_model";
+
+ private static final DeferredRegister- ITEMS = DeferredRegister.create(Registries.ITEM, MODID);
+ public static final RegistryObject
- BUCKET = ITEMS.register("bucket", () -> new BucketItem(() -> Fluids.LAVA, new Item.Properties().setId(ITEMS.key("bucket"))));
+
+ public FluidBucketModelTest(FMLJavaModLoadingContext context) {
+ super(context, false, true);
+ this.testItem(lookup -> BUCKET.get().getDefaultInstance());
+ }
+
+ @GameTest
+ public static void item_model(GameTestHelper helper) {
+ var manager = Minecraft.getInstance().getModelManager();
+
+ var key = rl("pig_head");
+ var model = manager.getItemModel(key);
+ if (model == null)
+ helper.fail("Failed to retreive " + key + " item model");
+
+ if (model == manager.getMissingModel())
+ helper.fail("Itme Model was the missing model");
+
+ helper.succeed();
+ }
+}
diff --git a/src/test/resources/fluid_bucket_model/assets/fluid_bucket_model/items/bucket.json b/src/test/resources/fluid_bucket_model/assets/fluid_bucket_model/items/bucket.json
new file mode 100644
index 0000000000..cec24c2bd1
--- /dev/null
+++ b/src/test/resources/fluid_bucket_model/assets/fluid_bucket_model/items/bucket.json
@@ -0,0 +1,6 @@
+{
+ "model": {
+ "type": "minecraft:model",
+ "model": "fluid_bucket_model:item/bucket"
+ }
+}
\ No newline at end of file
diff --git a/src/test/resources/fluid_bucket_model/assets/fluid_bucket_model/models/item/bucket.json b/src/test/resources/fluid_bucket_model/assets/fluid_bucket_model/models/item/bucket.json
new file mode 100644
index 0000000000..9846b8a1a0
--- /dev/null
+++ b/src/test/resources/fluid_bucket_model/assets/fluid_bucket_model/models/item/bucket.json
@@ -0,0 +1,6 @@
+{
+ "parent": "forge:item/bucket",
+ "flip_gas": true,
+ "fluid": "minecraft:lava",
+ "loader": "forge:fluid_container"
+}
\ No newline at end of file