Skip to content

Commit aa3ef52

Browse files
committed
Update README.md and bump version to 2.2.1
1 parent c418c7c commit aa3ef52

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ val processingLibs = listOf(
6262
The Raspberry Pi app can be installed using `./gradlew raspberrypi:installDist` task and zipped using `./gradlew raspberrypi:distZip` task.
6363
See the [Application Plugin](https://docs.gradle.org/current/userguide/application_plugin.html) docs for more info.
6464

65+
### JDK
66+
67+
Project must be built using JDK 17. You can use [SDKMAN!](https://sdkman.io/) with provided `.sdkmanrc` file to use correct JDK version.
68+
6569
## How to run
6670

6771
You can run the project with Gradle `run` task. Be sure to include the `--sketch-path` argument so sketches can properly resolve the data folder containing resources needed by some Sketches.
@@ -71,10 +75,7 @@ You can run the project with Gradle `run` task. Be sure to include the `--sketch
7175
./gradlew visuals:run --args='--sketch-path=/path/to/project/'
7276
```
7377

74-
There are also IntelliJ Run configurations in `.run` folder which you can use to run the app from IDE. Just be sure to edit their configuration to match your setup.
75-
76-
Note: Due to the fragileness of Processing dependencies (namely JogAmp), the project currently works only with some JDK versions, specifically `11.0.11-zulu`. You can find `.sdkmanrc` file in project folder
77-
that sets up the current SDK for you if you use [SDKMAN!](https://sdkman.io/). (`11.0.12` does not work yet, causing [this](https://github.com/processing/processing4/issues/249) issue).
78+
There are also IntelliJ Run configurations in `.run` folder which you can use to run the app from IDE. Just be sure to edit their configuration to match your setup.
7879

7980
## Remote control
8081
Currently, the project supports 3 remote control options:
@@ -108,5 +109,15 @@ private var fader1: Float by oscFaderDelegate("/1/fader1", defaultValue = 0.5f)
108109

109110
Most of the delegated properties support value assign, so, if for example you create the fader variable and at some point in time you assign the value into it, the corresponding control in TouchOSC app will reflect that change.
110111

111-
## Known bugs after Processing4 migration
112-
- movie library does not work (issues with linking native libs)
112+
## Troubleshooting
113+
114+
### App crashes on sketches which are using `movie` library
115+
116+
Movie library stopped working after migration to Processing 4. Related issue: [#56](https://github.com/matejsemancik/astral-visuals/issues/56)
117+
118+
### App crashes with `Instance creation error : could not create instance for [Single:'dev.matsem.astral.core.tools.audio.AudioProcessor']`
119+
120+
It's probably one of these things:
121+
- Your system has no audio input devices. Make sure to have at least one audio input device, as it's required by audio processing toolchain.
122+
- Your system has no audio input devices compatible with `minim` library. (Might happen on newer macOS versions). Happens on my M2 Pro Mac. You can use a virtual audio input device to mitigate this.
123+
- If you're on macOS, make sure to grant microphone permissions for your Processing installation. The simplest way to do this is to run some Processing sample from `sound` library. The system will ask you to grant microphone permission.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
object ProjectSettings {
2-
const val version = "2.2.0"
2+
const val version = "2.2.1"
33
const val group = "dev.matsem"
44
const val jvmTarget = "17"
55
}

0 commit comments

Comments
 (0)