cleanup codebase and update README

- partially fixed IMG and spout OSC sync
- improved beatprogress display
- improved nestdrop settings value sync

Author: NikkyAI

.env

@@ -1,3 +1,3 @@
 NESTDROP=~/VJ/NestDropProV2
 NESTDROP_PROFILE=DefaultUserProfile.xml
-SHOW_LOGS=true
+DEBUG=false

.github/workflows/build_nightly_distribution.main.kts

@@ -1,7 +1,7 @@
 #!/usr/bin/env kotlin
 
 @file:Repository("https://repo.maven.apache.org/maven2/")
-@file:DependsOn("io.github.typesafegithub:github-workflows-kt:3.0.0")
+@file:DependsOn("io.github.typesafegithub:github-workflows-kt:3.0.2")
 
 @file:Repository("https://bindings.krzeminski.it")
 
@@ -11,9 +11,11 @@
 @file:DependsOn("joutvhu:/create-release:v1.0.1")
 @file:DependsOn("gradle:actions__setup-gradle:v3")
 @file:DependsOn("jimeh:update-tags-action:v1.0.1")
+@file:DependsOn("Dylan700:sftp-upload-action:v1.2.3")
 
 import io.github.typesafegithub.workflows.actions.actions.Checkout
 import io.github.typesafegithub.workflows.actions.actions.SetupJava
+import io.github.typesafegithub.workflows.actions.dylan700.SftpUploadAction_Untyped
 import io.github.typesafegithub.workflows.actions.gradle.ActionsSetupGradle
 import io.github.typesafegithub.workflows.actions.jimeh.UpdateTagsAction_Untyped
 import io.github.typesafegithub.workflows.actions.softprops.ActionGhRelease

README.md

@@ -2,55 +2,68 @@
 
 # setup and building
 
