BlueMap/README.md

48 lines
2.6 KiB
Markdown
Raw Normal View History

2020-03-17 20:26:48 +01:00
![title-banner](https://bluecolored.de/paste/BluemapBanner.png)
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).
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
2020-08-15 13:42:11 +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://github.com/BlueMap-Minecraft/BlueMap/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.
2020-01-03 13:08:59 +01:00
### Build
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`.
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
You are welcome to contribute!
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-02-09 17:22:28 +01:00
### Todo / planned features
2021-02-16 01:05:15 +01:00
[Here is a todo-list](https://github.com/BlueMap-Minecraft/BlueMap/projects/1?fullscreen=true)! It is ordered by what i right now think is the priority, but it might always change or be reordered at my discretion. *(I develop BlueMap in my free-time, so nothing here is a promise and there are no ETA's)*
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>
Special thanks to [JetBrains](https://www.jetbrains.com/?from=BlueMap) for giving out an OpenSource-Licence for BlueMap development!