Skip to content

Commit 1fd3c2b

Browse files
committed
2 parents d93610c + a7ea9eb commit 1fd3c2b

File tree

1 file changed

+44
-18
lines changed

1 file changed

+44
-18
lines changed

README.md

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
1-
![title-banner](https://bluecolored.de/paste/BluemapBanner.png)
1+
[![title-banner](https://bluecolored.de/paste/BluemapBanner.png)](https://bluemap.bluecolored.de/)
22

3-
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).
3+
<div align="center">
44

5-
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.
5+
create **3D**-maps of your Minecraft worlds and display them in your browser
6+
**>> [DEMO MAP](https://bluecolored.de/bluemap) <<**
67

7-
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.
88

9-
![screenshot](https://bluecolored.de/paste/BlueMapScreenshot.jpg)
9+
[![GitHub issues](https://img.shields.io/github/issues-raw/BlueMap-Minecraft/BlueMap)](https://github.com/orgs/BlueMap-Minecraft/projects/2)
10+
[![GitHub all releases](https://img.shields.io/github/downloads/BlueMap-Minecraft/BlueMap/total)](https://github.com/BlueMap-Minecraft/BlueMap/releases)
11+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/BlueMap-Minecraft/BlueMap)](https://github.com/BlueMap-Minecraft/BlueMap/releases/latest)
12+
[![Discord](https://img.shields.io/discord/665868367416131594?label=discord)](https://discord.gg/zmkyJa3)
1013

11-
### Download
12-
You can choose a version and download BlueMap from [here](https://github.com/BlueMap-Minecraft/BlueMap/releases).
14+
</div>
1315

14-
### Using BlueMap
15-
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!
16+
<br>
17+
<br>
18+
19+
## What is BlueMap
20+
BlueMap is a program that reads your Minecraft world files and generates not only a map, but also 3D-models of the whole surface.
21+
With the web-app you then can look at those in your browser and basically view the world as if you were ingame!
22+
Or just look at it from far away to get an overview.
23+
24+
[![screenshot](https://bluecolored.de/paste/BlueMapScreenshot.jpg?2)](https://bluecolored.de/bluemap)
25+
26+
BlueMap comes as a Spigot/Paper or Sponge Plugin, as a Fabric or Forge-Mod and you can also use BlueMap without any Server
27+
from the Command-Line as a standalone tool.
28+
29+
If installed as a Plugin/Mod, BlueMap **renders asynchronously** to your MinecraftServer-Thread.
30+
This means at no time it will block your server-thread directly.
31+
So as long as your CPU is not fully utilized, your server should not be slowed down while BlueMap is rendering.
1632

33+
34+
## Using BlueMap
35+
You can download BlueMap from [here](https://github.com/BlueMap-Minecraft/BlueMap/releases).
36+
Read the [installation instructions](https://bluemap.bluecolored.de/wiki/getting-started/Installation.html) to get started!
37+
38+
Here you can see how many servers are using BlueMap:
39+
40+
[![BlueMap Graph](https://metrics.bluecolored.de/bluemap/graph.php?1)](https://metrics.bluecolored.de/)
41+
42+
## Development
1743
### Clone
1844
If you have git installed, simply use the command `git clone --recursive https://github.com/BlueMap-Minecraft/BlueMap.git` to clone BlueMap.
1945

2046
### Build
2147
In order to build BlueMap you simply need to run the `./gradlew clean build` command in BlueMap's root directory.
2248
You can find the compiled JAR files in `./build/release`.
2349

24-
### Issues / Suggestions
25-
You found a bug, have another issue or a suggestion? Please create an issue [here](https://github.com/BlueMap-Minecraft/BlueMap/issues)!
50+
### Issues
51+
You found a bug, have another issue?
52+
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).
53+
If you are sure it's a bug on BlueMap's end, please create an issue [here](https://github.com/BlueMap-Minecraft/BlueMap/issues)!
2654

2755
### Contributing
2856
You are welcome to contribute!
@@ -33,13 +61,11 @@ Just create a pull request with your changes :)
3361
Keep in mind that we have to maintain all new features and keep supporting them in the future.
3462
This means we always can decide to not accept a PR for any reason.
3563

36-
### Todo / planned features
37-
[Here is a todo-list](https://github.com/orgs/BlueMap-Minecraft/projects/2)
38-
39-
### Links
40-
**Wiki:** https://bluecolo.red/map-wiki <br>
41-
**Discord:** https://bluecolo.red/map-discord <br>
42-
**Reddit:** https://www.reddit.com/r/BlueMap <br>
64+
## Links
65+
**TODO-List:** https://github.com/orgs/BlueMap-Minecraft/projects/2
66+
**Wiki:** https://bluecolo.red/map-wiki
67+
**Discord:** https://bluecolo.red/map-discord
68+
**Reddit:** https://www.reddit.com/r/BlueMap
4369

4470
---
4571

0 commit comments

Comments
 (0)