BlueMap

mirror of https://github.com/BlueMap-Minecraft/BlueMap.git synced 2024-11-23 19:16:35 +01:00

A Minecraft mapping tool that creates 3D models of your Minecraft worlds and displays them in a web viewer.

bluemap minecraft minecraft-mod minecraft-plugin threejs webgl

Go to file

Lukas Rieger (Blue) 8cde7f4162 Fix docker base-image		2024-09-15 14:38:53 +02:00
.github	Rework gradle-build system (#574 )	2024-09-12 17:45:21 +02:00
api@1992148128	Push api	2024-09-12 17:49:14 +02:00
buildSrc	Disable debug mode for modrinth deployments	2024-09-15 14:02:35 +02:00
common	Allow only providing the map-id in the page-adress, fixes: #589	2024-09-15 10:22:18 +02:00
core	Fix self-healing for corrupted render-state files, fixes: #588	2024-09-15 10:09:53 +02:00
gradle	Update BlueNBT	2024-09-13 15:09:08 +02:00
implementations	Add 1.21.1 to supported versions	2024-09-12 22:09:03 +02:00
.dockerignore	Docker container for CLI version (#320 )	2022-08-14 22:33:40 +02:00
.gitattributes	preserve lf lineseparator for config templates	2024-03-17 13:15:07 +01:00
.gitignore	Rework gradle-build system (#574 )	2024-09-12 17:45:21 +02:00
.gitmodules	Rework gradle-build system (#574 )	2024-09-12 17:45:21 +02:00
Dockerfile	Fix docker base-image	2024-09-15 14:38:53 +02:00
gradle.properties	Rework gradle-build system (#574 )	2024-09-12 17:45:21 +02:00
gradlew	Rework gradle-build system (#574 )	2024-09-12 17:45:21 +02:00
gradlew.bat	Rework gradle-build system (#574 )	2024-09-12 17:45:21 +02:00
LICENSE	Initial commit: Merging Projects BlueMapCore, BlueMapCLI and BlueMapSponge into one	2019-11-02 17:23:48 +01:00
LICENSE_HEADER	Rework gradle-build system (#574 )	2024-09-12 17:45:21 +02:00
README.md	Update README.md	2022-08-28 17:51:55 +02:00
settings.gradle.kts	Rework gradle-build system (#574 )	2024-09-12 17:45:21 +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!