mirror of
https://github.com/BluTac10/Xbox-Neo.git
synced 2026-05-24 20:04:41 +00:00
42a582fb9f
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
5.1 KiB
5.1 KiB
FourKit Event Parity
Records which FourKit events ship in this build, mapped to the native hook sites that fire them. This document is the canonical reference for plugin authors: if an event is listed here, you can subscribe to it. Use the donor reference for the upstream FourKit event catalog if you need a richer description of any specific event.
The Phase 1 reconnaissance showed that every donor hook-bearing source file in this repo was byte-identical to vanilla, so the donor's full set of hooks was applied to LCE-Revelations without policy-driven deferrals. Status is PORTED for everything below.
Server lifecycle
| Event | Native hook site | Status |
|---|---|---|
FourKitBridge::Initialize |
Minecraft.Server/Windows64/ServerMain.cpp post-startup |
PORTED |
FourKitBridge::Shutdown |
Minecraft.Server/Windows64/ServerMain.cpp early-shutdown |
PORTED |
FireWorldSave |
ServerMain.cpp autosave trigger |
PORTED |
Player lifecycle
| Event | Native hook site | Status |
|---|---|---|
FirePlayerPreLogin |
Minecraft.Client/PendingConnection.cpp::handlePreLogin |
PORTED |
FirePlayerLogin (offline) |
Minecraft.Client/PendingConnection.cpp::handleLogin |
PORTED |
FirePlayerLogin (online) |
Minecraft.Client/PendingConnection.cpp::handleAcceptedLogin |
PORTED |
FirePlayerJoin |
Minecraft.Client/PlayerConnection.cpp::tick (first-tick gated by hasDoneFirstTickFourKit) |
PORTED |
FirePlayerKick |
PlayerConnection.cpp::disconnect |
PORTED |
FirePlayerQuit |
PlayerConnection.cpp::disconnect and onDisconnect paths |
PORTED |
UpdatePlayerEntityId |
Two respawn(...) sites in PlayerConnection.cpp |
PORTED |
FirePlayerMove |
PlayerConnection.cpp::handleMovePlayer |
PORTED |
Player gameplay
| Event | Native hook site | Status |
|---|---|---|
FirePlayerChat |
PlayerConnection.cpp::handleChat |
PORTED |
FireCommandPreprocess |
PlayerConnection.cpp::handleCommand |
PORTED |
HandlePlayerCommand |
PlayerConnection.cpp::handleCommand |
PORTED |
FirePlayerInteract (USE_ITEM) |
handleUseItem (face == 255) |
PORTED |
FirePlayerInteract (RIGHT_CLICK_BLOCK) |
handleUseItem (face != 255) |
PORTED |
FireBlockPlace |
handleUseItem post useItemOn |
PORTED |
FirePlayerInteract (LEFT_CLICK_BLOCK) |
handlePlayerAction::START_DESTROY_BLOCK |
PORTED |
FirePlayerInteract (LEFT_CLICK_AIR) |
handleAnimate::SWING |
PORTED |
FirePlayerInteractEntity |
handleInteract::INTERACT (uses MapEntityType) |
PORTED |
FirePlayerDropItem |
handlePlayerAction::DROP_ITEM and DROP_ALL_ITEMS |
PORTED |
Inventory
| Event | Native hook site | Status |
|---|---|---|
FireInventoryClick |
PlayerConnection.cpp::handleContainerClick |
PORTED |
FireSignChange |
PlayerConnection.cpp::handleSignUpdate |
PORTED |
Block / world
The Phase 1 recon enumerated 17 hook-bearing files in Minecraft.World/. Each file was bulk-copied from the donor (all were vanilla in target). The hooks they contain cover:
| Source file | Hook category | Status |
|---|---|---|
AbstractContainerMenu.cpp |
Inventory open / interact | PORTED |
LivingEntity.cpp |
Entity damage, death | PORTED |
ItemEntity.cpp |
Item entity events | PORTED |
ThrownEnderpearl.cpp |
Teleport / portal | PORTED |
PistonBaseTile.cpp |
Block piston extend / retract | PORTED |
LiquidTileDynamic.cpp |
Block from-to (water / lava flow) | PORTED |
FireTile.cpp |
Block burn | PORTED |
GrassTile.cpp, Mushroom.cpp, Sapling.cpp |
Block spread / form | PORTED |
CactusTile.cpp, CocoaTile.cpp, CropTile.cpp, EggTile.cpp, NetherWartTile.cpp, ReedTile.cpp, StemTile.cpp |
Block grow | PORTED |
The exact Fire* calls inside each file match the donor verbatim.
Console / commands
| Event | Native hook site | Status |
|---|---|---|
HandleConsoleCommand |
Minecraft.Server/Console/ServerCliEngine.cpp (unknown-command branch) |
PORTED |
GetPluginCommandHelp |
ServerCliEngine.cpp (suggest-names branch) |
PORTED |
Native callback surface (C# → C++)
FourKitNatives.cpp was copied verbatim from the donor. All ~80 native callbacks (player damage / health / teleport / kick / ban, world tile get / set, inventory access, virtual containers, sound, explosion, etc.) are present. Phase 1 spot-checks confirmed signature compatibility against the engine APIs in this repo.
Known gaps
None at the time of writing. If runtime testing in Phase 8 reveals an event that compiles but does not fire (e.g., the donor refactored the calling function in a way the recon missed), it will be added here as a deferred item.
Out of scope (per the locked plan)
- Hot-reload (PluginLoadContext is non-collectible by design)
- Permission system
- Async / thread-safety hardening of the dispatcher
- New events beyond donor parity
- Managed unit tests for the API surface