Speedrun API / SeedQueue compatibility (#202)

* upgradle: loom 1.5

* feature: speedrunapi support

* check if createWorld is called on clientthread for seedqueue compat

* bump version to 15.0

* fix: always use english option compat with fabric resource loader

* remove the mixin plugin as it is unnecessary

---------

Co-authored-by: contaria <[email protected]>

Author: tildejustin

build.gradle

@@ -1,7 +1,7 @@
 //file:noinspection GroovyUnusedAssignment
 //file:noinspection GroovyAssignabilityCheck
 plugins {
-	id 'fabric-loom' version '1.4-SNAPSHOT'
+	id 'fabric-loom' version '1.5-SNAPSHOT'
 	id 'maven-publish'
 }
 
@@ -26,6 +26,8 @@ dependencies {
 	minecraft "com.mojang:minecraft:${project.minecraft_version}"
 	mappings "com.github.RedLime:yarn:${project.yarn_mappings}:v2"
 	modImplementation "net.fabricmc:fabric-loader:${project.loader_version}"
+	// https://jitpack.io/#kingcontaria/speedrunapi
+	modImplementation "com.github.KingContaria:SpeedrunAPI:3d7827a9c1"
 
 	// PSA: Some older mods, compiled on Loom 0.2.1, might have outdated Maven POMs.
 	// You may need to force-disable transitiveness on them.

gradle.properties

@@ -10,6 +10,6 @@ yarn_mappings=1.16.1.build.19
 loader_version=0.14.25
 
 # Mod Properties
-mod_version=14.2
+mod_version=15.0
 maven_group=com.redlimerl.speedrunigt
 archives_base_name=SpeedRunIGT

src/main/java/com/redlimerl/speedrunigt/SpeedRunIGTMixinPlugin.java

@@ -0,0 +1,13 @@
+package com.redlimerl.speedrunigt.gui.screen;
+
+import net.minecraft.client.gui.screen.Screen;
+import org.jetbrains.annotations.NotNull;
+import org.mcsr.speedrunapi.config.api.SpeedrunConfigScreenProvider;
+
+@SuppressWarnings("unused")
+public class SpeedRunOptionScreenProvider implements SpeedrunConfigScreenProvider {
+    @Override
+    public @NotNull Screen createConfigScreen(Screen parent) {
+        return new SpeedRunOptionScreen(parent);
+    }
+}

src/main/java/com/redlimerl/speedrunigt/gui/screen/SpeedRunOptionScreenProvider.java

@@ -74,6 +74,12 @@ public abstract class MinecraftClientMixin {
 
     @Inject(at = @At("HEAD"), method = "createWorld")
     public void onCreate(String worldName, LevelInfo levelInfo, RegistryTracker.Modifiable registryTracker, GeneratorOptions generatorOptions, CallbackInfo ci) {
+        // don't start timer when the world is being created on another thread
+        // this is for compatibility with SeedQueue, where this is method is called to create background seeds
+        if (!MinecraftClient.getInstance().isOnThread()) {
+            return;
+        }
+
         RunCategory category = SpeedRunOption.getOption(SpeedRunOptions.TIMER_CATEGORY);
         if (category.isAutoStart()) InGameTimer.start(worldName, RunType.fromBoolean(InGameTimerUtils.IS_SET_SEED));
         InGameTimer.getInstance().setDefaultGameMode(levelInfo.getGameMode().getId());

src/main/java/com/redlimerl/speedrunigt/mixins/MinecraftClientMixin.java

@@ -1,17 +1,18 @@
 package com.redlimerl.speedrunigt.mixins.retime;
 
 import com.redlimerl.speedrunigt.timer.InGameTimerUtils;
+import org.spongepowered.asm.mixin.Dynamic;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Pseudo;
 import org.spongepowered.asm.mixin.injection.At;
 import org.spongepowered.asm.mixin.injection.Inject;
 import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
 
-@SuppressWarnings("UnresolvedMixinReference")
 @Pseudo
 @Mixin(targets = "me.jellysquid.mods.sodium.client.gui.options.OptionImpl", remap = false)
 public class SodiumOptionImplMixin {
 
+    @Dynamic
     @Inject(method = "setValue", remap = false, at = @At("HEAD"))
     public void onSetValue(CallbackInfo ci) {
         InGameTimerUtils.CHANGED_OPTIONS.add(this);

src/main/java/com/redlimerl/speedrunigt/mixins/retime/SodiumOptionImplMixin.java

@@ -3,6 +3,7 @@
 import com.mojang.blaze3d.systems.RenderSystem;
 import com.redlimerl.speedrunigt.SpeedRunIGTUpdateChecker;
 import com.redlimerl.speedrunigt.gui.screen.SpeedRunOptionScreen;
+import net.fabricmc.loader.api.FabricLoader;
 import net.minecraft.client.gui.screen.Screen;
 import net.minecraft.client.gui.screen.options.OptionsScreen;
 import net.minecraft.client.gui.widget.ButtonWidget;
@@ -20,6 +21,7 @@ public class OptionsScreenMixin extends Screen {
     private static final Identifier ENDER_PEARL = new Identifier("textures/item/ender_pearl.png");
     private static final Identifier BLAZE_POWDER = new Identifier("textures/item/blaze_powder.png");
     private static final Identifier ENDER_EYE = new Identifier("textures/item/ender_eye.png");
+    private static final boolean hasSpeedrunAPI = FabricLoader.getInstance().isModLoaded("speedrunapi");
 
     private ButtonWidget timerButton;
 
@@ -29,6 +31,7 @@ protected OptionsScreenMixin(Text title) {
 
     @Inject(method = "init", at = @At("TAIL"))
     private void onInit(CallbackInfo ci) {
+        if (hasSpeedrunAPI) return;
         this.timerButton = new ButtonWidget(this.width / 2 - 180, this.height / 6 - 12, 20, 20, new LiteralText(""), (buttonWidget) -> {
             if (this.client != null) {
                 this.client.openScreen(new SpeedRunOptionScreen(this));
@@ -40,6 +43,7 @@ private void onInit(CallbackInfo ci) {
     @SuppressWarnings("deprecation")
     @Inject(method = "render", at = @At("TAIL"))
     private void renderEnderPearl(MatrixStack matrices, int mouseX, int mouseY, float delta, CallbackInfo ci) {
+        if (hasSpeedrunAPI) return;
         if (this.client != null) {
             RenderSystem.pushMatrix();
             RenderSystem.translatef(-.5f, -.5f, 0);

src/main/java/com/redlimerl/speedrunigt/mixins/screen/OptionsScreenMixin.java

@@ -10,7 +10,9 @@
 import org.spongepowered.asm.mixin.injection.At;
 import org.spongepowered.asm.mixin.injection.Inject;
 import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+import org.spongepowered.asm.mixin.injection.callback.LocalCapture;
 
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -28,4 +30,11 @@ private static void onLoad(List<Resource> resources, Map<String, String> transla
                     .ifPresent(langStream -> Language.load(langStream, translationMap::put));
         });
     }
+
+    @Inject(method = "load(Ljava/util/List;Ljava/util/Map;)V", at = @At(value = "INVOKE", target = "Lnet/minecraft/resource/Resource;getInputStream()Ljava/io/InputStream;"), locals = LocalCapture.CAPTURE_FAILSOFT, cancellable = true)
+    private static void cancelExternalLoadingOfTranslations(List<Resource> resources, Map<String, String> translationMap, CallbackInfo ci, Iterator<Resource> resourceIterator, Resource resource) {
+        if (SpeedRunOption.getOption(SpeedRunOptions.ALWAYS_ENGLISH_TRANSLATIONS) && resource.getId().getNamespace().equals("speedrunigt") && !resource.getId().getPath().equalsIgnoreCase("lang/en_us.json")) {
+            ci.cancel();
+        }
+    }
 }

src/main/java/com/redlimerl/speedrunigt/mixins/translate/TranslationStorageMixin.java

@@ -6,7 +6,12 @@
   "name": "SpeedRunIGT",
   "description": "Displays the timer with RTA, IGT in Minecraft",
   "authors": [
-    "RedLime"
+    {
+      "name": "RedLime",
+      "contact": {
+        "homepage": "https://github.com/RedLime"
+      }
+    }
   ],
   "contact": {
     "sources": "https://github.com/RedLime/SpeedRunIGT"
@@ -39,5 +44,15 @@
 
   "breaks": {
     "ghostrunner": "<=3.0"
+  },
+
+  "suggests": {
+    "speedrunapi": "*"
+  },
+
+  "custom": {
+    "speedrunapi": {
+      "screen": "com.redlimerl.speedrunigt.gui.screen.SpeedRunOptionScreenProvider"
+    }
   }
 }

src/main/resources/fabric.mod.json

@@ -1,7 +1,6 @@
 {
   "required": true,
   "package": "com.redlimerl.speedrunigt.mixins",
-  "plugin": "com.redlimerl.speedrunigt.SpeedRunIGTMixinPlugin",
   "mixins": [
     "access.ServerStatHandlerAccessor",