BlueMap

mirror of https://github.com/BlueMap-Minecraft/BlueMap.git synced 2024-12-27 03:17:43 +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

Blue (Lukas Rieger) 0e1e4056bb Workaround for SpongePowered/Configurate#206 When that issue is fixed, this commit can be reverted.		2021-06-09 13:54:14 +02:00
.github	Update gradle to 7.0.2 and add fabric-1.17 implementation	2021-06-08 22:44:55 +02:00
BlueMapAPI@b8abf79957	Implement API additions	2021-05-24 14:48:31 +02:00
BlueMapCommon	Workaround for SpongePowered/Configurate#206	2021-06-09 13:54:14 +02:00
BlueMapCore	Update gradle to 7.0.2 and add fabric-1.17 implementation	2021-06-08 22:44:55 +02:00
gradle/wrapper	Update gradle to 7.0.2 and add fabric-1.17 implementation	2021-06-08 22:44:55 +02:00
implementations	Add additional full-update intervall and periodically restart file-watchers	2021-06-09 00:34:12 +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	Update gradle to 7.0.2 and add fabric-1.17 implementation	2021-06-08 22:44:55 +02:00
gradle.properties	Push version	2021-05-17 00:26:11 +02: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	2021-02-16 01:05:15 +01:00
settings.gradle	Update gradle to 7.0.2 and add fabric-1.17 implementation	2021-06-08 22:44:55 +02:00

README.md

BlueMap is a tool that generates 3d-maps of your Minecraft worlds and displays them in your browser. Take a look at this demo. It is really easy to set up - almost plug-and-play - if you use the integrated web-server (optional).

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.

Some features and some blocks are still missing. Especially some tile-entities will not render correctly/at all. See below for a list of what is planned for future releases.

Download

You can choose a version and download BlueMap from here.

Using BlueMap

BlueMap can be used on the command-line, or as a plugin/mod for your Sponge/Spigot/Paper/Forge/Fabric-Server. Read the wiki to get started!

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 / Suggestions

You found a bug, have another issue or a suggestion? 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 / planned features

Here is a todo-list! It is ordered by what i right now think is the priority, but it might always change or be reordered at my discretion. (I develop BlueMap in my free-time, so nothing here is a promise and there are no ETA's)

Links

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!