BlueMap

Go to file

Lukas Rieger (Blue) 05c220ec3b Maybe also use the same lz4 compression type minecraft uses		2024-05-15 01:18:53 +02:00
.github	Add fabric 1.20.5 build	2024-05-01 11:58:52 +02:00
BlueMapAPI@5c3624832f	Push BlueMapAPI	2023-09-27 23:51:01 +02:00
BlueMapCommon	PDO php script implementation (#486 )	2023-11-20 12:40:47 +01:00
BlueMapCore	Maybe also use the same lz4 compression type minecraft uses	2024-05-15 01:18:53 +02:00
gradle/wrapper	Add fabric 1.20.5 build	2024-05-01 11:58:52 +02:00
implementations	Add forge and neoforge 1.20.6	2024-05-12 11:40:51 +02:00
.dockerignore
.gitattributes
.gitignore	Add releasenotes to publications	2023-11-19 16:00:46 +01:00
.gitmodules	Move BlueMapVue and BlueMapWeb into the main repo	2022-12-18 16:58:37 +01:00
build.gradle.kts	Add neoforge implementation	2023-12-06 17:19:18 +01:00
Dockerfile	feat: arm64 support for docker image (#432 )	2023-05-15 17:01:44 +02:00
gradle.properties	Stay within Github Actions RAM boundaries	2022-11-25 13:01:16 +01:00
gradlew	Update Gradle and 1.20.2 support (#479 )	2023-09-27 17:39:47 +02:00
gradlew.bat	Update Gradle and 1.20.2 support (#479 )	2023-09-27 17:39:47 +02:00
HEADER
jitpack.yml	Test making BlueMapCommon and BlueMapCore available to jitpack	2022-12-04 00:18:45 +01:00
LICENSE
README.md	Update README.md	2022-08-28 17:51:55 +02:00
settings.gradle.kts	Add forge and neoforge 1.20.6	2024-05-12 11:40:51 +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!