JETRIS Version 1.2

- Add Launch4J configuration and a new Gradle taks launch4j for generating an Windows exe file
- Use a Gradle plugin to create MAC OS X app package and a dmg file
- Remove the publish HiScores functionality, as it did not work
- Remove the webapp source folder, since there is no web page anymore
- Small code improvements
- Update Gradle wrapper to version 2.5
- Update the documentation

Author: devng

CHANGES.md

@@ -1,9 +1,13 @@
-2015-08-06
+2015-08-07
 ----------
 * JETRIS Version 1.2
-* Add Launch4J configuration
+* Add Launch4J configuration and a new Gradle taks launch4j for generating an Windows exe file
+* Use a Gradle plugin to create MAC OS X app package and a dmg file
 * Remove the publish HiScores functionality, as it did not work
 * Remove the webapp source folder, since there is no web page anymore
+* Small code improvements
+* Update Gradle wrapper to version 2.5
+* Update the documentation
 
 2015-08-05
 ----------

JETRIS

@@ -1,4 +1,4 @@
 #!/bin/sh
 
-java -jar build/libs/jetris.jar
+java -jar build/libs/jetris-1.2.jar -Xdock:name="JETRIS"
 

JETRIS.DAT

@@ -1,4 +1,4 @@
 rem Batch file to run JETRIS on Windows
 
-start javaw -jar build\libs\JETRIS.jar
+start javaw -jar build\libs\jetris-1.2.jar
 

JETRIS.bat

@@ -1,15 +1,18 @@
-# Jetris - A Java-Based Tetris Clone
+# JETRIS - A Java-Based Tetris Clone
 
 ## TL;DR
 
-Jetris is a Java-based Tetris clone for the desktop. Jetris is focused on a fast gaming, so a game usually takes about 10 min.
+JETRIS is a Java-based Tetris clone for the desktop. JETRIS is focused on a fast gaming, so a game usually takes about 10 min.
 
 ![](screenshot.png?raw=true)
 
 ### This Readme includes:
 
 1. System Requirements
 2. How to Build JETRIS
+  * How to build an Windows EXE
+  * How to build a Mac OS APP and DMG
+  * How to extend JETRIS
 3. Running JETRIS on Your System
 4. How to Play
 5. Scoring System
@@ -20,11 +23,11 @@ Jetris is a Java-based Tetris clone for the desktop. Jetris is focused on a fast
 
 JETRIS is written in the JAVA programming language, this means that it can be run on any Operating System which has JAVA Runtime Environment (JRE).
 
-You need JRE 1.6.0 or above. You can download JRE for free at www.java.com
+You need JRE 1.7.0 or above. You can download JRE for free at www.java.com
 
 2. How to Build JETRIS
 ----------------------
-If you want to build JETRIS on your local machine you need to install the Java Development Kit (JDK). You need JDK 1.6.0 or above.
+If you want to build JETRIS on your local machine you need to install the Java Development Kit (JDK). You need JDK 1.7.0 or above.
 
 JETRIS uses the Gradle build system, you can build the project locally just by typing the following in the console:
 
@@ -37,20 +40,53 @@ On Windows use:
 ./gradlew.bat build
 ```
 
-The generated jar file can be found in the folder _build/libs_
+The generated jar file can be found in the folder _build/libs_.
+
+### How to build an Windows EXE
+The Gradle build script provides a way to build an Windows executable. You can even do this on a non-Windows machine. For that purpose you need an external application called
+[Launch4j](http://launch4j.sourceforge.net/). Download it and install it on your local machine. The version used to test this feature is 3.8, but it will probably work with
+other versions too. In addition to this, you need to create an environment variable called `LAUNCH4J_HOME` which points to the folder where you have installed the application.
+
+After that you can build the exe file by running:
+```
+./gradlew launch4j
+```
+
+The generated exe file can be found in the folder _build/launch4j_.
+
+### How to build a Mac OS APP and DMG
+The JETRIS Gradle build script uses [MacAppBundle Plugin](https://github.com/crotwell/gradle-macappbundle) to generate Mac OS X app packages _and_ a _dmg_ distribution file.
+This is done automatically with each Gradle build.
+
+The generated app package can be found in the folder _build/macApp_ and the dmg file in _build/distributions_.
+
+### How to extend JETRIS
+If you want to import the project in an IDE such as Eclipse or IntelliJ IDEA then Gradle provides a way to generate all the necessary project files.
+
+Generate Eclipse project:
+```
+./gradlew eclipse
+```
+
+Generate IntelliJ IDEA project:
+```
+./gradlew idea
+```
 
 3. Running JETRIS on Your System
 --------------------------------
 
 To start JETRIS try one of the following options: 
 
-* Double click on the JAR File to start JETRIS. If this didn't work, then you didn't associate your JAR Files with your JRE. 
+* Double click on the JAR File to start JETRIS. If this didn't work, then you didn't associate your JAR Files with your JRE.
+
+* For Windows users we also provide an exe file, which ist just a wrapper for the JAR file. Double click on the exe file to start the application.
 
-* Double click on JETRIS.bat for Windows users or on JETRIS for Linux/OS X users.
+* Double click on `JETRIS.bat` for Windows users or on `JETRIS` for Linux users. This will start the application, but only if you have built it with Gradle first.
 
 * Open the console go to your JETRIS folder and type: 
 ```
