BlueMap

Go to file

Lukas Rieger (Blue) 201b8c9e77 Push configurate-version to fix #339		2022-10-10 18:00:03 +02:00
.github	Improve Docker image tags (#337 )	2022-09-09 16:40:27 +02:00
BlueMapAPI@3bbf92965d	Update BlueMapAPI + Implementation	2022-08-25 15:46:37 +02:00
BlueMapCommon	Push BlueMapVue	2022-10-04 20:41:27 +02:00
BlueMapCore	Push configurate-version to fix #339	2022-10-10 18:00:03 +02:00
gradle/wrapper	Moving live-player-endpoint to maps/[mapid]/live/player, webroot/data is now webroot/maps, fixed color-css-alpha format	2022-06-27 01:13:48 +02:00
implementations	Fix #338	2022-10-10 17:46:57 +02:00
.dockerignore	Docker container for CLI version (#320 )	2022-08-14 22:33:40 +02:00
.gitattributes	Add .gitattributes	2019-12-29 18:51:24 +01:00
.gitignore	Some changes to remove 404-responses from the webserver on empty map-tiles	2021-03-28 13:25:39 +02:00
.gitmodules	Replace the webapp with the new BlueMapVue project and adapt the build-script	2021-03-18 22:55:07 +01:00
build.gradle.kts	Refactored config management	2022-04-20 22:54:27 +02:00
Dockerfile	Docker container for CLI version (#320 )	2022-08-14 22:33:40 +02:00
gradle.properties	Add back some heap-space for gradle	2022-01-15 02:09:14 +01:00
gradlew	Add execute permission to gradlew file	2019-12-29 16:37:48 +01:00
gradlew.bat	Add execute permission to gradlew file	2019-12-29 16:37:48 +01:00
HEADER	Add license-header check and fix all missing or invalid license headers	2020-08-03 17:51:07 +02:00
LICENSE	Initial commit: Merging Projects BlueMapCore, BlueMapCLI and BlueMapSponge into one	2019-11-02 17:23:48 +01:00
README.md	Update README.md	2022-08-28 17:51:55 +02:00
settings.gradle.kts	Add forge 1.19.1 support	2022-08-02 23:05:32 +02:00

README.md

create 3D-maps of your Minecraft worlds and display them in your browser
>> DEMO MAP <<

What is BlueMap

BlueMap is a program that reads your Minecraft world files and generates not only a map, but also 3D-models of the whole surface. With the web-app you then can look at those in your browser and basically view the world as if you were ingame! Or just look at it from far away to get an overview.

BlueMap comes as a Spigot/Paper or Sponge Plugin, as a Fabric or Forge-Mod and you can also use BlueMap without any Server from the Command-Line as a standalone tool.

If installed as a Plugin/Mod, BlueMap renders asynchronously to your MinecraftServer-Thread. This means at no time it will block your server-thread directly. So as long as your CPU is not fully utilized, your server should not be slowed down while BlueMap is rendering.

Using BlueMap

You can download BlueMap from here.
Read the installation instructions to get started!

Here you can see how many servers are using BlueMap:

Development

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

You found a bug, have another issue?
First, make sure it's not on your end, if you are unsure you can always ask about it in our Discord.
If you are sure it's a bug on BlueMap's end, please create an issue here!

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.

Links

TODO-List: https://github.com/orgs/BlueMap-Minecraft/projects/2
Wiki: https://bluecolo.red/map-wiki
Discord: https://bluecolo.red/map-discord
Reddit: https://www.reddit.com/r/BlueMap

Special thanks to JetBrains for giving out an OpenSource-Licence for BlueMap development!