feature: weighted locks (#97)

* feature: weighted locks

Allow resource packs to change lock weights with optional lock metadata
(e.g. lock-42.png.mcdata).

* feat: defaultWeight for lock textures

Add a default lock texture weight settable in lock.png.mcmeta.

Author: me-nx

src/main/java/me/contaria/seedqueue/customization/LockTexture.java

@@ -4,6 +4,8 @@
 import me.contaria.speedrunapi.util.IdentifierUtil;
 import net.minecraft.client.MinecraftClient;
 import net.minecraft.client.texture.NativeImage;
+import net.minecraft.resource.Resource;
+import net.minecraft.resource.ResourceManager;
 import net.minecraft.util.Identifier;
 
 import java.io.IOException;
@@ -13,29 +15,68 @@
 public class LockTexture extends AnimatedTexture {
     private final int width;
     private final int height;
+    private final LockTextureMetadata metadata;
 
-    public LockTexture(Identifier id) throws IOException {
+    public LockTexture(Identifier id, int defaultWeight) throws IOException {
         super(id);
-        try (NativeImage image = NativeImage.read(MinecraftClient.getInstance().getResourceManager().getResource(id).getInputStream())) {
+
+        Resource resource = MinecraftClient.getInstance()
+            .getResourceManager()
+            .getResource(id);
+
+        try (NativeImage image = NativeImage.read(resource.getInputStream())) {
             this.width = image.getWidth();
             this.height = image.getHeight() / (this.animation != null ? this.animation.getFrameIndexSet().size() : 1);
         }
+
+        LockTextureMetadata metadata = resource.getMetadata(LockTextureMetadata.READER);
+
+        if (metadata == null) {
+            metadata = new LockTextureMetadata();
+        }
+
+        if (metadata.weight == 0) {
+            metadata.weight = defaultWeight;
+        }
+
+        this.metadata = metadata;
     }
 
     public double getAspectRatio() {
         return (double) this.width / this.height;
     }
 
+    public int getWeight() {
+        return Math.max(1, this.metadata.weight);
+    }
+
     public static List<LockTexture> createLockTextures() {
+        ResourceManager resourceManager = MinecraftClient.getInstance().getResourceManager();
+
         List<LockTexture> lockTextures = new ArrayList<>();
+
         Identifier lock = IdentifierUtil.of("seedqueue", "textures/gui/wall/lock.png");
+
+        int defaultWeight = 1;
+        try {
+            MainLockTextureMetadata metadata = resourceManager
+                .getResource(lock)
+                .getMetadata(MainLockTextureMetadata.READER);
+
+            if (metadata != null) {
+                defaultWeight = metadata.defaultWeight;
+            }
+        } catch (IOException e) {
+            SeedQueue.LOGGER.warn("Failed to read the main lock texture", e);
+        }
+
         do {
             try {
-                lockTextures.add(new LockTexture(lock));
+                lockTextures.add(new LockTexture(lock, defaultWeight));
             } catch (IOException e) {
                 SeedQueue.LOGGER.warn("Failed to read lock image texture: {}", lock, e);
             }
-        } while (MinecraftClient.getInstance().getResourceManager().containsResource(lock = IdentifierUtil.of("seedqueue", "textures/gui/wall/lock-" + lockTextures.size() + ".png")));
+        } while (resourceManager.containsResource(lock = IdentifierUtil.of("seedqueue", "textures/gui/wall/lock-" + lockTextures.size() + ".png")));
         return lockTextures;
     }
 }

src/main/java/me/contaria/seedqueue/customization/LockTextureMetadata.java

@@ -0,0 +1,26 @@
+package me.contaria.seedqueue.customization;
+
+import com.google.gson.Gson;
+import com.google.gson.JsonObject;
+import net.minecraft.resource.metadata.ResourceMetadataReader;
+
+@SuppressWarnings("unused") // fields set by GSON
+class LockTextureMetadata {
+    public static final ResourceMetadataReader<LockTextureMetadata> READER = new Reader();
+
+    public int weight;
+
+    private static class Reader implements ResourceMetadataReader<LockTextureMetadata> {
+        private static final Gson GSON = new Gson();
+
+        @Override
+        public String getKey() {
+            return "seedqueue";
+        }
+
+        @Override
+        public LockTextureMetadata fromJson(JsonObject json) {
+            return GSON.fromJson(json, LockTextureMetadata.class);
+        }
+    }
+}

src/main/java/me/contaria/seedqueue/customization/MainLockTextureMetadata.java

@@ -0,0 +1,26 @@
+package me.contaria.seedqueue.customization;
+
+import com.google.gson.Gson;
+import com.google.gson.JsonObject;
+import net.minecraft.resource.metadata.ResourceMetadataReader;
+
+class MainLockTextureMetadata {
+    public static final ResourceMetadataReader<MainLockTextureMetadata> READER = new Reader();
+
+    @SuppressWarnings("unused") // set by GSON
+    public int defaultWeight;
+
+    private static class Reader implements ResourceMetadataReader<MainLockTextureMetadata> {
+        private static final Gson GSON = new Gson();
+
+        @Override
+        public String getKey() {
+            return "seedqueue";
+        }
+
+        @Override
+        public MainLockTextureMetadata fromJson(JsonObject json) {
+            return GSON.fromJson(json, MainLockTextureMetadata.class);
+        }
+    }
+}

src/main/java/me/contaria/seedqueue/gui/wall/SeedQueueWallScreen.java

@@ -74,6 +74,7 @@ public class SeedQueueWallScreen extends Screen {
     private boolean playedScheduledEnterWarning;
 
     private List<LockTexture> lockTextures;
+    private int lockTexturesWeightSum;
     @Nullable
     private AnimatedTexture background;
     @Nullable
@@ -113,14 +114,29 @@ protected void init() {
         this.lockedPreviews = this.layout.locked != null ? new ArrayList<>() : null;
         this.preparingPreviews = new ArrayList<>();
         this.lockTextures = LockTexture.createLockTextures();
+        this.lockTexturesWeightSum = this.lockTextures.stream()
+            .mapToInt(LockTexture::getWeight)
+            .reduce(0, Math::addExact);
         this.background = AnimatedTexture.of(WALL_BACKGROUND);
         this.overlay = AnimatedTexture.of(WALL_OVERLAY);
         this.instanceBackground = AnimatedTexture.of(INSTANCE_BACKGROUND);
         this.instanceOverlay = AnimatedTexture.of(INSTANCE_OVERLAY);
     }
 
     protected LockTexture getRandomLockTexture() {
-        return this.lockTextures.get(this.random.nextInt(this.lockTextures.size()));
+        int target = this.random.nextInt(this.lockTexturesWeightSum);
+
+        int i = 0;
+
+        for (LockTexture lockTexture : this.lockTextures) {
+            i += lockTexture.getWeight();
+
+            if (i > target) {
+                return lockTexture;
+            }
+        }
+
+        throw new AssertionError("unreachable");
     }
 
     @Override