Skip to content

Commit

Permalink
Update readme in preparation for 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
TechnicJelle committed Sep 8, 2024
1 parent 4c991f8 commit 63ad121
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 15 deletions.
Binary file removed .github/readme_assets/bmgui.png
Binary file not shown.
Binary file added .github/readme_assets/control_panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme_assets/main_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme_assets/map_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
86 changes: 71 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,83 @@

# BlueMap GUI

A GUI wrapper around the BlueMap CLI, mainly to make using BlueMap easier for single player worlds.
**Use BlueMap on your single-player worlds with ease!**

![screenshot](.github/readme_assets/bmgui.png)
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](.github/readme_assets/control_panel.png)

## Requirements
Make sure you have **Java 16** or higher installed and on your PATH!
Make sure you have **Java 16** or higher installed!

## Usage Guide
### 1. Setting up Java
When you first open the program, you will need to choose which Java version you want to use.
It tries to automatically detect the Java version installed on your system.
If it couldn't find it, you can pick one manually.
_I am planning on adding an Automatic Download button for Java
[in the future](https://github.com/TechnicJelle/BlueMapGUI/issues/18)._

### 2. Setting up a project
Once you've supplied a working Java version, you will be asked to select a project directory.
I recommend making a new, empty folder somewhere and using that.

From now on, whenever you start BlueMap GUI, it will automatically open this project again.
The current project can be closed by clicking the close button in the top right corner.
You can always open it back up again, or you can make a new project by opening a new (empty) folder.
_I'm planning on adding more proper project management
[in the future](https://github.com/TechnicJelle/BlueMapGUI/milestone/3)._

### 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, you will be instructed 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 file to accept the download.
Just set the `accept-download` option to `true`.

#### 3.b Configuring your maps
Now, you have to configure your maps.
Click the `+ New map` button in the sidebar, and in the popup,
choose a template (overworld, nether, or end) and type in a unique ID for the map.

Now, you need to set the path to your world folder by editing the map config.
For the time being, you have to manually copy the path
to your world folder into the map config.
_I'll make a simpler workflow for this [later](https://github.com/TechnicJelle/BlueMapGUI/milestone/2)._

Example paths:
##### Windows
```hocon
world: "C:/Users/TechnicJelle/AppData/Roaming/.minecraft/saves/1_20_4/"
```
> [!NOTE]
> Make sure to use forward slashes (` / `) on Windows as well!
> It likely copies the path with backslashes (` \ `), so you probably have to change them manually.
## Usage
When you first open the program, it asks you to select a project directory.
I recommend making a new folder somewhere and using that one.
##### Linux
```hocon
world: "/home/technicjelle/.minecraft/saves/1_20_4/"
```

It will then download the BlueMap CLI tool into that folder,
and verify that it's the exact correct one, to prevent any suspicious files from being run.
#### 3.c Starting BlueMap
Once you've set up all the maps you want to render,
you can go back to the Control Panel, and click the `▶ Start` button to start BlueMap!

Lastly, it'll generate all the default configs for you, and show them in the left sidebar.
You can view the progress and status in the console output,
and you can open the map by clicking the `⬆ Open` button.

You can then click the Start button to start BlueMap!
## Support
To get help with this program, join the [BlueMap Discord server](https://bluecolo.red/map-discord)
and ask your questions in [#3rd-party-support](https://discord.com/channels/665868367416131594/863844716047106068).
You're welcome to ping me, @TechnicJelle.

The first time, you will be instructed to accept the download in the core.conf file.
You can edit that very simply, inside BlueMap GUI by clicking the Core button in the left sidebar.
## More screenshots
![screenshot](.github/readme_assets/main_menu.png)

From there on, you have to configure your maps. I'll make a better workflow for that later.
For the time being, you have to copy the path to your world folder into the map config manually.
You can edit the map config in the built-in config editor, too.
![screenshot](.github/readme_assets/map_config.png)

0 comments on commit 63ad121

Please sign in to comment.