Implement MineChat spec v1.0.0, and improve performance & storage

.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Release JAR
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: '21'
+
+      - name: Cache Gradle dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.gradle/caches
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*','**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Build plugin
+        # Pass the tag name into Gradle as "ver"
+        run: ./gradlew build -Pver=${{ github.ref_name }}
+
+      - name: Run tests
+        run: ./gradlew test -Pver=${{ github.ref_name }}
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          draft: true
+          generate_release_notes: true
+          files: build/libs/*.jar
+          preserve_order: false

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace

README.md

@@ -23,7 +23,37 @@ The plugin works by generating temporary codes that players can use to authentic
    - Download the latest release from the [releases](https://github.com/walker84837/MineChat-Server/releases/latest) page.
    - Place the downloaded JAR file into your server's `plugins` directory.
 
-3. **Start Your Server**: Start or restart your Paper server to load the MineChat Server Plugin.
+3. **Generate a TLS keystore**:
+   MineChat requires TLS to be enabled. Generate a self-signed keystore using modern algorithms (EC secp384r1):
+   ```bash
+   keytool -genkeypair \
+     -alias minechat \
+     -keyalg EC \
+     -keysize 384 \
+     -storetype PKCS12 \
+     -keystore keystore.p12 \
+     -validity 3650 \
+     -storepass <your-password> \
+     -keypass <your-password> \
+     -dname "CN=localhost, OU=Dev, O=MineChat, L=City, ST=State, C=US"
+   ```
+
+4. **Configure TLS**:
+   - Copy the generated `keystore.p12` to your server's plugin data folder:
+     ```
+     <server>/plugins/MineChat/keystore.p12
+     ```
+   - Edit the generated `config.yml` in the plugin folder, or create one with:
+     ```yaml
+     port: 25575
+     tls:
+       enabled: true
+       keystore: "keystore.p12"
+       keystore-password: "your-password"
+     ```
+   - **Note**: The server enforces TLS 1.3 for maximum security.
+
+5. **Start Your Server**: Start or restart your Paper server to load the MineChat Server Plugin.
 
 ## Usage
 
@@ -42,13 +72,13 @@ The plugin works by generating temporary codes that players can use to authentic
 
 ## How it works
 
-- **Initial phase**:  
+- **Initial phase**:
   The plugin opens a server socket on port `25575` to listen for connections from MineChat clients.
 
 - **Authentication**:
   - Clients use either a new link code or their stored client UUID to authenticate.
   - Successful authentication triggers in-game notifications (join/leave messages) to all players.
-  
+
 - **Message broadcasting**:
   - The plugin listens for in-game chat events and broadcasts messages to connected clients.
   - Similarly, messages received from clients are broadcast to the Minecraft chat.

build.gradle.kts

@@ -1,11 +1,21 @@
-import java.text.SimpleDateFormat
-import java.util.*
+buildscript {
+    repositories {
+        mavenCentral()
+        maven { url = uri("https://download.objectbox.io/maven") }
+    }
+    dependencies {
+        classpath("io.objectbox:objectbox-gradle-plugin:3.8.0")
+    }
+}
 
 plugins {
-    id("com.gradleup.shadow") version "8.3.6"
-    kotlin("jvm") version "2.1.10"
+    id("com.gradleup.shadow") version "9.3.0"
+    kotlin("jvm") version "2.3.0"
+    kotlin("plugin.serialization") version "2.3.0"
 }
 
+apply(plugin = "io.objectbox")
+
 group = "org.winlogon.minechat"
 
 fun getLatestGitTag(): String? {
@@ -20,7 +30,7 @@ fun getLatestGitTag(): String? {
         } else {
             null
         }
-    } catch (e: Exception) {
+    } catch (_: Exception) {
         null
     }
 }
@@ -52,7 +62,6 @@ repositories {
         url = uri("https://repo.papermc.io/repository/maven-public/")
         content {
             includeModule("io.papermc.paper", "paper-api")
-            includeModule("io.papermc", "paperlib")
             includeModule("net.md-5", "bungeecord-chat")
         }
     }
@@ -65,22 +74,32 @@ repositories {
     }
 
     maven {
-        url = uri("https://libraries.minecraft.net")
+        url = uri("https://maven.winlogon.org/releases")
     }
 
     mavenCentral()
 }
 
 dependencies {
-    compileOnly("io.papermc.paper:paper-api:1.21.4-R0.1-SNAPSHOT")
-    compileOnly("net.kyori:adventure-text-serializer-plain:4.19.0")
-    compileOnly("com.mojang:brigadier:1.1.8")
-    compileOnly("com.github.ben-manes.caffeine:caffeine:3.2.0")
-
-    testRuntimeOnly("org.junit.platform:junit-platform-launcher:1.11.4")
-    testImplementation("io.papermc.paper:paper-api:1.21.4-R0.1-SNAPSHOT")
-    testImplementation("org.junit.jupiter:junit-jupiter:5.11.4")
-    testImplementation("org.jetbrains.kotlin:kotlin-test:2.1.10")
+    compileOnly(libs.caffeine)
+    compileOnly(libs.zstd.jni)
+
+    compileOnly(libs.objectbox.kotlin)
+    compileOnly(libs.paper.api)
+    compileOnly(libs.kotlin.reflect)
+    compileOnly(libs.asynccraftr)
+    implementation(libs.kaml)
+
+    implementation(libs.jackson.dataformat.cbor)
+    implementation(libs.jackson.module.kotlin)
+
+    implementation(libs.kotlinx.serialization.json)
+    implementation(libs.kotlinx.serialization.cbor)
+
+    testRuntimeOnly(libs.junit.platform.launcher)
+    testImplementation(libs.paper.api.test)
+    testImplementation(libs.junit.jupiter)
+    testImplementation(libs.kotlin.test)
 }
 
 tasks.test {
@@ -104,7 +123,6 @@ tasks.shadowJar {
     minimize()
 }
 
-// Disable jar and replace with shadowJar
 tasks.jar {
     enabled = false
 }
@@ -113,7 +131,6 @@ tasks.assemble {
     dependsOn(tasks.shadowJar)
 }
 
-// Utility tasks
 tasks.register("printProjectName") {
     doLast {
         println(projectName)
@@ -131,3 +148,9 @@ tasks.register("release") {
         }
     }
 }
+
+tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>().configureEach {
+    compilerOptions {
+        freeCompilerArgs.add("-Xannotation-default-target=param-property")
+    }
+}

gradle.properties

@@ -1,7 +1,3 @@
-# This file was generated by the Gradle 'init' task.
-# https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties
-
 org.gradle.configuration-cache=false
 org.gradle.parallel=true
 org.gradle.caching=true
-

gradle/libs.versions.toml

@@ -1,2 +1,29 @@
-# This file was generated by the Gradle 'init' task.
-# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format
+[versions]
+kotlinx-serialization-json = "1.10.0"
+kotlinx-serialization-cbor = "1.10.0"
+kaml = "0.102.0"
+caffeine = "3.2.0"
+zstd-jni = "1.5.6-1"
+objectbox = "3.8.0"
+paper = "1.21.6-R0.1-SNAPSHOT"
+kotlin = "2.1.10"
+asynccraftr = "0.1.0"
+jackson = "2.17.1"
+junit = "1.11.4"
+
+[libraries]
+caffeine = { module = "com.github.ben-manes.caffeine:caffeine", version.ref = "caffeine" }
+zstd-jni = { module = "com.github.luben:zstd-jni", version.ref = "zstd-jni" }
+objectbox-kotlin = { module = "io.objectbox:objectbox-kotlin", version.ref = "objectbox" }
+paper-api = { module = "io.papermc.paper:paper-api", version.ref = "paper" }
+kotlin-reflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref = "kotlin" }
+asynccraftr = { module = "org.winlogon:asynccraftr", version.ref = "asynccraftr" }
+kaml = { module = "com.charleskorn.kaml:kaml", version.ref = "kaml" }
+jackson-dataformat-cbor = { module = "com.fasterxml.jackson.dataformat:jackson-dataformat-cbor", version.ref = "jackson" }
+jackson-module-kotlin = { module = "com.fasterxml.jackson.module:jackson-module-kotlin", version.ref = "jackson" }
+kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlinx-serialization-json" }
+kotlinx-serialization-cbor = { module = "org.jetbrains.kotlinx:kotlinx-serialization-cbor", version.ref = "kotlinx-serialization-cbor" }
+junit-platform-launcher = { module = "org.junit.platform:junit-platform-launcher", version.ref = "junit" }
+paper-api-test = { module = "io.papermc.paper:paper-api", version.ref = "paper" }
+junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit" }
+kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME