zhangyuheng/BlueMap
1
0
Fork 0
forked from mirror/BlueMap
Code Pull Requests Activity
977 Commits 5 Branches 102 Tags 9 MiB
Java 78.5%
JavaScript 17.7%
Vue 2.9%
SCSS 0.5%
PHP 0.3%
8f97b08eb5
Go to file
Lukas Rieger (Blue) 8f97b08eb5
Use string-builder in verbose logger
2023-06-29 08:38:46 +02:00
.github Update CONTRIBUTING.md 2023-06-14 19:27:22 +02:00
BlueMapAPI@40140f87c6 Bump BlueMapAPI 2023-06-26 18:56:02 +02:00
BlueMapCommon Use string-builder in verbose logger 2023-06-29 08:38:46 +02:00
BlueMapCore Add supressed exception for more info 2 2023-06-21 15:13:27 +02:00
gradle/wrapper Add forge-1.19.4 implementation and update gradle 2023-03-15 15:51:10 +01:00
implementations Add port-in-use check (#440) 2023-06-08 23:12:20 +02:00
.dockerignore
.gitattributes
.gitignore
.gitmodules Move BlueMapVue and BlueMapWeb into the main repo 2022-12-18 16:58:37 +01:00
build.gradle.kts Do spotless checks on each github action build 2023-06-08 22:15:21 +02: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
gradlew.bat
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-1.20 implementation 2023-06-08 18:22:21 +02: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.

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

JetBrainsLogo

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