A Minecraft mapping tool that creates 3D models of your Minecraft worlds and displays them in a web viewer.
Go to file
Gerber Lóránt Viktor a847e247e5
Add mechanism for retrieving BlockEntity data (#524)
* Add mechanism for retrieving BlockEntity data

This commit adds a mechanism for retrieving block entity data.
Block entity data is required to support for example text on signs,
banner patterns, or mods such as Domum Ornamentum.

* Fix the coordinate-packing for block entity-loading

This commit fixes the incorrect shifting of bits when
packing the chunk-local coordinates of a block entity
into a 64-bit long for lookups.

* Change mapping type of BlockEntity lookups

This commit changes the type stored for BlockEntity
mappings from a class of the type associated with the
ID to a method reference to its constructor.

* Tidy BlockEntity mappings

This commit introduces a small functional interface
to make the type less ungodly. Also silences the warning
about referencing subclasses in the superclass, it is
fine in this case, we're just storing a reference to
the constructor.

* Add missing license headers

The license headers were missing. Oops.
2024-03-20 23:23:03 +01:00
.github Workflow to check translations for outdated data and missing strings (#514) 2024-02-24 23:58:21 +01:00
BlueMapAPI@6cad751ac5 Fix Map-Updates not working correctly 2024-02-22 12:58:57 +01:00
BlueMapCommon Add mechanism for retrieving BlockEntity data (#524) 2024-03-20 23:23:03 +01:00
BlueMapCore Add mechanism for retrieving BlockEntity data (#524) 2024-03-20 23:23:03 +01:00
gradle/wrapper Tidy up buildscript and dependencies, fix spongeworld world-folder being wrong 2024-02-07 23:01:31 +01:00
implementations Fix paper-implementation not saving the world on the main thread 2024-03-14 09:17:22 +01: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 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
Dockerfile feat: arm64 support for docker image (#432) 2023-05-15 17:01:44 +02: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
build.gradle.kts Fix spotless testing for root-modules 2024-03-04 13:10:00 +01: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
jitpack.yml Test making BlueMapCommon and BlueMapCore available to jitpack 2022-12-04 00:18:45 +01:00
settings.gradle.kts Fix spotless testing for root-modules 2024-03-04 13:10:00 +01:00

README.md

title-banner

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

GitHub issues GitHub all releases GitHub release (latest by date) Discord



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.

screenshot

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:

BlueMap Graph

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.

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


JetBrainsLogo

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