Tell Sodium to keep animating sparks and Tiara wing textures

(fixes #4580)

Author: TheRealWormbo

Fabric/build.gradle

@@ -134,6 +134,8 @@ dependencies {
 
     modCompileOnly 'teamreborn:energy:3.0.0'
 
+    modCompileOnly('maven.modrinth:sodium:mc1.20.1-0.5.3') { transitive = false }
+
     // modCompileOnly 'com.blamejared.crafttweaker:CraftTweaker-fabric-1.18.2:9.1.123'
 
     modCompileOnly 'com.unascribed:ears-api:1.4.5'

Fabric/src/main/java/vazkii/botania/fabric/client/FabricClientXplatImpl.java

@@ -1,12 +1,15 @@
 package vazkii.botania.fabric.client;
 
+import com.google.common.base.Supplier;
+import com.google.common.base.Suppliers;
 import com.mojang.blaze3d.vertex.PoseStack;
 
 import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.renderer.ItemBlockRenderTypes;
 import net.minecraft.client.renderer.MultiBufferSource;
 import net.minecraft.client.renderer.texture.AbstractTexture;
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
 import net.minecraft.client.resources.model.BakedModel;
 import net.minecraft.core.BlockPos;
 import net.minecraft.network.chat.Component;
@@ -22,8 +25,10 @@
 import vazkii.botania.api.BotaniaFabricClientCapabilities;
 import vazkii.botania.api.block.WandHUD;
 import vazkii.botania.api.item.TinyPotatoRenderCallback;
+import vazkii.botania.fabric.integration.sodium.SodiumHelper;
 import vazkii.botania.network.BotaniaPacket;
 import vazkii.botania.xplat.ClientXplatAbstractions;
+import vazkii.botania.xplat.XplatAbstractions;
 
 public class FabricClientXplatImpl implements ClientXplatAbstractions {
 	@Override
@@ -70,4 +75,14 @@ public void tessellateBlock(Level level, BlockState state, BlockPos pos, PoseSta
 		brd.getModelRenderer().tesselateBlock(level, brd.getBlockModel(state), state, pos, ps,
 				buffer, true, RandomSource.create(), state.getSeed(pos), overlay);
 	}
+
+	@Override
+	public void markSpriteActive(TextureAtlasSprite sprite) {
+		if (sodiumLoaded.get()) {
+			SodiumHelper.markSpriteActive(sprite);
+		}
+	}
+
+	private final Supplier<Boolean> sodiumLoaded = Suppliers.memoize(() -> XplatAbstractions.INSTANCE.isModLoaded("sodium")
+			|| XplatAbstractions.INSTANCE.isModLoaded("embeddium"));
 }

Fabric/src/main/java/vazkii/botania/fabric/integration/sodium/SodiumHelper.java

@@ -0,0 +1,13 @@
+package vazkii.botania.fabric.integration.sodium;
+
+import me.jellysquid.mods.sodium.client.render.texture.SpriteUtil;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+
+public class SodiumHelper {
+
+	public static void markSpriteActive(TextureAtlasSprite sprite) {
+		// this should work with both the actual Sodium and the Fabric backport of its Forge port Embeddium
+		SpriteUtil.markSpriteActive(sprite);
+	}
+}

Forge/build.gradle

@@ -36,6 +36,13 @@ repositories {
             includeGroup "com.unascribed"
         }
     }
+    maven {
+        name = "Modrinth"
+        url = "https://api.modrinth.com/maven" // for Sodium ports
+        content {
+            includeGroup "maven.modrinth"
+        }
+    }
 }
 
 legacyForge {
@@ -98,6 +105,8 @@ dependencies {
 
     modCompileOnly('com.unascribed:ears-api:1.4.5')
 
+    modCompileOnly('maven.modrinth:rubidium:0.7.0') { transitive = false }
+
     compileOnly "org.jetbrains:annotations:24.0.1"
 }
 

Forge/src/main/java/vazkii/botania/forge/client/ForgeClientXplatImpl.java

@@ -1,11 +1,14 @@
 package vazkii.botania.forge.client;
 
+import com.google.common.base.Supplier;
+import com.google.common.base.Suppliers;
 import com.mojang.blaze3d.vertex.PoseStack;
 
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.renderer.MultiBufferSource;
 import net.minecraft.client.renderer.RenderType;
 import net.minecraft.client.renderer.texture.AbstractTexture;
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
 import net.minecraft.client.resources.model.BakedModel;
 import net.minecraft.core.BlockPos;
 import net.minecraft.network.chat.Component;
@@ -23,9 +26,11 @@
 import vazkii.botania.api.block.WandHUD;
 import vazkii.botania.api.item.TinyPotatoRenderEvent;
 import vazkii.botania.forge.CapabilityUtil;
+import vazkii.botania.forge.integration.rubidium.RubidiumHelper;
 import vazkii.botania.forge.network.ForgePacketHandler;
 import vazkii.botania.network.BotaniaPacket;
 import vazkii.botania.xplat.ClientXplatAbstractions;
+import vazkii.botania.xplat.XplatAbstractions;
 
 public class ForgeClientXplatImpl implements ClientXplatAbstractions {
 	@Override
@@ -77,4 +82,13 @@ public void tessellateBlock(Level level, BlockState state, BlockPos pos, PoseSta
 					state.getSeed(pos), overlay, modelData, type);
 		}
 	}
