Reorganize config, add render-bounds and make some optimizations

Author: TBlueF

BlueMapCLI/src/main/java/de/bluecolored/bluemap/cli/BlueMapCLI.java

@@ -58,6 +58,7 @@
 import de.bluecolored.bluemap.core.logger.Logger;
 import de.bluecolored.bluemap.core.mca.MCAWorld;
 import de.bluecolored.bluemap.core.metrics.Metrics;
+import de.bluecolored.bluemap.core.render.RenderSettings;
 import de.bluecolored.bluemap.core.render.TileRenderer;
 import de.bluecolored.bluemap.core.render.hires.HiresModelManager;
 import de.bluecolored.bluemap.core.render.lowres.LowresModelManager;
@@ -66,6 +67,7 @@
 import de.bluecolored.bluemap.core.web.BlueMapWebServer;
 import de.bluecolored.bluemap.core.web.WebFilesManager;
 import de.bluecolored.bluemap.core.web.WebSettings;
+import de.bluecolored.bluemap.core.world.SlicedWorld;
 import de.bluecolored.bluemap.core.world.World;
 
 public class BlueMapCLI {
@@ -93,13 +95,18 @@ public void renderMaps() throws IOException {
 		Map<String, MapType> maps = new HashMap<>(); 
 
 		for (MapConfig mapConfig : config.getMapConfigs()) {
-			File mapPath = new File(mapConfig.getWorldPath());
-			if (!mapPath.exists() || !mapPath.isDirectory()) {
-				throw new IOException("Save folder '" + mapPath + "' does not exist or is not a directory!");
+			File worldFolder = new File(mapConfig.getWorldPath());
+			if (!worldFolder.exists() || !worldFolder.isDirectory()) {
+				throw new IOException("Save folder '" + worldFolder + "' does not exist or is not a directory!");
 			}
 
 			Logger.global.logInfo("Preparing renderer for map '" + mapConfig.getId() + "' ...");
-			World world = MCAWorld.load(mapPath.toPath(), UUID.randomUUID(), configManager.getBlockIdConfig(), configManager.getBlockPropertiesConfig(), configManager.getBiomeConfig());
+			World world = MCAWorld.load(worldFolder.toPath(), UUID.randomUUID(), configManager.getBlockIdConfig(), configManager.getBlockPropertiesConfig(), configManager.getBiomeConfig());
+			
+			//slice world to render edges if configured
+			if (mapConfig.isRenderEdges() && !(mapConfig.getMin().equals(RenderSettings.DEFAULT_MIN) && mapConfig.getMax().equals(RenderSettings.DEFAULT_MAX))) {
+				world = new SlicedWorld(world, mapConfig.getMin(), mapConfig.getMax());
+			}
 
 			HiresModelManager hiresModelManager = new HiresModelManager(
 					config.getWebDataPath().resolve("hires").resolve(mapConfig.getId()),
@@ -123,12 +130,16 @@ public void renderMaps() throws IOException {
 
 		Logger.global.logInfo("Writing settings.json ...");
 		WebSettings webSettings = new WebSettings(config.getWebDataPath().resolve("settings.json").toFile());
+		webSettings.setAllEnabled(false);
 		for (MapType map : maps.values()) {
+			webSettings.setEnabled(true, map.getId());
 			webSettings.setName(map.getName(), map.getId());
 			webSettings.setFrom(map.getTileRenderer(), map.getId());
 		}
+		int ordinal = 0;
 		for (MapConfig map : config.getMapConfigs()) {
 			if (!maps.containsKey(map.getId())) continue; //don't add not loaded maps
+			webSettings.setOrdinal(ordinal++, map.getId());
 			webSettings.setHiresViewDistance(map.getHiresViewDistance(), map.getId());
 			webSettings.setLowresViewDistance(map.getLowresViewDistance(), map.getId());
 		}
@@ -233,7 +244,7 @@ private boolean loadResources() throws IOException, ParseResourceException {
 		return true;
 	}
 
-	private boolean handleMissingResources(File resourceFile) {
+	private boolean handleMissingResources(File resourceFile) throws IOException {
 		if (configManager.getMainConfig().isDownloadAccepted()) {
 			try {
 				Logger.global.logInfo("Downloading " + ResourcePack.MINECRAFT_CLIENT_URL + " to " + resourceFile.getCanonicalPath() + " ...");
@@ -246,7 +257,7 @@ private boolean handleMissingResources(File resourceFile) {
 		} else {
 			Logger.global.logWarning("BlueMap is missing important resources!");
 			Logger.global.logWarning("You need to accept the download of the required files in order of BlueMap to work!");
-			Logger.global.logWarning("Please check " + configManager.getMainConfigFile() + " and try again!");
+			Logger.global.logWarning("Please check " + configManager.getMainConfigFile().getCanonicalPath() + " and try again!");
 			return false;
 		}
 	}
@@ -278,7 +289,7 @@ public static void main(String[] args) throws IOException, ParseResourceExceptio
 			config.loadMainConfig();
 
 			if (configCreated) {
-				Logger.global.logInfo("No config file found! Created default configs here: " + configFolder);
+				Logger.global.logInfo("No config file found! Created default configs here: " + config.getMainConfigFile().getCanonicalPath());
 				return;
 			}
 

BlueMapCLI/src/main/resources/bluemap-cli-defaults.conf

@@ -1,10 +1,10 @@
 accept-download: false
 metrics: true
+renderThreadCount: 0
 data: "."
-web {
+webroot: "web"
+webserver {
 	enabled: false
-	webroot: "web"
 	port: 8100
 	maxConnectionCount: 100
 }
-renderThreadCount: 0

BlueMapCLI/src/main/resources/bluemap-cli.conf

@@ -5,20 +5,23 @@
 ##  http://bluecolored.de/  ##
 ##                          ##
 
-# !! Don't change this !!
-# This is used to detect version-changes in the configuration 
-# and update configuration correctly.
-version: "%version%"
-
 # By changing the setting (accept-download) below to TRUE you are indicating that you have accepted mojang's EULA (https://account.mojang.com/documents/minecraft_eula),
 # you confirm that you own a license to Minecraft (Java Edition)
 # and you agree that BlueMap will download and use this file for you: %minecraft-client-url%
 # (Alternatively you can download the file yourself and store it here: <data>/minecraft-client-%minecraft-client-version%.jar)
-# This file contains resources that belong to mojang and you must not redistribute it or do anything else that is not compilant with mojang's EULA.
+# This file contains resources that belong to mojang and you must not redistribute it or do anything else that is not compliant with mojang's EULA.
 # BlueMap uses resources in this file to generate the 3D-Models used for the map and texture them. (BlueMap will not work without those resources.)
 # %datetime-iso%
 accept-download: false
 
+# This changes the amount of threads that BlueMap will use to render the maps.
+# A higher value can improve render-speed but could impact performance on the host machine.
+# This should be always below or equal to the number of available processor-cores.
+# Zero or a negative value means the amount of of available processor-cores subtracted by the value.
+# (So a value of -2 with 6 cores results in 4 render-processes)
+# Default is 0
+renderThreadCount: 0
+
 # If this is true, BlueMap might send really basic metrics reports containg only the implementation-type and the version that is being used to https://metrics.bluecolored.de/bluemap/
 # This allows me to track the basic usage of BlueMap and helps me stay motivated to further develop this tool! Please leave it on :)
 # An example report looks like this: {"implementation":"CLI","version":"%version%"}
@@ -27,40 +30,33 @@ metrics: true
 # The folder where bluemap saves data-files it needs during runtime
 data: "."
 
-web {
+# The webroot of the website that displays the map.
+webroot: "web"
+
+# Unncomment this to override the path where bluemap stores the data-files.
+# Default is "<webroot>/data"
+#webdata: "path/to/data/folder"
+
+webserver {
 	# With this setting you can enable the integrated web-server.
+	# Default is disabled
 	enabled: false
 
-	# The webroot of the website that displays the map.
-	webroot: "web"
-	
 	# The IP-Adress that the webserver binds to.
 	# If this setting is commented out, bluemap tries to find the default ip-adress of your system.
 	# If you only want to access it locally use "localhost".
 	#ip: "localhost"
 	#ip: "127.0.0.1"
-	
+
 	# The port that the webserver listenes to.
 	# Default is 8100
 	port: 8100
-	
+
 	# Max number of simultaneous connections that the webserver allows
 	# Default is 100
 	maxConnectionCount: 100
-
-	# Unncomment this to override the path where bluemap stores the data-files.
-	# Default is "<webroot>/data"
-	#web-data: "path/to/data/folder"
 }
 
-# This changes the amount of threads that BlueMap will use to render the maps.
-# A higher value can improve render-speed but could impact performance on the host machine.
-# This should be always below or equal to the number of available processor-cores.
-# Zero or a negative value means the amount of of available processor-cores subtracted by the value.
-# (So a value of -2 with 6 cores results in 4 render-processes)
-# Default is 0
-renderThreadCount: 0
-
 # This is an array with multiple configured maps.
 # You can define multiple maps, for different worlds with different render-settings here
 maps: [
@@ -96,15 +92,21 @@ maps: [
 		# Default is 0.8
 		lighting: 0.8
 
-		# Using this, BlueMap pretends that every Block above the defined value is AIR.
-		# Default is disabled
-		#sliceY: 90
-		
-		# With the below values you can just not render blocks at certain heights.
-		# This can be used to ignore the nethers ceiling.
-		# Default is no min or max y value
+		# With the below values you can limit the map-render.
+		# This can be used to ignore the nethers ceiling or render only a certain part of a world.
+		# Default is no min or max value (= infinite bounds)
+		#minX: -4000
+		#maxX: 4000
+		#minZ: -4000
+		#maxZ: 4000
 		#minY: 50
 		#maxY: 126
+				
+		# Using this, BlueMap pretends that every Block out of the defined render-bounds is AIR,
+		# this means you can see the blocks where the world is cut (instead of having a see-through/xray view).
+		# This has only an effect if you set some render-bounds above.
+		# Default is enabled
+		renderEdges: true
 
 		# HIRES is the high-resolution render of the map. Where you see every block.
 		hires {
@@ -118,7 +120,7 @@ maps: [
 			viewDistance: 4.5
 		}
 
-		# LOWRES is the low-resolution render of the map. THats the model that you see if you zoom far out to get an overview.
+		# LOWRES is the low-resolution render of the map. Thats the model that you see if you zoom far out to get an overview.
 		lowres {
 			# Defines resolution of the lowres model. E.g. If the hires.tileSize is 32, a value of 4 means that every 8*8 blocks will be summarized by one point on the lowres map.
 			# Calculation: 32 / 4 = 8
@@ -137,13 +139,13 @@ maps: [
 	}
 
 	# Here another example for the End-Map
-	# Things we dont want to change from default we can just omit
+	# Things we don't want to change from default we can just omit
 	{
 		id: "end"
 		name: "End"
 		world: "world/DIM1"
 
-		# In the end is no light, so we need to enable this or we don't see anything.
+		# In the end is no sky-light, so we need to enable this or we won't see anything.
 		renderCaves: true
 
 		# Same here, we don't want a dark map. But not completely disabled, so we see the effect of e.g torches.
@@ -159,12 +161,10 @@ maps: [
 		renderCaves: true
 		lighting: 0.6
 
-		# We slice the whole world at y:90 so evrery block above 90 will be air.
-		# This way we dont render the nethers ceiling.
-		sliceY: 90
-		
-		# Instead of slicing we also could do this, that would look like an x-ray view through the ceiling.
-		#maxY: 126
+		# We slice the whole world at y:90 so every block above 90 will be air.
+		# This way we don't render the nethers ceiling.
+		maxY: 90
+		renderEdges: true
 	}
 
 ]

BlueMapCore/src/main/java/de/bluecolored/bluemap/core/config/BiomeConfig.java

@@ -51,7 +51,7 @@ public BiomeConfig(ConfigurationNode node, ConfigurationLoader<? extends Configu
 		for (Entry<Object, ? extends ConfigurationNode> e : node.getChildrenMap().entrySet()){
 			String id = e.getKey().toString();
 			Biome biome = Biome.create(id, e.getValue());
-			biomes.put(biome.getOrdinal(), biome);
+			biomes.put(biome.getNumeralId(), biome);
 		}
 
 	}