mirror of
https://git.revela.dev/itsRevela/LCE-Revelations.git
synced 2026-05-21 19:24:55 +00:00
Adds the FourKit .NET 10 plugin host as a second dedicated server
build flavour alongside the existing vanilla server. Both flavours
build from the same source tree, with FourKit gated by the
MINECRAFT_SERVER_FOURKIT_BUILD preprocessor define.
Build layout:
Minecraft.Server vanilla, no plugin support, no .NET dep
Minecraft.Server.FourKit FourKit-enabled, ships with bundled
.NET 10 self-contained runtime in runtime/
and an empty plugins/ folder
Both produce a Minecraft.Server.exe in their own per-target output
dir. The variant identity lives in the directory name, not the
binary name, so either flavour can be shipped as a drop-in.
Native bridge (Minecraft.Server/FourKit*.{cpp,h}):
* FourKitRuntime: hosts CoreCLR via hostfxr's command-line init API
(the runtime-config API does not support self-contained components)
* FourKitBridge: ~50 Fire* event entry points, with inline no-op
stubs for the standalone build so gameplay code can call them
unconditionally
* FourKitNatives: ~80 native callbacks the managed side invokes
for player/world/inventory mutations
* FourKitMappers: type and enum mapping helpers
Managed plugin host (Minecraft.Server.FourKit/):
* Bukkit-style API: Player, World, Block, Inventory, Command,
Listener, EventHandler attribute, ~54 event classes
* PluginLoader with per-plugin AssemblyLoadContext
* FourKitHost as the [UnmanagedCallersOnly] entry point table
* Runtime resolves plugins relative to the host process so they
always live next to Minecraft.Server.exe regardless of where the
managed assembly itself is loaded from
Engine hooks (Minecraft.Client/, Minecraft.World/):
* Player lifecycle (PreLogin, Login, Join, Quit, Kick, Move,
Teleport, Portal, Death) wired into PendingConnection and
PlayerConnection without disturbing the cipher handshake or
identity-token security flow
* Inventory open/click/drop hooks across every container menu type
* Block place/break/grow/burn/spread/from-to hooks across the
full tile family
* Bed enter/leave, sign change, entity damage/death, ender pearl
teleport hooks
Regression fixes preserved while applying donor diffs:
* ServerPlayer::die() retains the LCE-Revelations hardcore branch
(setGameMode(ADVENTURE) + banPlayerForHardcoreDeath) in both the
FourKit and non-FourKit code paths
* ServerLevel::entityAdded() retains the sub-entity ID reassignment
loop required by the client's handleAddMob offset, fixing Ender
Dragon and Wither boss multi-part hit detection
* LivingEntity::travel() retains the raw Player* cast and the
cached frictionTile, both Revelations perf wins that the donor
silently reverted
* ServerLogger.cpp keeps the file-logging code donor stripped
* PlayerList.cpp end portal transition fix and UIScene_EndPoem
bounds-check are intact
Build system:
* Top-level CMakeLists.txt adds the Minecraft.Server.FourKit
subdirectory and pulls in the new shared cmake/ServerTarget.cmake
helper
* Minecraft.Server/cmake/sources/Common.cmake is now location
independent (uses CMAKE_CURRENT_LIST_DIR) so the source list
can be consumed from either server target's CMakeLists.txt
* The seven FourKit*.cpp/h files live in their own
_MINECRAFT_SERVER_COMMON_SERVER_FOURKIT variable so the
standalone target omits them
* configure-time .NET 10 SDK check fails fast with a clear
download link if the SDK is missing
* global.json pins the SDK to 10.0.100 with latestFeature
rollforward
Sample plugin (samples/HelloPlugin/) demonstrates the loader and
the PlayerJoinEvent listener pattern.
CI:
* nightly.yml builds both server flavours, ships
LCE-Revelations-Server-Win64.zip and
LCE-Revelations-Server-Win64-FourKit.zip, attests both, and
updates release notes for the dual-flavour layout
* pull-request.yml pulls in actions/setup-dotnet so the FourKit
publish step works in PR validation
* All zip artifacts and the client zip are renamed from
LCREWindows64 to LCE-Revelations-{Client,Server}-Win64
Documentation:
* COMPILE.md gets a VS 2022 quick start, .NET 10 prereq section,
server flavours explanation, and a troubleshooting section
* docs/FOURKIT_PORT_RECON.md captures the file-by-file recon that
drove the port
* docs/FOURKIT_PARITY.md is the canonical reference for which
events FourKit fires
Docker:
* docker-compose.dedicated-server.yml MC_RUNTIME_DIR default points
at the vanilla CMake output. The FourKit Docker image is
intentionally NOT shipped yet because hosting .NET 10 self
contained inside Wine has not been smoke-tested
365 lines
13 KiB
YAML
365 lines
13 KiB
YAML
name: Nightly Release
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: write
|
|
id-token: write
|
|
attestations: write
|
|
|
|
concurrency:
|
|
group: nightly
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build-client:
|
|
name: Build Client
|
|
runs-on: windows-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v6
|
|
|
|
- name: Setup MSVC
|
|
uses: ilammy/msvc-dev-cmd@v1
|
|
|
|
- name: Setup CMake
|
|
uses: lukka/get-cmake@latest
|
|
|
|
- name: Run CMake
|
|
uses: lukka/run-cmake@v10
|
|
env:
|
|
VCPKG_ROOT: ""
|
|
with:
|
|
configurePreset: windows64
|
|
buildPreset: windows64-release
|
|
buildPresetAdditionalArgs: "['--target', 'Minecraft.Client']"
|
|
|
|
- name: Zip Build
|
|
shell: pwsh
|
|
run: |
|
|
$source = "./build/windows64/Minecraft.Client/Release"
|
|
$zip = "LCE-Revelations-Client-Win64.zip"
|
|
$topLevel = "LCE-Revelations-Client-Win64"
|
|
|
|
# Collect files, excluding unwanted extensions
|
|
$files = Get-ChildItem -Path $source -Recurse -File |
|
|
Where-Object { $_.Extension -notin '.pch', '.zip', '.ipdb', '.iobj' }
|
|
|
|
Add-Type -AssemblyName System.IO.Compression
|
|
Add-Type -AssemblyName System.IO.Compression.FileSystem
|
|
|
|
$basePath = (Resolve-Path $source).Path
|
|
$fs = [System.IO.File]::Open($zip, [System.IO.FileMode]::Create)
|
|
try {
|
|
$archive = New-Object System.IO.Compression.ZipArchive($fs, [System.IO.Compression.ZipArchiveMode]::Create)
|
|
try {
|
|
# Add directories
|
|
Get-ChildItem -Path $basePath -Recurse -Directory | ForEach-Object {
|
|
$rel = $_.FullName.Substring($basePath.Length).TrimStart('\', '/')
|
|
$archive.CreateEntry("$topLevel/$($rel -replace '\\','/')/") | Out-Null
|
|
}
|
|
# Add files
|
|
foreach ($file in $files) {
|
|
$rel = $file.FullName.Substring($basePath.Length).TrimStart('\', '/')
|
|
$entryName = "$topLevel/$($rel -replace '\\','/')"
|
|
[System.IO.Compression.ZipFileExtensions]::CreateEntryFromFile(
|
|
$archive, $file.FullName, $entryName,
|
|
[System.IO.Compression.CompressionLevel]::Optimal
|
|
) | Out-Null
|
|
}
|
|
} finally { $archive.Dispose() }
|
|
} finally { $fs.Dispose() }
|
|
|
|
Write-Host "Created $zip"
|
|
|
|
- name: Stage artifacts
|
|
shell: pwsh
|
|
run: |
|
|
New-Item -ItemType Directory -Force -Path staging
|
|
Copy-Item LCE-Revelations-Client-Win64.zip staging/
|
|
Copy-Item ./build/windows64/Minecraft.Client/Release/Minecraft.Client.exe staging/
|
|
|
|
- name: Upload artifacts
|
|
uses: actions/upload-artifact@v6
|
|
with:
|
|
name: client-build
|
|
path: staging/*
|
|
|
|
build-server:
|
|
name: Build Server
|
|
runs-on: windows-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v6
|
|
|
|
- name: Setup MSVC
|
|
uses: ilammy/msvc-dev-cmd@v1
|
|
|
|
- name: Setup CMake
|
|
uses: lukka/get-cmake@latest
|
|
|
|
- name: Setup .NET
|
|
uses: actions/setup-dotnet@v4
|
|
with:
|
|
global-json-file: global.json
|
|
|
|
- name: Run CMake
|
|
uses: lukka/run-cmake@v10
|
|
env:
|
|
VCPKG_ROOT: ""
|
|
with:
|
|
configurePreset: windows64
|
|
buildPreset: windows64-release
|
|
buildPresetAdditionalArgs: "['--target', 'Minecraft.Server', '--target', 'Minecraft.Server.FourKit']"
|
|
|
|
- name: Zip Build (vanilla)
|
|
shell: pwsh
|
|
run: |
|
|
$source = "./build/windows64/Minecraft.Server/Release"
|
|
$zip = "LCE-Revelations-Server-Win64.zip"
|
|
$topLevel = "LCE-Revelations-Server-Win64"
|
|
|
|
$files = Get-ChildItem -Path $source -Recurse -File |
|
|
Where-Object { $_.Extension -notin '.pch', '.zip', '.ipdb', '.iobj' }
|
|
|
|
Add-Type -AssemblyName System.IO.Compression
|
|
Add-Type -AssemblyName System.IO.Compression.FileSystem
|
|
|
|
$basePath = (Resolve-Path $source).Path
|
|
$fs = [System.IO.File]::Open($zip, [System.IO.FileMode]::Create)
|
|
try {
|
|
$archive = New-Object System.IO.Compression.ZipArchive($fs, [System.IO.Compression.ZipArchiveMode]::Create)
|
|
try {
|
|
Get-ChildItem -Path $basePath -Recurse -Directory | ForEach-Object {
|
|
$rel = $_.FullName.Substring($basePath.Length).TrimStart('\', '/')
|
|
$archive.CreateEntry("$topLevel/$($rel -replace '\\','/')/") | Out-Null
|
|
}
|
|
foreach ($file in $files) {
|
|
$rel = $file.FullName.Substring($basePath.Length).TrimStart('\', '/')
|
|
$entryName = "$topLevel/$($rel -replace '\\','/')"
|
|
[System.IO.Compression.ZipFileExtensions]::CreateEntryFromFile(
|
|
$archive, $file.FullName, $entryName,
|
|
[System.IO.Compression.CompressionLevel]::Optimal
|
|
) | Out-Null
|
|
}
|
|
} finally { $archive.Dispose() }
|
|
} finally { $fs.Dispose() }
|
|
|
|
Write-Host "Created $zip"
|
|
|
|
- name: Zip Build (FourKit)
|
|
shell: pwsh
|
|
run: |
|
|
$source = "./build/windows64/Minecraft.Server.FourKit/Release"
|
|
$zip = "LCE-Revelations-Server-Win64-FourKit.zip"
|
|
$topLevel = "LCE-Revelations-Server-Win64-FourKit"
|
|
|
|
$files = Get-ChildItem -Path $source -Recurse -File |
|
|
Where-Object { $_.Extension -notin '.pch', '.zip', '.ipdb', '.iobj' }
|
|
|
|
Add-Type -AssemblyName System.IO.Compression
|
|
Add-Type -AssemblyName System.IO.Compression.FileSystem
|
|
|
|
$basePath = (Resolve-Path $source).Path
|
|
$fs = [System.IO.File]::Open($zip, [System.IO.FileMode]::Create)
|
|
try {
|
|
$archive = New-Object System.IO.Compression.ZipArchive($fs, [System.IO.Compression.ZipArchiveMode]::Create)
|
|
try {
|
|
Get-ChildItem -Path $basePath -Recurse -Directory | ForEach-Object {
|
|
$rel = $_.FullName.Substring($basePath.Length).TrimStart('\', '/')
|
|
$archive.CreateEntry("$topLevel/$($rel -replace '\\','/')/") | Out-Null
|
|
}
|
|
foreach ($file in $files) {
|
|
$rel = $file.FullName.Substring($basePath.Length).TrimStart('\', '/')
|
|
$entryName = "$topLevel/$($rel -replace '\\','/')"
|
|
[System.IO.Compression.ZipFileExtensions]::CreateEntryFromFile(
|
|
$archive, $file.FullName, $entryName,
|
|
[System.IO.Compression.CompressionLevel]::Optimal
|
|
) | Out-Null
|
|
}
|
|
} finally { $archive.Dispose() }
|
|
} finally { $fs.Dispose() }
|
|
|
|
Write-Host "Created $zip"
|
|
|
|
- name: Stage artifacts
|
|
shell: pwsh
|
|
run: |
|
|
New-Item -ItemType Directory -Force -Path staging
|
|
Copy-Item LCE-Revelations-Server-Win64.zip staging/
|
|
Copy-Item LCE-Revelations-Server-Win64-FourKit.zip staging/
|
|
|
|
- name: Upload artifacts
|
|
uses: actions/upload-artifact@v6
|
|
with:
|
|
name: server-build
|
|
path: staging/*
|
|
|
|
release-server:
|
|
name: Release Server
|
|
needs: build-server
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v6
|
|
|
|
- name: Download server artifacts
|
|
uses: actions/download-artifact@v7
|
|
with:
|
|
name: server-build
|
|
path: artifacts
|
|
|
|
- name: Attest artifacts
|
|
uses: actions/attest-build-provenance@v2
|
|
with:
|
|
subject-path: |
|
|
artifacts/LCE-Revelations-Server-Win64.zip
|
|
artifacts/LCE-Revelations-Server-Win64-FourKit.zip
|
|
|
|
- name: Get short SHA
|
|
id: sha
|
|
run: echo "short=$(echo '${{ github.sha }}' | cut -c1-7)" >> "$GITHUB_OUTPUT"
|
|
|
|
- name: Delete old release
|
|
env:
|
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
run: gh release delete Nightly-Dedicated-Server --yes || true
|
|
|
|
- name: Delete old tag
|
|
env:
|
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
run: gh api repos/${{ github.repository }}/git/refs/tags/Nightly-Dedicated-Server --method DELETE || true
|
|
|
|
- name: Import GPG key
|
|
uses: crazy-max/ghaction-import-gpg@v6
|
|
with:
|
|
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
|
|
passphrase: ${{ secrets.GPG_PASSPHRASE }}
|
|
git_user_signingkey: true
|
|
git_tag_gpgsign: true
|
|
|
|
- name: Create signed tag
|
|
run: |
|
|
git tag -s -f Nightly-Dedicated-Server -m "Nightly server release ${{ steps.sha.outputs.short }}"
|
|
git push origin Nightly-Dedicated-Server --force
|
|
|
|
- name: Create release
|
|
env:
|
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
run: |
|
|
gh release create Nightly-Dedicated-Server artifacts/* \
|
|
--title "Server: ${{ steps.sha.outputs.short }}" \
|
|
--notes "Dedicated Server runtime for Windows64.
|
|
|
|
Two flavours are attached:
|
|
- \`LCE-Revelations-Server-Win64.zip\`: vanilla server, no plugin support, smallest download.
|
|
- \`LCE-Revelations-Server-Win64-FourKit.zip\`: server with the FourKit plugin host, bundled .NET 10 runtime, and an empty \`plugins/\` folder ready for plugin authors to drop DLLs into.
|
|
|
|
Pick the flavour you want and extract it to a folder where you'd like to keep the server runtime." \
|
|
--latest=false
|
|
|
|
release-client:
|
|
name: Release Client
|
|
needs: [build-client, release-server]
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v6
|
|
|
|
- name: Download client artifacts
|
|
uses: actions/download-artifact@v7
|
|
with:
|
|
name: client-build
|
|
path: artifacts
|
|
|
|
- name: Attest artifacts
|
|
uses: actions/attest-build-provenance@v2
|
|
with:
|
|
subject-path: |
|
|
artifacts/LCE-Revelations-Client-Win64.zip
|
|
artifacts/Minecraft.Client.exe
|
|
|
|
- name: Get short SHA
|
|
id: sha
|
|
run: echo "short=$(echo '${{ github.sha }}' | cut -c1-7)" >> "$GITHUB_OUTPUT"
|
|
|
|
- name: Delete old release
|
|
env:
|
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
run: gh release delete Nightly --yes || true
|
|
|
|
- name: Delete old tag
|
|
env:
|
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
run: gh api repos/${{ github.repository }}/git/refs/tags/Nightly --method DELETE || true
|
|
|
|
- name: Import GPG key
|
|
uses: crazy-max/ghaction-import-gpg@v6
|
|
with:
|
|
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
|
|
passphrase: ${{ secrets.GPG_PASSPHRASE }}
|
|
git_user_signingkey: true
|
|
git_tag_gpgsign: true
|
|
|
|
- name: Create signed tag
|
|
run: |
|
|
git tag -s -f Nightly -m "Nightly release ${{ steps.sha.outputs.short }}"
|
|
git push origin Nightly --force
|
|
|
|
- name: Write release notes
|
|
run: |
|
|
cat > notes.md <<'NOTES'
|
|
# Instructions:
|
|
**Newcomers:**
|
|
- If this is your first time, download `LCE-Revelations-Client-Win64.zip` and extract it wherever you would like to keep it.
|
|
- I would recommend to set your username prior to launch (create a file called `username.txt`, put your desired username into the file, and save).
|
|
- To play, simply run `Minecraft.Client.exe`.
|
|
|
|
**For those that wish to update their existing installation with the latest build:**
|
|
- Download `Minecraft.Client.exe` and `Minecraft.Client.pdb` and copy them over to your existing LCE-Revelations-Client-Win64 build (overwrite your old version of Minecraft.Client.exe and Minecraft.Client.pdb).
|
|
|
|
**Steam Deck & Linux:**
|
|
- Y'all know the drill. Download the `LCE-Revelations-Client-Win64.zip`, extract it, add the `Minecraft.Client.exe` as a "Non-Steam Game" within the Steam library, turn on compatibility mode with Proton Experimental, and then run it!
|
|
|
|
# Multiplayer instructions:
|
|
LAN games are natively supported, and any LAN games will appear automatically on the right. However, if you'd like to play with your friends online (and if you don't want to require them to setup a vpn, and/or if you don't want to port forward), I would recommend the following setup. Please keep in mind, you do NOT need to do this to enjoy the game. This is just how I have it setup for me so my friends can join without any hassle:
|
|
|
|
Prerequisites:
|
|
- Premium playit.gg account, costs about $3 USD per month. This is for setting up the tunnel.
|
|
- playit.gg agent installed on host PC.
|
|
|
|
How-to:
|
|
- Ensure your playit.gg agent is connected to your playit.gg account
|
|
- On the playit.gg website, setup a new tunnel (choose TCP). Ensure the configurable settings are set to the below values, assuming your agent is installed on the same computer as your online LCE Revelations game is hosted from.
|
|
- Configurable settings:
|
|
- Local IP: `127.0.0.1`
|
|
- Local Port: `25565`
|
|
- Proxy Protocol: `None`
|
|
- After creating your tunnel, navigate to the "Tunnels" main page. You'll see the IP address and port for your tunnel. This is what your friends will input when adding your server in order to join your online game!
|
|
NOTES
|
|
|
|
- name: Create release
|
|
env:
|
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
run: |
|
|
gh release create Nightly artifacts/* \
|
|
--title "Client: ${{ steps.sha.outputs.short }}" \
|
|
--notes-file notes.md
|
|
|
|
cleanup:
|
|
needs: [release-client, release-server]
|
|
if: always()
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Cleanup artifacts
|
|
uses: geekyeggo/delete-artifact@v5
|
|
with:
|
|
name: |
|
|
client-build
|
|
server-build
|