Add jpackageZip and Github actions for publishing binaries

Added orx-shapes

.github/workflows/build-on-commit.yaml

@@ -0,0 +1,15 @@
+name: Build on commit
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-java@v1
+        with:
+          java-version: 14
+      - name: Build sources
+        run: ./gradlew build

.github/workflows/publish-binaries-linux-x64.yaml

@@ -0,0 +1,30 @@
+name: Publish Linux/x64 binaries
+
+on:
+  push:
+    tags:
+      - v0.*
+      - v0.*.*
+      - v1.*
+      - v1.*.*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 14
+        uses: actions/setup-java@v1
+        with:
+          java-version: 14
+      - name: Build with Gradle
+        run: ./gradlew jpackageZip
+      - name: Create Release
+        uses: ncipollo/release-action@v1.6.1
+        id: create_release
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          allowUpdates: true
+          replaceArtifacts: false
+          body: Fully automated release
+          artifacts: "./build/distributions/openrndr-application-linux-x64.zip"

.github/workflows/publish-binaries-macos.yaml

@@ -0,0 +1,30 @@
+name: Publish macOS binaries
+
+on:
+  push:
+    tags:
+      - v0.*
+      - v0.*.*
+      - v1.*
+      - v1.*.*
+
+jobs:
+  build:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 14
+        uses: actions/setup-java@v1
+        with:
+          java-version: 14
+      - name: Build with Gradle
+        run: ./gradlew jpackageZip
+      - name: Create Release
+        uses: ncipollo/release-action@v1.6.1
+        id: create_release
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          allowUpdates: true
+          replaceArtifacts: false
+          body: Fully automated release
+          artifacts: "./build/distributions/openrndr-application-macos.zip"

.github/workflows/publish-binaries-windows.yaml

@@ -0,0 +1,30 @@
+name: Publish Windows binaries
+
+on:
+  push:
+    tags:
+      - v0.*
+      - v0.*.*
+      - v1.*
+      - v1.*.*
+      -
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 14
+        uses: actions/setup-java@v1
+        with:
+          java-version: 14
+      - name: Build with Gradle
+        run: ./gradlew jpackageZip
+      - name: Create Release
+        uses: ncipollo/release-action@v1.6.1
+        id: create_release
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          allowUpdates: true
+          replaceArtifacts: false
+          body: Fully automated release
+          artifacts: "./build/distributions/openrndr-application-windows.zip"

README.md

@@ -1,12 +1,24 @@
-# openrndr-template
+# OPENRNDR template project
 A feature rich template for creating OPENRNDR programs based on Gradle/Kts
 
