README.md

Pl3xMap

Pl3xMap is a minimalistic and lightweight live world map viewer for Paper servers.

What is Pl3xMap

If, like me, you have no real need for 3D views, the novelty of Dynmap and Bluemap have worn off, and you're ready for something actually usable for navigation without all the heavy bulk or slow renders then this is the plugin for you.

Features

• Ultra fast render times. Get your map viewable today, not next week!
• Simple vanilla-like top down 2D view, designed for navigation.
• Player markers showing yaw rotation, health, and armor
• Easy configuration. Even a caveman can do it.
• Up to date Leaflet front-end.
• Addons and integrations for many popular plugins.

Contact

Join us on Discord in the #pl3xmap channel

Downloads

Downloads can be obtained from the jenkins server.

• 1.17 builds 138+
• 1.16.5 builds 137 and below

Servers Using Pl3xMap

Click here to view a list of servers using Pl3xMap.

License

This project is licensed under the MIT license

Leaflet (the web ui frontend) is licensed under 2-clause BSD License

bStats

API

Javadoc

Dependency Information

Maven

<repository>
    <id>pl3x-repo</id>
    <url>https://repo.pl3x.net/</url>
</repository>

<dependency>
    <groupId>net.pl3x.map</groupId>
    <artifactId>pl3xmap-api</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Gradle

repositories {
    maven("https://repo.pl3x.net/")
}

dependencies {
    compileOnly("net.pl3x.map", "pl3xmap-api", "1.0.0-SNAPSHOT")
}

Building from source

To compile Pl3xMap, you need to have the Paper server implementation installed to your local maven repository.

Download Paper from papermc.io/downloads then run this Java command (using the JAR you downloaded)

java -jar -Dpaperclip.install=true paper-1.17-75.jar

Once that is complete you can compile Pl3xMap with this command

./gradlew build