Skip to content

Commit

Permalink
Version bump + documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
piegamesde authored and unknown committed Feb 8, 2020
1 parent 2a421ca commit 2194786
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 21 deletions.
Expand Up @@ -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.5.1" };
return new String[] { "1.6.0" };
// $REPLACE_END
}
}
31 changes: 22 additions & 9 deletions README.md
@@ -1,4 +1,4 @@
# BlockMap - A Minecraft 1.13/1.14 world viewer
# BlockMap A Minecraft 1.13-1.15 world viewer

[![Build Status](https://saibotk.de/buildstatus.php)]()

Expand All @@ -14,11 +14,10 @@
- An interactive GUI viewer made with JavaFX
- Pins on the map show additional information like players and villages
- Different color maps and shaders that highlight exactly what you are looking for (including an underground caves and an ocean ground view)
- A gui library to include maps into your own JavaFX applications (but not released yet)
- A command line interface to render your worlds from scripts
- The core rendering code as library to use in your own projects (releasing soon™)
- Gamma corrected rendering
- Works with both 1.13 and 1.14 worlds
- Works with both 1.13+ worlds (currently: 1.15)

## Gallery

Expand All @@ -41,7 +40,7 @@ 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-gui-1.5.0.jar
java -jar BlockMap-gui-1.6.0.jar

to start.

Expand All @@ -59,9 +58,9 @@ to start.
If you want to use BlockMap through the command line without,

# For general usage help
java -jar BlockMap-cli-1.5.0.jar help
java -jar BlockMap-cli-1.6.0.jar help
# For help about rendering worlds to a folder
java -jar BlockMap-cli-1.5.0.jar help render
java -jar BlockMap-cli-1.6.0.jar help render

will get you started. On Linux even with colors!

Expand All @@ -88,15 +87,28 @@ If this fails, try `./gradlew run2`\*. If you want to create a release jar and r

\* There is a bug in JavaFX that currently prevents the `run` task to work, so as a workaround use `./gradlew run2` for now.

## Release it:
## Update and Release BlockMap:

```sh
./gradlew regenerate
./gradlew generateScreenshots # Optional
./gradlew release
```
This will create two executable fat (=containing all needed dependencies) jars in `./BlockMap-{gui,cli}/build/libs/fat/`.

## Update to newer BlockMap version
- Bump the version in `build.gradle`
- Update `README.md`
- Bump the version information in file paths
- Bump the Minecraft version (if applicable)
- Check the feature list and read through it
- Update the `changelog.md`
- Regenerate all resources
- If something in the UI changed, regenerate the screenshots
- Generate the release binaries (need to be called on each target platform)
- This will create two executable fat (=containing all needed dependencies) jars in `./BlockMap-{gui,cli}/build/libs/fat/`.
- Release on GitHub
- Update all packaged versions (currently only AUR)

## Update to newer Minecraft version

- Update and start Minecraft. Create a new debug world. Copy it to `BlockMap/BlockMap-internal/src/test/resources`.
- Copy the current block color instructions in `BlockMap/BlockMap-internal/src/main/resources/` to match the new Minecraft version.
Expand All @@ -115,6 +127,7 @@ This will create two executable fat (=containing all needed dependencies) jars i
- Regenerate the screenshots
- Optimize the BlockMapWorld in Minecraft
- `./gradlew clear && ./gradlew regenerate && ./gradlew generateScreenshots`
- Release it 🎉

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Expand Up @@ -16,7 +16,7 @@ buildscript {
apply plugin: "com.github.ben-manes.versions"

allprojects {
version = '1.5.1'
version = '1.6.0'

repositories {
jcenter()
Expand Down
8 changes: 7 additions & 1 deletion changelog.md
@@ -1,8 +1,14 @@
# Changelog

## Version 1.6.1
## Version 1.6.0
### Changes
- Added proper caves view
- Renamed old cave view into X-ray view
- Performance optimizations
- Update for Minecraft 1.15
- Changed image filtering in HTML view (#32, thanks @rasmusolle)
- Fixed compiling under Java 13
- Internal changes and documentation

## Version 1.5.1
### Changes
Expand Down
9 changes: 0 additions & 9 deletions update.md

This file was deleted.

0 comments on commit 2194786

Please sign in to comment.