Explorers Map

Showcase

Installation

Download the mod
Put the mod into your mods folder
On singleplayer you have to enable the mod for your world. Right-click on your world and set the checkmark for ExplorersMap.
Enjoy!

Configuration

The mod can be configured in-game using the command /explorersmap. You will need to be op or have the permission explorersmap.command to run the command.

The mod comes with the following configuration file:

mods/Cerus_ExplorersMap/ExplorersMap.json

{
  // The radius of chunks around your player that will be discovered.
  // Warning: Setting this any higher than 10 could make your game or server very laggy.
  "ExplorationRadius": 3,
  // When set to true, each player will each have a different map and will only see the places they've personally been to.
  // When set to false, all players share a map and will see where others have been to. Includes live updates.
  "PerPlayerMap": true,
  // The rate at which cached tile images are loaded from the disk. This value is per tick.
  "DiskLoadRate": 16,
  // The rate at which the chunks around the player are mapped into tiles. This value is per tick. Vanilla value is 20.
  "GenerationRate": 20,
  // Sets how far you can zoom out. Min value is 2.
  "MinZoom": 8.0,  // When set to true, tiles from instances (temporary worlds) will be saved to disk.  // Each instance type gets a dedicated folder.  "SaveInstanceTiles": false,
  // The tile resolution. Available resolutions:
  // - BEST: 96x96 tiles. Vanilla. Will crash the game on very well explored maps.
  // - GOOD: 32x32 tiles. Still very detailed. Might crash the game on well explored maps.
  // - FAST: 16x16 tiles. Default. Looks good enough.
  // - FASTER: 8x8 tiles. Starting to lose a lot of detail.
  // - FASTEST: 4x4 tiles. Almost no detail left. Only use if all other resolutions crash the game.
  "Resolution": "FAST"
}

Technical details

The plugin will cache generated tiles on the disk as images. This significantly reduces the stress on the game to generate chunks.
- The tiles are stored at mods/Cerus_ExplorersMap/tiles
The information which chunks have been discovered by who is stored at mods/Cerus_ExplorersMap/discovered
The mod overwrites the vanilla map rendering mechanic. This could lead to incompatibilities with other mods doing the same.

Need help? Want to report bugs?

Feel free to open an issue on GitHub. You can also join my Discord server and talk in #hytale about this mod.

Enjoying the mod?

Consider buying me a coffee! <3