From 21b563a31556bc612c9ff890b09f365eec07d497 Mon Sep 17 00:00:00 2001 From: Lukas Rieger Date: Sun, 28 Aug 2022 17:49:23 +0200 Subject: [PATCH] Update README.md --- README.md | 62 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 44 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 1b263d11..e41746dc 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,45 @@ -![title-banner](https://bluecolored.de/paste/BluemapBanner.png) +[![title-banner](https://bluecolored.de/paste/BluemapBanner.png)](https://bluemap.bluecolored.de/) -BlueMap is a tool that generates 3d-maps of your Minecraft worlds and displays them in your browser. Take a look at [this demo](https://bluecolored.de/bluemap). 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. +create **3D**-maps of your Minecraft worlds and display them in your browser +**>> [DEMO MAP](https://bluecolored.de/bluemap) <<** -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. -![screenshot](https://bluecolored.de/paste/BlueMapScreenshot.jpg) +[![GitHub issues](https://img.shields.io/github/issues-raw/BlueMap-Minecraft/BlueMap)](https://github.com/orgs/BlueMap-Minecraft/projects/2) +[![GitHub all releases](https://img.shields.io/github/downloads/BlueMap-Minecraft/BlueMap/total)](https://github.com/BlueMap-Minecraft/BlueMap/releases) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/BlueMap-Minecraft/BlueMap)](https://github.com/BlueMap-Minecraft/BlueMap/releases/latest) +[![Discord](https://img.shields.io/discord/665868367416131594?label=discord)](https://discord.gg/zmkyJa3) -### Download -You can choose a version and download BlueMap from [here](https://github.com/BlueMap-Minecraft/BlueMap/releases). +
-### 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](https://bluemap.bluecolored.de/wiki/) to get started! +
+
+## What is BlueMap +BlueMap is basically 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](https://bluecolored.de/paste/BlueMapScreenshot.jpg?2)](https://bluecolored.de/bluemap) + +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](https://github.com/BlueMap-Minecraft/BlueMap/releases). +Read the [installation instructions](https://bluemap.bluecolored.de/wiki/getting-started/Installation.html) to get started! + +Here you can see how many servers are using BlueMap: + +[![BlueMap Graph](https://metrics.bluecolored.de/bluemap/graph.php?1)](https://metrics.bluecolored.de/) + +## Development ### Clone If you have git installed, simply use the command `git clone --recursive https://github.com/BlueMap-Minecraft/BlueMap.git` to clone BlueMap. @@ -21,8 +47,10 @@ If you have git installed, simply use the command `git clone --recursive https:/ 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](https://github.com/BlueMap-Minecraft/BlueMap/issues)! +### 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](https://bluecolo.red/map-discord). +If you are sure it's a bug on BlueMap's end, please create an issue [here](https://github.com/BlueMap-Minecraft/BlueMap/issues)! ### Contributing You are welcome to contribute! @@ -33,13 +61,11 @@ Just create a pull request with your changes :) 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](https://github.com/orgs/BlueMap-Minecraft/projects/2) - -### Links -**Wiki:** https://bluecolo.red/map-wiki
-**Discord:** https://bluecolo.red/map-discord
-**Reddit:** https://www.reddit.com/r/BlueMap
+## 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 ---