# Companion for map mods

**With this plugin your minimap will never be confused which world you're in. [A more in-depth explanation can be found in the wiki](https://github.com/turikhay/MapModCompanion/wiki/How-it-works).**

How it should look like

| Mod | Screenshot | | ----|------------| | Xaero's World Map | Screenshot of Xaero's WorldMap menu

| | VoxelMap | Screenshot of the game with a minimap on the top-right corner

Companion plugin for [Xaero's Minimap] (and their [World Map][Xaero's World Map]), [JourneyMap] and VoxelMap (both [old][VoxelMap (old)] and [updated][VoxelMap]). Provides a way for these mods to identify worlds on BungeeCord/Velocity servers. It's recommended to install this plugin on a fresh server, otherwise **existing map data** (waypoints, map cache, etc.) **may no longer be visible to some players**. Fortunately, [there are ways to restore it](https://github.com/turikhay/MapModCompanion/wiki/Restore-map-data). It's worth mentioning that the plugin doesn't affect in-game progress. This plugin was inspired by @kosma's [worldnamepacket], which supported Velocity, Fabric and Spigot at the time of writing. If you have any questions, please [join my Discord][Discord]. [![](https://bstats.org/signatures/bukkit/MapModCompanion.svg)](https://bstats.org/plugin/bukkit/MapModCompanion/16539 "MapModCompanion on bStats") ## Support table | Mod | Oldest version | Latest version | Status | |------------------------------------------------------------------------------------|----------------------------|--------------------------------------------------------------|-------------| | [Xaero's Minimap] | v20.20.0 / Minecraft 1.8.9 | v23.9.x / Minecraft 1.20.x | ✅ Supported | | [Xaero's World Map] | v1.10.0 / Minecraft 1.8.9 | v1.37.8 / Minecraft 1.20.x | ✅ Supported^{[[1]](https://github.com/turikhay/MapModCompanion/issues/62)} | | [JourneyMap] | v5.7.1 / Minecraft 1.16.5 | v5.9.9 / Minecraft 1.20.1 | ✅ Supported | | VoxelMap | [v1.7.10][VoxelMap (old)] / Minecraft 1.8 | [v1.12.x][VoxelMap] / Minecraft 1.20.1 | ✅ Supported^{[[2]](https://github.com/turikhay/MapModCompanion/issues/8)} | [Folia](https://papermc.io/software/folia) is supported, but isn't tested regularly. Please report if the support is broken. ## Installation ℹ️ You should install this plugin on both sides: BungeeCord/Velocity and Spigot/Paper. 1. Download the latest release 2. Put each file into the corresponding plugins folder 3. That's it. No configuration is required. You can restart your servers now. ## Configuration The configuration file is stored at `plugins/MapModCompanion/config.yml` for both Spigot and BungeeCord. Velocity uses `plugins/mapmodcompanion/config.toml`. The configuration file reloads automatically if it's modified. [Discord]: https://discord.gg/H9ACHEqBrg [Xaero's Minimap]: https://modrinth.com/mod/xaeros-minimap [Xaero's World Map]: https://modrinth.com/mod/xaeros-world-map [JourneyMap]: https://modrinth.com/mod/journeymap [VoxelMap (old)]: https://www.curseforge.com/minecraft/mc-mods/voxelmap [VoxelMap]: https://modrinth.com/mod/voxelmap-updated [worldnamepacket]: https://github.com/kosma/worldnamepacket