Add JourneyMap integration (#42)

triphora · web-flow · commit ae3e6e749c7b · 2022-04-03T19:13:28.000-04:00
diff --git a/README.md b/README.md
@@ -1,17 +1,15 @@
+<!-- modrinth_exclude.start -->
 # Empire Minecraft Utilities
 
 [![Modrinth downloads](https://img.shields.io/modrinth/dt/emcutils?color=5da545&label=downloads&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMSAxMSIgd2lkdGg9IjE0LjY2NyIgaGVpZ2h0PSIxNC42NjciICB4bWxuczp2PSJodHRwczovL3ZlY3RhLmlvL25hbm8iPjxkZWZzPjxjbGlwUGF0aCBpZD0iQSI+PHBhdGggZD0iTTAgMGgxMXYxMUgweiIvPjwvY2xpcFBhdGg+PC9kZWZzPjxnIGNsaXAtcGF0aD0idXJsKCNBKSI+PHBhdGggZD0iTTEuMzA5IDcuODU3YTQuNjQgNC42NCAwIDAgMS0uNDYxLTEuMDYzSDBDLjU5MSA5LjIwNiAyLjc5NiAxMSA1LjQyMiAxMWMxLjk4MSAwIDMuNzIyLTEuMDIgNC43MTEtMi41NTZoMGwtLjc1LS4zNDVjLS44NTQgMS4yNjEtMi4zMSAyLjA5Mi0zLjk2MSAyLjA5MmE0Ljc4IDQuNzggMCAwIDEtMy4wMDUtMS4wNTVsMS44MDktMS40NzQuOTg0Ljg0NyAxLjkwNS0xLjAwM0w4LjE3NCA1LjgybC0uMzg0LS43ODYtMS4xMTYuNjM1LS41MTYuNjk0LS42MjYuMjM2LS44NzMtLjM4N2gwbC0uMjEzLS45MS4zNTUtLjU2Ljc4Ny0uMzcuODQ1LS45NTktLjcwMi0uNTEtMS44NzQuNzEzLTEuMzYyIDEuNjUxLjY0NSAxLjA5OC0xLjgzMSAxLjQ5MnptOS42MTQtMS40NEE1LjQ0IDUuNDQgMCAwIDAgMTEgNS41QzExIDIuNDY0IDguNTAxIDAgNS40MjIgMCAyLjc5NiAwIC41OTEgMS43OTQgMCA0LjIwNmguODQ4QzEuNDE5IDIuMjQ1IDMuMjUyLjgwOSA1LjQyMi44MDljMi42MjYgMCA0Ljc1OCAyLjEwMiA0Ljc1OCA0LjY5MSAwIC4xOS0uMDEyLjM3Ni0uMDM0LjU2bC43NzcuMzU3aDB6IiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGZpbGw9IiM1ZGE0MjYiLz48L2c+PC9zdmc+)](https://modrinth.com/mod/emcutils)
-![](https://tokei.rs/b1/github/wafflecoffee/Empire-Minecraft-Utilities?category=code)
-![](https://tokei.rs/b1/github/wafflecoffee/Empire-Minecraft-Utilities?category=files)
 ![](https://img.shields.io/badge/environment-client-1976d2)
+<!-- modrinth_exclude.end -->
 
 Empire Minecraft Utilities, aka emcutils, is a 1.16, 1.17, and 1.18 mod containing a collection of small utilities for players of [Empire Minecraft](https://ref.emc.gs/wafflecoffee).  
 Feature idea credits go to [Giselbaer](https://u.emc.gs/Giselbaer)/[gbl](https://github.com/gbl).
 
 Made by [MrFrydae](https://u.emc.gs/GreenMeanie) and [wafflecoffee/Emmaffle](https://u.emc.gs/wafflecoffee), available under the MIT License.
 
-Modrinth page for downloads: https://modrinth.com/mod/emcutils
-
 Architectury API is the only required dependency (download for [Fabric](https://www.curseforge.com/minecraft/mc-mods/architectury-fabric) or [Forge](https://www.curseforge.com/minecraft/mc-mods/architectury-forge)). [Not Enough Crashes](https://modrinth.com/mod/notenoughcrashes) is recommended, as are [Mod Menu](https://modrinth.com/mod/modmenu) and [VoxelMap](https://www.curseforge.com/minecraft/mc-mods/voxelmap) when on Fabric.
 
 ## Feature List
@@ -21,15 +19,11 @@ Architectury API is the only required dependency (download for [Fabric](https://
 * Easier viewing of usable Custom Items such as [Pot of Gold](https://wiki.emc.gs/pot-of-gold) or [EMC Peppermint](https://wiki.emc.gs/emc-peppermint)
 * Customizable tab list sorting
 * Vault buttons
-* Integration with VoxelMap and Xaero's World Map/Minimap
+* Integration with JourneyMap, VoxelMap, and Xaero's World Map/Minimap
   * Clicking on a residence will teleport you to that residence
-  * Automatic world detection and map confirmation/creation (Voxel only)
+  * Automatic world detection and map confirmation/creation (not available on Xaero's)
 * And more to come :)
 
-## Maven/Development
-
-See [here](https://gist.github.com/wafflecoffee/95cc480698ec06b6295d1e9c8946fa61) for instructions on developing with emcutils.
-
 ## Disclaimer
 
 This mod is not sponsored by nor affiliated with Empire Minecraft, Starlis LLC, or Mojang Studios. It has been approved for use on Empire Minecraft in accordance with its [approved mod](https://mods.emc.gs) policies.
diff --git a/build.gradle b/build.gradle
@@ -2,7 +2,8 @@ plugins {
   id "architectury-plugin" version "3.4.+"
   id "dev.architectury.loom" version "0.11.0.+" apply false
   id "com.modrinth.minotaur" version "2.+" apply false
-  id "io.github.juuxel.loom-quiltflower" version "1.+" apply false
+  id "org.quiltmc.quilt-mappings-on-loom" version "4.+"
+  //id "io.github.juuxel.loom-quiltflower" version "1.+" apply false
 }
 
 architectury {
@@ -11,10 +12,11 @@ architectury {
 
 subprojects {
   apply plugin: "dev.architectury.loom"
-  apply plugin: "io.github.juuxel.loom-quiltflower"
+  //apply plugin: "io.github.juuxel.loom-quiltflower"
   apply plugin: "com.modrinth.minotaur"
 
   repositories {
+    mavenLocal()
     maven {
       url "https://api.modrinth.com/maven"
       content { includeGroup "maven.modrinth" }
@@ -31,7 +33,9 @@ subprojects {
 
   dependencies {
     minecraft "com.mojang:minecraft:${rootProject.mc_version}"
-    mappings "net.fabricmc:yarn:${rootProject.mc_version}+build.${rootProject.yarn_mappings}:v2"
+    mappings( loom.layered { it.addLayer ( quiltMappings.mappings (
+            "org.quiltmc:quilt-mappings:${rootProject.mc_version}+build.${rootProject.quilt_mappings}:v2"
+    ))})
 
     if (project.name != "forge") {
       modImplementation "net.fabricmc:fabric-loader:${rootProject.loader_version}"
@@ -50,9 +54,6 @@ allprojects {
   archivesBaseName = "emcutils-${project.name}-${rootProject.mc_version}"
   version = mod_version + System.getenv().SNAPSHOT
 
-  // Comment this line out if you have good internet
-  idea { module { downloadJavadoc = false } }
-
   tasks.withType(JavaCompile) {
     options.encoding = "UTF-8"
     //noinspection all
diff --git a/common/src/main/java/dev/frydae/emcutils/containers/EmpireServer.java b/common/src/main/java/dev/frydae/emcutils/containers/EmpireServer.java
@@ -38,7 +38,6 @@ public enum EmpireServer {
   @Getter private final char tabListDisplay;
   @Getter private final String command;
   @Getter private final List<EmpireResidence> residences;
-  private static boolean didConnectionFail;
 
   EmpireServer(int id, String name, int tabListRank, char tabListDisplay) {
     this.id = id;
@@ -136,11 +135,9 @@ public void collectResidences() {
               .getAsJsonObject("areas");
 
       object.entrySet().forEach(e -> residences.add(new EmpireResidence(this, e.getValue().getAsJsonObject())));
-    } catch (IOException ioException) {
-      didConnectionFail = true;
+      LOG.info("Loaded Residences for: " + name.toLowerCase());
+    } catch (IOException e) {
+      LOG.info("Residence collector for " + name.toLowerCase() + " failed; you may find the 'Don't run residence collector' option to be useful. This option will prevent the residence collector from running at all, which, on very slow connections, will help prevent requests which will fail anyway.");
     }
-
-    if (didConnectionFail) LOG.info("Residence collector for " + name.toLowerCase() + " failed; you may find the 'Don't run residence collector' option to be useful. This option will prevent the residence collector from running at all, which, on very slow connections, will help prevent requests which will fail anyway.");
-    else LOG.info("Loaded Residences for: " + name.toLowerCase());
   }
 }
diff --git a/common/src/main/java/dev/frydae/emcutils/features/VaultScreen.java b/common/src/main/java/dev/frydae/emcutils/features/VaultScreen.java
@@ -171,8 +171,8 @@ private void handleClick(int buttonX, double mouseX, double mouseY, String comma
   }
 
   @Override
-  public void close() {
-    if (shouldCallClose) super.close();
+  public void onClose() {
+    if (shouldCallClose) super.onClose();
     else shouldCallClose = true;
   }
 }
diff --git a/common/src/main/java/dev/frydae/emcutils/mixins/ClientPlayNetworkHandlerMixin.java b/common/src/main/java/dev/frydae/emcutils/mixins/ClientPlayNetworkHandlerMixin.java
@@ -40,6 +40,8 @@ public void onPostReceiveMessage(GameMessageS2CPacket packet, CallbackInfo info)
   @Inject(at = @At("TAIL"), method = "onGameJoin")
   public void onGameJoin(GameJoinS2CPacket packet, CallbackInfo info) {
     if (Util.isOnEMC) {
+      Util.world = packet.dimensionId().getValue().getPath();
+
       EmpireMinecraftUtilities.onJoinEmpireMinecraft();
 
       ClientTickEvent.CLIENT_LEVEL_POST.register(instance -> Util.executeJoinCommands());
diff --git a/common/src/main/java/dev/frydae/emcutils/mixins/MinecraftClientMixin.java b/common/src/main/java/dev/frydae/emcutils/mixins/MinecraftClientMixin.java
@@ -3,7 +3,7 @@
 import dev.frydae.emcutils.features.VaultScreen;
 import net.minecraft.client.MinecraftClient;
 import net.minecraft.client.gui.screen.Screen;
-import net.minecraft.client.option.KeyBinding;
+import net.minecraft.client.option.KeyBind;
 import net.minecraft.client.util.Window;
 import org.jetbrains.annotations.Nullable;
 import org.spongepowered.asm.mixin.Final;
@@ -33,7 +33,7 @@ public void onOpenScreen(@Nullable Screen screen, CallbackInfo ci) {
 
     mc.currentScreen = screen;
     mc.mouse.unlockCursor();
-    KeyBinding.unpressAll();
+    KeyBind.unpressAll();
     screen.init(mc, window.getScaledWidth(), window.getScaledHeight());
     mc.skipGameRender = false;
 
diff --git a/common/src/main/java/dev/frydae/emcutils/utils/Util.java b/common/src/main/java/dev/frydae/emcutils/utils/Util.java
@@ -9,8 +9,8 @@
 import lombok.SneakyThrows;
 import net.minecraft.client.MinecraftClient;
 import net.minecraft.client.network.PlayerListEntry;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.Arrays;
 import java.util.Collections;
@@ -22,10 +22,10 @@
 
 public class Util {
   public static final String MODID = "emcutils";
-  public static final Logger LOG = LogManager.getLogger(MODID);
+  public static final Logger LOG = LoggerFactory.getLogger(MODID);
   public static boolean isOnEMC = false;
   @Getter public static String world;
-  public static boolean hideFeatureMessages;
+  @Setter public static boolean hideFeatureMessages;
   @Getter @Setter private static String serverAddress;
   @Getter private static EmpireServer currentServer;
   private static Queue<String> onJoinCommandQueue;
@@ -98,10 +98,6 @@ public static synchronized Util getInstance() {
     return singleton;
   }
 
-  public void setHideFeatureMessages(boolean hide) {
-    hideFeatureMessages = hide;
-  }
-
   public static void runResidenceCollector() {
     if (!Config.dontRunResidenceCollector()) {
       ExecutorService executor = Executors.newCachedThreadPool();
diff --git a/fabric/build.gradle b/fabric/build.gradle
@@ -33,6 +33,7 @@ dependencies {
     exclude group: "net.fabricmc"
   }
 
+  include project(":journey")
   include project(":voxel")
   include project(":xaero")
 
@@ -91,7 +92,9 @@ modrinth {
           new ModDependency("codAaoxh", "required"), // MidnightLib
           new ModDependency("mOgUt4GM", "optional"), // Mod Menu
   ]
+  syncBodyFrom = rootProject.file("README.md").text
 }
+tasks.modrinth.dependsOn(tasks.modrinthSyncBody)
 
 publishing {
   publications {
diff --git a/gradle.properties b/gradle.properties
@@ -3,13 +3,15 @@ org.gradle.jvmargs=-Xmx4G
 org.gradle.parallel=true
 
 mc_version=1.18.2
-mod_version=3.0.1-SNAPSHOT
+mod_version=3.1.0
 
-release_title=Update to 1.18.2
-changeLog=
+release_title=Add JourneyMap compatibility
+changeLog=JM compat requires 5.8.1beta3 or higher.\n\nAlso has some internal changes in how presence of compat mods are present.
+
+# https://lambdaurora.dev/tools/import_quilt.html
+quilt_mappings=21
 
 # https://fabricmc.net/develop
-yarn_mappings=2
 loader_version=0.13.3
 fabric_version=0.48.0+1.18.2
 
@@ -28,6 +30,11 @@ modmenu_version=3.1.0
 # https://www.curseforge.com/minecraft/mc-mods/config-menus-forge/files/all
 config_menus_version=3671318
 
+# https://www.curseforge.com/minecraft/mc-mods/journeymap/files/all
+jm_version=3717512
+# https://jm.gserv.me/service/rest/repository/browse/maven-public/info/journeymap/journeymap-api/
+jm_api_version=1.18.2-1.8-fabric-SNAPSHOT
+
 # https://www.curseforge.com/minecraft/mc-mods/voxelmap/files/all
 # voxel_version=3345206
 
diff --git a/journey/build.gradle b/journey/build.gradle
@@ -0,0 +1,21 @@
+repositories {
+  maven {
+    url "https://jm.gserv.me/repository/maven-public/"
+  }
+}
+
+dependencies {
+  modCompileOnlyApi "info.journeymap:journeymap-api:${project.jm_api_version}"
+  modRuntimeOnly "curse.maven:jm-32274:${project.jm_version}"
+
+  api project(":common")
+  api project(":fabric")
+}
+
+processResources {
+  inputs.property "version", rootProject.mod_version
+
+  filesMatching("fabric.mod.json") {
+    expand "version": rootProject.mod_version
+  }
+}
diff --git a/journey/src/main/java/dev/frydae/emcutils/journey/EmpireMinecraftUtilitiesJourney.java b/journey/src/main/java/dev/frydae/emcutils/journey/EmpireMinecraftUtilitiesJourney.java
@@ -0,0 +1,65 @@
+package dev.frydae.emcutils.journey;
+
+import dev.frydae.emcutils.containers.EmpireResidence;
+import dev.frydae.emcutils.utils.Util;
+import journeymap.client.api.IClientAPI;
+import journeymap.client.api.IClientPlugin;
+import journeymap.client.api.display.Context;
+import journeymap.client.api.display.ModPopupMenu;
+import journeymap.client.api.event.ClientEvent;
+import journeymap.client.api.event.fabric.FabricEvents;
+import net.minecraft.client.MinecraftClient;
+import net.minecraft.util.math.BlockPos;
+import net.minecraft.util.math.Vec3d;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.EnumSet;
+
+import static dev.frydae.emcutils.utils.Util.MODID;
+import static journeymap.client.api.event.ClientEvent.Type.MAPPING_STARTED;
+
+public class EmpireMinecraftUtilitiesJourney implements IClientPlugin {
+  private IClientAPI api;
+  @Override
+  public void initialize(@NotNull final IClientAPI api) {
+    this.api = api;
+
+    api.subscribe(getModId(), EnumSet.of(MAPPING_STARTED));
+
+    // Turn off radars on EMC
+    FabricEvents.ENTITY_RADAR_UPDATE_EVENT.register(event -> { if (Util.isOnEMC) event.setCanceled(true); });
+
+    // Add residence TP button
+    FabricEvents.FULLSCREEN_POPUP_MENU_EVENT.register(event ->
+            event.getPopupMenu().addMenuItem("Teleport to Residence", new TeleportToResidenceAction()));
+  }
+
+  @Override
+  public String getModId() {
+    return MODID;
+  }
+
+  @SuppressWarnings("deprecation")
+  @Override
+  public void onEvent(@NotNull final ClientEvent event) {
+    if (event.type.equals(MAPPING_STARTED) && Util.isOnEMC) {
+      // Disable cave maps on EMC
+      api.toggleDisplay(null, Context.MapType.Underground, Context.UI.Any, false);
+
+      // Set world names on EMC
+      api.setWorldId(Util.getCurrentServer().getName().toLowerCase());
+    }
+  }
+
+  private static class TeleportToResidenceAction implements ModPopupMenu.Action {
+    @Override
+    public void doAction(final @NotNull BlockPos pos) {
+      if (Util.isOnEMC) {
+        EmpireResidence res = Util.getCurrentServer().getResidenceByLoc(new Vec3d(pos.getX(), pos.getY(), pos.getZ()));
+        if (res != null) {
+          MinecraftClient.getInstance().player.sendChatMessage(res.getVisitCommand());
+        }
+      }
+    }
+  }
+}
diff --git a/journey/src/main/resources/fabric.mod.json b/journey/src/main/resources/fabric.mod.json
@@ -0,0 +1,26 @@
+{
+  "schemaVersion": 1,
+  "id": "emcutils-jm-compat",
+  "version": "${version}",
+  "name": "Empire Minecraft Utilities JourneyMap Compatibility",
+  "description": "JourneyMap compatibility for Empire Minecraft Utilities",
+  "authors": [
+    "wafflecoffee"
+  ],
+  "license": "MIT",
+  "environment": "client",
+  "entrypoints": {
+    "journeymap": [
+      "dev.frydae.emcutils.journey.EmpireMinecraftUtilitiesJourney"
+    ]
+  },
+  "custom": {
+    "modmenu": {
+      "parent": "emcutils"
+    }
+  },
+  "depends": {
+    "journeymap-fabric": ">=5.8.1beta3",
+    "emcutils": ">=3.0.0"
+  }
+}
diff --git a/settings.gradle b/settings.gradle
@@ -1,5 +1,9 @@
 pluginManagement {
   repositories {
+    maven {
+      name = 'Quilt'
+      url = 'https://maven.quiltmc.org/repository/release/'
+    }
     maven {
       name = 'Fabric'
       url = 'https://maven.fabricmc.net/'
@@ -23,5 +27,6 @@ pluginManagement {
 include 'common'
 include 'fabric'
 include 'forge'
+include 'journey'
 include 'voxel'
 include 'xaero'

Original file line number	Diff line number	Diff line change
`@@ -171,8 +171,8 @@ private void handleClick(int buttonX, double mouseX, double mouseY, String comma`
`171`	`171`	`}`
`172`	`172`
`173`	`173`	`@Override`
`174`		`- public void close() {`
`175`		`- if (shouldCallClose) super.close();`
	`174`	`+ public void onClose() {`
	`175`	`+ if (shouldCallClose) super.onClose();`
`176`	`176`	`else shouldCallClose = true;`
`177`	`177`	`}`
`178`	`178`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ dependencies {`
`33`	`33`	`exclude group: "net.fabricmc"`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ include project(":journey")`
`36`	`37`	`include project(":voxel")`
`37`	`38`	`include project(":xaero")`
`38`	`39`
`@@ -91,7 +92,9 @@ modrinth {`
`91`	`92`	`new ModDependency("codAaoxh", "required"), // MidnightLib`
`92`	`93`	`new ModDependency("mOgUt4GM", "optional"), // Mod Menu`
`93`	`94`	`]`
	`95`	`+ syncBodyFrom = rootProject.file("README.md").text`
`94`	`96`	`}`
	`97`	`+tasks.modrinth.dependsOn(tasks.modrinthSyncBody)`
`95`	`98`
`96`	`99`	`publishing {`
`97`	`100`	`publications {`