add bundled JRE support with custom sbt jlink plugin

.github/workflows/release.yaml

@@ -7,6 +7,7 @@ on:
     branches: [ "master" ]
 
   # Allows you to run this workflow manually from the Actions tab
+    branches: ["master"]
   workflow_dispatch:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
@@ -19,19 +20,19 @@ jobs:
       GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
       EXCLUDE_TEST_TAG: moe.brianhsu.AudioOutputTest
     container:
-      image: openjdk:11
+      image: openjdk:17-slim-bullseye
     steps:
       - uses: actions/checkout@v3
       - name: Install packages
         run: |
           apt-get update -yqq
-          apt-get install apt-transport-https -yqq
+          apt-get install -yqq apt-transport-https curl gnupg
           echo "deb https://repo.scala-sbt.org/scalasbt/debian all main" | tee /etc/apt/sources.list.d/sbt.list
           echo "deb https://repo.scala-sbt.org/scalasbt/debian /" | tee /etc/apt/sources.list.d/sbt_old.list
           curl -sL "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x2EE0EA64E40A89B84B2DF73499E82A75642AC823" | apt-key add
           apt-get update
           apt-get -y install sbt
-          apt-get -y install xorg-dev libglu1-mesa libgl1-mesa-dev xvfb libxinerama1 libxcursor1 libswt-gtk-4-java libswt-gtk-4-jni libxml2-utils bc zip
+          apt-get -y install xorg-dev libglu1-mesa libgl1-mesa-dev xvfb libxinerama1 libxcursor1 libswt-gtk-4-java libswt-gtk-4-jni libxml2-utils bc zip gnupg
 
       - name: Setup Git Information
         run: |
@@ -45,15 +46,15 @@ jobs:
 
       - name: Archive Test Results
         if: always()
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           name: test-results
           path: target/test-reports-html/
 
       - name: Set Coverage rate for badges
         id: CoverageExport
         run: |
-          echo "::set-output name=COVERAGE_RATE::$(xmllint --xpath "string(/scoverage/@branch-rate)" target/scala-2.13/scoverage-report/scoverage.xml)"
+          echo "COVERAGE_RATE=$(xmllint --xpath "string(/scoverage/@branch-rate)" target/scala-2.13/scoverage-report/scoverage.xml)" >> $GITHUB_OUTPUT
 
       - name: Release
         run: |
@@ -63,7 +64,7 @@ jobs:
       - name: Export Version
         id: VersionExport
         run: |
-          echo "::set-output name=CURRENT_VERSION::$(git tag | tail -n1)"
+          echo "CURRENT_VERSION=$(git tag | tail -n1)" >> $GITHUB_OUTPUT
 
       - name: Prepare mvn repository
         run: |
@@ -94,6 +95,8 @@ jobs:
           message: Update badages for ${{ steps.VersionExport.outputs.CURRENT_VERSION }}
 
       - name: Assembly JAR
+          apt-get -y install xorg-dev libglu1-mesa libgl1-mesa-dev xvfb libxinerama1 libxcursor1 libswt-gtk-4-java libswt-gtk-4-jni libxml2-utils bc
+      - name: Compile and Test
         run: |
           ./distclean
           sbt clean assembly
@@ -104,19 +107,19 @@ jobs:
 
 
       - name: Upload Swing Version
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           name: Live2DForScala-Swing
           path: Live2DForScala-Swing-${{ steps.VersionExport.outputs.CURRENT_VERSION }}.zip
 
       - name: Upload SWT Linux Version
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           name: Live2DForScala-SWT-Linux
           path: Live2DForScala-SWT-Linux-${{ steps.VersionExport.outputs.CURRENT_VERSION }}.tar.gz
 
       - name: Upload SWT Windows Version
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           name: Live2DForScala-SWT-Windows
           path: Live2DForScala-SWT-Windows-${{ steps.VersionExport.outputs.CURRENT_VERSION }}.zip
@@ -128,3 +131,4 @@ jobs:
           branch: ${{ github.ref }}
 
 
+          xvfb-run --auto-servernum sbt compile test

.github/workflows/unitTest.yaml

@@ -20,13 +20,13 @@ jobs:
       GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
       EXCLUDE_TEST_TAG: moe.brianhsu.AudioOutputTest  
     container:
-      image: openjdk:11
+      image: openjdk:17-slim-bullseye
     steps:
       - uses: actions/checkout@v3
       - name: Install packages
         run: |
           apt-get update -yqq
-          apt-get install apt-transport-https -yqq
+          apt-get install -yqq apt-transport-https curl gnupg
           echo "deb https://repo.scala-sbt.org/scalasbt/debian all main" | tee /etc/apt/sources.list.d/sbt.list
           echo "deb https://repo.scala-sbt.org/scalasbt/debian /" | tee /etc/apt/sources.list.d/sbt_old.list
           curl -sL "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x2EE0EA64E40A89B84B2DF73499E82A75642AC823" | apt-key add
@@ -39,7 +39,7 @@ jobs:
 
       - name: Archive Test Results
         if: always()
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           name: test-results
           path: target/test-reports-html/

Developing_Guideline.md

@@ -0,0 +1,109 @@
+#  Developing Guideline
+
+This guide describes how to build, test, and contribute to the Live2D For Scala forked project.
+
+---
+
+##  Prerequisites
+
+- **Java Development Kit (JDK) 21**
+  - Windows: [Microsoft Build of OpenJDK](https://learn.microsoft.com/en-us/java/openjdk/download)
+  - Linux: Install via your distro's package manager
+  - macOS: `brew install openjdk@21`
+
+- **SBT (Scala Build Tool)**
+  - Installation guide: [https://www.scala-sbt.org/download.html](https://www.scala-sbt.org/download.html)
+
+---
+
+##  Build & Test Instructions
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/jjiill888/Live2DForScala.git
+cd Live2DForScala
+```
+
+### 2. Run SBT Console
+
+```bash
+sbt
+```
+
+### 3. Compile the Code
+
+```sbt
+compile
+```
+
+### 4. Run Unit Tests
+
+```sbt
+test
+```
+
+> ⚠ On macOS, SWT + LWJGL-based tests may fail due to platform limitations.
+
+---
+
+##  Running Demo Applications
+
+Inside the SBT console, use:
+
+```sbt
+exampleSwing/run         # Run Swing version
+exampleSWTLinux/run      # Run SWT version on Linux
+exampleSWTWin/run        # Run SWT version on Windows
+```
+
+---
+
+##  Packaging with Assembly
+
+To generate executable JAR files:
+
+```sbt
+exampleSwing/assembly
+exampleSWTLinux/assembly
+exampleSWTWin/assembly
+```
+
+---
+
+##  Creating a Release Package
+
+To bundle the app with dependencies and OpenSeeFace face tracking engine:
+
+```sbt
+releaseswing     # Swing version
+releaselinux     # SWT Linux version
+releasewin       # SWT Windows version
+```
+
+You may ignore errors related to existing directories on reruns.
+
+---
+
+##  Project Structure Overview
+
+```
+modules/
+├── core              # Core rendering and Live2D logic
+├── joglBinding       # JOGL OpenGL binding
+├── lwjglBinding      # LWJGL binding
+├── swtBinding        # SWT integration
+└── examples/
+    ├── swing         # Swing-based demo
+    ├── swt           # SWT-based demo
+    └── swt-*-bundle  # Platform-specific bundles
+```
+
+---
+
+##  Notes
+
+- Make sure your JDK version is 21 (some modules may not run correctly on older versions).
+- First SBT run may take a while as it downloads dependencies.
+
+For more details, see: [`Old_README.md`](./Old_README.md)

LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2022 Brian Hsu
+MIT License
+
+Copyright (c) 2025 jjiill888
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -16,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.