2020-03-17 20:26:48 +01:00
![title-banner ](https://bluecolored.de/paste/BluemapBanner.png )
2019-11-02 17:23:48 +01:00
2020-01-14 23:38:03 +01:00
BlueMap is a tool that generates 3d-maps of your Minecraft worlds and displays them in your browser. Take a look at [this demo ](https://bluecolored.de/bluemap ). It is really easy to set up - almost plug-and-play - if you use the integrated web-server (optional).
2019-11-02 17:23:48 +01:00
2020-08-15 13:42:11 +02:00
The plugins/mods automatically update your map as soon as something changes in your world, as well as rendering newly generated terrain and managing the render-tasks.
2020-01-03 13:08:59 +01:00
2020-09-05 20:53:48 +02:00
Some features and some blocks are still missing. Especially some tile-entities will not render correctly/at all. See below for a list of what is planned for future releases.
2020-01-03 13:08:59 +01:00
2020-08-23 15:21:25 +02:00
![screenshot ](https://bluecolored.de/paste/BlueMapScreenshot.jpg )
2020-02-09 17:22:28 +01:00
### Download
You can choose a version and download BlueMap from [here ](https://github.com/BlueMap-Minecraft/BlueMap/releases ).
### Using BlueMap
2021-07-31 21:53:01 +02:00
BlueMap can be used on the command-line, or as a plugin/mod for your Sponge/Spigot/Paper/Forge/Fabric-Server. Read the [wiki ](https://bluemap.bluecolored.de/wiki/ ) to get started!
2020-02-09 17:22:28 +01:00
### Clone
2020-04-09 22:15:08 +02:00
If you have git installed, simply use the command `git clone --recursive https://github.com/BlueMap-Minecraft/BlueMap.git` to clone BlueMap.
2019-11-02 17:23:48 +01:00
2020-01-03 13:08:59 +01:00
### Build
2020-04-06 16:54:11 +02:00
In order to build BlueMap you simply need to run the `./gradlew clean build` command in BlueMap's root directory.
You can find the compiled JAR files in `./build/release` .
2019-11-02 17:23:48 +01:00
2020-01-03 13:08:59 +01:00
### Issues / Suggestions
You found a bug, have another issue or a suggestion? Please create an issue [here ](https://github.com/BlueMap-Minecraft/BlueMap/issues )!
### Contributing
2020-01-14 23:38:03 +01:00
You are welcome to contribute!
2019-11-02 17:23:48 +01:00
Just create a pull request with your changes :)
2020-01-03 13:08:59 +01:00
2020-08-15 13:42:11 +02:00
**If you want to have your changes merged, make sure they are complete, documented and well tested!**
Keep in mind that we have to maintain all new features and keep supporting them in the future.
This means we always can decide to not accept a PR for any reason.
2020-07-29 10:49:00 +02:00
2020-02-09 17:22:28 +01:00
### Todo / planned features
2022-08-15 21:24:41 +02:00
[Here is a todo-list ](https://github.com/orgs/BlueMap-Minecraft/projects/2 )
2020-08-15 13:42:11 +02:00
### Links
**Wiki:** https://bluecolo.red/map-wiki < br >
**Discord:** https://bluecolo.red/map-discord < br >
2020-09-12 14:47:22 +02:00
**Reddit:** https://www.reddit.com/r/BlueMap < br >
2021-02-16 01:05:15 +01:00
---
[![JetBrainsLogo ](https://bluecolored.de/paste/jetbrains-variant-4.svg )](https://www.jetbrains.com/?from=BlueMap)< br >
2021-10-26 12:13:42 +02:00
< br >
2021-02-16 01:05:15 +01:00
Special thanks to [JetBrains ](https://www.jetbrains.com/?from=BlueMap ) for giving out an OpenSource-Licence for BlueMap development!