MapEngine

Description

MapEngine is a map library plugin for paper servers. It provides a simple API to create maps with custom content. Using lightweight and asynchronous techniques, MapEngine has a very low impact on server performance.

Features

Pipelined API for custom pipelines
Asynchronous rendering
Completely packet based
Optional dithering (Floyd-Steinberg)
Groups as z-layer interpretation for saving immense network traffic
Per player buffering, only the changed pixels are sent to the player
Optional packet bundling prevents tearing
Drawing utilities (text, components, lines, triangles, rectangles, circles, ellipses, polygons)

Color Conversion Cache Performance Graph

Performance Graph

Live streaming via RTMP on maps

This is an example of a live stream on a map. The stream is played on a 7x4 map array. The Stream source is 1920x1080@20 streamed with OBS.

Floyd Sternberg dithering

This is an example of a map with Floyd-Steinberg dithering enabled. The stream is played on a 7x4 map array. The Stream source is 1920x1080@20 streamed with OBS.

Javadoc

A hosted version of the javadoc can be found here.

Support

Server Version	Supported
Paper 1.21.11	✔️
Paper 1.21.10	✔️
Paper 1.21.9	✔️
Paper 1.21.8	✔️
Paper 1.21.7	✔️
Paper 1.21.6	✔️
Paper 1.21.5	✔️
Paper 1.21.4	✔️
Paper 1.21.3	✔️
Paper 1.21.2	✔️
Paper 1.21.1	✔️
Paper 1.21	✔️
Paper 1.20.x	✔️
Paper 1.19.4	✔️
Paper 1.19.3	✔️

Usage

MapEngine has to be added as a dependency to the plugin.yml regardless of the build system used.

Maven

<repositories>
    <repository>
        <id>minceraft</id>
        <url>https://repo.minceraft.dev/releases/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>de.pianoman911</groupId>
        <artifactId>mapengine-api</artifactId>
        <version>1.8.11</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Gradle (groovy)

repositories {
    maven {
        url = 'https://repo.minceraft.dev/releases/'
        name = 'minceraft'
    }
}

dependencies {
    compileOnly 'de.pianoman911:mapengine-api:1.8.11'
}

Gradle (kotlin)

repositories {
    maven("https://repo.minceraft.dev/releases/") {
        name = "minceraft"
    }
}

dependencies {
    compileOnly("de.pianoman911:mapengine-api:1.8.11")
}

Example

public class Bar {

    // getting the api instance
    private static final MapEngineApi MAP_ENGINE = Bukkit.getServicesManager().load(MapEngineApi.class);

    public void foo(BufferedImage image, BlockVector cornerA, BlockVector cornerB, BlockFace facing, Player viewer) {
        // create a map display instance
        IMapDisplay display = MAP_ENGINE.displayProvider().createBasic(cornerA, cornerB, facing);
        display.spawn(viewer); // spawn the map display for the player

        // create an input pipeline element
        // this object can also be used to draw simple shapes and text
        IDrawingSpace input = MAP_ENGINE.pipeline().createDrawingSpace(display);

        // draw the image to the input pipeline element
        input.image(image,0,0);

        // draw a triangle
        input.triangle(0, 0, 10, 10, 20, 0, 0xff0000ff);

        // add a player to the pipeline context,
        // making the player receive the map
        input.ctx().receivers().add(viewer);

        // enable floyd-steinberg dithering
        input.ctx().converter(Converter.FLOYD_STEINBERG);

        // enable per player buffering
        input.ctx().buffering(true);

        // flush the pipeline
        // the drawing space can be reused
        input.flush();
    }
}

More detailed examples can be found in the MinceraftMC/MapEngineExamples repository.

Building

Clone the project (git clone https://github.com/MinceraftMC/MapEngine.git)
Go to the cloned directory (cd MapEngine)
Build the Jar (./gradlew build on Linux/MacOS, gradlew build on Windows)

The plugin jar can be found in the build → libs directory

It shows Floyd Steinberg dithering and an RTMP stream on a map display.

Version	Minecraft	Loader	Download
MapEngine 1.8.12 1.8.12	1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.9, 1.21.10, 1.21.11, 26.1, 26.1.1, 26.1.2	paper, purpur	Download
MapEngine 1.8.11 1.8.11	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.9, 1.21.10, 1.21.11	paper, purpur	Download
MapEngine 1.8.10 1.8.10	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.9, 1.21.10	paper, purpur	Download
MapEngine 1.8.9 1.8.9	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8	paper, purpur	Download
MapEngine 1.8.8 1.8.8	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5	paper, purpur	Download
MapEngine 1.8.7 1.8.7	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4	paper, purpur	Download
MapEngine 1.8.6 1.8.6	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4	paper, purpur	Download
MapEngine 1.8.5 1.8.5	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4	paper, purpur	Download
MapEngine 1.8.4 1.8.4	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3	paper, purpur	Download
MapEngine 1.8.3 1.8.3	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3	paper, purpur	Download
MapEngine 1.8.2 1.8.2	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1	paper, purpur	Download
MapEngine 1.8.1 1.8.1	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1	paper, purpur	Download
MapEngine 1.8.0 1.8.0	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6	paper, purpur	Download
MapEngine 1.7.3 1.7.3	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4	paper, purpur	Download
MapEngine 1.7.2 1.7.2	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4	paper, purpur	Download
MapEngine 1.7.1 1.7.1	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4	paper, purpur	Download
MapEngine 1.7.0 1.7.0	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4	paper, purpur	Download
MapEngine 1.6.3 1.6.3	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4	paper, purpur	Download
MapEngine 1.6.2 1.6.2	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2	paper, purpur	Download
MapEngine 1.6.1 1.6.1	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2	paper, purpur	Download
MapEngine 1.6.0 1.6.0	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2	paper, purpur	Download
MapEngine 1.5.5 1.5.5	1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2	paper, purpur	Download
MapEngine 1.5.4 1.5.4	1.19.3, 1.19.4, 1.20, 1.20.1	paper, purpur	Download
MapEngine 1.5.3 1.5.3	1.19.3, 1.19.4, 1.20, 1.20.1	paper, purpur	Download
MapEngine 1.5.2 1.5.2	1.19.3, 1.19.4, 1.20, 1.20.1	paper, purpur	Download
MapEngine 1.5.1 1.5.1	1.19.3, 1.19.4, 1.20, 1.20.1	paper, purpur	Download
MapEngine 1.5.0 1.5.0	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.9 1.4.9	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.8 1.4.8	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.7 1.4.7	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.6-hotfix 1.4.6-hotfix	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.6 1.4.6	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.5 1.4.5	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.4 1.4.4	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.3 1.4.3	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.2 1.4.2	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.1 1.4.1	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.4.0 1.4.0	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.3.2 1.3.2	1.19.3, 1.19.4	paper, purpur	Download
MapEngine 1.3.1 1.3.1	1.19.3, 1.19.4	paper, purpur	Download