BlueMap how to

Setting up the plugin

1. Set the accept-download to true in the core.conf file to enable the plugin (this actually enables the download of Minecraft official textures)

   # core.conf
   
   # 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 a minecraft-client file (depending on the minecraft-version) from mojangs servers (https://piston-meta.mojang.com/) for you.
   # 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.)
   # <date-and_time>
   accept-download: true
   

2. In the same file set the number of threads used for rendering:

   # core.conf
   
   # 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 available processor-cores subtracted by the value.
   # (So a value of -2 with 6 cores results in 4 render-processes)
   # Default is 1
   render-thread-count: 4
   

3. In the SQL config file set the IP of the database, the table, the database and the password

   # storage/sql.conf
   
   # The JDBC-Connection URL that is used to connect to the database.
   # The format for this url is usually something like: jdbc:[driver]://[host]:[port]/[database]
   # The exact format of the url is determined by the JDBC-Driver you are using.
   connection-url: "jdbc:mysql://10.10.10.201:3306/<table-name>?permitMysqlScheme"
   
   # You can set any additional (JDBC-Driver-specific) properties here
   # Usually that's your db-user and password
   connection-properties: {
       user: "bluemap",
       password: "t&iYL4W#z!2b1#"
   }
   

   Warning

   Make sure to modify the <table-name> variable accordingly

4. Set every "map" (file) inside the maps directory so that it uses the SQL storage

   # maps/world.conf
   
   # This defines the storage-config that will be used to save this map.
   # You can find your storage configs next to this config file in the 'storages'-folder.
   # Changing this value requires a re-render of the map. The map in the old storage will not be deleted.
   # Default is "file"
   storage: "sql"
   

   # maps/world_nether.conf
   
   # ...
   storage: "sql"
   

   # maps/world_the_end.conf
   
   # ...
   storage: "sql"
   

   If you have other maps do this step for those maps to.

5. In the webserver.conf (in the root directory of the plugin) set the enabled flag to false to disable the internal web server (to use the external)

   # webserver.conf
   
   # With this setting you can disable the integrated web-server.
   # This is useful if you want to only render the map-data for later use, or if you setup your own webserver.
   # Default is enabled
   enabled: false
   

6. OPTIONAL To disable the visibility of online players in the webserver set the live-player-markers to false in the plugin.conf

   # plugin.conf
   
   # If the server should send player-positions to the webapp.
   # This only works if the integrated webserver is enabled.
   # Default is true
   live-player-markers: false
   

7. You can up restart the plugin with /bluemap reload or restart the server

Info

Bluemap will create a folder in the main docker directory called "bluemap", this folder contains the webserver (the folder will be created even if the internal webserver is disables), please do not delete the folder (if it is deleted it will be re-generated automatically).

The position of the webserver folder can be changed in the webapp.conf file, THIS OPERATION IS NOT RECOMANDED.

# webapp.conf

# The webroot where the web-application files will be created.
# Usually this should be set to the same directory like in the webserver.conf!
# Default is "bluemap/web"
webroot: "bluemap/web"

If the internal webserver is enabled and you decide to modify this path please be sure to modify the same path also in the webserver.conf file

# webserver.conf

# The webroot that the server will host to the web.
# Usually this should be set to the same directory like in the webapp.conf!
# Default is "bluemap/web"
webroot: "bluemap/web"

Setup for the external webserver

1. Create the external webserver docker

2. Copy this folder

   /user/appdata/pelican-winbg/data/volumes/<UUDIS-pelican-docker>/bluemap/web
   to
   /user/appdata/<webserver-name>/www
   

3. now you can set the SQL connection inside the sql.php file in the webserver

4. modify the ngix config file try_files $uri ecc...