+
+	@Override
+	public void markSpriteActive(TextureAtlasSprite sprite) {
+		if (rubidiumLoaded.get()) {
+			RubidiumHelper.markSpriteActive(sprite);
+		}
+	}
+
+	private final Supplier<Boolean> rubidiumLoaded = Suppliers.memoize(() -> XplatAbstractions.INSTANCE.isModLoaded("rubidium"));
 }

Forge/src/main/java/vazkii/botania/forge/integration/rubidium/RubidiumHelper.java

@@ -0,0 +1,13 @@
+package vazkii.botania.forge.integration.rubidium;
+
+import me.jellysquid.mods.sodium.client.render.texture.SpriteUtil;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+
+public class RubidiumHelper {
+
+	public static void markSpriteActive(TextureAtlasSprite sprite) {
+		// this should work with all Sodium ports
+		SpriteUtil.markSpriteActive(sprite);
+	}
+}

Xplat/src/main/java/vazkii/botania/client/render/entity/BaseSparkRenderer.java

@@ -27,6 +27,7 @@
 import vazkii.botania.common.entity.SparkBaseEntity;
 import vazkii.botania.common.helper.ColorHelper;
 import vazkii.botania.common.helper.VecHelper;
+import vazkii.botania.xplat.ClientXplatAbstractions;
 
 import java.util.Objects;
 import java.util.Random;
@@ -52,6 +53,7 @@ public BaseSparkRenderer(EntityRendererProvider.Context ctx) {
 	@Override
 	public void render(@NotNull T tEntity, float yaw, float partialTicks, PoseStack ms, MultiBufferSource buffers, int light) {
 		TextureAtlasSprite iicon = getBaseIcon(tEntity);
+		ClientXplatAbstractions.instance().markSpriteActive(iicon);
 
 		ms.pushPose();
 

Xplat/src/main/java/vazkii/botania/common/item/equipment/bauble/FlugelTiaraItem.java

@@ -52,6 +52,7 @@
 import vazkii.botania.common.item.CustomCreativeTabContents;
 import vazkii.botania.common.item.StoneOfTemperanceItem;
 import vazkii.botania.common.proxy.Proxy;
+import vazkii.botania.xplat.ClientXplatAbstractions;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -413,6 +414,7 @@ public void doRender(HumanoidModel<?> bipedModel, ItemStack stack, LivingEntity
 			}
 
 			BakedModel model = MiscellaneousModels.INSTANCE.tiaraWingIcons[meta - 1];
+			ClientXplatAbstractions.instance().markSpriteActive(model.getParticleIcon());
 			boolean flying = living instanceof Player player && player.getAbilities().flying;
 			float flap = 20F + (float) ((Math.sin((double) (living.tickCount + partialTicks) * (flying ? 0.4F : 0.2F)) + 0.5F) * (flying ? 30F : 5F));
 

Xplat/src/main/java/vazkii/botania/xplat/ClientXplatAbstractions.java

@@ -4,6 +4,7 @@
 
 import net.minecraft.client.renderer.MultiBufferSource;
 import net.minecraft.client.renderer.texture.AbstractTexture;
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
 import net.minecraft.client.resources.model.BakedModel;
 import net.minecraft.core.BlockPos;
 import net.minecraft.network.chat.Component;
@@ -43,6 +44,8 @@ public interface ClientXplatAbstractions {
 	void setFilterSave(AbstractTexture texture, boolean filter, boolean mipmap);
 	void restoreLastFilter(AbstractTexture texture);
 	void tessellateBlock(Level level, BlockState state, BlockPos pos, PoseStack ps, MultiBufferSource buffers, int overlay);
+	/** Marks an animated sprite as "active" for Sodium, if present. */
+	void markSpriteActive(TextureAtlasSprite sprite);
 
 	ClientXplatAbstractions INSTANCE = ServiceUtil.findService(ClientXplatAbstractions.class, null);
 

web/changelog.md

@@ -23,6 +23,7 @@ of time the maintainers are able to spend on this effort. For the time being, up
 * Fix: Botania's Creative inventory tab no longer randomly shows up among the vanilla tabs
 * Fix: Rod of the Sea and Extrapolated Bucket may vanish when interacting with cauldrons
 * Fix: Partially reverted an internal change that needlessly caused an incompatibility with existing versions of ExtraBotany
+* Fix: Ensure spark textures and animated Tiara wings are animated in the presence of Sodium or its various Forge ports
 
 ---