[0.6.x + 0.7.0 pre1] Nomad Compass

Compass v1.0.1 should run on Hytale 0.7.0 pre1. If you have any issues, please leave a comment!

Nomad Compass adds one item: a wooden pocket compass with a hinged lid and a needle that moves. Switch to it and the lid snaps open. Hold it and the needle settles on north. Turn, and it stays on north.

Then, point it at something. /compass track [name] and the needle swings to wherever that player is and follows him as he moves.

/compass point 340 64 -120 and it holds on that spot until you clear it.

The target goes with the item, so your players can pass directions to each other in a physical item: set a compass on your base and hand it to a newcomer.

• Craft it at a workbench from two copper bars and a stick.
• Install it by dropping NomadCompass.jar into Server/mods/. Nothing on the client.
• Hook into it from your own mod: set and clear targets through a small public API, or give a player a compass that already points at the objective, so a quest can start with "follow the needle" instead of a coordinate in chat.

Inspiration Credit

When I was searching for Hytale compass mods, Biome's Compass by EtherealLabs popped up, and I really liked their compass design with the lid flipping open. There were certain aspects I changed a lot, because I had some priorities like making the animation feel satisfying when the player switches to the compass, but I did absolutely take some inspiration from their design. Please check out their mods!

Commands

For mod authors

Declare Compass in your manifest.json so the server loads it before you (use OptionalDependencies instead if your mod should still run without it, and null-check the plugin):

"Dependencies": { "co.nomadlabs:NomadCompass": "*" }

Then get the plugin and ask it for a compass:

NomadCompassAPI compass = PluginManager.get().getPlugin(NomadCompassPlugin.class);

// A compass already pointing at a spot, dropped into a player's hotbar.
compass.giveCompass(playerUuid, TrackingTarget.at(new WorldPoint("Orbis", 340, 64, -120)));

// Or build the stack yourself and hand it out however you like.
ItemStack reward = compass.newCompass(TrackingTarget.player(targetUuid, targetName));

withTarget(stack, target) re-points an existing compass (null clears it) and targetOf(stack) reads one, so a quest mod can check whether the player still carries the compass you gave them. Classes are co.nomadlabs.compass.plugin.NomadCompassAPI and co.nomadlabs.compass.domain.TrackingTarget; compile against the jar.