BlueMap/README.md

![title-banner](https://bluecolored.de/paste/BluemapBanner.png)

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.

**BlueMap is currently in an early development state!**

A lot of features are still missing, and some blocks - especially some 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)!

### 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 / Suggestions
You found a bug, have another issue or a suggestion? Please create an issue [here](https://github.com/BlueMap-Minecraft/BlueMap/issues)!

### Contributing
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!

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.

### 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
- more configurations
- easier mod-integration
- ability to display the world-border
- animated textures (if feasible)
- add support for models in obj format (if feasible)
Update readme 2020-03-17 20:26:48 +01:00			`![title-banner](https://bluecolored.de/paste/BluemapBanner.png)`
Initial commit: Merging Projects BlueMapCore, BlueMapCLI and BlueMapSponge into one 2019-11-02 17:23:48 +01:00
Fix a few issues with building on windows 2020-01-14 23:38:03 +01:00			`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).`
Initial commit: Merging Projects BlueMapCore, BlueMapCLI and BlueMapSponge into one 2019-11-02 17:23:48 +01:00
Update readme 2020-02-09 17:22:28 +01:00			`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.`
Update README.md 2020-01-03 13:08:59 +01:00
Update readme 2020-02-09 17:22:28 +01:00			`BlueMap is currently in an early development state!`
Update README.md 2020-01-03 13:08:59 +01:00
Update readme 2020-02-09 17:22:28 +01:00			`A lot of features are still missing, and some blocks - especially some tile-entities - will not render correctly/at all.`
Update README.md 2020-01-03 13:08:59 +01:00			`See below for a list of what is planned for future releases.`

Update readme 2020-02-09 17:22:28 +01:00			`### 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!`
Initial commit: Merging Projects BlueMapCore, BlueMapCLI and BlueMapSponge into one 2019-11-02 17:23:48 +01:00
Update readme 2020-02-09 17:22:28 +01:00			`### 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)!`

			`### Clone`
Add BlueMapAPI submodule 2020-04-09 22:15:08 +02:00			If you have git installed, simply use the command `git clone --recursive https://github.com/BlueMap-Minecraft/BlueMap.git` to clone BlueMap.
Initial commit: Merging Projects BlueMapCore, BlueMapCLI and BlueMapSponge into one 2019-11-02 17:23:48 +01:00
Update README.md 2020-01-03 13:08:59 +01:00			`### Build`
Correct build setups for Sponge and Bukkit implementations 2020-04-06 16:54:11 +02:00			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`.
Initial commit: Merging Projects BlueMapCore, BlueMapCLI and BlueMapSponge into one 2019-11-02 17:23:48 +01:00
Update README.md 2020-01-03 13:08:59 +01:00			`### Issues / Suggestions`
			`You found a bug, have another issue or a suggestion? Please create an issue [here](https://github.com/BlueMap-Minecraft/BlueMap/issues)!`

			`### Contributing`
Fix a few issues with building on windows 2020-01-14 23:38:03 +01:00			`You are welcome to contribute!`
Initial commit: Merging Projects BlueMapCore, BlueMapCLI and BlueMapSponge into one 2019-11-02 17:23:48 +01:00			`Just create a pull request with your changes :)`
Update README.md 2020-01-03 13:08:59 +01:00
Add important branch descriptions for contributions 2020-07-29 10:49:00 +02:00			`If you want to have your changes merged faster, make sure they are complete, documented and well tested!`

			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.

Update readme 2020-02-09 17:22:28 +01:00			`### Todo / planned features`
Fix some possible errors if blocks dont contain expected properties 2020-01-07 14:27:48 +01:00			`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.)`
Update README.md 2020-01-03 13:08:59 +01:00
Update README 2020-05-11 22:13:46 +02:00			`- live player positions`
			`- fabric version`
Update readme 2020-02-09 17:22:28 +01:00			`- render more tile-entities (banners, shulker-chests, etc..)`
			`- render entities (armor-stands, item-frames, maybe even cows and such..)`
Update README.md 2020-01-03 13:08:59 +01:00			`- free-flight-controls`
			`- more configurations`
Update readme 2020-02-09 17:22:28 +01:00			`- easier mod-integration`
Update README.md 2020-01-03 13:08:59 +01:00			`- ability to display the world-border`
Update readme 2020-02-09 17:22:28 +01:00			`- animated textures (if feasible)`
Update readme 2020-03-17 20:26:48 +01:00			`- add support for models in obj format (if feasible)`