Server rewrite

.github/workflows/build.yml

@@ -84,23 +84,25 @@ jobs:
       - name: GUI Lint
         run: pnpm i && cd gui && pnpm run lint
 
-  java-checks:
-    name: Java Checks
+  server-checks:
+    name: Server Checks
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v6
         with:
           submodules: recursive
-      - name: Set up JDK 17
+      - name: Set up JDK 24
         uses: actions/setup-java@v5
         with:
-          java-version: '17'
+          java-version: '24'
           distribution: 'adopt'
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v6
-      - name: Java Spotless Check
+      - name: Server Spotless Check
         run: ./gradlew spotlessCheck --build-cache
+      - name: Server Detekt Lint
+        run: ./gradlew :server:detekt --build-cache
 
 
   build-server-jar:
@@ -113,10 +115,10 @@ jobs:
           submodules: recursive
       - name: Get tags
         run: git fetch --tags origin --recurse-submodules=no --force
-      - name: Set up JDK 17
+      - name: Set up JDK 24
         uses: actions/setup-java@v5
         with:
-          java-version: '17'
+          java-version: '24'
           distribution: 'adopt'
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v6
@@ -260,10 +262,10 @@ jobs:
           submodules: recursive
       - name: Get tags
         run: git fetch --tags origin --recurse-submodules=no --force
-      - name: Set up JDK 17
+      - name: Set up JDK 24
         uses: actions/setup-java@v5
         with:
-          java-version: '17'
+          java-version: '24'
           distribution: 'adopt'
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v6

.gitignore

@@ -4,8 +4,10 @@
 # Syncthing ignore file
 .stignore
 
