diff --git a/README.md b/README.md index ea0b448..dac2c63 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,57 @@ seems he uses LiveSplit now (?). Regardless, here I will be extending the original application as best I can by adding some missing features here and there and fixing bugs as needed. +## Download + +Check the [releases page](https://github.com/gered/Llanfair/releases) for downloadable JARs. + +JARs can be run from the command line via something similar to: + +``` +$ java -jar Llanfair.jar +``` + +## Changes + +### 1.5 +Changes from v1.4.3 (the last official release). Note that a couple of these changes were actually by +Xunkar himself as he did some work post-1.4.3 that he just never released. + +* If the JNativeHook event hook registration fails the app will display an error prompt instead of failing + silently. Additionally on some OS's you may see your OS prompt you with some kind of accessibility permissions + request (note that in either case, you will have to restart Llanfair for the permissions change to take effect). +* XML formats for both app config and saved runs. Some backwards compatibility for opening the old binary versions. +* Config and runs are now saved by default under `$user_home/.llanfair/`. +* Runs are now saved with a default `.lfs` file extension. +* Support for a delayed/negative run start time. Useful if you want to start the run at a time more convenient for you + but before any of the segments should start (e.g. to skip initial loading, fadeouts, etc) +* Attempt counter (both number of total attempts and number of completed attempts). +* Additional font customization settings. +* Coloring of split time deltas using slightly different color shades based on if you're gaining/losing time while + already ahead/behind. +* Other very minor bug fixes. + +**NOTE**: I've temporarily disabled localization support. Some of the strings used were out of sync between English +and the other languages and I ended up adding new English strings too. I only speak English and so have no way to +update the other language translations. It seemed wrong to include an option in the app to switch languages when the +other language text was "bad", so it will remain disabled until these translations are brought up to date again. + ## Building and Running -You will need Gradle. The Gradle `application` plugin is being used, so you can run Llanfair simply by doing: +You will need Gradle. Obviously any IDE with Gradle support will simply mean you can just open this project +right away in your IDE and get developing immediately. Easy. + +Llanfair currently requires Java 7. + +#### Command Line Building / Running / Distribution + +To build: + +``` +$ gradle build +``` + +The Gradle `application` plugin is being used, so you can run Llanfair simply by doing: ``` $ gradle run @@ -26,21 +74,20 @@ To package up a JAR file for redistribution, run: $ gradle shadowJar ``` -Which will spit out an "uber JAR" under `build/libs` under the naming convention `llanfair-[VERSION]-all.jar`. +Which will spit out an "uber JAR" under `build/libs` under the naming convention `llanfair-[VERSION]-all.jar`. This +JAR will of course work on any OS. -## Mac OS X and Accessibility Settings for Global Hotkeys +To build a redistributable Mac app bundle (.app): -Previous releases of Llanfair used an older version of JNativeHook which didn't really provide any built-in help -if OS X was not properly configured in advance when Llanfair tried to hook into global key events. This version -uses a more recent version that pops up a dialog telling you what to do if Llanfair does not yet have the required -accessibility permissions, so you should not get the problem where Llanfair mysteriously closes immediately after -running. +``` +$ gradle createApp +``` -Note that currently Llanfair **only** supports hotkeys via the JNativeHook / global hotkey interface! If it was not -able to hook into the OS's key events (either because you denied proper permissions or for some other reason), then -you will not be able to set any hotkeys in the settings window and you will thusly not be able to trigger any splits or -start/stop any runs! This is one of the first things I intend to address. +Which will create an app bundle under `build/macApp`. ## TODO -Lots of stuff still to be done. :) +* Bug fixing +* Some UI cleanups, especially in the Edit Run dialog and Settings dialog. +* Even more font/color customization options? +* ...