mirror of
https://git.huckle.dev/Huckles-Minecraft-Archive/LCE-Revelations.git
synced 2026-05-22 17:35:50 +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
216 lines
7.3 KiB
C#
216 lines
7.3 KiB
C#
using Minecraft.Server.FourKit.Event.Server;
|
|
using Minecraft.Server.FourKit.Plugin;
|
|
using System.Reflection;
|
|
|
|
namespace Minecraft.Server.FourKit;
|
|
|
|
internal sealed class PluginLoader
|
|
{
|
|
private static readonly BindingFlags DeclaredPublic =
|
|
BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly;
|
|
|
|
private readonly List<ServerPlugin> _plugins = new();
|
|
|
|
public IReadOnlyList<ServerPlugin> Plugins => _plugins.AsReadOnly();
|
|
|
|
public void LoadPlugins(string pluginsDirectory)
|
|
{
|
|
if (!Directory.Exists(pluginsDirectory))
|
|
{
|
|
ServerLog.Info("fourkit", $"Creating plugins directory: {pluginsDirectory}");
|
|
Directory.CreateDirectory(pluginsDirectory);
|
|
return;
|
|
}
|
|
|
|
var rootDlls = Directory.GetFiles(pluginsDirectory, "*.dll");
|
|
if (rootDlls.Length > 0)
|
|
{
|
|
ServerLog.Info("fourkit", $"Found {rootDlls.Length} DLL(s) in plugins root.");
|
|
foreach (var dll in rootDlls)
|
|
{
|
|
try { LoadPluginAssembly(dll); }
|
|
catch (Exception ex) { ServerLog.Error("fourkit", $"Failed to load {Path.GetFileName(dll)}: {ex.Message}"); }
|
|
}
|
|
}
|
|
|
|
foreach (var subDir in Directory.GetDirectories(pluginsDirectory))
|
|
{
|
|
string folderName = Path.GetFileName(subDir);
|
|
var allDlls = Directory.GetFiles(subDir, "*.dll");
|
|
if (allDlls.Length == 0)
|
|
continue;
|
|
|
|
string? mainDll = allDlls.FirstOrDefault(f =>
|
|
string.Equals(Path.GetFileNameWithoutExtension(f), folderName, StringComparison.OrdinalIgnoreCase));
|
|
|
|
if (mainDll != null)
|
|
{
|
|
try
|
|
{
|
|
LoadPluginAssembly(mainDll);
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
ServerLog.Error("fourkit", $"Failed to load {Path.GetFileName(mainDll)}: {ex.Message}");
|
|
FourKit.FireEvent(new PluginLoadFailedEvent(mainDll, ex.Message));
|
|
}
|
|
}
|
|
else
|
|
{
|
|
foreach (var dll in allDlls)
|
|
{
|
|
try
|
|
{
|
|
LoadPluginAssembly(dll);
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
ServerLog.Error("fourkit", $"Failed to load {Path.GetFileName(dll)}: {ex.Message}");
|
|
FourKit.FireEvent(new PluginLoadFailedEvent(dll, ex.Message));
|
|
|
|
}
|
|
}
|
|
}
|
|
}
|
|
FourKit.FireEvent(new PluginsLoadedEvent());
|
|
}
|
|
|
|
private void LoadPluginAssembly(string dllPath)
|
|
{
|
|
var context = new PluginLoadContext(dllPath);
|
|
var assembly = context.LoadFromAssemblyPath(Path.GetFullPath(dllPath));
|
|
|
|
int found = 0;
|
|
foreach (var type in assembly.GetTypes())
|
|
{
|
|
if (type.IsAbstract || type.IsInterface)
|
|
continue;
|
|
|
|
if (!typeof(ServerPlugin).IsAssignableFrom(type))
|
|
continue;
|
|
|
|
var plugin = (ServerPlugin?)Activator.CreateInstance(type);
|
|
if (plugin == null)
|
|
continue;
|
|
|
|
_plugins.Add(plugin);
|
|
found++;
|
|
|
|
string pName = GetPluginString(plugin, "name", "getName", "GetName", plugin.GetType().Name);
|
|
string pVersion = GetPluginString(plugin, "version", "getVersion", "GetVersion", "1.0");
|
|
string pAuthor = GetPluginString(plugin, "author", "getAuthor", "GetAuthor", "Unknown");
|
|
|
|
if (!HasDeclaredMember(type, "name"))
|
|
ServerLog.Warn("fourkit", $"Plugin {type.Name} does not declare a 'name' property.");
|
|
if (!HasDeclaredMember(type, "version"))
|
|
ServerLog.Warn("fourkit", $"Plugin {type.Name} does not declare a 'version' property.");
|
|
if (!HasDeclaredMember(type, "author"))
|
|
ServerLog.Warn("fourkit", $"Plugin {type.Name} does not declare an 'author' property.");
|
|
|
|
ServerLog.Info("fourkit", $"Loaded plugin: {pName} v{pVersion} by {pAuthor}");
|
|
}
|
|
|
|
if (found == 0)
|
|
{
|
|
ServerLog.Warn("fourkit", $"No ServerPlugin classes found in {Path.GetFileName(dllPath)}");
|
|
}
|
|
}
|
|
|
|
public void EnableAll()
|
|
{
|
|
foreach (var plugin in _plugins)
|
|
{
|
|
EnablePlugin(plugin);
|
|
}
|
|
}
|
|
|
|
public void DisableAll()
|
|
{
|
|
foreach (var plugin in _plugins)
|
|
{
|
|
DisablePlugin(plugin);
|
|
}
|
|
}
|
|
|
|
public void EnablePlugin(ServerPlugin plugin)
|
|
{
|
|
try
|
|
{
|
|
InvokePluginMethod(plugin, "onEnable", "OnEnable");
|
|
string pName = GetPluginString(plugin, "name", "getName", "GetName", plugin.GetType().Name);
|
|
ServerLog.Info("fourkit", $"Enabled: {pName}");
|
|
|
|
FourKit.FireEvent(new PluginEnableEvent(plugin));
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
string pName = GetPluginString(plugin, "name", "getName", "GetName", plugin.GetType().Name);
|
|
ServerLog.Error("fourkit", $"Error enabling {pName}: {ex.Message}");
|
|
}
|
|
}
|
|
|
|
public void DisablePlugin(ServerPlugin plugin)
|
|
{
|
|
try
|
|
{
|
|
InvokePluginMethod(plugin, "onDisable", "OnDisable");
|
|
string pName = GetPluginString(plugin, "name", "getName", "GetName", plugin.GetType().Name);
|
|
ServerLog.Info("fourkit", $"Disabled: {pName}");
|
|
|
|
FourKit.FireEvent(new PluginDisableEvent(plugin));
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
string pName = GetPluginString(plugin, "name", "getName", "GetName", plugin.GetType().Name);
|
|
ServerLog.Error("fourkit", $"Error disabling {pName}: {ex.Message}");
|
|
}
|
|
}
|
|
|
|
private static void InvokePluginMethod(ServerPlugin plugin, string camelName, string pascalName)
|
|
{
|
|
Type type = plugin.GetType();
|
|
|
|
MethodInfo? method = type.GetMethod(camelName, DeclaredPublic, Type.EmptyTypes)
|
|
?? type.GetMethod(pascalName, DeclaredPublic, Type.EmptyTypes);
|
|
|
|
if (method != null)
|
|
{
|
|
method.Invoke(plugin, null);
|
|
}
|
|
}
|
|
|
|
private static bool HasDeclaredMember(Type type, string name)
|
|
{
|
|
return type.GetProperty(name, DeclaredPublic) != null
|
|
|| type.GetMethod("get" + char.ToUpper(name[0]) + name[1..], DeclaredPublic, Type.EmptyTypes) != null;
|
|
}
|
|
|
|
private static string GetPluginString(
|
|
ServerPlugin plugin, string propertyName,
|
|
string getterCamel, string getterPascal,
|
|
string fallback)
|
|
{
|
|
Type type = plugin.GetType();
|
|
|
|
PropertyInfo? prop = type.GetProperty(propertyName, DeclaredPublic);
|
|
if (prop != null && prop.PropertyType == typeof(string))
|
|
{
|
|
return (string?)prop.GetValue(plugin) ?? fallback;
|
|
}
|
|
|
|
MethodInfo? getter = type.GetMethod(getterCamel, DeclaredPublic, Type.EmptyTypes);
|
|
if (getter != null && getter.ReturnType == typeof(string))
|
|
{
|
|
return (string?)getter.Invoke(plugin, null) ?? fallback;
|
|
}
|
|
|
|
getter = type.GetMethod(getterPascal, DeclaredPublic, Type.EmptyTypes);
|
|
if (getter != null && getter.ReturnType == typeof(string))
|
|
{
|
|
return (string?)getter.Invoke(plugin, null) ?? fallback;
|
|
}
|
|
|
|
return fallback;
|
|
}
|
|
}
|