-java -jar JETRIS.jar
+java -jar jetris-1.2.jar
 ```
 
 4. How to Play
@@ -83,4 +119,4 @@ The current level is 20 (the highest level) and You clear 4 Lines at once, then
 6. Saving Your Old HiScores
 ---------------------------
 
-Copy the old JETRIS.dat File to your new version of Jetris folder. 
+Copy the old `JETRIS.DAT` File to your new version of JETRIS folder.

README.md

@@ -1,36 +1,58 @@
-apply plugin: 'java'
-apply plugin: 'eclipse'
-apply plugin: 'idea'
+plugins {
+    id 'java'
+    id "edu.sc.seis.macAppBundle" version "2.1.1"
+    id 'eclipse'
+    id 'idea'
+}
 
 task wrapper(type: Wrapper) {
-	gradleVersion = '2.4.0'
+	gradleVersion = '2.5'
 }
 
-// Keep this in sync with JetrisMainFrame.NAME
+// Keep this in sync with GV.VERSION
 version='1.2'
 
-repositories { 
-	mavenCentral() 
-}
-
 sourceCompatibility = 1.7
 targetCompatibility = 1.7
 
 jar {
     manifest {
-        attributes 'Main-Class': 'JetrisMain'
+        attributes 'Implementation-Title': 'JETRIS',
+                'Implementation-Version': version,
+                'Main-Class': "JetrisMain"
     }
 }
 
-// Windows wrapper configuration to generate "jetris.exe" //
+macAppBundle {
+    mainClassName = "JetrisMain"
+    icon = "src/main/resources/osx/jetris.icns"
+    bundleJRE = false
+    javaProperties.put("apple.laf.useScreenMenuBar", "true")
+}
+
+// Windows wrapper configuration to generate "jetris.exe"
 task launch4jConfig(type: Copy) {
-    from 'src/main/resources/launch4j.xml'
+    from 'src/main/resources/launch4j/launch4j.xml'
     into 'build/launch4j'
     expand(
             JAR_FILE: project.jar.archivePath,
             VERSION: project.version,
-            ICON: file('src/main/resources/jetris.ico')
+            ICON: file('src/main/resources/launch4j/jetris.ico')
     )
 }
 
-build.dependsOn 'launch4jConfig'
+task launch4j(type: Exec, dependsOn: [':jar', ':launch4jConfig']) {
+    def launch4jCfg = file('build/launch4j/launch4j.xml')
+    def isWindows = System.properties['os.name'].startsWith('Windows')
+    def launch4jDir = System.getenv('LAUNCH4J_HOME')
+
+    if (launch4jDir == null || !(new File(launch4jDir).exists())) {
+        throw new GradleException("'LAUNCH4J_HOME' not defined or invalid. Launch4j (http://launch4j.sourceforge.net) is required to generare the JETRIS Windows EXE file.")
+    }
+
+    if (isWindows) {
+        commandLine 'cmd', '/c', launch4jDir + "/launch4j.exe", launch4jCfg
+    } else {
+        commandLine launch4jDir + "/launch4j", launch4jCfg
+    }
+}

build.gradle

@@ -1,6 +1,6 @@
-#Mon Aug 03 08:24:05 CEST 2015
+#Fri Aug 07 05:42:51 CEST 2015
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-2.4-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-2.5-bin.zip

gradle/wrapper/gradle-wrapper.properties

@@ -162,4 +162,3 @@ eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
 JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
 
 exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
-

gradlew

@@ -88,4 +88,3 @@ exit /b 1
 if "%OS%"=="Windows_NT" endlocal
 
 :omega
-

gradlew.bat

@@ -0,0 +1 @@
+rootProject.name = 'JETRIS'