Merge branch 'master' into bleeding

Author: TBlueF

.github/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# How to contribute
+
+You want help me make BlueMap better? Awesome!<br>
+Here you learn how it works and what you need to know before contributing.
+
+>**Please read this before creating an Issue or a PullRequest!** Issues/PR's that don't follow these instructions will be closed!<br>
+>**Issues are NOT for asking questions!** If you have a question, please use our [Discord](https://discord.gg/zmkyJa3) or [Reddit](https://www.reddit.com/r/BlueMap/)!
+
+### Table of Contents
+- [Reporting a Bug](#reporting-a-bug)
+- [Suggesting a new feature or change](#suggesting-a-new-feature-or-change)
+- [Creating a Pull-Request](#creating-a-pull-request)
+
+## Reporting a Bug
+The first thing you need to do, is to make sure what you found is actually a bug:<br>
+- A bug is an unintended behaviour of an implemented feature.
+BlueMap is not "done", there are quite a lot of features missing!
+So, if something doesn't work because it is not implemented yet, its not a bug.
+If you are not sure, you can briefly ask about it in our [Discord](https://discord.gg/zmkyJa3) before creating an Issue. :)
+- Make sure you tested it well enough to be sure it's not an issue on your end. If something doesn't work for you but for everyone else, its probably **not** a bug!
+
+Also, please make sure noone else has already reported the same or a very similar bug!
+If you have additional information for an existing bug-report, you can add a comment to the already existing Issue :)
+
+To report your bug, please open a [new Issue](https://github.com/BlueMap-Minecraft/BlueMap/issues/new?template=bug_report.md) with the `Bug report`-template and follow these guidlines:
+
+### Guidlines for a good Bug-Issue
+**A short, informative Title**<br>
+Your Issue should have a short but informative title, which makes it possible to distinquish it from- and easily recognize it in-between- other Issues.
+If someone else finds the same bug, they should be able to find your Issue only based on the title!
+
+**A detailed description**<br>
+Describe your bug in as much detail as possible:
+- What did you do before it happened? (How can the bug be reproduced?)
+- What did you expect to happen?
+- What happened instead?
+- CONTEXT!!
+  - The exact BlueMap-Version (e.g. the name of the used .jar file)
+  - The used os and platform (Windows/Linux, Spigot/Paper/Forge/Fabric/Sponge)
+  - Has the world been generated using any minecraft-mods?
+  - etc..
+- Is there a log- or a config-file that might help? Include it.
+- Maybe add a screenshot or video for illustration.
+
+**Well formatted and structured**<br>
+Make sure your Issue is easy to read and not a mess:
+- Use paragraphs to structure your issue.
+- Use [Markdown](https://guides.github.com/features/mastering-markdown/) to add headings and formatting.
+- Use codeblocks for log-snippets.
+- Upload full logs as file-attachments or use a paste-site like [GitHub Gists](https://gist.github.com/) or [Pastebin](https://pastebin.com/).
+
+**One Issue, one bug**<br>
+Create a separate Issue for each bug you find! Issues that contain more than one bug will be closed!
+
+## Suggesting a new feature or change
+**(Todo)**
+
+## Creating a Pull-Request
+**(Todo)**

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,19 +1,36 @@
 ---
 name: Bug report
-about: Found a bug? Report it to help BlueMap improve!
+about: 'Use this if you want to report a bug!'
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
-**BlueMap Version:**
-*Full version including the target, e.g. `1.0.0-fabric-1.16.1`*
+<!-- 
+Make sure you read the Contribution-Guidelines (https://github.com/BlueMap-Minecraft/BlueMap/blob/master/.github/CONTRIBUTING.md) before submitting your Bug-Report!
+Issues that don't follow these Guidelines will likely be closed!
+-->
+
+### What i did / Steps to reproduce
+<!-- What did you do before it happened? (How can the bug be reproduced?) -->
+
+### Expected result
+<!-- What did you expect to happen? -->
+
+### Actual result
+<!-- What happened instead? -->
+
+### Context
+**BlueMap Version:** <!-- Full BlueMap-version including the target, for example: --> 
+`1.0.0-fabric-1.16.1`
 
-I am using:
-- [ ] mods (on the rendered world)
-- [ ] resourcepacks (in bluemaps `config/resourcepack` folder)
+<!-- 
+Add more context here!
+- The used os and platform (Windows/Linux, Spigot/Paper/Forge/Fabric/Sponge)
+- Has the world been generated using any minecraft-mods?
+etc..
 
-**Description:**
-*Describe the bug in full detail, including a way to reproduce it.
-Sometimes a full log of your server-startup or a crash-report can be of much help!*
+Also:
+- Is there a log- or a config-file that might help? Include it.
+- Maybe add a screenshot or video for illustration.
+-->

BlueMapCore/src/main/java/de/bluecolored/bluemap/core/MinecraftVersion.java

@@ -33,6 +33,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+@DebugDump
 public class MinecraftVersion implements Comparable<MinecraftVersion> {
 
 	private static final Pattern VERSION_REGEX = Pattern.compile("(?:(?<major>\\d+)\\.(?<minor>\\d+))(?:\\.(?<patch>\\d+))?(?:\\-(?:pre|rc)\\d+)?");
@@ -41,10 +42,8 @@ public class MinecraftVersion implements Comparable<MinecraftVersion> {
 	public static final MinecraftVersion EARLIEST_SUPPORTED = new MinecraftVersion(1, 12, 2);
 	public static final MinecraftVersion THE_FLATTENING = new MinecraftVersion(1, 13);
 
-	@DebugDump
 	private final int major, minor, patch;
 
-	@DebugDump
 	private final Lazy<MinecraftResource> resource;
 
 	public MinecraftVersion(int major, int minor) {
@@ -142,6 +141,7 @@ public static MinecraftVersion of(String versionString) {
 		return new MinecraftVersion(major, minor, patch);
 	}
 
+	@DebugDump
 	public enum MinecraftResource {
 
 		MC_1_12 (new MinecraftVersion(1, 12), "mc1_12", "https://launcher.mojang.com/v1/objects/0f275bc1547d01fa5f56ba34bdc87d981ee12daf/client.jar"),
@@ -152,9 +152,9 @@ public enum MinecraftResource {
 		MC_1_16_2 (new MinecraftVersion(1, 16, 2), "mc1_16", "https://launcher.mojang.com/v1/objects/653e97a2d1d76f87653f02242d243cdee48a5144/client.jar"),
 		MC_1_17 (new MinecraftVersion(1, 17), "mc1_16", "https://launcher.mojang.com/v1/objects/1cf89c77ed5e72401b869f66410934804f3d6f52/client.jar");
 
-		@DebugDump private final MinecraftVersion version;
-		@DebugDump private final String resourcePrefix;
-		@DebugDump private final String clientUrl;
+		private final MinecraftVersion version;
+		private final String resourcePrefix;
+		private final String clientUrl;
 
 		MinecraftResource(MinecraftVersion version, String resourcePrefix, String clientUrl) {
 			this.version = version;

BlueMapCore/src/main/java/de/bluecolored/bluemap/core/config/CoreConfig.java

@@ -30,14 +30,14 @@
 import java.io.File;
 import java.io.IOException;
 
+@DebugDump
 public class CoreConfig {
 
-	@DebugDump private boolean downloadAccepted = false;
-	@DebugDump private int renderThreadCount = 0;
-	@DebugDump private boolean metricsEnabled = false;
-	@DebugDump private File dataFolder = new File("data");
-	
-	
+	private boolean downloadAccepted = false;
+	private int renderThreadCount = 0;
+	private boolean metricsEnabled = false;
+	private File dataFolder = new File("data");
+
 	public CoreConfig(ConfigurationNode node) throws IOException {
 
 		//accept-download

BlueMapCore/src/main/java/de/bluecolored/bluemap/core/map/BmMap.java

@@ -182,5 +182,15 @@ public boolean equals(Object obj) {
 
 		return false;
 	}
-	
+
+	@Override
+	public String toString() {
+		return "BmMap{" +
+			   "id='" + id + '\'' +
+			   ", name='" + name + '\'' +
+			   ", world=" + world +
+			   ", fileRoot=" + fileRoot +
+			   '}';
+	}
+
 }

BlueMapCore/src/main/java/de/bluecolored/bluemap/core/mca/MCAWorld.java

@@ -422,5 +422,14 @@ public static Vector2i blockToChunk(Vector3i pos) {
 				pos.getZ() >> 4
 			);
 	}
-	
+
+	@Override
+	public String toString() {
+		return "MCAWorld{" +
+			   "uuid=" + uuid +
+			   ", worldFolder=" + worldFolder +
+			   ", name='" + name + '\'' +
+			   '}';
+	}
+
 }

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.jvmargs=-Xmx3G
 org.gradle.daemon=false
 
-coreVersion=1.5.4
+coreVersion=1.5.5