Run the Minecraft client inside your CI/CD pipeline.
-
@@ -31,7 +31,7 @@ This way you can already run simple boot tests, checking whether the game will b
Mods for newer versions also execute all [gametests](https://www.minecraft.net/en-us/creator/article/get-started-gametest-framework)
registered.
-Mc-Runtime-Test currently supports the following Minecraft versions and modloaders:
+MC-Runtime-Test currently supports the following Minecraft versions and modloaders:
You can configure it to use any other version, but in that case you need to set `mc-runtime-test` to `none` and provide another way for the game to exit, or the workflow will run indefinitely.
@@ -59,11 +59,19 @@ name: Run the MC client
on:
workflow_dispatch:
+env:
+ java_version: 21
+
jobs:
run:
runs-on: ubuntu-latest
steps:
- # ... run actions to build your client
+ - name: Install Java
+ uses: actions/setup-java@v4
+ with:
+ java-version: ${{ env.java_version }}
+ distribution: "temurin"
+ # ... run actions to build your mod
# Copy the jar that you build to the mods folder
- name: Copy mod jar to mods
run: mkdir -p run/mods && cp build/libs/.jar run/mods
@@ -75,7 +83,7 @@ jobs:
modloader: fabric
regex: .*fabric.*
mc-runtime-test: fabric
- java: 17
+ java: ${{ env.java_version }}
```
An example workflow in action can be found
[here](https://github.com/3arthqu4ke/hmc-optimizations/blob/1.20.4/.github/workflows/run-fabric.yml).
@@ -89,7 +97,6 @@ at once can be found
- `modloader`: The modloader to install with HeadlessMC (`forge`, `neoforge` or `fabric`).
- `regex`: A Regex to match the MC version to launch (can in most cases just be `.*.*`, like `.*fabric.*`, very old versions of forge might start with an uppercase `Forge`).
- `java`: The Java version to use, e.g. `17`.
-- `java-distribution`: The [Java distribution](https://github.com/actions/setup-java?tab=readme-ov-file#supported-distributions) to use, by default we use the adopt distribution.
- `dummy-assets`: HeadlessMC will use dummy assets to not download all the MC assets. Can be disabled by setting this to `false`.
- `mc-runtime-test`: The MC-Runtime-Test jar to download (`none`, `lexforge`, `fabric` or `neoforge`). When using `none` you need to provide a way for the game to exit or the action will run indefinitely and time out.
- `xvfb`: If `true` (default), runs the game with Xvfb, if false, you should probably use the -lwjgl option in headlessmc.
@@ -101,8 +108,7 @@ at once can be found
# Running your own tests
MC-Runtime-Test does not provide a framework for full integration tests.
-You can, however,
-use Minecrafts own [Game-Test Framework](https://www.minecraft.net/en-us/creator/article/get-started-gametest-framework).
+You can, however, use Minecrafts own [Game-Test Framework](https://www.minecraft.net/en-us/creator/article/get-started-gametest-framework).
MC-Runtime-Test will basically execute the `/test runall` command after joining the world.
On Neoforge/Lexforge gametest discovery does really not work in production, you might need to register
them themselves and use other [hacks](gametest/src/main/java/me/earth/clientgametest/mixin/MixinGameTestRegistry.java)
diff --git a/action.yml b/action.yml
index f453e95..190a99e 100644
--- a/action.yml
+++ b/action.yml
@@ -1,5 +1,5 @@
-name: 'Mc-Runtime-Test'
-description: 'Runs the MC client inside your CI.'
+name: MC-Runtime-Test
+description: Runs the MC client inside your CI
author: 3arthqu4ke
branding:
icon: play
@@ -7,133 +7,140 @@ branding:
inputs:
mc:
- description: 'The MC version to run'
+ description: Minecraft version to run
required: true
- default: '1.20.4'
+ default: "1.20.4"
modloader:
- description: 'The modloader to install with HeadlessMc (forge, neoforge or fabric)'
+ description: Modloader to install (forge, neoforge, fabric)
required: true
- default: 'fabric'
+ default: "fabric"
regex:
- description: 'Regex to match the MC version to launch (forge is like 1.20.4-forge and fabric starts with fabric-1.20)'
+ description: Regex to match the modloader jar
required: true
- default: '.*fabric.*'
+ default: ".*fabric.*"
java:
- description: 'The Java version to use'
+ description: Java version to use
required: true
- default: '17'
- java-distribution:
- description: 'The Java distribution to use'
- required: false
- default: 'adopt'
+ default: "17"
dummy-assets:
- description: 'Whether to use Dummy Assets or not'
+ description: Use dummy assets during testing
required: true
- default: 'true'
+ default: "true"
mc-runtime-test:
- description: 'The mc-runtime-test jar to download (none, lexforge, fabric or neoforge)'
+ description: MC-Runtime-Test jar to download (none, lexforge, neoforge, fabric)
required: true
- default: 'fabric'
+ default: "fabric"
xvfb:
- description: 'Runs the game with Xvfb, if false, you should probably use the -lwjgl option in headlessmc.'
+ description: Runs the game with Xvfb (if false, add the -lwjgl argument)
required: false
- default: 'true'
+ default: "true"
headlessmc-command:
- description: 'Arguments for the headlessmc command.'
+ description: Command-line arguments for HeadlessMC
required: false
- default: '--jvm -Djava.awt.headless=true'
+ default: "--jvm -Djava.awt.headless=true"
fabric-api:
- description: 'Downloads the Fabric-API from https://maven.fabricmc.net/. Supply the version (e.g. 0.97.0, or none)'
+ description: Fabric API version to download (e.g. 0.97.0) or none
required: false
- default: 'none'
+ default: "none"
fabric-gametest-api:
- description: 'Downloads the Fabric-GameTest-API from https://maven.fabricmc.net/. Supply the version (e.g. 1.3.5+85d85a934f, or none)'
+ description: Fabric GameTest API version (e.g. 1.3.5+85d85a934f) or none
required: false
- default: 'none'
+ default: "none"
download-hmc:
- description: 'Whether to download headlessmc or not, if not you need to provide a file called headlessmc-launcher.jar.'
+ description: Download HeadlessMC
required: false
- default: 'true'
+ default: "true"
hmc-version:
- description: 'The version of headlessmc to download.'
+ description: HeadlessMC version
+ required: false
+ default: "2.4.1"
+ cache-mc:
+ description: Cache .minecraft
required: false
- default: '2.4.1'
+ default: "true"
runs:
- using: "composite"
+ using: composite
steps:
- - uses: actions/setup-java@v4
- with:
- java-version: ${{ inputs.java }}
- distribution: ${{ inputs.java-distribution }}
- - name: Setup HeadlessMC directory
- run: mkdir HeadlessMC
- shell: bash
- - name: Configure HeadlessMC java versions
- run: echo hmc.java.versions=$JAVA_HOME/bin/java > HeadlessMC/config.properties
- shell: bash
- - name: Configure HeadlessMC game directory
- run: echo hmc.gamedir=$PWD/run >> HeadlessMC/config.properties
- shell: bash
- - name: Configure offline mode
- run: echo hmc.offline=true >> HeadlessMC/config.properties
- shell: bash
- - name: Configure Exceptions
- run: echo hmc.rethrow.launch.exceptions=true >> HeadlessMC/config.properties
- shell: bash
- - name: Configure Failing on wrong command
- run: echo hmc.exit.on.failed.command=true >> HeadlessMC/config.properties
+ - name: Bootstrap HeadlessMC
+ run: |
+ mkdir -p HeadlessMC run/mods
+ cat <> HeadlessMC/config.properties
+ hmc.java.versions=$JAVA_HOME/bin/java
+ hmc.gamedir=$PWD/run
+ hmc.offline=true
+ hmc.rethrow.launch.exceptions=true
+ hmc.exit.on.failed.command=true
+ EOF
shell: bash
- - name: Configure Dummy Assets
- if: ${{ inputs.dummy-assets == 'true' }}
+
+ - if: inputs.dummy-assets == 'true'
+ name: Configure Dummy Assets
run: echo hmc.assets.dummy=true >> HeadlessMC/config.properties
shell: bash
- - name: Get HeadlessMC
- if: ${{ inputs.download-hmc == 'true' }}
- run: wget -O headlessmc-launcher.jar https://github.com/3arthqu4ke/headlessmc/releases/download/${{ inputs.hmc-version }}/headlessmc-launcher-${{ inputs.hmc-version }}.jar
- shell: bash
- - name: Download ${{ inputs.mc }}
- run: java -jar headlessmc-launcher.jar --command download ${{ inputs.mc }}
- shell: bash
- - name: Download Fabric ${{ inputs.mc }}
- run: java -jar headlessmc-launcher.jar --command ${{ inputs.modloader }} ${{ inputs.mc }} --java ${{ inputs.java }}
- shell: bash
- - name: List versions
- run: java -jar headlessmc-launcher.jar --command versions
- shell: bash
- - name: Make mods dir
- run: mkdir -p run/mods
- shell: bash
- - name: Download mc-runtime-test jar ${{ inputs.mc-runtime-test }}
- if: ${{ inputs.mc-runtime-test != 'none' }}
- run: wget -O run/mods/mc-runtime-test-${{ inputs.mc }}-2.4.2-${{ inputs.mc-runtime-test }}-release.jar https://github.com/3arthqu4ke/mc-runtime-test/releases/download/2.4.2/mc-runtime-test-${{ inputs.mc }}-2.4.2-${{ inputs.mc-runtime-test }}-release.jar
- shell: bash
- - name: Download fabric-api jar ${{ inputs.fabric-api }}
- if: ${{ inputs.fabric-api != 'none' }}
- run: wget -O run/mods/fabric-api-${{ inputs.fabric-api }}+${{ inputs.mc }}.jar https://maven.fabricmc.net/net/fabricmc/fabric-api/fabric-api/${{ inputs.fabric-api }}+${{ inputs.mc }}/fabric-api-${{ inputs.fabric-api }}+${{ inputs.mc }}.jar
- shell: bash
- - name: Download fabric-gametest-api jar ${{ inputs.fabric-gametest-api }}
- if: ${{ inputs.fabric-gametest-api != 'none' }}
- run: wget -O run/mods/fabric-gametest-api-v1-${{ inputs.fabric-gametest-api }}.jar https://maven.fabricmc.net/net/fabricmc/fabric-api/fabric-gametest-api-v1/${{ inputs.fabric-gametest-api }}/fabric-gametest-api-v1-${{ inputs.fabric-gametest-api }}.jar
- shell: bash
- - name: Configure Accessibility
- run: echo onboardAccessibility:false >> run/options.txt
+
+ - if: inputs.download-hmc == 'true'
+ name: Get HeadlessMC
+ uses: robinraju/release-downloader@v1.11
+ with:
+ repository: 3arthqu4ke/headlessmc
+ tag: ${{ inputs.hmc-version }}
+ fileName: headlessmc-launcher-${{ inputs.hmc-version }}.jar
+
+ - if: inputs.cache-mc == 'true'
+ name: Cache Minecraft
+ uses: actions/cache@v4
+ with:
+ path: /home/runner/.minecraft
+ key: hmc-${{ inputs.modloader }}-${{ inputs.mc }}
+
+ - name: Download ${{ inputs.modloader }}-${{ inputs.mc }}
+ run: |
+ if [ ! -f "$HOME/.minecraft/versions/${{ inputs.mc }}/${{ inputs.mc }}.json" ]; then
+ java -jar headlessmc-launcher-${{ inputs.hmc-version }}.jar --command download ${{ inputs.mc }}
+ java -jar headlessmc-launcher-${{ inputs.hmc-version }}.jar --command ${{ inputs.modloader }} ${{ inputs.mc }} --java ${{ inputs.java }}
+ fi
shell: bash
- - name: Configure pauseOnLostFocus
- run: echo pauseOnLostFocus:false >> run/options.txt
+
+ - if: inputs.mc-runtime-test != 'none'
+ name: Get mc-runtime-test
+ uses: robinraju/release-downloader@v1.11
+ with:
+ repository: 3arthqu4ke/mc-runtime-test
+ tag: "2.4.2"
+ fileName: mc-runtime-test-${{ inputs.mc }}-2.4.2-${{ inputs.mc-runtime-test }}-release.jar
+ out-file-path: run/mods
+
+ - if: inputs.fabric-api != 'none'
+ name: Download fabric-api v${{ inputs.fabric-api }}
+ run: >
+ wget -O run/mods/fabric-api-${{ inputs.fabric-api }}+${{ inputs.mc }}.jar
+ https://maven.fabricmc.net/net/fabricmc/fabric-api/fabric-api/${{ inputs.fabric-api }}+${{ inputs.mc }}/fabric-api-${{ inputs.fabric-api }}+${{ inputs.mc }}.jar
shell: bash
- - name: LS mods dir
- run: ls run/mods
+
+ - if: inputs.fabric-gametest-api != 'none'
+ name: Download fabric-gametest-api v${{ inputs.fabric-gametest-api }}
+ run: >
+ wget -O run/mods/fabric-gametest-api-v1-${{ inputs.fabric-gametest-api }}.jar
+ https://maven.fabricmc.net/net/fabricmc/fabric-api/fabric-gametest-api-v1/${{ inputs.fabric-gametest-api }}/fabric-gametest-api-v1-${{ inputs.fabric-gametest-api }}.jar
shell: bash
- - name: Install xrandr
- if: ${{ inputs.xvfb == 'true' }}
- run: sudo apt install x11-xserver-utils
+
+ - name: Configure game
+ run: |
+ cat <> run/options.txt
+ onboardAccessibility:false
+ pauseOnLostFocus:false
+ EOF
shell: bash
- - name: Run game with xvfb
- if: ${{ inputs.xvfb == 'true' }}
- run: xvfb-run java -Dhmc.check.xvfb=true -jar headlessmc-launcher.jar --command launch ${{ inputs.regex }} -regex ${{ inputs.headlessmc-command }}
+
+ - if: inputs.xvfb == 'true'
+ name: Run game with xvfb
+ run: |
+ sudo DEBIAN_FRONTEND=noninteractive apt-get install -y x11-xserver-utils
+ xvfb-run java -Dhmc.check.xvfb=true -jar headlessmc-launcher-${{ inputs.hmc-version }}.jar --command launch ${{ inputs.regex }} -regex ${{ inputs.headlessmc-command }}
shell: bash
- - name: Run game
- if: ${{ inputs.xvfb != 'true' }}
- run: java -jar headlessmc-launcher.jar --command launch ${{ inputs.regex }} -regex ${{ inputs.headlessmc-command }}
+
+ - if: inputs.xvfb != 'true'
+ name: Run game
+ run: java -jar headlessmc-launcher-${{ inputs.hmc-version }}.jar --command launch ${{ inputs.regex }} -regex ${{ inputs.headlessmc-command }}
shell: bash
diff --git a/api/build.gradle b/api/build.gradle
index f476022..74fd324 100644
--- a/api/build.gradle
+++ b/api/build.gradle
@@ -37,7 +37,7 @@ afterEvaluate {
name = 'GithubPagesMaven'
url = System.getenv('DEPLOY_TO_GITHUB_PACKAGES_URL')
credentials {
- username = System.getenv('GITHUB_USER')
+ username = System.getenv('GITHUB_ACTOR')
password = System.getenv('GITHUB_TOKEN')
}
}
diff --git a/api/gradlew b/api/gradlew
old mode 100644
new mode 100755
diff --git a/gametest/gradlew b/gametest/gradlew
old mode 100644
new mode 100755
diff --git a/snapshots/gradlew b/snapshots/gradlew
old mode 100644
new mode 100755