{"id":111269,"date":"2026-06-06T16:03:45","date_gmt":"2026-06-06T13:03:45","guid":{"rendered":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/"},"modified":"2026-06-06T16:03:45","modified_gmt":"2026-06-06T13:03:45","slug":"nminimap","status":"publish","type":"mod","link":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/","title":{"rendered":"NMinimap"},"content":{"rendered":"
\n

# NMinimap<\/p>\n

Serverside minimap based on core shaders<\/p>\n

![](https:\/\/raw.githubusercontent.com\/NezuShin\/NMinimap\/refs\/heads\/master\/images\/example_5.png)<\/p>\n<\/div>\n

### Features<\/p>\n

– Round and square minimap
\n– Unlimited amount of custom markers
\n– Side of the screen selection (left or right)
\n– Scale of map from 1x (1 pixel = 1 block) to 8x (1 pixel = 8×8 blocks)
\n– Async work as much as possible
\n– Map size up to 127 x 127 pixels
\n– Automatic resource pack build<\/p>\n

### Supported server platforms
\n– Papermc
\n– Folia
\n– Spigot with a [lot of limitations](#running-on-spigot)<\/p>\n

### Showcase<\/p>\n

![](https:\/\/raw.githubusercontent.com\/NezuShin\/NMinimap\/refs\/heads\/master\/images\/example_1.gif)
\n![](https:\/\/raw.githubusercontent.com\/NezuShin\/NMinimap\/refs\/heads\/master\/images\/example_2.gif)
\n![](https:\/\/raw.githubusercontent.com\/NezuShin\/NMinimap\/refs\/heads\/master\/images\/example_3.gif)<\/p>\n

### Dependencies<\/p>\n

– AnvilORM
\n– Packet events
\n– PassengerAPI (Optional; Needed for compatibility with another plugins)
\n– PlaceholderAPI (Optional; If you need placeholders)<\/p>\n

### Installation<\/p>\n

– Install all [dependencies](#dependencies)
\n– Download jar from releases and put it to the server’s plugins directory.
\n– Restart the server<\/p>\n

Also, you can configure PackMerger
\nor Resource Pack Manager for resource pack merge and distribution<\/p>\n

### Permissions<\/p>\n

– `nminimap.admin` – access for `\/minimap admin` command
\n– `nminimap.scale.1\/2\/4\/8` – access for `\/minimap scale` command (if enabled in config)
\n– Another minimap commands can be accessed without any premissions<\/p>\n

### Admin commands
\n– `\/minimap admin reload` – reload config
\n– `\/minimap admin stats` – get statistics info <\/p>\n

### User commands<\/p>\n

– `\/minimap scale 1\/2\/4\/8` – set map scale. 1 – one block per pixel, 2 – four blocks per pixel (2×2 zone), etc
\n– `\/minimap side left\/right` – set side of the screen where map will be displayed
\n– `\/minimap style round\/square` – set map round or square
\n– `\/minmap disable\/enable` – disable or enable map<\/p>\n

### PlaceholderAPI Placeholders<\/p>\n

#### Player related:
\n– `nminimap_enabled` – true or false
\n– `nminimap_scale` – 1, 2, 4, 8
\n– `nminimap_side` – right or left
\n– `nminimap_style` – round or square<\/p>\n

#### Statistics related:
\n– `nminimap_stats_loaded_tiles` – count of tiles in ram, number
\n– `nminimap_stats_cache_size` – total count of all cached chunks, number
\n– `nminimap_stats_enabled_maps` – how many players use map right now, number
\n– `nminimap_stats_threads` – how many plugin’s threads running right now, number
\n– `nminimap_stats_disk_total_space_g` – total available disk space in gigabytes, number (double)
\n– `nminimap_stats_disk_free_space_g` – free space on disk in gigabytes, number (double)
\n– `nminimap_stats_disk_total_space` – total available disk space in bytes, number
\n– `nminimap_stats_disk_free_space` – free space on disk in bytes, number<\/p>\n

### Markers<\/p>\n

Markers are just font images with special marks on texture, so they have same limitations:
\n– No animations. But you can replace the icon to another one every AsyncMarkerRenderEvent call using API.
\n– Texture size is limited to 256 x 254 pixels (two extra columns used for marks)
\n– Note that large amount of big images can significantly slow down resource pack loading. <\/p>\n

To add marker, drop your image to `markers` directory and type `\/minimap admin reload`. New resourcepack will be generated.
\nYou can make images smaller by increasing image size with same texture. Like in `player_small` default marker.<\/p>\n

### Compatibility <\/p>\n

#### Core shaders and another plugins
\nPlugin uses `rendertype_text` shader, so shaders for hud or text decorations may not be compatible. In most plugins you must
\ndisable text decorations for NMinimap work.
\nPatched shader for BetterHUD is already provided. If you are developer you can add compatibility with your plugin using this example easily<\/p>\n

#### Mods<\/p>\n

Plugin can turn off some mod-driven minimaps at all or while serverside minimap enabled:<\/p>\n

![](https:\/\/raw.githubusercontent.com\/NezuShin\/NMinimap\/refs\/heads\/master\/images\/example_4.gif)<\/p>\n

Supported mods:
\n– Xaero’s Minimap
\n– VoxelMap-Updated
\n– JourneyMap
\n– Another mods do not have such functionality, or it is not documented. <\/p>\n

#### Known incompatibilities
\n– ImmediatelyFast – Stores all maps to one atlas, which breaks shader logic<\/p>\n

### How does it work?<\/p>\n

#### Maps
\nPlugin spawns packet-based invisible item frames with a map in it and renders the map with special sequence on first row.
\nShader detects this row and places the map at corner of the screen. Vanilla maps still works (Except one map id used for display. Id is configurable).
\nThe first map column is also disabled for symmetry.<\/p>\n

#### Markers<\/p>\n

Marker images have for pixels with specific color on then’s corners. For every combination of map style and screen corner image is being created. Four images in total
\nAlso color of image is used. Red is X position on map. Green is Y position on map. Blue is marker rotation.<\/p>\n

### API<\/p>\n

Change player’s map settings
\n“`java
\npublic void changeSettings(Player p) {
\n var player = NMinimap.getInstance().getPlayersWithMap().stream().filter(i -> i.getPlayer().equals(p)).findFirst().orElse(null);<\/p>\n

player.setEnabled(true);
\n player.setScale(8);
\n player.getRight(true);
\n player.setRound(true);
\n}
\n“`<\/p>\n

Draw on map and add markers. Both events being called on every map redraw. <\/p>\n

“`java
\n@EventHandler
\npublic void drawDot(AsyncMapRenderEvent event){
\n byte[] mapData = event.getMapData();<\/p>\n

\/\/middle of the map
\n int x = 64;
\n int y = 64;<\/p>\n

\/\/Accepts only colors from ColorUtil.colors. Another values will result transparent color
\n mapData[x + (y * 128)] = ColorUtil.exactColor(ColorUtil.colors[10]);<\/p>\n

int anotherX = 1;\/\/first row is reserved for internal use. First **column** is disalbed for symmetry. Displayed map has resolution 127 x 127
\n int anotherY = 1;<\/p>\n

\/\/Similar to deprecated MapPalette.matchColor(). Will find most nearest color.
\n mapData[anotherX + (anotherY * 128)] = ColorUtil.getNearestColor(Color.fromRGB(255, 0, 0));
\n}<\/p>\n

@EventHandler
\npublic void drawMarker(AsyncMarkerRenderEvent e){
\n List markers = e.getMarkers();<\/p>\n

String markerIcon = “player”;\/\/Icon from NMinimap\/markers directory<\/p>\n

\/\/Add marker with fixed location
\n markers.add(new LocationMarker(markerIcon, new Location(e.getPlayer().getPlayer().getWorld(), 1, 1, 1)));<\/p>\n

int positionMarkerX = 0;\/\/Accepts values from -127 to 127. -127 – left. 127 – right
\n int positionMarkerY = 0;\/\/-127 – top. 127 – bottom
\n int positionMarkerRotation = 0;\/\/from 0 to 256. 0 points top, 128 points bottom<\/p>\n

\/\/Add marker with relative position on map.
\n markers.add(new PositionMarker(markerIcon, positionMarkerX, positionMarkerY, positionMarkerRotation));<\/p>\n

}
\n“`<\/p>\n

### Inspirations
\n– VanillaMinimaps
\n– Cartographer2
\n– Minimap control<\/p>\n

### Credits
\n– NezuShin – Plugin development
\n– DartCat25 – Shader development
\n– DEMEMZEA – Help with readme<\/p>\n

### Help and support<\/p>\n

If you have questions, want ask for a feature or report a bug – feel free to open issue,
\nAlso you can ask a question in the discord server.<\/p>\n

### Running on spigot<\/p>\n

Spigot is outdated server software and should not be used in production. However, it is possible to run NMinimap on Spigot.
\nMain problem is that spigot, unlike paper, cannot load chunks asynchronously. To run on spigot, you need to set `max-render-threads` config property to `1`. Otherwise, the server will freeze on chunck generation.
\nAlso recommended to set `max-scale` to 1 or 2 to reduce server load.<\/p>\n","protected":false},"excerpt":{"rendered":"

Papermc plugin to display Minimap on vanilla client<\/p>\n","protected":false},"featured_media":111270,"template":"","meta":{"_minecraft_slug":"nminimap","_minecraft_project_id":"lBBekvEQ","_minecraft_author":"NezuShin","_minecraft_license":"GPL-3.0-only","_minecraft_downloads":597,"_minecraft_follows":5,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"nminimap.zip","_minecraft_size_bytes":739266,"_minecraft_version_count":6,"_minecraft_updated_at":"2026-05-16T10:26:37.378104Z","_minecraft_date_created":"2026-04-11T22:08:42.791865Z","_minecraft_date_modified":"2026-05-13T02:35:33.187286Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/nminimap","_minecraft_icon_attachment_id":111270,"_minecraft_imported_at":"2026-06-06T13:03:45+00:00","_minecraft_import_hash":"bebb307b8e8945160df414d05104b78c","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[87,125,127,128,129,92],"mod_loader":[131,132,133,134],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82,83,167,163],"class_list":["post-111269","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-adventure","mod_category-folia","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-utility","mod_loader-folia","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9","minecraft_version-26-1","minecraft_version-26-1-1","minecraft_version-26-1-2"],"yoast_head":"\nNMinimap - Minecraft<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"NMinimap - Minecraft\" \/>\n<meta property=\"og:description\" content=\"Papermc plugin to display Minimap on vanilla client\" \/>\n<meta property=\"og:url\" content=\"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/\" \/>\n<meta property=\"og:site_name\" content=\"Minecraft\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/nminimap\\\/\",\"url\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/nminimap\\\/\",\"name\":\"NMinimap - Minecraft\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/nminimap\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/nminimap\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/wp-content\\\/uploads\\\/2026\\\/06\\\/nminimap-icon-e392c246c079044ca6cf7779d25409c2a82a7eb9_96.webp\",\"datePublished\":\"2026-06-06T13:03:45+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/nminimap\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/nminimap\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/nminimap\\\/#primaryimage\",\"url\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/wp-content\\\/uploads\\\/2026\\\/06\\\/nminimap-icon-e392c246c079044ca6cf7779d25409c2a82a7eb9_96.webp\",\"contentUrl\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/wp-content\\\/uploads\\\/2026\\\/06\\\/nminimap-icon-e392c246c079044ca6cf7779d25409c2a82a7eb9_96.webp\",\"width\":96,\"height\":96},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/nminimap\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Mods\",\"item\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"NMinimap\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/#website\",\"url\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/\",\"name\":\"Minecraft\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"NMinimap - Minecraft","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/","og_locale":"en_US","og_type":"article","og_title":"NMinimap - Minecraft","og_description":"Papermc plugin to display Minimap on vanilla client","og_url":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/","og_site_name":"Minecraft","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/","url":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/","name":"NMinimap - Minecraft","isPartOf":{"@id":"https:\/\/vpesports.com\/minecraft\/#website"},"primaryImageOfPage":{"@id":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/#primaryimage"},"image":{"@id":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/#primaryimage"},"thumbnailUrl":"https:\/\/vpesports.com\/minecraft\/wp-content\/uploads\/2026\/06\/nminimap-icon-e392c246c079044ca6cf7779d25409c2a82a7eb9_96.webp","datePublished":"2026-06-06T13:03:45+00:00","breadcrumb":{"@id":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/#primaryimage","url":"https:\/\/vpesports.com\/minecraft\/wp-content\/uploads\/2026\/06\/nminimap-icon-e392c246c079044ca6cf7779d25409c2a82a7eb9_96.webp","contentUrl":"https:\/\/vpesports.com\/minecraft\/wp-content\/uploads\/2026\/06\/nminimap-icon-e392c246c079044ca6cf7779d25409c2a82a7eb9_96.webp","width":96,"height":96},{"@type":"BreadcrumbList","@id":"https:\/\/vpesports.com\/minecraft\/mods\/nminimap\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/vpesports.com\/minecraft\/"},{"@type":"ListItem","position":2,"name":"Mods","item":"https:\/\/vpesports.com\/minecraft\/mods\/"},{"@type":"ListItem","position":3,"name":"NMinimap"}]},{"@type":"WebSite","@id":"https:\/\/vpesports.com\/minecraft\/#website","url":"https:\/\/vpesports.com\/minecraft\/","name":"Minecraft","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/vpesports.com\/minecraft\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/mod\/111269","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/mod"}],"about":[{"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/types\/mod"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/media\/111270"}],"wp:attachment":[{"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/media?parent=111269"}],"wp:term":[{"taxonomy":"mod_category","embeddable":true,"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/mod_category?post=111269"},{"taxonomy":"mod_loader","embeddable":true,"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/mod_loader?post=111269"},{"taxonomy":"minecraft_version","embeddable":true,"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/minecraft_version?post=111269"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}