Documentation + Version bump

1.4.0

BlockMap-standalone/src/main/java/de/piegames/blockmap/standalone/VersionProvider.java

@@ -8,7 +8,7 @@ public class VersionProvider implements IVersionProvider {
 	public String[] getVersion() throws Exception {
 		/* This part of the code gets generated automatically through `gradle generateSources`. Do not modify! */
 		// $REPLACE_START
-		return new String[] { "1.3.0" };
+		return new String[] { "1.4.0" };
 		// $REPLACE_END
 	}
 }

BlockMap-standalone/src/main/resources/de/piegames/blockmap/guistandalone/about/aboutpane.fxml

@@ -25,7 +25,7 @@
 		<VBox>
 			<children>
 				<Label
-					text="BlockMap 1.3.0"
+					text="BlockMap 1.4.0"
 					id="about-title"
 					alignment="CENTER"
 					maxWidth="Infinity"

README.md

@@ -1,7 +1,9 @@
-# BlockMap - A Minecraft 1.13 world viewer
+# BlockMap - A Minecraft 1.13/1.14 world viewer
 
 [![Build Status](https://saibotk.de/buildstatus.php)]()
 
+<img src="BlockMap-standalone/src/main/resources/de/piegames/blockmap/guistandalone/icon.png" width=150/>
+
 *This started as fork of [TMCMR](https://github.com/TOGoS/TMCMR), but has been almost completely rewritten due to the update. If you want something stable that works with 1.12 and before worlds, go check it out.*
 
 ## Features:
@@ -32,16 +34,16 @@ Download the latest version from the [Release page](https://github.com/piegamesd
 
 The GUI version should just run by (double)clicking it. Otherwise run it through:
 
-    java -jar BlockMap-1.3.0.jar
+    java -jar BlockMap-1.4.0.jar
 
 to start. If you want to use BlockMap through the command line without GUI (not only for scripts),
 
     # For general usage help
-    java -jar BlockMap-1.3.0.jar help
+    java -jar BlockMap-1.4.0.jar help
     # For help about rendering worlds to a folder
-    java -jar BlockMap-1.3.0.jar help render
+    java -jar BlockMap-1.4.0.jar help render
     # For help about saving rendered worlds
-    java -jar BlockMap-1.3.0.jar render help save
+    java -jar BlockMap-1.4.0.jar render help save
 
 will get you started. On Linux even with colors!
 
@@ -75,6 +77,20 @@ All screenshots (see them below) are generated automatically through the gradle
 
 There is a bug in JavaFX that currently prevents the `run` task to work, so as a workaround use `./gradlew run2` for now.
 
+**Quick start:**
+
+    git clone https://github.com/Minecraft-Technik-Wiki/BlockMap
+    cd BlockMap
+    ./gradlew regenerate
+    ./gradlew run2
+
+## Troubleshooting
+
+If you cannot start the GUI and you get errors similar to
+
+    java.lang.IllegalAccessError: superclass access check failed: class impl.org.controlsfx.behavior.RangeSliderBehavior (in unnamed module @0xa1d113b) cannot access class com.sun.javafx.scene.control.behavior.BehaviorBase (in module javafx.controls) because module javafx.controls does not export com.sun.javafx.scene.control.behavior to unnamed module @0xa1d113b
+please try the *Quick start* section above. This is a known JavaFX bug, please try the workaround before reporting.
+
 ## Gallery
 
 ![Four rendered region files, each with one with a different color map](screenshots/screenshot-1.png "All existing color maps")

build.gradle

@@ -16,7 +16,7 @@ buildscript {
 apply plugin: "com.github.ben-manes.versions"
 
 allprojects {
-	version = '1.3.0'
+	version = '1.4.0'
 
 	repositories {
 		jcenter()

changelog.md

@@ -1,7 +1,29 @@
 # Changelog
 
-## Version 1.3.0
+## Version 1.4.0
 ## Changes
+- Updated to 1.14
+	- 1.13 worlds and chunks still work
+	- 1.14 villages are recognized
+	- New biome colors and other details are still missing (help appreciated!)
+- Improved GUI
+	- Minor pin improvements
+	- Added "about" dialog
+	- Keyboard shortcuts
+	- Splash screen
+	- Improved startup performance
+	- Everything is cached now, so it should be a lot faster
+- New world save format and command line options
+- Bug fixes
+- New bugs
+
+## Backwards-compatibility
+The save format and command line have changed, and it is not backwards-compatible to BlockMap 1.3.0.
+If you use BlockMap on a server, you'll need to update the server script and older clients won't be able
+to open the worlds anymore.
+
+## Version 1.3.0
+### Changes
 - Added Pins
 	- They contain information about the world and the render process (did it fail?)
 	- Save them together with your rendered world