mirror of
https://github.com/BlueMap-Minecraft/BlueMap.git
synced 2024-11-26 04:25:31 +01:00
Merge branch 'base' into feature/live
This commit is contained in:
commit
96a1145a14
8
.github/workflows/gradle.yml
vendored
8
.github/workflows/gradle.yml
vendored
@ -1,6 +1,12 @@
|
||||
name: Java CI
|
||||
|
||||
on: [push]
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- mc/1.12
|
||||
- mc/1.13
|
||||
- mc/1.15
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
@ -21,7 +21,7 @@ dependencies {
|
||||
}
|
||||
|
||||
build.dependsOn shadowJar {
|
||||
destinationDir = file '../build/release'
|
||||
destinationDir = file '../build/unsupported'
|
||||
archiveFileName = "BlueMap-${version}-bukkit.jar"
|
||||
|
||||
//relocate 'com.flowpowered.math', 'de.bluecolored.shadow.flowpowered.math' //DON'T relocate this, because the API depends on it
|
||||
|
@ -33,7 +33,7 @@ dependencies {
|
||||
}
|
||||
|
||||
build.dependsOn shadowJar {
|
||||
destinationDir = file '../build/release'
|
||||
destinationDir = file '../build/unsupported'
|
||||
archiveFileName = "BlueMap-${version}-forge.jar"
|
||||
|
||||
configurations = [project.configurations.include]
|
||||
|
24
README.md
24
README.md
@ -2,21 +2,18 @@
|
||||
|
||||
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 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.
|
||||
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.
|
||||
|
||||
**BlueMap is currently in an early development state!**
|
||||
**BlueMap is currently in a BETA state!**
|
||||
|
||||
A lot of features are still missing, and some blocks - especially some tile-entities - will not render correctly/at all.
|
||||
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.
|
||||
See below for a list of what is planned for future releases.
|
||||
|
||||
### 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 for your Sponge/Spigot/Paper-Server. Read the [wiki](https://github.com/BlueMap-Minecraft/BlueMap/wiki) to get started!
|
||||
|
||||
### Discord
|
||||
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)!
|
||||
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!
|
||||
|
||||
### Clone
|
||||
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
|
||||
You are welcome to contribute!
|
||||
Just create a pull request with your changes :)
|
||||
|
||||
If you want to have your changes merged faster, make sure they are complete, documented and well tested!
|
||||
**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.
|
||||
|
||||
The `master`-branch is for the latest version of minecraft.
|
||||
The `mc/xx`-branches are for other minecraft-versions.
|
||||
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.
|
||||
**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.
|
||||
|
||||
### Todo / planned features
|
||||
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.)*
|
||||
|
||||
- live player positions
|
||||
- fabric version
|
||||
- render more tile-entities (banners, shulker-chests, etc..)
|
||||
- render entities (armor-stands, item-frames, maybe even cows and such..)
|
||||
- free-flight-controls
|
||||
@ -51,3 +50,8 @@ Here is a *(surely incomplete)* list of things that i want to include in future
|
||||
- ability to display the world-border
|
||||
- animated textures (if feasible)
|
||||
- add support for models in obj format (if feasible)
|
||||
|
||||
### Links
|
||||
**Wiki:** https://bluecolo.red/map-wiki <br>
|
||||
**Reddit:** https://www.reddit.com/r/BlueMap <br>
|
||||
**Discord:** https://bluecolo.red/map-discord <br>
|
||||
|
Loading…
Reference in New Issue
Block a user