Merge branch 'master' into fix/midiTransceiverFailsOnVeryShortMessages

Author: edwinRNDR

.github/workflows/build.yml

@@ -20,9 +20,6 @@ jobs:
         with:
           path: ./orx
 
-      - name: Validate Gradle wrapper
-        uses: gradle/actions/wrapper-validation@v3
-
       - name: Checkout OPENRNDR repository
         uses: actions/checkout@v4
         with:
@@ -40,8 +37,10 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: temurin
-          java-version: 17
-          cache: gradle
+          java-version: 21
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
 
       - name: Build OPENRNDR
         working-directory: ./openrndr

.github/workflows/generate-screenshots.yml

@@ -16,9 +16,6 @@ jobs:
         with:
           path: ./orx
 
-      - name: Validate Gradle wrapper
-        uses: gradle/actions/wrapper-validation@v3
-
       - name: Checkout OPENRNDR repository
         uses: actions/checkout@v4
         with:
@@ -37,7 +34,9 @@ jobs:
         with:
           distribution: temurin
           java-version: 21
-          cache: gradle
+      
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
 
       - name: Build OPENRNDR
         working-directory: ./openrndr

.github/workflows/release-apidocs.yml

@@ -0,0 +1,65 @@
+name: Release API docs
+on:
+  push:
+    branches: [ master ]
+
+defaults:
+  run:
+    working-directory: ./orx
+
+jobs:
+  release_apidocs:
+    if: github.repository == 'openrndr/orx'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout current repository
+        uses: actions/checkout@v4
+        with:
+          path: ./orx
+          fetch-depth: 0
+
+      - name: Checkout OPENRNDR repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          repository: openrndr/openrndr
+          path: ./openrndr
+          ref: master
+
+      - name: Test glxinfo
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y mesa-utils xvfb
+          xvfb-run glxinfo
+
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Build OPENRNDR
+        working-directory: ./openrndr
+        run: ./gradlew publishToMavenLocal snapshot
+
+      - name: Build apidocs
+        run: ./gradlew :dokkaGenerate -Dorg.gradle.jvmargs=-Xmx1536M
+
+      - name: Publish to gh-pages
+        run: |
+          git worktree add --detach docs-temp
+          cd docs-temp
+          git checkout --orphan gh-pages
+          git reset HEAD -- .
+          git clean -df
+          mv ../build/dokka/html/* .
+          cp ../dokka/styles/* styles/
+          echo orx.openrndr.org > CNAME
+          git status
+          git config --global user.email "actions@openrndr.org"
+          git config --global user.name "OPENRNDR Actions"
+          git add . 
+          git commit -m "Add automatically generated API docs"
+          git push origin gh-pages --force

.github/workflows/release-candidate-to-maven-central.yml

@@ -19,7 +19,7 @@ jobs:
           echo "${{secrets.SIGNING_SECRET_KEY_RING_FILE}}" > ~/.gradle/secring.gpg.b64
           base64 -d ~/.gradle/secring.gpg.b64 > ~/.gradle/secring.gpg
       - name: Publish
-        run: ./gradlew publishToSonatype -Prelease.useLastTag=true -Psigning.keyId=${{secrets.SIGNING_KEY_ID}} -Psigning.password=openrndr -Psigning.secretKeyRingFile=$(echo ~/.gradle/secring.gpg)
+        run: ./gradlew publishAggregationToCentralPortal -Prelease.useLastTag=true -Psigning.keyId=${{secrets.SIGNING_KEY_ID}} -Psigning.password=openrndr -Psigning.secretKeyRingFile=$(echo ~/.gradle/secring.gpg)
         env:
           OSSRH_USERNAME: ${{secrets.OSSRH_USERNAME}}
           OSSRH_PASSWORD: ${{secrets.OSSRH_PASSWORD}}

.github/workflows/release-to-maven-central.yml

@@ -21,7 +21,7 @@ jobs:
           echo "${{secrets.SIGNING_SECRET_KEY_RING_FILE}}" > ~/.gradle/secring.gpg.b64
           base64 -d ~/.gradle/secring.gpg.b64 > ~/.gradle/secring.gpg
       - name: Publish
-        run: ./gradlew publishToSonatype -Prelease.useLastTag=true -Psigning.keyId=${{secrets.SIGNING_KEY_ID}} -Psigning.password=openrndr -Psigning.secretKeyRingFile=$(echo ~/.gradle/secring.gpg)
+        run: ./gradlew publishAggregationToCentralPortal -Prelease.useLastTag=true -Psigning.keyId=${{secrets.SIGNING_KEY_ID}} -Psigning.password=openrndr -Psigning.secretKeyRingFile=$(echo ~/.gradle/secring.gpg)
         env:
           OSSRH_USERNAME: ${{secrets.OSSRH_USERNAME}}
           OSSRH_PASSWORD: ${{secrets.OSSRH_PASSWORD}}

CNAME

@@ -0,0 +1 @@
+orx.openrndr.org

CONTRIBUTING.md

@@ -57,6 +57,7 @@ orx-magic/
 ```
 Note that inside `src` only `commonMain` is required.
 
+
 ## ORX README.md
 
 Assuming you are creating an orx called `magic`, the readme should be formatted as follows:
@@ -88,6 +89,7 @@ Main content describing the usage of orx-magic goes here
    This is specially useful for orx'es that produce graphical output, but less so for orx'es that interface
    with hardware (like `orx-midi`).
 
+
 ## ORX build.gradle.kts
 
 ORX `build.gradle.kts` files declare their dependencies and most follow the same structure. 
@@ -107,6 +109,36 @@ See an [example](https://github.com/openrndr/orx/blob/master/orx-jvm/orx-dnk3/bu
 
 The multiplatform build files may have blocks like `commonMain`, `commonTest`, `jvmTest`, `jvmDemo`, etc. to specify the dependencies for each case. See an [example](https://github.com/openrndr/orx/blob/master/orx-color/build.gradle.kts).
 
+
+## I want to contribute to the documentation
+
+There are various places where you can contribute without writing code. It will be greatly
+appreciated by others trying to learn about OPENRNDR.
+
+### Guide
+
+The [guide](https://guide.openrndr.org/) is the first contact with OPENRNDR for most users.
+[Learn how to work on the guide](https://github.com/openrndr/openrndr-guide/blob/dev/contributing.md).
+
+### ORX API page
+
+The [ORX API page](https://orx.openrndr.org/) needs some love too. The content is automatically
+extracted from comments written in ORX's source code. It goes like this:
+
+1. Fork the [ORX repo](https://github.com/openrndr/orx/), then clone your fork (so you
+   have a copy on your computer) and get familiar with OPENRNDR and ORX.
+2. Find an undocumented section at https://orx.openrndr.org you want to explain.
+3. Find the corresponding Kotlin file in your cloned repo and add missing comments. Read about
+   the [suggested style](https://developers.google.com/style).
+4. Generate the API website locally to verify your changes look correct by running the following
+   command: `./gradlew dokkaGenerate -Dorg.gradle.jvmargs=-Xmx1536M`. This will create the
+   html documentation under `build/dokka/html/`.
+5. Open the `build/dokka/html/index.html` in your web browser. If something looks off
+   tweak your comments. Note: the sidebar will be empty unless viewed through a web server.
+   You can launch one by running `python3 -m http.server --bind 127.0.0.1` in the html folder.
+7. To continue improving the API go back to step 3, otherwise send a Pull Requests from your fork.
+
+
 ## Demos
 
 ORX'es often include a `jvmDemo` folder. This folder should contain small programs demonstrating

README.md

@@ -1,9 +1,15 @@
 # ORX (OPENRNDR EXTRA)
 
-[![Download](https://maven-badges.herokuapp.com/maven-central/org.openrndr.extra/orx-parameters-jvm/badge.svg)](https://mvnrepository.com/artifact/org.openrndr.extra)
+[![ORX maven badge](https://img.shields.io/maven-central/v/org.openrndr.extra/orx-noise-jvm?style=flat&color=%23FFC0CB
+)](https://mvnrepository.com/artifact/org.openrndr.extra)
 
 A growing library of assorted data structures, algorithms and utilities to
-complement [OPENRNDR](https://github.com/openrndr/openrndr).
+complement [OPENRNDR](https://github.com/openrndr/openrndr). 
+Multiplatform, unless they deal with hardware or depend on binary libraries. Those are JVM-only.
+
+## Usage
+
+To make use of these extensions clone the [OPENRNDR template](https://github.com/openrndr/openrndr-template), uncomment the ones you need in its [build.gradle.kts](https://github.com/openrndr/openrndr-template/blob/master/build.gradle.kts) file, and reload Gradle. Cloning this repo is optional but useful to run the demos in each ORX folder, to study the source code, and to contribute to existing or new ORX'es.
 
 <!-- __orxListBegin__ -->
 
@@ -15,8 +21,6 @@ complement [OPENRNDR](https://github.com/openrndr/openrndr).
 | [`orx-color`](orx-color/) | Color spaces, palettes, histograms, named colors. |
 | [`orx-composition`](orx-composition/) | Shape composition library |
 | [`orx-compositor`](orx-compositor/) | Toolkit to make composite (layered) images using blend modes and filters. |
-| [`orx-compute-graph`](orx-compute-graph/) | A graph for computation. |
-| [`orx-compute-graph-nodes`](orx-compute-graph-nodes/) | A collection of nodes that can be used with `orx-compute-graph`. |
 | [`orx-delegate-magic`](orx-delegate-magic/) | Collection of magical property delegators. For tracking variable change or interpolate towards the value of a variable. |
 | [`orx-easing`](orx-easing/) | Easing functions for smooth animation or non-linear interpolation. |
 | [`orx-envelopes`](orx-envelopes/) | ADSR (Attack, Decay, Sustain, Release) envelopes and tools. |
@@ -33,10 +37,12 @@ complement [OPENRNDR](https://github.com/openrndr/openrndr).
 | [`orx-jumpflood`](orx-jumpflood/) | Calculates distance or direction fields from an image. GPU accelerated, 2D. Results are provided as an image. |
 | [`orx-kdtree`](orx-kdtree/) | Fast search of points closest to the queried point in a data set. 2D, 3D and 4D. |
 | [`orx-marching-squares`](orx-marching-squares/) | Tools for extracting contours from functions |
+| [`orx-math`](orx-math/) | Mathematical utilities <!-- __demos__ --> ## Demos ### linearrange/DemoLinearRange02 |
 | [`orx-mesh-generators`](orx-mesh-generators/) | 3D-mesh generating functions and DSL. |
+| [`orx-mesh-noise`](orx-mesh-noise/) | Generate random samples on the surface of a mesh <!-- __demos__ --> ## Demos ### DemoMeshNoise01 |
 | [`orx-no-clear`](orx-no-clear/) | Provides the classical "draw-without-clearing-the-screen" functionality. |
 | [`orx-noise`](orx-noise/) | Randomness for every type of person: Perlin, uniform, value, simplex, fractal and many other types of noise. |
-| [`orx-obj-loader`](orx-obj-loader/) | Simple loader for Wavefront .obj 3D mesh files. |
+| [`orx-obj-loader`](orx-obj-loader/) | Simple loader and saver for Wavefront .obj 3D mesh files. |
 | [`orx-palette`](orx-palette/) | Provides hundreds of color palettes. |
 | [`orx-parameters`](orx-parameters/) | Provides annotations and tools for turning Kotlin properties into introspectable parameters. Used by [`orx-gui`](../orx-jvm/orx-gui/README.md) to automatically generate user interfaces. |
 | [`orx-property-watchers`](orx-property-watchers/) | Tools for setting up property watcher based pipelines |
@@ -46,6 +52,7 @@ complement [OPENRNDR](https://github.com/openrndr/openrndr).
 | [`orx-shapes`](orx-shapes/) | Collection of 2D shape generators and modifiers. |
 | [`orx-svg`](orx-svg/) | SVG reader and writer library. |
 | [`orx-temporal-blur`](orx-temporal-blur/) | Post-processing temporal-blur video effect. CPU intense, therefore not intended  for use with the `ScreenRecorder` extension or other real-time uses. |
+| [`orx-text-on-contour`](orx-text-on-contour/) | Writing texts on contours. |
 | [`orx-text-writer`](orx-text-writer/) | Writing texts with layouts |
 | [`orx-time-operators`](orx-time-operators/) | A collection of time-sensitive functions aimed at controlling raw data over-time,  such as Envelope and LFO. |
 | [`orx-timer`](orx-timer/) | Simple timer functionality providing `repeat`, to run code with a given interval and `timeOut`, to run code once after a given delay. |
@@ -73,8 +80,8 @@ complement [OPENRNDR](https://github.com/openrndr/openrndr).
 | [`orx-osc`](orx-jvm/orx-osc/) | Open Sound Control makes it possible to send and receive messages from other OSC enabled programs in the same or a different computer. Used to create multi-application or multi-device software. |
 | [`orx-panel`](orx-jvm/orx-panel/) | The OPENRNDR UI toolkit. Provides buttons, sliders, text, a color picker and much more. HTML/CSS-like. |
 | [`orx-poisson-fill`](orx-jvm/orx-poisson-fill/) | Post processing effect that fills transparent parts of the image interpolating the edge pixel colors. GPU-based. |
+| [`orx-processing`](orx-jvm/orx-processing/) | orx-processing is a module designed to facilitate seamless type conversions between Processing's types and OPENRNDR's types. It provides utilities and methods that allow developers to integrate the two graphics frameworks effectively by bridging the gap between their respective data structures. |
 | [`orx-rabbit-control`](orx-jvm/orx-rabbit-control/) | Creates a web-based remote UI to control your OPENRNDR program from a mobile device or a different computer. Alternative to `orx-gui`. |
-| [`orx-runway`](orx-jvm/orx-runway/) | Interfaces with the RunwayML machine learning library that provides features like motion capture, image synthesis, object recognition, style transfer and more. More info at [runwayml.com](https://runwayml.com/). |
 | [`orx-syphon`](orx-jvm/orx-syphon/) | Send frames to- and from OPENRNDR to other applications in real time using _Syphon_ for Mac. |
 | [`orx-video-profiles`](orx-jvm/orx-video-profiles/) | GIF, H265, PNG, Prores, TIFF and Webp `VideoWriterProfile`s for `ScreenRecorder` and `VideoWriter`. |
 <!-- __orxListEnd__ -->

build.gradle

@@ -1,14 +1,16 @@
 plugins {
     alias(libs.plugins.nebula.release)
-    alias(libs.plugins.gradle.nexus.publish)
+    //alias(libs.plugins.gradle.nexus.publish)
+    id("com.gradleup.nmcp.aggregation").version("1.1.0")
+
     id("org.openrndr.extra.convention.dokka")
 }
 
 repositories {
     mavenCentral()
 }
 
-task buildMainReadme {
+tasks.register('buildMainReadme') {
     doFirst {
         def subProjects = project.subprojects
         //.findAll { !it.name.contains("kinect-common") && !it.name.contains
@@ -37,7 +39,7 @@ task buildMainReadme {
         // Skip the hash character from the headline, then start
         // on the next line and continue until the next empty line.
         // Don't fall into Windows line breaks.
-        def descriptionRx = ~/(?s)\#.*?\n(.+?)\n\r?\n/
+        def descriptionRx = ~/(?s)#.*?\n(.+?)\n\r?\n/
         // Note: the readme needs an empty line after the description
 
         def orxMultiplatform = []
@@ -89,17 +91,28 @@ task buildMainReadme {
     }
 }
 group = "org.openrndr.extra"
+nmcpAggregation {
+    centralPortal {
+        username.set(findProperty("ossrhUsername") ?: System.getenv("OSSRH_USERNAME"))
+        password.set(findProperty("ossrhPassword") ?: System.getenv("OSSRH_PASSWORD"))
 
-nexusPublishing {
-    repositories {
-        sonatype {
-            username.set(findProperty("ossrhUsername") ?: System.getenv("OSSRH_USERNAME"))
-            password.set(findProperty("ossrhPassword") ?: System.getenv("OSSRH_PASSWORD"))
-            nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
-            snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots"))
-        }
+        // publish manually from the portal
+        publishingType = "USER_MANAGED"
     }
+
+    // Publish all projects that apply the 'maven-publish' plugin
+    publishAllProjectsProbablyBreakingProjectIsolation()
 }
+//nexusPublishing {
+//    repositories {
+//        sonatype {
+//            username.set(findProperty("ossrhUsername") ?: System.getenv("OSSRH_USERNAME"))
+//            password.set(findProperty("ossrhPassword") ?: System.getenv("OSSRH_PASSWORD"))
+//            nexusUrl.set(uri("https://ossrh-staging-api.central.sonatype.com/service/local/"))
+//            snapshotRepositoryUrl.set(uri("https://central.sonatype.com/repository/maven-snapshots/"))
+//        }
+//    }
+//}
 
 subprojects {
     // Equivalent Kotlin is: tasks.register<DependencyReportTask>("dependenciesAll") { ...
@@ -109,6 +122,20 @@ subprojects {
     }
 }
 
+dependencies {
+    subprojects.findAll {
+        it.name.startsWith("orx-")
+    }.each { subproject ->
+        dokka(project(subproject.path))
+    }
+}
+class SleepTask extends DefaultTask {
+    @TaskAction
+    void action() {
+        sleep(60 * 5 * 1000)
+    }
+}
+tasks.register("sleep", SleepTask)
 gradle.buildFinished {
     println("\n")
     println("orx = \"${version}\"")

buildSrc/build.gradle.kts

@@ -18,5 +18,9 @@ dependencies {
     "preloadImplementation"(libs.openrndr.application)
     "preloadImplementation"(libs.openrndr.extensions)
 }
-
+kotlin {
+    compilerOptions {
+        freeCompilerArgs.add("-Xskip-metadata-version-check")
+    }
+}
 tasks.getByName("compileKotlin").dependsOn("compilePreloadKotlin")