-# Ignore .idea
-.idea
+# Ignore .idea, except shared project inspection profiles
+.idea/*
+!.idea/inspectionProfiles/
+!.idea/inspectionProfiles/*.xml
 
 # Ignore .fleet
 .fleet

AGENTS.md

@@ -0,0 +1,64 @@
+# OpenCode Agent Instructions
+
+## Environment & Tooling
+- **Server (Kotlin/Java)**: Use `gradle` (`./gradlew`).
+    - Run: `./gradlew run`
+    - Build: `./gradlew shadowJar`
+    - Format: `./gradlew spotlessApply`
+- **GUI (Electron/TS)**: Use `pnpm`.
+    - Install: `pnpm i`
+    - Dev: `pnpm gui`
+    - Build: `pnpm package:build`
+    - Format: `pnpm run lint:fix`
+- **SolarXR Protocol (Submodule)**: Use `bash` and `pnpm`.
+    - Edit: Only `schema/` files.
+    - Generate: `./generate-flatbuffer.sh` (Linux/macOS).
+    - Sync: Run `pnpm i` in root after generation.
+
+## Architecture: The Reducer/Behaviour Pattern
+The server uses a reactive reducer pattern for thread safety and observability.
+
+- **Core Primitives**: 
+  - `Context<S, A>`: Holds `StateFlow<S>`, `CoroutineScope`, and `Behaviour`s.
+  - `Behaviour<S, A, C>`:
+    - `reduce(state, action)`: **Pure function**. No side effects.
+    - `observe(receiver)`: **Side effects**. Launch coroutines using `receiver.context.scope`.
+- **Lifecycle**: `Module.create()` (inert construction) $\rightarrow$ `module.startObserving()` (side-effect activation).
+- **DI**: Uses `Phase1ContextProvider` $\rightarrow$ `AppContextProvider` hierarchy.
+- **Communication**: Modules communicate via `dispatch(action)` or by observing another module's `StateFlow`.
+
+## Design & Coding Preferences
+- **Function over Class**: Prefer plain functions or `object` over classes for single-purpose logic.
+- **Function over Extension**: Use plain functions instead of extension functions unless the receiver is the primary subject.
+- **Action Selection**: 
+  - Use `Update` (with a lambda) for internal state changes that require no external reaction.
+  - Use **Named Actions** when multiple behaviours must react to a specific event.
+- **State Management**: Only include data in `StateFlow` if it is required for observation by other modules.
+- **Communication**: Decouple modules by using `dispatch` or observing `StateFlow` rather than direct method calls.
+
+## Agent Workflow
+- **Phase 1: Discovery**: Use the `Glob` $\rightarrow$ `Grep` $\rightarrow$ `Read` pattern. Never guess file paths or contents.
+- **Phase 2: Planning**: For complex tasks, use `todowrite` to create a checklist. Present the plan to the user before implementation.
+- **Phase 3: Implementation**: Use `edit` for existing files; `write` for new files.
+- **Phase 4: Verification**: Always run the relevant linting or testing tools before marking a task as complete.
+
+## Common Pitfalls
+- **Coroutine Leaks**: Never launch coroutines in `observe` using a global scope; **always** use `receiver.context.scope`.
+- **Direct State Mutation**: Never attempt to mutate state properties directly. Always use `dispatch(action)`.
+- **Incomplete Cleanup**: Ensure any module owning a `Context` implements a `dispose()` method.
+
+## Conventions
+- **Files**: `module.kt` (Class/State/Actions) and `behaviours.kt` (Implementations).
+- **Actions**: Use `sealed interface`.
+- **State**: Data classes must use `val` only.
+- **Cleanup**: We use a direct `dispose()` method on modules instead of a `Disposable` interface.
+- **Detailed Conventions**: See `server/README.md` for full coding style and architecture details.
+
+## Testing
+- **Reducers**: Test by creating a `Context` with specific `Behaviour`s.
+- **Modules**: Use `TestAppContext` and `buildTest...` helpers from `TestServer.kt`.
+
+## Verification Protocol
+- **Linting**: Run `./gradlew spotlessApply` (Server) or `pnpm run lint:fix` (GUI).
+- **Testing**: Identify and run the relevant test suite (e.g., `./gradlew test` or specific module tests).
+- **Final Audit**: Perform a final `git diff` check to ensure no unintended changes were made.

CONTRIBUTING.md

@@ -22,21 +22,24 @@ Now you can open the codebase in [IDEA](https://www.jetbrains.com/idea/download/
 
 ### Java (server)
 
+Before contributing to the server, read [server/README.md](server/README.md) for an overview of its architecture and design guidelines.
+
 The Java code is built with `gradle`, a CLI tool that manages java projects and their
 dependencies.
 - You can run the server by running `./gradlew run` in your IDE's terminal.
 - To compile the code, run `./gradlew shadowJar`. The result will
-be at `server/build/libs/slimevr.jar` (you can ignore `server.jar`).
+be at `server/desktop/build/libs/slimevr.jar` (you can ignore `server.jar`).
 
 (Note: Your IDE may be able to do all of the above for you.)
 
 ### Electron (gui)
 
-- Activate corepack (included with Node.JS) via `corepack enable` (might require administrator permissions)
+- Activate corepack (included with Node.js) via `corepack enable` 
+(might require launching Git Bash as administrator on Windows)
 - Run `pnpm i` in your IDE's terminal to download and install dependencies.
 - To launch the GUI in dev mode, run `pnpm gui`.
-- Finally, to compile for production, run `pnpm package:build`. The result
-will be at `dist/artifacts/` content will change depending of the platform.
+- Finally, to compile for production, run `pnpm package:build`. 
+The result will be in `gui/dist/artifacts/`. Content will change depending on the platform.
 
 ## Code style
 

README.md

@@ -22,6 +22,8 @@ Latest setup instructions are [in our docs](https://docs.slimevr.dev/server/inde
 ## Building & Contributing
 For information on building and contributing to the codebase, see [CONTRIBUTING.md](CONTRIBUTING.md).
 
+For an overview of the server architecture and design guidelines, see [server/README.md](server/README.md).
+
 ## Translating
 
 Translation is done via Pontoon at [i18n.slimevr.dev](https://i18n.slimevr.dev/). Please join our [Discord translation forum](https://discord.com/channels/817184208525983775/1050413434249949235) to coordinate.

flake.nix

@@ -3,13 +3,16 @@
 
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    # Pinned to a revision that still ships temurin jdk-24
+    nixpkgs-jdk24.url = "github:NixOS/nixpkgs/d0fc30899600b9b3466ddb260fd83deb486c32f1";
     flake-parts.url = "github:hercules-ci/flake-parts";
   };
 
   outputs =
     inputs@{
       self,
       nixpkgs,
+      nixpkgs-jdk24,
       flake-parts,
       ...
     }:
@@ -20,8 +23,15 @@
       ];
 
       perSystem =
-        { lib, pkgs, ... }:
+        {
+          system,
+          lib,
+          pkgs,
+          ...
+        }:
         let
+          java = (import nixpkgs-jdk24 { inherit system; }).jdk24;
+
           runtimeLibs = [
             pkgs.alsa-lib
             pkgs.libpulseaudio
@@ -114,7 +124,8 @@
           devShells.default = pkgs.mkShell {
             packages = [
               # for running the jar
-              pkgs.jdk17
+              java
+
               # for build
               pkgs.electron
               pkgs.rpm
@@ -139,7 +150,7 @@
             ];
             buildInputs = runtimeLibs;
 
-            JAVA_HOME = "${pkgs.jdk17}/lib/openjdk";
+            JAVA_HOME = "${java}/lib/openjdk";
             USE_SYSTEM_FPM = "true";
             ELECTRON_BUILDER_7ZIP_PATH = "${pkgs.p7zip}/bin/7za";
             APPIMAGE_TOOLS_PATH = "${appImageTools}";

gradle.properties

@@ -17,7 +17,4 @@ kotlinVersion=2.3.10
 spotlessVersion=8.2.1
 shadowJarVersion=9.3.1
 buildconfigVersion=6.0.7
-
-# Fix gradle leaving multiple java processes running that accumulate and use multiple GBs of RAM
-# This mostly seems to affect it when running from console, and then sending a SIGINT (Ctrl + C)
-org.gradle.daemon.idletimeout=10000
+wireVersion=5.3.1

gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.4-bin.zip
-distributionSha256Sum=f1771298a70f6db5a29daf62378c4e18a17fc33c9ba6b14362e0cdf40610380d
+distributionSha256Sum=bbaeb2fef8710818cf0e261201dab964c572f92b942812df0c3620d62a529a01
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.0-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME