mirror of
https://github.com/BlueMap-Minecraft/BlueMap.git
synced 2024-12-01 23:13:28 +01:00
58 lines
2.8 KiB
Markdown
58 lines
2.8 KiB
Markdown
|
|
|
|
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).
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
|
|
|
|
### Download
|
|
You can choose a version and download BlueMap from [here](https://github.com/BlueMap-Minecraft/BlueMap/releases).
|
|
|
|
### Using BlueMap
|
|
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!
|
|
|
|
### Clone
|
|
If you have git installed, simply use the command `git clone --recursive https://github.com/BlueMap-Minecraft/BlueMap.git` to clone BlueMap.
|
|
|
|
### 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`.
|
|
|
|
### 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 :)
|
|
|
|
**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.
|
|
|
|
### Todo / planned features
|
|
Here is a *(surely incomplete)* list of things that i want to include in future versions. *(They are not in any specific order. There is no guarantee that any of those things will ever be included.)*
|
|
|
|
- rewrite web-app
|
|
- free-flight-controls
|
|
- localization config
|
|
- a fix for issue #13
|
|
- add /bluemap help
|
|
- render more tile-entities (banners, shulker-chests, etc..)
|
|
- update markers (semi) live (currently if they change, e.g. via plugin, you have to reload the page to see the changes)
|
|
- ability to display the world-border
|
|
- live daylight cycle
|
|
- ability to change a players display names
|
|
- smooth lighting (if feasible)
|
|
- render entities (armor-stands, item-frames, maybe even cows and such..)
|
|
- 3th zoom-layer to be able to zoom out even further
|
|
- animated textures (if feasible)
|
|
|
|
### Links
|
|
**Wiki:** https://bluecolo.red/map-wiki <br>
|
|
**Discord:** https://bluecolo.red/map-discord <br>
|
|
**Reddit:** https://www.reddit.com/r/BlueMap <br>
|