- Round and square minimap
- Unlimited amount of custom markers
- Side of the screen selection (left or right)
- Scale of map from 1x (1 pixel = 1 block) to 8x (1 pixel = 8x8 blocks)
- Async work as much as possible
- Map size up tp 127 x 127 pixels
- Automatic resource pack build
- Supported minecraft versions from 1.21.11 to 26.2
- Configurable mob and player radar
- Papermc
- Folia
- Spigot with a lot of limitations
- AnvilORM 1.0.2 or newer
- Packet events
- PassengerAPI (Optional; Needed for compatibility with another plugins)
- PlaceholderAPI (Optional; If you need placeholders)
- Install all dependencies
- Download jar from releases and put it to the server's plugins directory.
- Restart the server
- Install resource pack from
NMinimap/built-pack.zip
Also, you can configure PackMerger or Resource Pack Manager for automatic resource pack merge and distribution
nminimap.admin- access for/minimap admincommandnminimap.command.minimap- access for player/minimapcommands (if enabled in config)nminimap.scale.1/2/4/8- access for/minimap scalecommand (if enabled in config)nminimap.allow-radar- access for/minimap radar enablecommand (if enabled in config)nminimap.bedrock-bypass- allow Bedrock players to use the minimap despite Bedrock restrictions- Another minimap commands can be accessed without any permissions (unless
command-permission.useis enabled)
/minimap admin reload- reload config/minimap admin stats- get statistics info/minimap admin clean-cahced- clean cached tiles of map
/minimap scale 1/2/4/8- set map scale. 1 - one block per pixel, 2 - four blocks per pixel (2x2 zone), etc/minimap side left/right- set side of the screen where map will be displayed/minimap style round/square- set map round or square/minimap disable/enable- disable or enable map/minimap radar disable/enable- disable or enable mob radar
nminimap_enabled- true or falsenminimap_is_bedrock- true or falsenminimap_radar- true or falsenminimap_scale- 1, 2, 4, 8nminimap_side- right or leftnminimap_style- round or square
nminimap_stats_loaded_tiles- count of tiles in ram, numbernminimap_stats_cache_size- total count of all cached chunks, numbernminimap_stats_enabled_maps- how many players use map right now, numbernminimap_stats_bedrock_players- how many Bedrock players are online, numbernminimap_stats_threads- how many plugin's threads running right now, numbernminimap_stats_loading_chunks- how many chunks are being rendered right now, numbernminimap_stats_render_queue- how many chunks are waiting to be rendered, numbernminimap_stats_disk_total_space_g- total available disk space in gigabytes, number (double)nminimap_stats_disk_free_space_g- free space on disk in gigabytes, number (double)nminimap_stats_disk_total_space- total available disk space in bytes, numbernminimap_stats_disk_free_space- free space on disk in bytes, numbernminimap_stats_memory_used- JVM heap memory used in bytes, numbernminimap_stats_memory_used_g- JVM heap memory used in gigabytes, number (double)nminimap_stats_memory_available- JVM heap memory available until max (-Xmx) in bytes, numbernminimap_stats_memory_available_g- JVM heap memory available until max (-Xmx) in gigabytes, number (double)nminimap_stats_memory_nminimap- estimated NMinimap tile memory usage in bytes, numbernminimap_stats_memory_nminimap_g- estimated NMinimap tile memory usage in gigabytes, number (double)
Markers are just font images with special marks on texture, so they have same limitations:
- No animations. But you can replace the icon to another one every AsyncMarkerRenderEvent call using API.
- Texture size is limited to 256 x 254 pixels (two extra columns used for marks)
- Note that large amount of big images can significantly slow down resource pack loading.
To add marker, drop your image to markers directory and type /minimap admin reload. New resourcepack will be generated.
You can make images smaller/bigger using markers.sizes config property. Like in player_small default marker.
Plugin uses rendertype_text shader, so shaders for hud or text decorations may not be compatible. In most plugins you must
disable text decorations for NMinimap work.
Patched shader examples for BetterHUD is already provided. You can easily add compatibility using AI (or by hands if you are developer) via examples.
Plugin can turn off some mod-driven minimaps at all or while serverside minimap enabled:
Supported mods:
- Xaero's Minimap
- VoxelMap-Updated
- JourneyMap
- Another mods do not have such functionality, or it is not documented.
Compatibility cannot be added because Iris don't use core shaders. You can disable NMinimap for users with Iris using NMinimapIrisBlocker
Bedrock is not supported yet due absolutely different render pipeline. Plugin will not allow bedrock players to turn on the minimap if Geyser installed on server.
Players with nminimap.bedrock-bypass can still use the commands.
If you are Bedrock developer and want to contribute please contact me.
Plugin spawns packet-based invisible item frames with a map in it and renders the map with special sequence on first row.
Shader 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).
The first map column is also disabled for symmetry.
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
Also color of image is used. Red is X position on map. Green is Y position on map. Blue is marker rotation.
Change player's map settings
public void changeSettings(Player p) {
var player = NMinimap.getInstance().getPlayersWithMap().stream().filter(i -> i.getPlayer().equals(p)).findFirst().orElse(null);
player.setEnabled(true);
player.setScale(8);
player.getRight(true);
player.setRound(true);
}Draw on map and add markers. Both events being called on every map redraw.
@EventHandler
public void drawDot(AsyncMapRenderEvent event){
byte[] mapData = event.getMapData();
//middle of the map
int x = 64;
int y = 64;
//Accepts only colors from ColorUtil.colors. Another values will result transparent color
mapData[x + (y * 128)] = ColorUtil.exactColor(ColorUtil.colors[10]);
int anotherX = 1;//first row is reserved for internal use. First **column** is disalbed for symmetry. Displayed map has resolution 127 x 127
int anotherY = 1;
//Similar to deprecated MapPalette.matchColor(). Will find most nearest color.
mapData[anotherX + (anotherY * 128)] = ColorUtil.getNearestColor(Color.fromRGB(255, 0, 0));
}
@EventHandler
public void drawMarker(AsyncMarkerRenderEvent e){
List<NMapMarker> markers = e.getMarkers();
String markerIcon = "player";//Icon from NMinimap/markers directory
//Add marker with fixed location
markers.add(new LocationMarker(markerIcon, new Location(e.getPlayer().getPlayer().getWorld(), 1, 1, 1)));
int positionMarkerX = 0;//Accepts values from -127 to 127. -127 - left. 127 - right
int positionMarkerY = 0;//-127 - top. 127 - bottom
int positionMarkerRotation = 0;//from 0 to 256. 0 points top, 128 points bottom
//Add marker with relative position on map.
markers.add(new PositionMarker(markerIcon, positionMarkerX, positionMarkerY, positionMarkerRotation));
}- NezuShin - Plugin development
- DartCat25 - Shader development
- DEMEMZEA - Help with readme
- Meisosi - Plugin development,
underground-layersfeature - RBLKtenarios - Greek translation
With my link you can get 20% off Your first month
If you have questions, want ask for a feature or report a bug - feel free to open issue,
Also you can ask a question in the discord server.
Spigot is outdated server software and should not be used in production. However, it is possible to run NMinimap on Spigot.
Main 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.
Also recommended to set max-scale to 1 or 2 to reduce server load.