-You will find some [basic instructions](https://guide.openrndr.org/#/02_Getting_Started_with_OPENRNDR/C00_SetupYourFirstProgram) in the [OPENRNDR guide](https://guide.openrndr.org)
-
 The template consists of a configuration for Gradle and an example OPENRNDR program. The Gradle configuration should serve as the
 go-to starting point for writing OPENRNDR-based software.
 
+If you are looking at this from IntelliJ IDEA you can start by expanding the _project_ tab on the left. You will find a template program in `src/main/kotlin/TemplateProgram.kt`
+
+You will find some [basic instructions](https://guide.openrndr.org/#/02_Getting_Started_with_OPENRNDR/C00_SetupYourFirstProgram) in the [OPENRNDR guide](https://guide.openrndr.org)
+
 ## Gradle tasks
  - `run` runs the TemplateProgram
  - `jar` creates an executable platform specific jar file with all dependencies
  - `zipDistribution` creates a zip file containing the application jar and the data folder
+ - `jpackageZip` creates a zip with a stand-alone executable for the current platform (works with Java 14 only)
+
+## Cross builds
+To create runnable jars for a platform different from the platform you use to build one uses `./gradlew jar --PtargetPlatform=<platform>`. The supported platforms are `windows`, `macos`, `linux-x64` and `linux-arm64`. Note that the `linux-arm64` platform will only work with OPENRNDR snapshot builds from master and OPENRNDR 0.3.39 (a future version).
+
+## Github Actions
+
+This repository contains a number of Github Actions in `./github/workflows`. 
+The actions enable a basic build run on commit, plus publication actions that are executed when
+a commit is tagged with a version number like `v0.*` or `v1.*`.

build.gradle.kts

@@ -1,53 +1,105 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import org.gradle.internal.os.OperatingSystem
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import org.gradle.nativeplatform.platform.internal.DefaultNativePlatform
 
+/* the name of this project, default is the template version but you are free to change these */
 group = "org.openrndr.template"
-version = "0.3.8"
+version = "0.3.12"
+
 val applicationMainClass = "TemplateProgramKt"
 
-val openrndrUseSnapshot = false
-val openrndrVersion = if (openrndrUseSnapshot) "0.4.0-SNAPSHOT" else "0.3.37"
+/*  Which additional (ORX) libraries should be added to this project. */
+val orxFeatures = setOf(
+//  "orx-camera",
+    "orx-compositor",
+//  "orx-easing",
+//  "orx-file-watcher",
+//  "orx-parameters",
+//  "orx-filter-extension",
+    "orx-fx",
+//  "orx-glslify",
+//  "orx-gradient-descent",
+//  "orx-integral-image",
+//  "orx-interval-tree",
+//  "orx-jumpflood",
+    "orx-gui",
+    "orx-image-fit",
+//  "orx-kdtree",
+//  "orx-mesh-generators",
+//  "orx-midi",
+//  "orx-no-clear",
+    "orx-noise",
+//  "orx-obj-loader",
+    "orx-olive",
+//  "orx-osc",
+//  "orx-palette",
+//  "orx-poisson-fill",
+//  "orx-runway",
+//  "orx-shader-phrases",
+    "orx-shade-styles",
+//  "orx-shapes",
+//  "orx-syphon",
+//  "orx-temporal-blur",
+//  "orx-kinect-v1",
+    "orx-panel"
+)
 
-val panelUseSnapshot = false
-val panelVersion = if (panelUseSnapshot) "0.4.0-SNAPSHOT" else "0.3.19"
+/* Which OPENRNDR libraries should be added to this project? */
+val openrndrFeatures = setOf(
+    "video"
+)
+
+/*  Which version of OPENRNDR and ORX should be used? */
+val openrndrUseSnapshot = false
+val openrndrVersion = if (openrndrUseSnapshot) "0.4.0-SNAPSHOT" else "0.3.42"
 
 val orxUseSnapshot = false
-val orxVersion = if (orxUseSnapshot) "0.4.0-SNAPSHOT" else "0.3.44"
+val orxVersion = if (orxUseSnapshot) "0.4.0-SNAPSHOT" else "0.3.51"
 
-// supported features are: orx-camera, orx-compositor,orx-easing, orx-filter-extension,orx-file-watcher, orx-fx
-// orx-integral-image, orx-interval-tree, orx-jumpflood, orx-kdtree, orx-mesh-generators,orx-midi, orx-no-clear,
-// orx-noise, orx-obj, orx-olive, orx-osc, orx-palette, orx-runway
-val orxFeatures = setOf("orx-noise", "orx-fx")
+//<editor-fold desc="This is code for OPENRNDR, no need to edit this .. most of the times">
+val supportedPlatforms = setOf("windows", "macos", "linux-x64", "linux-arm64")
 
-// supported features are: video, panel
-val openrndrFeatures = setOf("video", "panel")
-
-// --------------------------------------------------------------------------------------------------------------------
-
-val openrndrOs = when (OperatingSystem.current()) {
+val openrndrOs = if (project.hasProperty("targetPlatform")) {
+    val platform : String = project.property("targetPlatform") as String
+    if (platform !in supportedPlatforms) {
+        throw IllegalArgumentException("target platform not supported: $platform")
+    } else {
+        platform
+    }
+} else when (OperatingSystem.current()) {
     OperatingSystem.WINDOWS -> "windows"
     OperatingSystem.MAC_OS -> "macos"
-    OperatingSystem.LINUX -> "linux-x64"
+    OperatingSystem.LINUX -> when(val h = DefaultNativePlatform("current").architecture.name) {
+        "x86-64" -> "linux-x64"
+        "aarch64" -> "linux-arm64"
+        else ->throw IllegalArgumentException("architecture not supported: $h")
+    }
     else -> throw IllegalArgumentException("os not supported")
 }
+//</editor-fold>
+
 enum class Logging {
     NONE,
     SIMPLE,
     FULL
 }
 
-val applicationLogging = Logging.SIMPLE
+/*  What type of logging should this project use? */
+val applicationLogging = Logging.FULL
 
-val kotlinVersion = "1.3.61"
+val kotlinVersion = "1.3.72"
 
 plugins {
     java
-    kotlin("jvm") version("1.3.61")
+    kotlin("jvm") version("1.3.72")
+    id("com.github.johnrengelman.shadow") version ("5.2.0")
+    id("org.beryx.runtime") version ("1.8.1")
 }
 
 repositories {
     mavenCentral()
-    if (openrndrUseSnapshot || orxUseSnapshot || panelUseSnapshot) {
+    if (openrndrUseSnapshot || orxUseSnapshot) {
         mavenLocal()
     }
     maven(url = "https://dl.bintray.com/openrndr/openrndr")
@@ -65,54 +117,62 @@ fun DependencyHandler.openrndrNatives(module: String): Any {
     return "org.openrndr:openrndr-$module-natives-$openrndrOs:$openrndrVersion"
 }
 
+fun DependencyHandler.orxNatives(module: String): Any {
+    return "org.openrndr.extra:$module-natives-$openrndrOs:$orxVersion"
+}
+
 dependencies {
-    runtime(openrndr("gl3"))
-    runtime(openrndrNatives("gl3"))
-    compile(openrndr("openal"))
-    runtime(openrndrNatives("openal"))
-    compile(openrndr("core"))
-    compile(openrndr("svg"))
-    compile(openrndr("animatable"))
-    compile(openrndr("extensions"))
-    compile(openrndr("filter"))
+    /*  This is where you add additional (third-party) dependencies */
 
-    compile("org.jetbrains.kotlinx", "kotlinx-coroutines-core","1.3.3")
+//    implementation("org.jsoup:jsoup:1.12.2")
+//    implementation("com.google.code.gson:gson:2.8.6")
 
-    compile("io.github.microutils", "kotlin-logging","1.7.8")
+    runtimeOnly(openrndr("gl3"))
+    runtimeOnly(openrndrNatives("gl3"))
+    implementation(openrndr("openal"))
+    runtimeOnly(openrndrNatives("openal"))
+    implementation(openrndr("core"))
+    implementation(openrndr("svg"))
+    implementation(openrndr("animatable"))
+    implementation(openrndr("extensions"))
+    implementation(openrndr("filter"))
+
+    implementation("org.jetbrains.kotlinx", "kotlinx-coroutines-core","1.3.6")
+    implementation("io.github.microutils", "kotlin-logging","1.7.9")
 
     when(applicationLogging) {
         Logging.NONE -> {
-            runtime("org.slf4j","slf4j-nop","1.7.29")
+            runtimeOnly("org.slf4j","slf4j-nop","1.7.30")
         }
         Logging.SIMPLE -> {
-            runtime("org.slf4j","slf4j-simple","1.7.29")
+            runtimeOnly("org.slf4j","slf4j-simple","1.7.30")
         }
         Logging.FULL -> {
-            runtime("org.apache.logging.log4j", "log4j-slf4j-impl", "2.13.0")
-            runtime("com.fasterxml.jackson.core", "jackson-databind", "2.10.1")
-            runtime("com.fasterxml.jackson.dataformat", "jackson-dataformat-yaml", "2.10.1")
+            runtimeOnly("org.apache.logging.log4j", "log4j-slf4j-impl", "2.13.1")
+            runtimeOnly("com.fasterxml.jackson.core", "jackson-databind", "2.10.3")
+            runtimeOnly("com.fasterxml.jackson.dataformat", "jackson-dataformat-yaml", "2.10.3")
         }
     }
 
     if ("video" in openrndrFeatures) {
-        compile(openrndr("ffmpeg"))
-        runtime(openrndrNatives("ffmpeg"))
-    }
-
-    if ("panel" in openrndrFeatures) {
-        compile("org.openrndr.panel:openrndr-panel:$panelVersion")
+        implementation(openrndr("ffmpeg"))
+        runtimeOnly(openrndrNatives("ffmpeg"))
     }
 
     for (feature in orxFeatures) {
-        compile(orx(feature))
+        implementation(orx(feature))
+    }
+
+    if ("orx-kinect-v1" in orxFeatures) {
+        runtimeOnly(orxNatives("orx-kinect-v1"))
     }
 
     if ("orx-olive" in orxFeatures) {
-        compile("org.jetbrains.kotlin", "kotlin-scripting-compiler-embeddable")
+        implementation("org.jetbrains.kotlin:kotlin-script-runtime:$kotlinVersion")
     }
 
     implementation(kotlin("stdlib-jdk8"))
-    testCompile("junit", "junit", "4.12")
+    testImplementation("junit", "junit", "4.12")
 }
 
 // --------------------------------------------------------------------------------------------------------------------
@@ -124,28 +184,64 @@ tasks.withType<KotlinCompile> {
     kotlinOptions.jvmTarget = "1.8"
 }
 
-tasks.withType<Jar> {
-    manifest {
-        attributes["Main-Class"] = applicationMainClass
-    }
-    doFirst {
-        from(configurations.compileClasspath.get().map { if (it.isDirectory) it else zipTree(it) })
-        from(configurations.runtimeClasspath.get().map { if (it.isDirectory) it else zipTree(it) })
-    }
 
-    exclude(listOf("META-INF/*.RSA", "META-INF/*.SF", "META-INF/*.DSA", "**/module-info*"))
-    archiveFileName.set("application-$openrndrOs.jar")
+project.setProperty("mainClassName", applicationMainClass)
+tasks {
+    named<ShadowJar>("shadowJar") {
+        manifest {
+            attributes["Main-Class"] = applicationMainClass
+        }
+        minimize {
+            exclude(dependency("org.openrndr:openrndr-gl3:.*"))
+            exclude(dependency("org.jetbrains.kotlin:kotlin-reflect:.*"))
+        }
+    }
+    named<org.beryx.runtime.JPackageTask>("jpackage") {
+        doLast {
+            when (OperatingSystem.current()) {
+                OperatingSystem.WINDOWS, OperatingSystem.LINUX -> {
+                    copy {
+                        from("data") {
+                            include("**/*")
+                        }
+                        into("build/jpackage/openrndr-application/data")
+                    }
+                }
+                OperatingSystem.MAC_OS -> {
+                    copy {
+                        from("data") {
+                            include("**/*")
+                        }
+                        into("build/jpackage/openrndr-application.app/data")
+                    }
+                }
+            }
+        }
+    }
 }
 
-tasks.create("zipDistribution", Zip::class.java) {
-    archiveFileName.set("application-$openrndrOs.zip")
-    from("./") {
-        include("data/**")
+tasks.register<Zip>("jpackageZip") {
+    archiveFileName.set("openrndr-application-$openrndrOs.zip")
+    from("$buildDir/jpackage") {
+        include("**/*")
     }
-    from("$buildDir/libs/application-$openrndrOs.jar")
-}.dependsOn(tasks.jar)
+}
+tasks.findByName("jpackageZip")?.dependsOn("jpackage")
 
-tasks.create("run", JavaExec::class.java) {
-    main = applicationMainClass
-    classpath = sourceSets.main.get().runtimeClasspath
-}.dependsOn(tasks.build)
+runtime {
+    jpackage {
+        imageName = "openrndr-application"
+        skipInstaller = true
+        if (OperatingSystem.current() == OperatingSystem.MAC_OS) {
+            jvmArgs.add("-XstartOnFirstThread")
+        }
+    }
+    options.empty()
+    options.add("--strip-debug")
+    options.add("--compress")
+    options.add("1")
+    options.add("--no-header-files")
+    options.add("--no-man-pages")
+    modules.empty()
+    modules.add("jdk.unsupported")
+}

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 #Thu Aug 01 12:32:31 CEST 2019
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.4-all.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists

src/main/kotlin/TemplateLiveProgram.kt

@@ -0,0 +1,22 @@
+import org.openrndr.application
+import org.openrndr.color.ColorRGBa
+import org.openrndr.extra.olive.oliveProgram
+
+/**
+ *  This is a template for a live program.
+ *
+ *  It uses oliveProgram {} instead of program {}. All code inside the
+ *  oliveProgram {} can be changed while the program is running.
+ */
+
+fun main() = application {
+    configure {
+        width = 800
+        height = 800
+    }
+    oliveProgram {
+        extend {
+            drawer.clear(ColorRGBa.PINK)
+        }
+    }
+}

src/main/resources/log4j2.yaml

@@ -1,20 +1,21 @@
 Configuration:
   status: warn
   Appenders:
-      Console:
-        name: Console
-        target: SYSTEM_OUT
+    Console:
+      - name: Console_Info
+        target: SYSTEM_ERR
         PatternLayout:
-          Pattern: "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"
-      File:
-        append: false
-        name: File_Appender
-        fileName: application.log
-        PatternLayout:
-          Pattern: "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"
+          Pattern: "%highlight{${LOG_LEVEL_PATTERN:-%5p}}{FATAL=red, ERROR=red, WARN=yellow, INFO=green, DEBUG=green, TRACE=green} %style{[%t]}{white} %style{%-30.30c{1.}}{white} %style{ ↘ %m%n%ex}{white}"
+          #Pattern: "%style{%d{yyyy-MM-dd HH:mm:ss.SSS}}{white} %highlight{${LOG_LEVEL_PATTERN:-%5p}}{FATAL=red, ERROR=red, WARN=yellow, INFO=green, DEBUG=green, TRACE=green} %style{[%t]}{white} %style{%-30.30c{1.}}{cyan} %style{:%m%n%ex}{white}"
+    File:
+      append: false
+      name: File_Appender
+      fileName: application.log
+      PatternLayout:
+        Pattern: "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"
   Loggers:
     Root:
-      level: debug
+      level: info
       AppenderRef:
-        - ref: Console
+        - ref: Console_Info
         - ref: File_Appender