feat: add FourKit plugin host with dual server build
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
This commit is contained in:
itsRevela
@@ -0,0 +1,93 @@
|
||||
namespace Minecraft.Server.FourKit.Event.Inventory;
|
||||
|
||||
/// <summary>
|
||||
/// What the client did to trigger this action (not the result).
|
||||
/// </summary>
|
||||
public enum ClickType
|
||||
{
|
||||
/// <summary>The left (or primary) mouse button.</summary>
|
||||
LEFT,
|
||||
/// <summary>Holding shift while pressing the left mouse button.</summary>
|
||||
SHIFT_LEFT,
|
||||
/// <summary>The right mouse button.</summary>
|
||||
RIGHT,
|
||||
/// <summary>Holding shift while pressing the right mouse button.</summary>
|
||||
SHIFT_RIGHT,
|
||||
/// <summary>Clicking the left mouse button on the grey area around the inventory.</summary>
|
||||
WINDOW_BORDER_LEFT,
|
||||
/// <summary>Clicking the right mouse button on the grey area around the inventory.</summary>
|
||||
WINDOW_BORDER_RIGHT,
|
||||
/// <summary>The middle mouse button, or a "scrollwheel click".</summary>
|
||||
MIDDLE,
|
||||
/// <summary>One of the number keys 1-9, correspond to slots on the hotbar.</summary>
|
||||
NUMBER_KEY,
|
||||
/// <summary>Pressing the left mouse button twice in quick succession.</summary>
|
||||
DOUBLE_CLICK,
|
||||
/// <summary>The "Drop" key (defaults to Q).</summary>
|
||||
DROP,
|
||||
/// <summary>Holding Ctrl while pressing the "Drop" key (defaults to Q).</summary>
|
||||
CONTROL_DROP,
|
||||
/// <summary>Any action done with the Creative inventory open.</summary>
|
||||
CREATIVE,
|
||||
/// <summary>A type of inventory manipulation not yet recognized by Bukkit.</summary>
|
||||
UNKNOWN,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Extension methods for <see cref="ClickType"/>.
|
||||
/// </summary>
|
||||
public static class ClickTypeExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets whether this ClickType represents the pressing of a key on a keyboard.
|
||||
/// </summary>
|
||||
/// <param name="click">The click type.</param>
|
||||
/// <returns>true if this ClickType represents the pressing of a key.</returns>
|
||||
public static bool isKeyboardClick(this ClickType click)
|
||||
{
|
||||
return click == ClickType.NUMBER_KEY || click == ClickType.DROP || click == ClickType.CONTROL_DROP;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether this ClickType represents an action that can only be performed
|
||||
/// by a Player in creative mode.
|
||||
/// </summary>
|
||||
/// <param name="click">The click type.</param>
|
||||
/// <returns>true if this action requires Creative mode.</returns>
|
||||
public static bool isCreativeAction(this ClickType click)
|
||||
{
|
||||
return click == ClickType.CREATIVE || click == ClickType.MIDDLE;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether this ClickType represents a right click.
|
||||
/// </summary>
|
||||
/// <param name="click">The click type.</param>
|
||||
/// <returns>true if this ClickType represents a right click.</returns>
|
||||
public static bool isRightClick(this ClickType click)
|
||||
{
|
||||
return click == ClickType.RIGHT || click == ClickType.SHIFT_RIGHT;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether this ClickType represents a left click.
|
||||
/// </summary>
|
||||
/// <param name="click">The click type.</param>
|
||||
/// <returns>true if this ClickType represents a left click.</returns>
|
||||
public static bool isLeftClick(this ClickType click)
|
||||
{
|
||||
return click == ClickType.LEFT || click == ClickType.SHIFT_LEFT
|
||||
|| click == ClickType.DOUBLE_CLICK || click == ClickType.CREATIVE;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether this ClickType indicates that the shift key was pressed
|
||||
/// down when the click was made.
|
||||
/// </summary>
|
||||
/// <param name="click">The click type.</param>
|
||||
/// <returns>true if the action uses Shift.</returns>
|
||||
public static bool isShiftClick(this ClickType click)
|
||||
{
|
||||
return click == ClickType.SHIFT_LEFT || click == ClickType.SHIFT_RIGHT;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
namespace Minecraft.Server.FourKit.Event.Inventory;
|
||||
|
||||
/// <summary>
|
||||
/// An estimation of what the result will be.
|
||||
/// </summary>
|
||||
public enum InventoryAction
|
||||
{
|
||||
/// <summary>Nothing will happen from the click.</summary>
|
||||
NOTHING,
|
||||
/// <summary>All of the items on the clicked slot are moved to the cursor.</summary>
|
||||
PICKUP_ALL,
|
||||
/// <summary>Some of the items on the clicked slot are moved to the cursor.</summary>
|
||||
PICKUP_SOME,
|
||||
/// <summary>Half of the items on the clicked slot are moved to the cursor.</summary>
|
||||
PICKUP_HALF,
|
||||
/// <summary>One of the items on the clicked slot are moved to the cursor.</summary>
|
||||
PICKUP_ONE,
|
||||
/// <summary>All of the items on the cursor are moved to the clicked slot.</summary>
|
||||
PLACE_ALL,
|
||||
/// <summary>Some of the items from the cursor are moved to the clicked slot (usually up to the max stack size).</summary>
|
||||
PLACE_SOME,
|
||||
/// <summary>A single item from the cursor is moved to the clicked slot.</summary>
|
||||
PLACE_ONE,
|
||||
/// <summary>The clicked item and the cursor are exchanged.</summary>
|
||||
SWAP_WITH_CURSOR,
|
||||
/// <summary>The entire cursor item is dropped.</summary>
|
||||
DROP_ALL_CURSOR,
|
||||
/// <summary>One item is dropped from the cursor.</summary>
|
||||
DROP_ONE_CURSOR,
|
||||
/// <summary>The entire clicked slot is dropped.</summary>
|
||||
DROP_ALL_SLOT,
|
||||
/// <summary>One item is dropped from the clicked slot.</summary>
|
||||
DROP_ONE_SLOT,
|
||||
/// <summary>The item is moved to the opposite inventory if a space is found.</summary>
|
||||
MOVE_TO_OTHER_INVENTORY,
|
||||
/// <summary>The clicked item is moved to the hotbar, and the item currently there is re-added to the player's inventory.</summary>
|
||||
HOTBAR_MOVE_AND_READD,
|
||||
/// <summary>The clicked slot and the picked hotbar slot are swapped.</summary>
|
||||
HOTBAR_SWAP,
|
||||
/// <summary>A max-size stack of the clicked item is put on the cursor.</summary>
|
||||
CLONE_STACK,
|
||||
/// <summary>The inventory is searched for the same material, and they are put on the cursor up to Material.getMaxStackSize().</summary>
|
||||
COLLECT_TO_CURSOR,
|
||||
/// <summary>An unrecognized ClickType.</summary>
|
||||
UNKNOWN,
|
||||
}
|
||||
@@ -0,0 +1,157 @@
|
||||
namespace Minecraft.Server.FourKit.Event.Inventory;
|
||||
|
||||
using Minecraft.Server.FourKit.Entity;
|
||||
using Minecraft.Server.FourKit.Inventory;
|
||||
|
||||
/// <summary>
|
||||
/// This event is called when a player clicks a slot in an inventory.
|
||||
/// <para>
|
||||
/// Because InventoryClickEvent occurs within a modification of the Inventory,
|
||||
/// not all Inventory related methods are safe to use.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The following should never be invoked by an EventHandler for
|
||||
/// InventoryClickEvent using the HumanEntity or InventoryView associated
|
||||
/// with this event:
|
||||
/// <list type="bullet">
|
||||
/// <item><description><see cref="HumanEntity.closeInventory()"/></description></item>
|
||||
/// <item><description><see cref="HumanEntity.openInventory(Inventory)"/></description></item>
|
||||
/// <item><description><see cref="InventoryView.close()"/></description></item>
|
||||
/// </list>
|
||||
/// </para>
|
||||
/// </summary>
|
||||
public class InventoryClickEvent : InventoryInteractEvent
|
||||
{
|
||||
private readonly SlotType _slotType;
|
||||
private readonly int _rawSlot;
|
||||
private readonly int _whichSlot;
|
||||
private readonly ClickType _click;
|
||||
private readonly InventoryAction _action;
|
||||
private readonly int _hotbarKey;
|
||||
private ItemStack? _currentItem;
|
||||
internal InventoryClickEvent(InventoryView view, SlotType type, int slot,
|
||||
ClickType click, InventoryAction action)
|
||||
: this(view, type, slot, click, action, -1)
|
||||
{
|
||||
}
|
||||
internal InventoryClickEvent(InventoryView view, SlotType type, int slot,
|
||||
ClickType click, InventoryAction action, int key)
|
||||
: base(view)
|
||||
{
|
||||
_slotType = type;
|
||||
_rawSlot = slot;
|
||||
_click = click;
|
||||
_action = action;
|
||||
_hotbarKey = key;
|
||||
_currentItem = view.getItem(slot);
|
||||
_whichSlot = view.convertSlot(slot);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the inventory that was clicked, or null if outside of window.
|
||||
/// </summary>
|
||||
/// <returns>The clicked inventory.</returns>
|
||||
public Inventory? getClickedInventory()
|
||||
{
|
||||
if (_rawSlot == InventoryView.OUTSIDE)
|
||||
return null;
|
||||
int topSize = getView().getTopInventory().getSize();
|
||||
if (_rawSlot < topSize)
|
||||
return getView().getTopInventory();
|
||||
return getView().getBottomInventory();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the type of slot that was clicked.
|
||||
/// </summary>
|
||||
/// <returns>The slot type.</returns>
|
||||
public SlotType getSlotType() => _slotType;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the current ItemStack on the cursor.
|
||||
/// </summary>
|
||||
/// <returns>The cursor ItemStack.</returns>
|
||||
public ItemStack? getCursor() => getView().getCursor();
|
||||
|
||||
/// <summary>
|
||||
/// Gets the ItemStack currently in the clicked slot.
|
||||
/// </summary>
|
||||
/// <returns>The item in the clicked slot.</returns>
|
||||
public ItemStack? getCurrentItem() => _currentItem;
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether or not the ClickType for this event represents a right click.
|
||||
/// </summary>
|
||||
/// <returns>true if the ClickType uses the right mouse button.</returns>
|
||||
public bool isRightClick() => _click.isRightClick();
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether or not the ClickType for this event represents a left click.
|
||||
/// </summary>
|
||||
/// <returns>true if the ClickType uses the left mouse button.</returns>
|
||||
public bool isLeftClick() => _click.isLeftClick();
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether the ClickType for this event indicates that the key was
|
||||
/// pressed down when the click was made.
|
||||
/// </summary>
|
||||
/// <returns>true if the ClickType uses Shift or Ctrl.</returns>
|
||||
public bool isShiftClick() => _click.isShiftClick();
|
||||
|
||||
/// <summary>
|
||||
/// Sets the item on the cursor.
|
||||
/// </summary>
|
||||
/// <param name="stack">The new cursor item.</param>
|
||||
[Obsolete("This changes the ItemStack in their hand before any calculations are applied to the Inventory.")]
|
||||
public void setCursor(ItemStack? stack) => getView().setCursor(stack);
|
||||
|
||||
/// <summary>
|
||||
/// Sets the ItemStack currently in the clicked slot.
|
||||
/// </summary>
|
||||
/// <param name="stack">The item to be placed in the current slot.</param>
|
||||
public void setCurrentItem(ItemStack? stack)
|
||||
{
|
||||
_currentItem = stack;
|
||||
if (_rawSlot >= 0)
|
||||
getView().setItem(_rawSlot, stack);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The slot number that was clicked, ready for passing to
|
||||
/// <see cref="Inventory.getItem(int)"/>. Note that there may be two slots
|
||||
/// with the same slot number, since a view links two different inventories.
|
||||
/// </summary>
|
||||
/// <returns>The slot number.</returns>
|
||||
public int getSlot() => _whichSlot;
|
||||
|
||||
/// <summary>
|
||||
/// The raw slot number clicked, ready for passing to
|
||||
/// <see cref="InventoryView.getItem(int)"/>. This slot number is unique
|
||||
/// for the view.
|
||||
/// </summary>
|
||||
/// <returns>The raw slot number.</returns>
|
||||
public int getRawSlot() => _rawSlot;
|
||||
|
||||
/// <summary>
|
||||
/// If the ClickType is NUMBER_KEY, this method will return the index of
|
||||
/// the pressed key (0-8).
|
||||
/// </summary>
|
||||
/// <returns>The number on the key minus 1 (range 0-8); or -1 if not a NUMBER_KEY action.</returns>
|
||||
public int getHotbarButton() => _hotbarKey;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the InventoryAction that triggered this event.
|
||||
/// This action cannot be changed, and represents what the normal outcome
|
||||
/// of the event will be. To change the behavior of this InventoryClickEvent,
|
||||
/// changes must be manually applied.
|
||||
/// </summary>
|
||||
/// <returns>The InventoryAction that triggered this event.</returns>
|
||||
public InventoryAction getAction() => _action;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the ClickType for this event.
|
||||
/// This is insulated against changes to the inventory by other plugins.
|
||||
/// </summary>
|
||||
/// <returns>The type of inventory click.</returns>
|
||||
public ClickType getClick() => _click;
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
namespace Minecraft.Server.FourKit.Event.Inventory;
|
||||
|
||||
using Minecraft.Server.FourKit.Entity;
|
||||
using Minecraft.Server.FourKit.Inventory;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a player related inventory event.
|
||||
/// </summary>
|
||||
public class InventoryEvent : Event
|
||||
{
|
||||
/// <summary>The inventory view associated with this event.</summary>
|
||||
protected readonly InventoryView transaction;
|
||||
internal InventoryEvent(InventoryView transaction)
|
||||
{
|
||||
this.transaction = transaction;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the primary Inventory involved in this transaction.
|
||||
/// </summary>
|
||||
/// <returns>The upper inventory.</returns>
|
||||
public global::Minecraft.Server.FourKit.Inventory.Inventory getInventory()
|
||||
{
|
||||
return transaction.getTopInventory();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the list of players viewing the primary (upper) inventory
|
||||
/// involved in this event.
|
||||
/// </summary>
|
||||
/// <returns>A list of people viewing.</returns>
|
||||
public List<HumanEntity> getViewers()
|
||||
{
|
||||
return transaction.getTopInventory().getViewers();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the view object itself.
|
||||
/// </summary>
|
||||
/// <returns>The InventoryView.</returns>
|
||||
public InventoryView getView()
|
||||
{
|
||||
return transaction;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
namespace Minecraft.Server.FourKit.Event.Inventory;
|
||||
|
||||
using Minecraft.Server.FourKit.Entity;
|
||||
using Minecraft.Server.FourKit.Inventory;
|
||||
|
||||
/// <summary>
|
||||
/// An abstract base class for events that describe an interaction between a
|
||||
/// <see cref="HumanEntity"/> and the contents of an <see cref="Inventory"/>.
|
||||
/// This is currently not emitted anywhere, use <see cref="InventoryClickEvent"/> instead.
|
||||
/// </summary>
|
||||
public abstract class InventoryInteractEvent : InventoryEvent, Cancellable
|
||||
{
|
||||
private bool _cancelled;
|
||||
internal protected InventoryInteractEvent(InventoryView transaction) : base(transaction)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the player who performed the click.
|
||||
/// </summary>
|
||||
/// <returns>The clicking player.</returns>
|
||||
public HumanEntity getWhoClicked()
|
||||
{
|
||||
return transaction.getPlayer();
|
||||
}
|
||||
|
||||
|
||||
/// <inheritdoc />
|
||||
public bool isCancelled() => _cancelled;
|
||||
|
||||
|
||||
/// <inheritdoc />
|
||||
public void setCancelled(bool cancel) => _cancelled = cancel;
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
namespace Minecraft.Server.FourKit.Event.Inventory;
|
||||
|
||||
using Minecraft.Server.FourKit.Entity;
|
||||
using Minecraft.Server.FourKit.Inventory;
|
||||
|
||||
/// <summary>
|
||||
/// Called when a player opens an inventory. Cancelling this event will prevent
|
||||
/// the inventory screen from showing.
|
||||
/// </summary>
|
||||
public class InventoryOpenEvent : InventoryEvent, Cancellable
|
||||
{
|
||||
private bool _cancelled;
|
||||
internal InventoryOpenEvent(InventoryView transaction) : base(transaction)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the player involved in this event.
|
||||
/// </summary>
|
||||
/// <returns>Player who is involved in this event.</returns>
|
||||
public HumanEntity getPlayer() => transaction.getPlayer();
|
||||
|
||||
/// <summary>
|
||||
/// Gets the cancellation state of this event. A cancelled event will not
|
||||
/// be executed in the server, but will still pass to other plugins.
|
||||
/// If an inventory open event is cancelled, the inventory screen will not show.
|
||||
/// </summary>
|
||||
/// <returns>true if this event is cancelled.</returns>
|
||||
public bool isCancelled() => _cancelled;
|
||||
|
||||
/// <summary>
|
||||
/// Sets the cancellation state of this event. A cancelled event will not
|
||||
/// be executed in the server, but will still pass to other plugins.
|
||||
/// If an inventory open event is cancelled, the inventory screen will not show.
|
||||
/// </summary>
|
||||
/// <param name="cancel">true if you wish to cancel this event.</param>
|
||||
public void setCancelled(bool cancel) => _cancelled = cancel;
|
||||
}
|
||||
Reference in New Issue
Block a user