BlueMap/README.md

55 lines
2.7 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-08-15 13:42:11 +02:00
**BlueMap is currently in a BETA state!**
2020-01-03 13:08:59 +01:00
2020-08-15 13:42:11 +02:00
It is however already quite stable and usable. There are just some features still missing, and some blocks - especially tile-entities - will not render correctly/at all.
2020-01-03 13:08:59 +01:00
See below for a list of what is planned for future releases.
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
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.)*
2020-01-03 13:08:59 +01:00
2020-02-09 17:22:28 +01:00
- render more tile-entities (banners, shulker-chests, etc..)
- render entities (armor-stands, item-frames, maybe even cows and such..)
2020-01-03 13:08:59 +01:00
- free-flight-controls
- more configurations
2020-02-09 17:22:28 +01:00
- easier mod-integration
2020-01-03 13:08:59 +01:00
- ability to display the world-border
2020-02-09 17:22:28 +01:00
- animated textures (if feasible)
2020-03-17 20:26:48 +01:00
- add support for models in obj format (if feasible)
2020-08-15 13:42:11 +02:00
### Links
**Wiki:** https://bluecolo.red/map-wiki <br>
**Reddit:** https://www.reddit.com/r/BlueMap <br>
**Discord:** https://bluecolo.red/map-discord <br>