project init

.gitignore

@@ -0,0 +1,5 @@
+application.log
+build
+out
+.idea
+.gradle

README.md

@@ -0,0 +1,24 @@
+# OPENRNDR template project
+A feature rich template for creating OPENRNDR programs based on Gradle/Kts
+
+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

@@ -0,0 +1,256 @@
+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.14"
+
+val applicationMainClass = "TemplateProgramKt"
+
+/*  Which additional (ORX) libraries should be added to this project. */
+val orxFeatures = setOf(
+//  "orx-boofcv",
+//  "orx-camera",
+//  "orx-chataigne",
+    "orx-compositor",
+//  "orx-dnk3",
+//  "orx-easing",
+//  "orx-file-watcher",
+//  "orx-parameters",
+//  "orx-filter-extension",
+    "orx-fx",
+//  "orx-glslify",
+//  "orx-gradient-descent",
+    "orx-gui",
+    "orx-image-fit",
+//  "orx-integral-image",
+//  "orx-interval-tree",
+//  "orx-jumpflood",
+//  "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-rabbit-control,
+//  "orx-runway",
+    "orx-shade-styles",
+//  "orx-shader-phrases",
+//  "orx-shapes",
+//  "orx-syphon",
+//  "orx-temporal-blur",
+//  "orx-time-operators",
+//  "orx-kinect-v1",
+
+    "orx-panel"
+)
+
+/* 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.44"
+
+val orxUseSnapshot = false
+val orxVersion = if (orxUseSnapshot) "0.4.0-SNAPSHOT" else "0.3.53"
+
+//<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")
+
+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 -> 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
+}
+
+/*  What type of logging should this project use? */
+val applicationLogging = Logging.FULL
+
+val kotlinVersion = "1.4.0"
+
+plugins {
+    java
+    kotlin("jvm") version("1.4.0")
+    id("com.github.johnrengelman.shadow") version ("6.1.0")
+    id("org.beryx.runtime") version ("1.11.4")
+}
+
+repositories {
+    mavenCentral()
+    if (openrndrUseSnapshot || orxUseSnapshot) {
+        mavenLocal()
+    }
+    maven(url = "https://dl.bintray.com/openrndr/openrndr")
+}
+
+fun DependencyHandler.orx(module: String): Any {
+        return "org.openrndr.extra:$module:$orxVersion"
+}
+
+fun DependencyHandler.openrndr(module: String): Any {
+    return "org.openrndr:openrndr-$module:$openrndrVersion"
+}
+
+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 {
+    /*  This is where you add additional (third-party) dependencies */
+
+//    implementation("org.jsoup:jsoup:1.12.2")
+//    implementation("com.google.code.gson:gson:2.8.6")
+
+    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.9")
+    implementation("io.github.microutils", "kotlin-logging","1.12.0")
+
+    when(applicationLogging) {
+        Logging.NONE -> {
+            runtimeOnly("org.slf4j","slf4j-nop","1.7.30")
+        }
+        Logging.SIMPLE -> {
+            runtimeOnly("org.slf4j","slf4j-simple","1.7.30")
+        }
+        Logging.FULL -> {
+            runtimeOnly("org.apache.logging.log4j", "log4j-slf4j-impl", "2.13.3")
+            runtimeOnly("com.fasterxml.jackson.core", "jackson-databind", "2.11.1")
+            runtimeOnly("com.fasterxml.jackson.dataformat", "jackson-dataformat-yaml", "2.11.1")
+        }
+    }
+
+    if ("video" in openrndrFeatures) {
+        implementation(openrndr("ffmpeg"))
+        runtimeOnly(openrndrNatives("ffmpeg"))
+    }
+
+    for (feature in orxFeatures) {
+        implementation(orx(feature))
+    }
+
+    if ("orx-kinect-v1" in orxFeatures) {
+        runtimeOnly(orxNatives("orx-kinect-v1"))
+    }
+
+    if ("orx-olive" in orxFeatures) {
+        implementation("org.jetbrains.kotlin:kotlin-script-runtime:$kotlinVersion")
+    }
+
+    implementation(kotlin("stdlib-jdk8"))
+    testImplementation("junit", "junit", "4.12")
+
+    implementation("com.github.javafaker", "javafaker", "1.0.2")
+}
+
+// --------------------------------------------------------------------------------------------------------------------
+
+configure<JavaPluginConvention> {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+}
+tasks.withType<KotlinCompile> {
+    kotlinOptions.jvmTarget = "1.8"
+}
+
+
+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.register<Zip>("jpackageZip") {
+    archiveFileName.set("openrndr-application-$openrndrOs.zip")
+    from("$buildDir/jpackage") {
+        include("**/*")
+    }
+}
+tasks.findByName("jpackageZip")?.dependsOn("jpackage")
+
+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")
+    modules.add("java.management")
+}

gradle.properties

@@ -0,0 +1 @@
+kotlin.code.style=official

gradle/wrapper/gradle-wrapper.properties

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