Skip to content

A GUI wrapper around the BlueMap CLI, mainly to make using BlueMap easier to use on single player worlds.

Notifications You must be signed in to change notification settings

TechnicJelle/BlueMapGUI

Repository files navigation

logo

GitHub Total Downloads Platform: Linux Platform: Linux Build Flutter Desktop

BlueMap GUI

Use BlueMap on your single-player worlds with ease!

This program is a GUI wrapper around the BlueMap CLI tool, which makes it easier to use for people who are not familiar with the command line, don't have a server, or just want a more user-friendly experience.

screenshot

Usage Guide

1. Setting up Java

When you first open the program, you will need to choose which Java version you want to use.
Go to the Settings tab in the sidebar on the left to select whether you want to:

  • automatically detect the Java version installed on your system.
  • pick a Java version manually. Useful if it couldn't automatically find it.

I am planning on adding an Automatic Download button for Java in the future.

2. Creating a project

Once you've supplied a working Java version, go back to the Projects tab in the sidebar.
You can create a new BlueMap project with the (+) button in the bottom right.
Clicking this button opens a dialog where you can name your project.
You can also choose a different place on your computer to store the project in, if you like.

Once you're happy with these settings, click the blue Create button.
Your new BlueMap project is now in the projects list!
Click on it to open it.

Opening will take a bit longer the first time, because it needs to download the BlueMap file.

You can return to the main menu by closing the project, by clicking the close button in the top right corner.

3. Setting up BlueMap

3.a Accepting the download

You can now try to start BlueMap by clicking the ▶ Start button.

But this first time, it will not work yet. You will see instructions to accept a download in the Core config.

This is because BlueMap needs to download some files from Mojang to work properly, and according to the Mojang EULA, you have to manually confirm this download.

Luckily, you can do this very simply, by clicking the Core button in the left sidebar.
This will open the config editor, where you can edit the config to accept the download.
Find the accept-download option, and change the false to true.

3.b Configuring your maps

Now, you have to configure your maps.

Click the + New map button in the sidebar.
A dialog will open up where you need to choose a template (overworld, nether, or end) and type in a unique ID for the map. This can be anything you like.
Once you're happy with these settings, click the blue Create button.

You will now see the ID you typed in the sidebar, under the Map configs section.

The config editor should be opened on your new map automatically, but if it isn't you can click the newly created map in the sidebar to open it.

You need to edit this file to tell BlueMap where on your computer your world is.

For the time being, you have to manually provide the path to your world folder.
I'll make a simpler workflow for this later.

So find your world folder on your computer and copy the path to it.

Then in the config editor, find the world option, and paste the path you copied into it.

Example paths:

Windows
world: "C:/Users/TechnicJelle/AppData/Roaming/.minecraft/saves/MyCoolWorld/"

Note

Make sure to use forward slashes (/) on Windows as well!
The path you copied likely has backslashes (\), so you have to change them manually.

Linux
world: "/home/technicjelle/.minecraft/saves/MyCoolWorld/"

3.c (OPTIONAL) Setting up resource-packs & data-packs

To make BlueMap use your preferred resource-packs and data-packs, click the Open in file manager button in the top right.

In the file manager window that now opened, go into the config folder, and then packs. Copy&paste all resource-packs/data-packs you want to use here. You do not need to unpack them.

You can read more about how to set these up on the BlueMap wiki.

Managing resource-packs and data-packs will be made nicer in the future.

3.d (OPTIONAL) Setting up mods

To make modded blocks show up correctly, BlueMap needs to know which mods you're using.

Click the Open in file manager button in the top right.

In the file manager window that now opened, go into the config folder, and then packs. Copy&paste all the .jar files of all the mods you're using into here.

BlueMap does not support all blocks from all mods, but most things will likely work. You can read more about BlueMap's mod support on the BlueMap wiki.

Adding mods will be made nicer in the future.

4. Starting BlueMap

Once you've set up all the maps you want to render, you can go back to the Control Panel tab in the sidebar, and click the ▶ Start button to finally start BlueMap!

You can view the progress and status in the console output, and you can open the map by clicking the ⬆ Open button.

Support

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

More screenshots

screenshot

screenshot

screenshot