MapModCompanion

KO | EN

gitlite — search

#react #ai #typescript #android #rust #nodejs #java #kubernetes #vue #security #pytorch #ios #openai #open-source

MapModCompanion

(★ 60)

Map mod support. Plugin that fixes Multi-world detection. Xaero's Minimap, VoxelMap and JourneyMap will be able to identify worlds on BungeeCord/Velocity servers.

MapModCompanion Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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).**

<details><summary>How it should look like</summary>

| Mod | Screenshot |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Xaero's World Map | <img src="https://raw.githubusercontent.com/turikhay/MapModCompanion-design/main/2023-03-28_00.32.04_1.png" width="200" alt="Screenshot of Xaero's WorldMap menu" /> |
| VoxelMap | <img src="https://raw.githubusercontent.com/turikhay/MapModCompanion-design/main/2023-03-28_00.34.50_1.png" width="200" alt="Screenshot of the game with a minimap on the top-right corner" /> <img src="https://raw.githubusercontent.com/turikhay/MapModCompanion-design/main/2023-03-28_00.35.04_1.png" width="200" alt="Screenshot of a map" /> |
| Xaero's Minimap | See Xaero's WorldMap |
| JourneyMap | It just works 😄 |

</details>

Companion plugin for
[Xaero's Minimap]
(and their [World Map][Xaero's World Map]),
[JourneyMap] and
VoxelMap (both [old][VoxelMap (old)] and [updated][VoxelMap-Updated]).
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 | v25.3.14 / Minecraft 26.1.2 | ✅ Supported |
| [Xaero's World Map] | v1.10.0 / Minecraft 1.8.9 | v1.40.17 / Minecraft 26.1.2 | ✅ Supported |
| [JourneyMap] | v5.7.1 / Minecraft 1.16.5 | v6.0.0-beta.76 / Minecraft 26.1.2 | ☑️ Supported [JourneyMap-Paper] is available since 26.1[[1]](https://github.com/turikhay/MapModCompanion/issues/252) |
| VoxelMap | [v1.7.10][VoxelMap (old)] / Minecraft 1.8 | [v1.16.6][VoxelMap-Updated] / Minecraft 26.1.2 | ✅ Supported[[2]](https://github.com/turikhay/MapModCompanion/issues/8) |

[Folia](https://papermc.io/software/folia) is supported and needs [PacketEvents](https://modrinth.com/plugin/packetevents/versions?l=folia) to work properly[[3]](https://github.com/turikhay/MapModCompanion/pull/251). Please report if support is broken.

## Installation

ℹ️ Plugin must be installed on every downstream (backend) server in your network. Simply installing it on the proxy side (BungeeCord/Velocity) isn't enough. To ensure compatibility, you need to install the plugin on both the proxy server (BungeeCord/Velocity) and each of the backend servers (Spigot/Paper/Folia).

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.

## Alternatives

- If you're running Forge or Fabric server, just install the map mod on your server: this will unlock all its
 features.
- [JourneyMap-Paper] (Paper)
- [Map Chameleon](https://modrinth.com/mod/map-chameleon) (Fabric)

[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
[JourneyMap-Paper]: https://teamjm.github.io/journeymap-docs/latest/server/installing/
[VoxelMap (old)]: https://www.curseforge.com/minecraft/mc-mods/voxelmap
[VoxelMap-Updated]: https://modrinth.com/mod/voxelmap-updated
[worldnamepacket]: https://github.com/kosma/worldnamepacket

MapModCompanion

MapModCompanion Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

MapModCompanion

MapModCompanion Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README