Merge pull request #138 from litetex-oss/dev

Release

Author: litetex

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 4.0.1
+* Made animated GIF decoding more reliable
+  * This should fix broken textures #135
+* The maximum size for image downloads is now 10MB by default
+
 # 4.0.0
 * Implemented Texture Resolvers
   * Added support for GIFs #131

README.md

@@ -53,16 +53,20 @@ This demo showcases how to apply the capes inside [``custom-cape-demo``](https:/
 
 For more details have a look at [CustomProvider](https://github.com/litetex-oss/mcm-cape-provider/tree/dev/src/main/java/net/litetex/capes/provider/CustomProvider.java) and [CustomProviderConfig](https://github.com/litetex-oss/mcm-cape-provider/tree/dev/src/main/java/net/litetex/capes/config/CustomProviderConfig.java)
 
+##### Maximum size
+
+Images/Textures should not exceed 10MB otherwise they might be ignored.
+
 ##### Texture resolvers / Animated textures
 
 Texture resolvers can be selected using the `textureResolverId` attribute.
 The following resolvers are currently built-in:
 
-| Resolver-ID | Animated | Format | Example |
-| --- | --- | --- | --- |
-| `default` / null | ❌ | [PNG](https://de.wikipedia.org/wiki/Portable_Network_Graphics) | [uuid.png](https://raw.githubusercontent.com/litetex-oss/mcm-cape-provider/refs/heads/dev/custom-cape-demo/uuid.png) |
-| `sprite` | ✔ | Stacked [PNG](https://de.wikipedia.org/wiki/Portable_Network_Graphics) | [animated.png](https://raw.githubusercontent.com/litetex-oss/mcm-cape-provider/refs/heads/dev/custom-cape-demo/animated.png) |
-| `gif` | ✔ | [GIF](https://de.wikipedia.org/wiki/Graphics_Interchange_Format) | [animated.gif](https://raw.githubusercontent.com/litetex-oss/mcm-cape-provider/refs/heads/dev/custom-cape-demo/animated.gif) |
+| Resolver-ID | Animated | Format | Example | Notes |
+| --- | --- | --- | --- | --- |
+| `default` / null | ❌ | [PNG](https://de.wikipedia.org/wiki/Portable_Network_Graphics) | [uuid.png](https://raw.githubusercontent.com/litetex-oss/mcm-cape-provider/refs/heads/dev/custom-cape-demo/uuid.png) | |
+| `sprite` | ✔ | Stacked [PNG](https://de.wikipedia.org/wiki/Portable_Network_Graphics) | [animated.png](https://raw.githubusercontent.com/litetex-oss/mcm-cape-provider/refs/heads/dev/custom-cape-demo/animated.png) | |
+| `gif` | ✔ | [GIF](https://de.wikipedia.org/wiki/Graphics_Interchange_Format) | [animated.gif](https://raw.githubusercontent.com/litetex-oss/mcm-cape-provider/refs/heads/dev/custom-cape-demo/animated.gif) | _Usage not recommended_<br/>GIFs require more resources when compared to more modern formats like PNG. |
 
 Please note that animated textures can be frozen or completely disabled in the settings.
 

gradle/wrapper/gradle-wrapper.properties

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

gradlew

@@ -0,0 +1,15 @@
+package net.litetex.capes.handler;
+
+import net.minecraft.client.texture.NativeImage;
+
+
+public record AnimatedNativeImageContainer(
+	NativeImage image,
+	int delayMs
+)
+{
+	public AnimatedNativeImageContainer(final NativeImage image)
+	{
+		this(image, 100);
+	}
+}

gradlew.bat

@@ -8,17 +8,14 @@
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.time.Duration;
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
-import java.util.LinkedHashMap;
 import java.util.List;
-import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
-import java.util.stream.Collectors;
+import java.util.concurrent.atomic.AtomicInteger;
 import java.util.stream.Stream;
 
 import org.slf4j.Logger;
@@ -172,7 +169,7 @@ private boolean isCapeBlocked(final CapeProvider provider, final byte[] imageByt
 		return blockedCapeHashes.contains(Arrays.hashCode(imageBytes));
 	}
 
-	private Map<Identifier, NativeImage> determineTexturesToRegister(
+	private List<TextureToRegister> determineTexturesToRegister(
 		final TextureResolver textureResolver,
 		final byte[] imageData,
 		final boolean freezeAnimation,
@@ -186,40 +183,42 @@ private Map<Identifier, NativeImage> determineTexturesToRegister(
 
 		if(resolved instanceof final TextureResolver.DefaultResolvedTextureData defaultResolvedTextureData)
 		{
-			return Map.of(identifier(this.uuid().toString()), defaultResolvedTextureData.texture());
+			return List.of(new TextureToRegister(
+				identifier(this.uuid().toString()),
+				defaultResolvedTextureData.texture()));
 		}
 		else if(resolved instanceof final TextureResolver.AnimatedResolvedTextureData animatedResolvedTextureData)
 		{
-			final Map<Integer, NativeImage> textures = animatedResolvedTextureData.textures();
-			Stream<Map.Entry<Integer, NativeImage>> animatedTextureStream = textures.entrySet().stream();
+			final List<AnimatedNativeImageContainer> textures = animatedResolvedTextureData.textures();
+			Stream<AnimatedNativeImageContainer> animatedTextureStream = textures.stream();
 
 			if(textures.isEmpty())
 			{
 				LOG.warn(
 					"Received animated texture with no frames[url='{}',profileId='{}']",
 					url,
 					this.profile.getId());
-				return Map.of();
+				return List.of();
 			}
 
 			if(freezeAnimation)
 			{
 				animatedTextureStream = animatedTextureStream.limit(1);
 			}
 
+			final AtomicInteger counter = new AtomicInteger(0);
 			return animatedTextureStream
-				.collect(Collectors.toMap(
-					e -> identifier(
-						this.uuid() + (!freezeAnimation ? "/" + e.getKey() : "")),
-					Map.Entry::getValue,
-					(l, r) -> r,
-					LinkedHashMap::new));
+				.map(c -> new TextureToRegister(
+					identifier(this.uuid() + (!freezeAnimation ? "/" + counter.getAndIncrement() : "")),
+					c.image(),
+					c.delayMs()))
+				.toList();
 		}
 		throw new IllegalStateException("Unexpected ResolvedTextureData: " + resolved.getClass().getSimpleName());
 	}
 
 	private Optional<IdentifierProvider> registerTexturesAndGetProvider(
-		final Map<Identifier, NativeImage> texturesToRegister)
+		final List<TextureToRegister> texturesToRegister)
 	{
 		if(texturesToRegister.isEmpty())
 		{
@@ -229,19 +228,31 @@ private Optional<IdentifierProvider> registerTexturesAndGetProvider(
 		final TextureManager textureManager = MinecraftClient.getInstance().getTextureManager();
 		// Do texturing work NOT on Render thread
 		CompletableFuture.runAsync(
-				() -> texturesToRegister.forEach((id, texture) ->
+				() -> texturesToRegister.forEach(t ->
 					textureManager.registerTexture(
-						id,
-						new NativeImageBackedTexture(id::toString, texture))),
+						t.identifier(),
+						new NativeImageBackedTexture(t.identifier()::toString, t.image()))),
 				MinecraftClient.getInstance())
 			.exceptionally(ex -> {
 				LOG.warn("Failed to register textures", ex);
 				return null;
 			});
 
 		return Optional.of(texturesToRegister.size() == 1
-			? new DefaultIdentifierProvider(texturesToRegister.keySet().iterator().next())
-			: new AnimatedIdentifierProvider(texturesToRegister.keySet()));
+			? new DefaultIdentifierProvider(texturesToRegister.getFirst().identifier())
+			: new AnimatedIdentifierProvider(texturesToRegister));
+	}
+	
+	record TextureToRegister(
+		Identifier identifier,
+		NativeImage image,
+		int delayMs
+	)
+	{
+		public TextureToRegister(final Identifier identifier, final NativeImage image)
+		{
+			this(identifier, image, 100);
+		}
 	}
 
 	private AnimatedCapesHandling animatedCapesHandling()
@@ -281,13 +292,21 @@ public boolean dynamicIdentifier()
 
 	static class AnimatedIdentifierProvider implements IdentifierProvider
 	{
-		private final List<Identifier> identifiers;
+		private final List<IdentifierContainer> identifiers;
 		private int lastFrameIndex;
 		private long nextFrameTime;
 
-		public AnimatedIdentifierProvider(final Collection<Identifier> identifiers)
+		public AnimatedIdentifierProvider(final Collection<TextureToRegister> identifiers)
 		{
-			this.identifiers = new ArrayList<>(identifiers);
+			this.identifiers = identifiers.stream()
+				.map(t -> new IdentifierContainer(
+					t.identifier(),
+					Math.clamp(
+						t.delayMs(),
+						1,
+						// 1min
+						60 * 1_000)))
+				.toList();
 		}
 
 		@Override
@@ -298,17 +317,25 @@ public Identifier identifier()
 			{
 				final int thisFrameIndex = (this.lastFrameIndex + 1) % this.identifiers.size();
 				this.lastFrameIndex = thisFrameIndex;
-				this.nextFrameTime = time + 100L;
 
-				return this.identifiers.get(thisFrameIndex);
+				final IdentifierContainer ic = this.identifiers.get(thisFrameIndex);
+				this.nextFrameTime = time + ic.delay();
+				
+				return ic.identifier();
 			}
-			return this.identifiers.get(this.lastFrameIndex);
+			return this.identifiers.get(this.lastFrameIndex).identifier();
 		}
 
 		@Override
 		public boolean dynamicIdentifier()
 		{
 			return true;
 		}
+		
+		record IdentifierContainer(
+			Identifier identifier,
+			int delay)
+		{
+		}
 	}
 }