-needed: JDK? probably java 19+
+needed: JDK/JRE probably java 21+
+
+with https://scoop.sh/
+```bash
+scoop bucket add java
+scoop install openjdk
+````
 
 # required software
 
 ## Nestdrop PRO V2
 
 https://www.nestimmersion.ca/nestdrop.php
 
-tested with `V2.x.0.13`
-
-## Carabiner
-
-https://github.com/Deep-Symmetry/carabiner/releases
-
-tested with `v1.2.0`
-
-launch `Carabiner.exe` in a terminal before running the controlpanel
-
-<!-- no longer necessary?
-## xq
+tested with `V2.x.0.23`
 
-https://github.com/sibprogrammer/xq/releases
+# Nestdrop setup
 
-`xq.exe` need to be in `PATH`
--->
+## OSC
 
-# Nestdrop setup
+OSC input and output needs to be enabled  
+input port: `8000`  
+output ip: `127.0.0.1`   
+output port: `8001`  
 
 ## Configuring Nestdrop location
 
-create a `.env` file in the working directory (repo root when running via gradle)
+edit `~/.nestctrl/.env` (automatically created when running NESTCTRL the first time)
 
 `~/` is supported as a shorthand for user home path
+adjust the `NESTDROP_PATH` as required, for more info see [dotenv keys](#dotenv-keys)
 ```.env
 NESTDROP=~/VJ/NestDropProV2
 NESTDROP_PROFILE=DefaultUserProfile.xml
 ```
+
 ## IMG sprites
 
 image sprites are getting loaded by parsing `Plugins\Milkdrop2\Sprites` folder
 
-## SPOUT
+## SPOUT sprites
 
-spout sprites are loaded from the first queue with `spout` in its name
+spout sprites are loaded from the first queue with `spout` in its name for each deck
 
 ... at least until UI gets added to pick them
 
+# dotenv keys
+
+the dotenv file is usually placed
+
+| key                      | default                  | notes                         |
+|--------------------------|--------------------------|-------------------------------|
+| `NESTDROP_PATH`          | `~/VJ/NestDropProV2`     |                               |
+| `NESTDROP_PROFILE`       | `DefaultUserProfile.xml` |                               |
+| `DEBUG`                  | `false`                  | dev-only, reduces performance |
+| `NESTCTRL_CONFIG_FOLDER` | `~/.nesctrl`             | dev-only, may break things    |
+
 # running from source / IDE
 
+ a .env file in the working directory (the repository root by default) 
+ can be used to test with a separate nestdrop installation by setting `NESTCTRL_CONFIG_FOLDER`
+
 ```bash
 ./gradlew desktop
 ```

build.gradle.kts

@@ -9,16 +9,12 @@ plugins {
     kotlin("plugin.serialization")
     kotlin("plugin.power-assert")
     id("dev.reformator.stacktracedecoroutinator")
+    id("org.bytedeco.gradle-javacpp-platform") version "1.5.10"
 }
 
 repositories {
     mavenCentral()
     maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
-//    maven("https://oss.sonatype.org/content/repositories/snapshots/") {
-//        this.mavenContent {
-//            this.includeGroup("com.ryanharter.kotlinx.serialization")
-//        }
-//    }
     google()
 }
 
@@ -51,13 +47,19 @@ kotlin {
             implementation(Ktor.client.cio)
             implementation("io.ktor:ktor-network:_")
 
-            implementation("org.deepsymmetry:lib-carabiner:_")
+//            implementation("org.deepsymmetry:lib-carabiner:_")
 
             implementation("com.illposed.osc:javaosc-core:_")
 //            implementation("com.illposed.osc:javaosc-java-se-addons:_")
 
 //            implementation("org.jetbrains.kotlinx:kotlinx-collections-immutable:_")
 
+            // MIDI xperiments.. WIP
+            implementation("dev.atsushieno:ktmidi:_")
+            implementation("dev.atsushieno:ktmidi-jvm-desktop:_")
+            api("dev.atsushieno:libremidi-javacpp:_")
+            api("dev.atsushieno:libremidi-javacpp-platform:_")
+
             implementation("io.github.pdvrieze.xmlutil:serialization:_")
 //            implementation("com.ryanharter.kotlinx.serialization:kotlinx-serialization-xml:_")
             implementation("io.github.xn32:json5k:_")

src/desktopMain/kotlin/Config.kt

@@ -7,11 +7,15 @@ import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.flow.sample
+import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
+import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.JsonNamingStrategy
 import nestdrop.deck.Deck
 import nestdrop.deck.applyConfig
 import nestdrop.deck.configFlow
-import tags.TagScoreEval
+import obs.LOOM
+import tags.PresetPlaylist
 import ui.screens.customSearches
 import utils.prettyPrint
 import kotlin.time.Duration.Companion.seconds
@@ -20,8 +24,8 @@ private val logger = KotlinLogging.logger { }
 
 @OptIn(ExperimentalCoroutinesApi::class)
 val configScope = CoroutineScope(
-    Dispatchers.IO
-        .limitedParallelism(32)
+    Dispatchers.LOOM
+        .limitedParallelism(16)
 ) + CoroutineName("flows")
 
 @Immutable
@@ -40,7 +44,7 @@ data class Config(
     val deck4: DeckConfig = DeckConfig(
         triggerTime = 0.25f + 0.125f
     ),
-    val searches: List<TagScoreEval> = emptyList()
+    val presetPlaylists: List<PresetPlaylist> = emptyList()
 )
 
 @Immutable
@@ -138,6 +142,9 @@ data class DeckConfig(
 
 val config = MutableStateFlow(Config())
 
+//val json = Json {
+//    namingStrategy = JsonNamingStrategy.SnakeCase
+//}
 val json5 = Json5 {
     prettyPrint = true
     encodeDefaults = true
@@ -202,7 +209,7 @@ suspend fun loadConfig() {
         logger.info { "loaded config" }
         logger.debug { config.prettyPrint() }
         beatFrame.value = config.beats
-        customSearches.value = config.searches
+        customSearches.value = config.presetPlaylists
         decks.forEach { deck ->
             when (deck.id) {
                 1 -> deck.applyConfig(config.deck1)
@@ -225,7 +232,7 @@ suspend fun loadConfig() {
 
     customSearches.onEach { searches ->
         updateConfig {
-            copy(searches = searches)
+            copy(presetPlaylists = searches)
         }
     }.launchIn(configScope)
 }