Merge pull request #60 from litetex-oss/dev

Release

Author: litetex

CHANGELOG.md

@@ -1,3 +1,17 @@
+# 2.0.0
+* New options
+  * Control over animated textures
+    * ON (default)
+    * Frozen = only the first frame of the animation is displayed
+    * OFF = Animated textures are ignored
+  * Only load your cape (and ignore other players)
+* New debug options
+   * block certain capes by provider
+   * amount of Cape-Loader Threads (default: 2)
+* Now refreshes the capes of all players when the configuration is changed
+* Utilizes Fabric's Rendering API - if present - to prevent conflicts with other mods
+* Various minor improvements and optimizations
+
 # 1.2.0
 * Updated to 1.21.6
   * Reworked/Fixed preview rendering

README.md

@@ -17,6 +17,7 @@ Improved/Reworked version of the ["Capes" mod](https://github.com/CaelTheColher/
 * Improved and easier cape provider integration
 * Allows ordering providers
 * Support for custom providers
+* More options to fine tune how capes are applied
 * Written only in Java (no Kotlin needed)
 * Various fixes and improvements
 

build.gradle

@@ -85,13 +85,13 @@ dependencies {
     mappings "net.fabricmc:yarn:${project.yarn_mappings}:v2"
     modImplementation "net.fabricmc:fabric-loader:${project.loader_version}"
     // Required when translations and icons should be loaded correctly
-    modImplementation "net.fabricmc.fabric-api:fabric-api:0.126.1+1.21.6"
+    modImplementation "net.fabricmc.fabric-api:fabric-api:0.127.1+1.21.6"
 
     modCompileOnly "com.terraformersmc:modmenu:${project.modmenu_version}"
 
     // Only needed during development
-//    modLocalRuntime "com.terraformersmc:modmenu:${project.modmenu_version}"
-    modLocalRuntime "net.fabricmc.fabric-api:fabric-api:0.126.1+1.21.6"
+    modLocalRuntime "com.terraformersmc:modmenu:${project.modmenu_version}"
+    modLocalRuntime "net.fabricmc.fabric-api:fabric-api:0.127.1+1.21.6"
     modLocalRuntime "me.djtheredstoner:DevAuth-fabric:1.2.1"
 //    modLocalRuntime "maven.modrinth:no-chat-reports:Fabric-1.21.4-v2.11.0"
 }

gradle.properties

@@ -1,15 +1,15 @@
 # Done to increase the memory available to gradle.
 org.gradle.jvmargs=-Xmx2G
 # Fabric Properties
-yarn_mappings=1.21.6-rc1+build.1
+yarn_mappings=1.21.6+build.1
 loader_version=0.16.14
 # Mod Properties
-mod_version=1.2.1-SNAPSHOT
+mod_version=2.0.0-SNAPSHOT
 maven_group=net.litetex.mcm
 archives_base_name=cape-provider
 mod_name=Cape Provider
 mod_desc=Use capes from various providers
 mod_license_spdx_id=LGPL-2.1-or-later
 mod_license_url=https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 # Additional
-modmenu_version=14.0.0-rc.2
+modmenu_version=15.0.0-beta.2

src/main/java/net/litetex/capes/Capes.java

@@ -5,12 +5,18 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.Set;
 import java.util.function.Consumer;
 import java.util.function.Predicate;
+import java.util.stream.Collectors;
 
 import net.litetex.capes.config.Config;
+import net.litetex.capes.handler.PlayerCapeHandlerManager;
+import net.litetex.capes.handler.TextureLoadThrottler;
 import net.litetex.capes.provider.CapeProvider;
 import net.litetex.capes.provider.MinecraftCapeProvider;
+import net.minecraft.client.MinecraftClient;
+import net.minecraft.client.network.ClientPlayNetworkHandler;
 import net.minecraft.util.Identifier;
 
 
@@ -42,6 +48,11 @@ public static void setInstance(final Capes instance)
 
 	private final boolean validateProfile;
 	private final Duration loadThrottleSuppressDuration;
+	private final Map<CapeProvider, Set<Integer>> blockedProviderCapeHashes;
+	
+	private final PlayerCapeHandlerManager playerCapeHandlerManager;
+	private final TextureLoadThrottler textureLoadThrottler;
+	private boolean shouldRefresh;
 
 	public Capes(
 		final Config config,
@@ -56,13 +67,50 @@ public Capes(
 		this.loadThrottleSuppressDuration = Optional.ofNullable(this.config().getLoadThrottleSuppressSec())
 			.map(Duration::ofSeconds)
 			.orElse(Duration.ofMinutes(3));
+		this.blockedProviderCapeHashes = Optional.ofNullable(this.config().getBlockedProviderCapeHashes())
+			.map(map -> map.entrySet()
+				.stream()
+				.filter(e -> allProviders.containsKey(e.getKey()))
+				.collect(Collectors.toMap(e -> allProviders.get(e.getKey()), Map.Entry::getValue)))
+			.orElseGet(Map::of);
+		
+		this.playerCapeHandlerManager = new PlayerCapeHandlerManager(this);
+		this.textureLoadThrottler = new TextureLoadThrottler(this.playerCapeHandlerManager);
 	}
 
 	public void saveConfig()
 	{
 		this.saveConfigFunc.accept(this.config);
 	}
 
+	public void saveConfigAndMarkRefresh()
+	{
+		this.saveConfig();
+		this.shouldRefresh = true;
+	}
+	
+	public void refreshIfMarked()
+	{
+		if(this.shouldRefresh)
+		{
+			this.refresh();
+			this.shouldRefresh = false;
+		}
+	}
+	
+	protected void refresh()
+	{
+		this.textureLoadThrottler.clearCache();
+		this.playerCapeHandlerManager.clearCache();
+		
+		final ClientPlayNetworkHandler networkHandler = MinecraftClient.getInstance().getNetworkHandler();
+		if(networkHandler != null)
+		{
+			networkHandler.getPlayerList().forEach(e ->
+				this.textureLoadThrottler.loadIfRequired(e.getProfile()));
+		}
+	}
+	
 	public Config config()
 	{
 		return this.config;
@@ -97,4 +145,19 @@ public Duration loadThrottleSuppressDuration()
 	{
 		return this.loadThrottleSuppressDuration;
 	}
+	
+	public Map<CapeProvider, Set<Integer>> blockedProviderCapeHashes()
+	{
+		return this.blockedProviderCapeHashes;
+	}
+	
+	public TextureLoadThrottler textureLoadThrottler()
+	{
+		return this.textureLoadThrottler;
+	}
+	
+	public PlayerCapeHandlerManager playerCapeHandlerManager()
+	{
+		return this.playerCapeHandlerManager;
+	}
 }

src/main/java/net/litetex/capes/CapesI18NKeys.java

@@ -14,7 +14,10 @@ public final class CapesI18NKeys
 	public static final String MANAGE_PROVIDERS = PREFIX + "manage_providers";
 
 	public static final String OTHER = PREFIX + "other";
+	public static final String ANIMATED_TEXTURES = PREFIX + "animated_textures";
 	public static final String ELYTRA_TEXTURE = PREFIX + "elytra_texture";
+	public static final String FROZEN = PREFIX + "frozen";
+	public static final String ONLY_LOAD_YOUR_CAPE = PREFIX + "only_load_your_cape";
 
 	private static final String ANTI_FEATURE_PREFIX = PREFIX + "anti_feature.";
 	public static final String ANTI_FEATURE_BAD_CONNECTION = ANTI_FEATURE_PREFIX + "bad_connection";

src/main/java/net/litetex/capes/CapesMixinPlugin.java

@@ -0,0 +1,74 @@
+package net.litetex.capes;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.function.BooleanSupplier;
+
+import org.objectweb.asm.tree.ClassNode;
+import org.spongepowered.asm.mixin.extensibility.IMixinConfigPlugin;
+import org.spongepowered.asm.mixin.extensibility.IMixinInfo;
+
+import net.litetex.capes.fabric.FabricModDetector;
+
+
+public class CapesMixinPlugin implements IMixinConfigPlugin
+{
+	private static final String MIXIN_PACKAGE = "net.litetex.capes.mixins.";
+	
+	static final Map<String, BooleanSupplier> CONDITIONS = Map.of(
+		MIXIN_PACKAGE + "SpecialGuiElementRendererRegisterGuiRendererMixin",
+		() -> !FabricModDetector.isFabricRenderingApiPresent()
+	);
+	
+	@Override
+	public boolean shouldApplyMixin(final String targetClassName, final String mixinClassName)
+	{
+		final BooleanSupplier supplier = CONDITIONS.get(targetClassName);
+		return supplier == null || supplier.getAsBoolean();
+	}
+	
+	// region Boiler
+	
+	@Override
+	public void onLoad(final String mixinPackage)
+	{
+	}
+	
+	@Override
+	public String getRefMapperConfig()
+	{
+		return null;
+	}
+	
+	@Override
+	public void acceptTargets(final Set<String> myTargets, final Set<String> otherTargets)
+	{
+	}
+	
+	@Override
+	public List<String> getMixins()
+	{
+		return null;
+	}
+	
+	@Override
+	public void preApply(
+		final String targetClassName,
+		final ClassNode targetClass,
+		final String mixinClassName,
+		final IMixinInfo mixinInfo)
+	{
+	}
+	
+	@Override
+	public void postApply(
+		final String targetClassName,
+		final ClassNode targetClass,
+		final String mixinClassName,
+		final IMixinInfo mixinInfo)
+	{
+	}
+	
+	// endregion
+}

src/main/java/net/litetex/capes/config/AnimatedCapesHandling.java

@@ -0,0 +1,8 @@
+package net.litetex.capes.config;
+
+public enum AnimatedCapesHandling
+{
+	ON,
+	FROZEN,
+	OFF
+}

src/main/java/net/litetex/capes/config/Config.java

@@ -3,6 +3,7 @@
 import java.util.Collection;
 import java.util.LinkedHashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
 
@@ -15,21 +16,29 @@ public class Config
 	private String currentPreviewProviderId;
 	// NOTE: Default/Minecraft is always active
 	private Set<String> activeProviderIds;
+	private boolean onlyLoadForSelf;
 	private boolean enableElytraTexture;
+	private AnimatedCapesHandling animatedCapesHandling = AnimatedCapesHandling.ON;
 	private List<CustomProviderConfig> customProviders = List.of();
 
 	// Advanced/Debug options
 	private Boolean validateProfile;
 	private Integer loadThrottleSuppressSec;
+	private Map<String, Set<Integer>> blockedProviderCapeHashes;
+	private Integer loadThreads;
 
 	public void reset()
 	{
 		this.setCurrentPreviewProviderId(null);
 		this.setActiveProviderIds(List.of(MinecraftCapesCapeProvider.ID, OptiFineCapeProvider.ID));
+		this.setOnlyLoadForSelf(false);
 		this.setEnableElytraTexture(true);
+		this.setAnimatedCapesHandling(AnimatedCapesHandling.ON);
 
 		this.setValidateProfile(null);
 		this.setLoadThrottleSuppressSec(null);
+		this.setBlockedProviderCapeHashes(null);
+		this.setLoadThreads(null);
 	}
 
 	public static Config createDefault()
@@ -61,6 +70,16 @@ public void setActiveProviderIds(final Collection<String> activeProviderIds)
 		this.activeProviderIds = new LinkedHashSet<>(Objects.requireNonNull(activeProviderIds));
 	}
 
+	public boolean isOnlyLoadForSelf()
+	{
+		return this.onlyLoadForSelf;
+	}
+	
+	public void setOnlyLoadForSelf(final boolean onlyLoadForSelf)
+	{
+		this.onlyLoadForSelf = onlyLoadForSelf;
+	}
+	
 	public boolean isEnableElytraTexture()
 	{
 		return this.enableElytraTexture;
@@ -71,6 +90,16 @@ public void setEnableElytraTexture(final boolean enableElytraTexture)
 		this.enableElytraTexture = enableElytraTexture;
 	}
 
+	public AnimatedCapesHandling getAnimatedCapesHandling()
+	{
+		return this.animatedCapesHandling;
+	}
+	
+	public void setAnimatedCapesHandling(final AnimatedCapesHandling animatedCapesHandling)
+	{
+		this.animatedCapesHandling = animatedCapesHandling;
+	}
+	
 	public List<CustomProviderConfig> getCustomProviders()
 	{
 		return this.customProviders;
@@ -101,5 +130,25 @@ public void setLoadThrottleSuppressSec(final Integer loadThrottleSuppressSec)
 		this.loadThrottleSuppressSec = loadThrottleSuppressSec;
 	}
 
+	public Map<String, Set<Integer>> getBlockedProviderCapeHashes()
+	{
+		return this.blockedProviderCapeHashes;
+	}
+	
+	public void setBlockedProviderCapeHashes(final Map<String, Set<Integer>> blockedProviderCapeHashes)
+	{
+		this.blockedProviderCapeHashes = blockedProviderCapeHashes;
+	}
+	
+	public Integer getLoadThreads()
+	{
+		return this.loadThreads;
+	}
+	
+	public void setLoadThreads(final Integer loadThreads)
+	{
+		this.loadThreads = loadThreads;
+	}
+	
 	// endregion
 }

src/main/java/net/litetex/capes/fabric/FabricCapes.java

@@ -27,6 +27,8 @@ public class FabricCapes implements ClientModInitializer
 	@Override
 	public void onInitializeClient()
 	{
+		FabricCapesCompatibilityInit.init();
+		
 		final Config config = this.loadConfig();
 		Capes.setInstance(new Capes(
 			config,