You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,21 +2,18 @@
2
2
3
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).
4
4
5
-
The Sponge/Spigot-Plugin automatically updates your map as soon as something changes in your world, as well as rendering newly generated terrain and managing the render-tasks.
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.
6
6
7
-
**BlueMap is currently in an early development state!**
7
+
**BlueMap is currently in a BETA state!**
8
8
9
-
A lot of features are still missing, and some blocks - especially some tile-entities - will not render correctly/at all.
9
+
It is however already quite stable and usable. There are just some features still missing, and some blocks - especially tile-entities - will not render correctly/at all.
10
10
See below for a list of what is planned for future releases.
11
11
12
12
### Download
13
13
You can choose a version and download BlueMap from [here](https://github.com/BlueMap-Minecraft/BlueMap/releases).
14
14
15
15
### Using BlueMap
16
-
BlueMap can be used on the command-line, or as a plugin for your Sponge/Spigot/Paper-Server. Read the [wiki](https://github.com/BlueMap-Minecraft/BlueMap/wiki) to get started!
17
-
18
-
### Discord
19
-
If you have a question, help others using BlueMap or get the latest news and info you are welcome to join us [on Discord](https://discord.gg/zmkyJa3)!
16
+
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://github.com/BlueMap-Minecraft/BlueMap/wiki) to get started!
20
17
21
18
### Clone
22
19
If you have git installed, simply use the command `git clone --recursive https://github.com/BlueMap-Minecraft/BlueMap.git` to clone BlueMap.
@@ -32,17 +29,19 @@ You found a bug, have another issue or a suggestion? Please create an issue [her
32
29
You are welcome to contribute!
33
30
Just create a pull request with your changes :)
34
31
35
-
If you want to have your changes merged faster, make sure they are complete, documented and well tested!
32
+
**If you want to have your changes merged, make sure they are complete, documented and well tested!**
33
+
34
+
Keep in mind that we have to maintain all new features and keep supporting them in the future.
35
+
This means we always can decide to not accept a PR for any reason.
36
36
37
37
The `master`-branch is for the latest version of minecraft.
38
38
The `mc/xx`-branches are for other minecraft-versions.
39
-
Changes that apply to all versions should be made on the`mc/1.13`-branch. This branch can be merged into `master` and every other `mc/xx` branch.
39
+
**Changes that apply to all versions should be based on the**`base`**branch.** This branch can be merged into `master` and every other `mc/xx` branch.
40
40
41
41
### Todo / planned features
42
42
Here is a *(surely incomplete)* list of things that i want to include in future versions. *(They are not in any specific order. There is no guarantee that any of those things will ever be included.)*
43
43
44
44
- live player positions
45
-
- fabric version
46
45
- render more tile-entities (banners, shulker-chests, etc..)
47
46
- render entities (armor-stands, item-frames, maybe even cows and such..)
48
47
- free-flight-controls
@@ -51,3 +50,8 @@ Here is a *(surely incomplete)* list of things that i want to include in future
51
50
- ability to display the world-border
52
51
- animated textures (if feasible)
53
52
- add support for models in obj format (if feasible)
0 commit comments