Compare commits

...

22 Commits

Author SHA1 Message Date
Abe Pazos
326474823c Update README.md: change Java requirement 14 -> 17 2025-09-13 09:30:03 +02:00
Abe Pazos
3d6774275a Add link to wiki 2025-09-11 13:10:29 +02:00
Abe Pazos
d38df2eed7 Enable orx-composition, orx-svg, orx-text-writer
They were part of openrndr and enabled by default in the past
2025-09-11 11:35:00 +02:00
Abe Pazos
622bfc5077 Merge branch 'next-version' ignoring changes in master
Includes openrndr and orx 0.4.5
2025-09-06 13:54:37 +02:00
Abe Pazos
c2756d2b9d Upgrade to openrndr/orx 0.4.5 2025-09-06 13:36:34 +02:00
Abe Pazos
3ed7c18932 build.gradle.kts: add orx-axidraw, reformatting 2025-09-03 11:11:35 +02:00
Abe Pazos
86c36a0f35 Update to openrndr and orx 0.4.5-alpha11 2025-09-03 11:04:20 +02:00
Abe Pazos
e6a9e319d9 Update to gradleup.shadow 9.1.0 2025-08-29 22:58:55 +02:00
Abe Pazos
a385ebb216 Update badges in README.md
Previous ones stopped working
2025-08-26 15:11:52 +02:00
Abe Pazos
e1d44de9a1 Update badges in README.md
Previous ones stopped working
2025-08-26 15:07:50 +02:00
Abe Pazos
8191515779 Update to openrndr and orx 0.4.5-alpha10 2025-08-22 14:05:10 +02:00
Abe Pazos
7597ac35e2 Update README.md
Simplify README by merging two sections
2025-08-22 12:03:35 +00:00
Abe Pazos
69f698df1f Update to kotlin 2.2.10, kotlinLogging 7.0.13, shadow 9.0.2
Replace com.github.johnrengelman.shadow with com.gradleup.shadow
2025-08-21 00:00:04 +02:00
Abe Pazos
f93a523115 Dependencies: update kotlinLogging to 7.0.11 2025-08-06 11:57:54 +02:00
Abe Pazos
aa3e5e15ac Ignore .lwjgl in .gitignore
For new users, it's confusing that IDEA suggests adding five extra files to git when they only edited one.
2025-07-30 08:40:39 +02:00
Abe Pazos
ef7cee01c7 Fix #53 - ffmpeg warnings after shadowJar 2024-11-21 11:19:30 +01:00
Abe Pazos
de35f064d8 Update README.md
Mention how to specify a main method to run after using shadowJar

Simplify the text.
2024-11-16 17:24:36 +00:00
Abe Pazos
524635e1ad Revert accidentally pushed code
This reverts commit 3ef46bcc4e.
2024-10-31 08:02:36 +01:00
Abe Pazos
db5ea1cdd2 Update to Gradle 8.10.2 2024-10-30 21:43:46 +01:00
Abe Pazos
3ef46bcc4e Add kinect test 2024-09-13 18:12:52 +02:00
Abe Pazos
1384143d6f Update to Gradle 8.10 2024-09-13 18:11:46 +02:00
Abe Pazos
10ccb692c7 Update to Gradle 8.9 2024-08-12 19:29:46 +02:00
3 changed files with 43 additions and 54 deletions

View File

