Skip to content

Minecraft Paper plugin and BlueMap addon for greater control over which areas get rendered

License

Notifications You must be signed in to change notification settings

TechnicJelle/BlueMapAreaControl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BlueMap Area Control

GitHub Total Downloads Servers using this plugin

A Minecraft Paper BlueMap addon for greater control over which areas get rendered

a screenshot of bluemap with a couple holes in it. one hole is rectangular, one is an ellipse, and the third is a single chunk

Compatible with Paper 1.13+, just like BlueMap itself.

To reload this plugin, just reload BlueMap itself with /bluemap reload.
You will probably need to rerender your map(s) if you change this plugin's configs.
You can do that with the command /bluemap purge <map-id>

Configuration

The configuration for this plugin uses HOCON files.

In the plugins/BlueMapAreaControl folder you should make a .conf file for each BlueMap map you want to control, with the map-id as the name.
When you install this plugin for the first time, it will generate a template config for each registered BlueMap map.

This is the default config:

is-whitelist=false
debug-mode=false

areas=[
	# Define areas here
]

is-whitelist is a boolean that defines whether the areas list is a whitelist or a blacklist.
When it's a blacklist, all areas will be rendered except the ones in the list.
When it's a whitelist, only the areas in the list will be rendered: the same map as earlier, but now all chunks that were holes are the only ones still left. the rest is now all empty

debug-mode is a boolean that defines whether the debug mode is enabled.
When it's enabled, all configured areas will be marked on the map with a blue border.
This makes it easier to visualise the areas you're defining, before you (re)render the map. the same image as the first, but with blue area markers overlaid

All areas should be denoted within the areas square brackets [ ]

The numbers in the configs are in blocks, but please be aware that BlueMap will round them down to the nearest tile.

There are currently two types of area available that you can use:

  • Rectangle:
{
	type = rect
	# X coordinate of one corner of the rectangle in blocks
	x1 = -30
	# Z coordinate of one corner of the rectangle in blocks
	z1 = -30
	# X coordinate of the opposite corner of the rectangle in blocks
	x2 = 33
	# Z coordinate of the opposite corner of the rectangle in blocks
	z2 = 33
}
  • Ellipse:
{
	type = ellipse
	# Center X coordinate in blocks
	x = 18
	# Center Z coordinate in blocks
	z = 114
	# Radius X in blocks
	rx = 176
	# Radius Z in blocks
	rz = 112
}

A full example config can be found here

Support

To get support with this plugin, join the BlueMap Discord server and ask your questions in #3rd-party-support. You're welcome to ping me, @TechnicJelle.

About

Minecraft Paper plugin and BlueMap addon for greater control over which areas get rendered

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages