Configuration

General

The main configuration file of bluemap (bluemap.conf) is formatted using HOCON. Please make sure you have a basic understanding of how to use HOCON and what "field", "key" and "value" mean in this context.

If you have no configuration file, bluemap generates an example config file for you. In this generated config every field has a comment above it with what it does and it's default value (if it has one).
It also has 3 maps pre-configured as an example. Using the list maps you can define as many maps as you want. Each configured map will appear in a drop-down the web-app where you can switch between them. Remember to remove the pre-generated maps if you don't use them!

The most basic config simply renders a world in the "world" folder in your current cwd and looks like this:

# set this to true, please read below what this means
accept-download: false

maps [
   {
      id: "my_world"
      name: "My World"
      world: "world"
   }
]

• The accept-download field defaults to false but you need to set this to true if you want to use bluemap! Before doing that, please read the following carefully:

By changing the setting accept-download to true you are indicating that you have accepted mojang's EULA,
you confirm that you own a license to Minecraft (Java Edition)
and you agree that BlueMap will download and use a minecraft-client-jar from mojang's servers (https://launcher.mojang.com/)
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.)

• The maps field is a list ([]) of one or more objects ({}). Every object represents one map that bluemap will render. You can render multiple maps of multiple worlds, or even multiple maps of the same world if you want. Each map-object should have the following fields:
  • The id field to define the id of the map, this id can only contain normal letters (a-z) numbers and underscores and has to be unique. It is used for example as folder-name where the rendered map-models will be saved.
  • The name field to define the display-name of the map. This will be how the map is called in the web-app.
  • The world field to define the folder of the world you want to render

Other general configuration fields

• The metrics field defaults to true and controls if bluemap is sending some really small metrics reports. The report only contains the used implementation type (e.g. 'CLI' or 'Sponge') and the Version. This allows me to track the basic usage of BlueMap and helps me stay motivated to further develop this tool! Please leave it on :)
  (Since sponge has it's own metrics control, this setting will be ignored if you use bluemap as sponge-plugin)
• With the data field you can change the folder where bluemap saves some files it needs during run-time or to save other data.
  (E.g. the downloaded minecraft-client file, other default resources and the state of your render-tasks if they got paused.)
• renderThreadCount defines how many render threads (processes) bluemap will create. Set this to 0 to maximize the utilization of your CPU (bluemap will create as many threads as available CPU-cores). If you set it to a negative value, bluemap will take the number of available cores and add the (negative) defined number to it. So with 8 cores and renderThreadCount: 2 its 8 + (-2) = 6 threads.