@@ -7,13 +7,20 @@ 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` and a live-coding example in `src/main/kotlin/TemplateLiveProgram.kt`.
You will find some [basic instructions](https://guide.openrndr.org/setUpYourFirstProgram.html) in the [OPENRNDR guide](https://guide.openrndr.org)
You will find some [basic instructions](https://guide.openrndr.org/setUpYourFirstProgram.html) in the [OPENRNDR guide](https://guide.openrndr.org).
## Gradle tasks
- `./gradlew run` runs the TemplateProgram (Use `gradlew.bat run` under Windows)
- `./gradlew run` runs `TemplateProgram.kt` (Use `gradlew.bat run` under Windows)
- `./gradlew run -Popenrndr.application=MyProgramKt` runs `src/main/kotlin/myProgram.kt`
- `./gradlew run -Popenrndr.application=foo.bar.MyProgramKt` runs `src/main/kotlin/foo/bar/myProgram.kt` (assuming `package foo.bar` is used in myProgram.kt)
- `./gradlew shadowJar` creates an executable platform specific jar file with all dependencies. Run the resulting program by typing `java -jar build/libs/openrndr-template-1.0.0-all.jar` in a terminal from the project root. If your project contains multiple `main` methods, specify which one to run with `java -cp build/libs/openrndr-template-1.0.0-all.jar MyProgramKt`, where `MyProgramKt` can also be `foo.bar.MyProgramKt` if it's in the package `foo.bar`.
- `./gradlew jpackageZip` creates a zip with a stand-alone executable for the current platform (works with Java 14 only). Run it like this: `cd build/jpackage/openrndr-application/ && bin/openrndr-application`.
- `./gradlew jpackageZip` creates a zip with a stand-alone executable for the current platform (requires Java 17 or newer). Run it like this: `cd build/jpackage/openrndr-application/ && bin/openrndr-application`.
- `./gradlew dependencyUpydates` checks whether any dependencies have newer versions.
## Tips and issues
See the [wiki](https://github.com/openrndr/openrndr-template/wiki)
## Cross builds
@@ -26,10 +33,10 @@ provides the optional [orsl](https://github.com/openrndr/orsl/) shader helper mo
The version numbers of these dependencies are specified in your [libs.versions.toml](gradle/libs.versions.toml) file.
Learn more about this file in the [Gradle documentation](https://docs.gradle.org/current/userguide/platforms.html#sub:conventional-dependencies-toml) website.
Newer versions bring useful features and bug fixes. The most recent versions are
<br>![openrndr version](https://maven-badges.herokuapp.com/maven-central/org.openrndr/openrndr-application/badge.svg) for OPENRNDR.
<br>![orx version](https://maven-badges.herokuapp.com/maven-central/org.openrndr.extra/orx-parameters-jvm/badge.svg) for ORX.
<br>![orsl version](https://maven-badges.herokuapp.com/maven-central/org.openrndr.orsl/orsl-shader-generator-jvm/badge.svg) for ORSL.
Newer versions bring useful features and bug fixes. The most recent versions are<br>
![Maven Central Version](https://img.shields.io/maven-central/v/org.openrndr/openrndr-math-jvm?label=OPENRNDR&color=%23FFC0CB)
![Maven Central Version](https://img.shields.io/maven-central/v/org.openrndr.extra/orx-noise-jvm?label=ORX&color=%23FFC0CB)
![Maven Central Version](https://img.shields.io/maven-central/v/org.openrndr.orsl/orsl-shader-generator-jvm?label=ORSL&color=%23FFC0CB).
Switch to the [next-version branch](https://github.com/openrndr/openrndr-template/tree/next-version) or enter these versions manually in your toml file.
They can look like "0.4.3" or "0.4.3-alpha4". Use the complete string, as in:
@@ -42,18 +49,6 @@ You can add other dependencies needed by your project to your [build.gradle.kts]
⚠️ Remember to reload the Gradle configuration after changing any dependencies.
## Run other Kotlin programs from the command line
By default `./gradlew run` runs a program called `TemplateProgram.kt` but a different one can be provided as an argument:
To run `src/main/kotlin/myProgram.kt`
./gradlew run -Popenrndr.application=MyProgramKt
To run `src/main/kotlin/foo/bar/myProgram.kt` (assuming `package foo.bar` in myProgram.kt)
./gradlew run -Popenrndr.application=foo.bar.MyProgramKt
## Github Actions
This repository contains various Github Actions under `./github/workflows`:

View File

@@ -11,11 +11,12 @@ val applicationMainClass = "TemplateProgramKt"
/** ## additional ORX features to be added to this project */
val orxFeatures = setOf<String>(
// "orx-axidraw",
// "orx-boofcv",
"orx-camera",
// "orx-chataigne",
"orx-color",
// "orx-composition",
"orx-composition",
"orx-compositor",
// "orx-compute-graph",
// "orx-compute-graph-nodes",
@@ -62,11 +63,11 @@ val orxFeatures = setOf<String>(
"orx-shade-styles",
// "orx-shader-phrases",
"orx-shapes",
// "orx-svg",
"orx-svg",
// "orx-syphon",
// "orx-temporal-blur",
// "orx-tensorflow",
// "orx-text-writer",
"orx-text-writer",
// "orx-time-operators",
// "orx-timer",
// "orx-triangulation",
@@ -139,14 +140,8 @@ dependencies {
implementation(libs.kotlin.logging)
when (applicationLogging) {
Logging.NONE -> {
runtimeOnly(libs.slf4j.nop)
}
Logging.SIMPLE -> {
runtimeOnly(libs.slf4j.simple)
}
Logging.NONE -> runtimeOnly(libs.slf4j.nop)
Logging.SIMPLE -> runtimeOnly(libs.slf4j.simple)
Logging.FULL -> {
runtimeOnly(libs.log4j.slf4j2)
runtimeOnly(libs.log4j.core)
@@ -197,6 +192,11 @@ tasks {
exclude(dependency("org.bytedeco:.*"))
}
}
}
// ------------------------------------------------------------------------------------------------------------------ //
tasks {
named<org.beryx.runtime.JPackageTask>("jpackage") {
doLast {
val destPath = if (OperatingSystem.current().isMacOsX)
@@ -205,26 +205,20 @@ tasks {
"build/jpackage/openrndr-application/data"
copy {
from("data") {
include("**/*")
}
from("data") { include("**/*") }
into(destPath)
}
}
}
}
// ------------------------------------------------------------------------------------------------------------------ //
tasks.register<Zip>("jpackageZip") {
register<Zip>("jpackageZip") {
archiveFileName = "openrndr-application.zip"
from("${layout.buildDirectory.get()}/jpackage") {
include("**/*")
}
dependsOn("jpackage")
}
}
tasks.findByName("jpackageZip")?.dependsOn("jpackage")
// ------------------------------------------------------------------------------------------------------------------ //
runtime {
jpackage {
@@ -241,8 +235,10 @@ runtime {
// ------------------------------------------------------------------------------------------------------------------ //
tasks.register<org.openrndr.extra.gitarchiver.GitArchiveToMarkdown>("gitArchiveToMarkDown") {
tasks {
register<org.openrndr.extra.gitarchiver.GitArchiveToMarkdown>("gitArchiveToMarkDown") {
historySize = 20
}
}
// ------------------------------------------------------------------------------------------------------------------ //
@@ -253,9 +249,7 @@ tasks {
val nonStableKeywords = listOf("alpha", "beta", "rc")
fun isNonStable(
version: String
) = nonStableKeywords.any {
fun isNonStable(version: String) = nonStableKeywords.any {
version.lowercase().contains(it)
}

View File

@@ -1,7 +1,7 @@
[versions]
kotlin = "2.2.0"
openrndr = "0.4.5-alpha9"
orx = "0.4.5-alpha9"
kotlin = "2.2.10"
openrndr = "0.4.5"
orx = "0.4.5"
orsl = "0.4.5-alpha5"
orml = "0.4.1"
slf4j = "2.0.17"
@@ -10,10 +10,10 @@ jackson = "2.17.2"
junit = "4.13.2"
kotlinxCoroutines = "1.10.2"
kotlinxSerialization = "1.9.0"
kotlinLogging = "7.0.7"
kotlinLogging = "7.0.13"
kotlinCsvJvm = "1.9.3"
jsoup = "1.17.1"
shadow = "8.1.1"
shadow = "9.1.0"
runtime = "1.13.1"
versions = "0.52.0"
@@ -48,7 +48,7 @@ csv = { group = "com.github.doyaaaaaken", name = "kotlin-csv-jvm", version.ref =
[plugins]
kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
shadow = { id = "com.github.johnrengelman.shadow", version.ref = "shadow" }
shadow = { id = "com.gradleup.shadow", version.ref = "shadow" }
runtime = { id = "org.beryx.runtime", version.ref = "runtime" }
gitarchive-tomarkdown = { id = "org.openrndr.extra.gitarchiver.tomarkdown", version.ref = "orx" }
versions = { id = "com.github.ben-manes.versions", version.ref = "versions" }