Plugin API for NetherGate - A Minecraft server management platform. Provides interfaces and models for developing NetherGate plugins.
$ dotnet add package NetherGate.APINetherGate 让插件开发变得简单而强大:
| 核心能力 | 状态 | 说明 |
|---|---|---|
| SMP 协议 | ✅ 100% | 35 个方法 + 22 个通知处理 |
| RCON 命令 | ✅ 100% | 完整的游戏命令支持(60+ 命令) |
| 日志监听 | ✅ 100% | 服务器生命周期 + 玩家事件 |
| 网络事件 | ✅ 100% | 4 种监听模式(LogBased 立即可用) |
| NBT 数据 | ✅ 100% | 读取 + 写入(玩家/世界数据) |
| 数据组件 | ✅ 100% | 1.20.5+ 物品组件系统支持 |
| 方块数据 | ✅ 100% | 箱子/漏斗/告示牌等容器读写 |
| 文件操作 | ✅ 100% | 读写/监听/备份 |
| 性能监控 | ✅ 100% | CPU/内存/TPS |
| 游戏实用工具 | ✅ 100% | 烟花/音乐/时间/区域操作 |
| 扩展方法库 | ✅ 100% | 物品堆/位置扩展方法 |
| 成就追踪 | ✅ 100% | 实时追踪玩家成就进度 |
| 统计分析 | ✅ 100% | 游戏统计/方块收集进度 |
| 排行榜系统 | ✅ 100% | 灵活的排行榜管理 |
| 数据推送 | ✅ 100% | WebSocket 实时数据广播 |
NetherGate 支持所有开放 RCON + SMP 协议的 Minecraft 服务端,包括但不限于:
前置要求:
从 Releases 下载适合您系统的版本:
| 操作系统 | 架构 | 文件名 |
|---|---|---|
| Windows | x64 (推荐) | nethergate-nightly-win-x64.zip |
| Windows | x86 | nethergate-nightly-win-x86.zip |
| Windows | ARM64 | nethergate-nightly-win-arm64.zip |
| Linux | x64 (推荐) | nethergate-nightly-linux-x64.tar.gz |
| Linux | ARM | nethergate-nightly-linux-arm.tar.gz |
| Linux | ARM64 | nethergate-nightly-linux-arm64.tar.gz |
| macOS | Intel x64 | nethergate-nightly-osx-x64.tar.gz |
| macOS | Apple Silicon | nethergate-nightly-osx-arm64.tar.gz |
或自行编译:
git clone https://github.com/your-org/NetherGate.git
cd NetherGate
dotnet build -c Release
首次运行会自动生成配置文件:
cd bin/Release
./NetherGate.Host
或使用交互式配置向导:
./NetherGate.Host --wizard
配置文件示例: nethergate-config.yaml
server_process:
launch_method: java # java | script | external
working_directory: ./
java:
jar_path: server.jar
min_memory: 2G
max_memory: 4G
详细配置: 配置文件详解
./NetherGate.Host
三种启动模式:
NetherGate.API 发布在 GitHub Packages,安装前需要配置 NuGet 源:
方式一:使用项目配置文件(推荐)
在项目根目录创建 nuget.config:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="github" value="https://nuget.pkg.github.com/virgil698/index.json" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
</packageSources>
</configuration>
然后进行身份验证并安装:
# 配置 GitHub Packages 认证(使用 GitHub Personal Access Token)
dotnet nuget add source --username YOUR_GITHUB_USERNAME --password YOUR_GITHUB_TOKEN --store-password-in-clear-text --name github "https://nuget.pkg.github.com/virgil698/index.json"
# 创建插件项目
dotnet new classlib -n MyPlugin
cd MyPlugin
# 安装 NetherGate.API
dotnet add package NetherGate.API
方式二:直接安装
dotnet new classlib -n MyPlugin
cd MyPlugin
dotnet add package NetherGate.API --source https://nuget.pkg.github.com/virgil698/index.json
using NetherGate.API.Plugins;
using NetherGate.API.Events;
namespace MyPlugin;
public class MyPlugin : IPlugin
{
private IPluginContext _context;
public void OnEnable(IPluginContext context)
{
_context = context;
_context.Logger.Info("MyPlugin 已启用!");
// 订阅玩家加入事件
_context.EventBus.Subscribe<PlayerJoinedEvent>(OnPlayerJoined);
}
private async void OnPlayerJoined(PlayerJoinedEvent e)
{
// 发送欢迎消息
await _context.GameDisplay.SendChatMessageAsync(
e.PlayerName,
$"§a欢迎 {e.PlayerName} 加入服务器!"
);
}
public void OnDisable()
{
_context.Logger.Info("MyPlugin 已禁用");
}
}
dotnet build
# 将生成的 DLL 复制到 plugins/ 目录
# 使用 `plugin load MyPlugin` 命令加载,或重启 NetherGate
NetherGate 提供了完整的 API,让你能实现任何想法:
// BossBar、Title、ActionBar、聊天消息
await context.GameDisplay.ShowBossBarAsync("my_boss", "欢迎!", 1.0f);
await context.GameDisplay.ShowTitleAsync("@a", "§6标题", "§e副标题");
// 烟花系统 - 快速释放绚丽烟花
await context.GameUtilities.LaunchFireworkAsync(
position, FireworkType.LargeBall,
colors: new[] { FireworkColor.Red, FireworkColor.Gold }
);
// 音乐播放器 - 在游戏中播放音符
await context.MusicPlayer.CreateMelody()
.AddNote(Note.C, 200)
.AddNote(Note.E, 200)
.AddNote(Note.G, 400)
.PlayAsync("@a");
// 实时追踪玩家成就进度(灵感来自 AATool)
var advancements = await context.AdvancementTracker.GetPlayerAdvancementsAsync(playerUuid);
context.Logger.Info($"成就完成度: {advancements.ProgressPercentage:F2}%");
// 监听成就完成事件
context.AdvancementTracker.AdvancementCompleted += async (s, e) => {
await context.GameDisplay.SendTitleAsync("@a",
$"§6{e.PlayerName} 完成了 {e.AdvancementName}!"
);
};
// 获取玩家游戏统计
var stats = await context.StatisticsTracker.GetPlayerStatisticsAsync(playerUuid);
context.Logger.Info($"游戏时长: {stats.PlayTimeSpan.TotalHours:F1} 小时");
// NBT 数据(1.20.4-)、数据组件(1.20.5+)
var playerData = await context.PlayerDataReader.ReadPlayerDataAsync(uuid);
await context.NbtDataWriter.UpdatePlayerHealthAsync(uuid, 20.0f);
// 物品组件系统
var item = await context.ItemComponentReader.ReadInventorySlotAsync(player, slot);
await context.ItemComponentWriter.UpdateComponentAsync(player, slot, "custom_name", "神剑");
// 箱子操作 - 读取、排序、写入
var items = await context.BlockDataReader.GetChestItemsAsync(chestPos);
var sortedItems = items.SortById().FilterEnchanted(); // 使用扩展方法
await context.BlockDataWriter.SetContainerItemsAsync(chestPos, sortedItems);
// 完整的服务器管理
var players = await context.SmpApi.GetPlayersAsync();
await context.SmpApi.AddToAllowlistAsync("Player123");
await context.SmpApi.UpdateGameRuleAsync("doDaylightCycle", "false");
// 执行任意 Minecraft 命令
var result = await context.RconClient.ExecuteCommandAsync("give @a diamond 64");
// 流式命令序列 - 延迟和重复执行
await context.GameUtilities.CreateSequence()
.Execute(() => DoSomething())
.WaitTicks(20) // 等待 1 秒(20 ticks)
.Execute(() => DoAnotherThing())
.Repeat(3) // 重复 3 次
.RunAsync();
完整 API 文档: API 参考
完整文档索引: docs/README.md
欢迎贡献代码、文档或建议!
贡献指南: CONTRIBUTING.md
本项目采用 LGPL-3.0 License 开源协议。
感谢以下项目为 NetherGate 提供了设计灵感和技术参考:
MCDReforged - 为 NetherGate 提供了优秀的插件系统设计思路和开发理念。MCDReforged 在 Python 生态中为 Minecraft 服务器管理树立了标杆,NetherGate 在继承这些优秀理念的基础上,结合 .NET 的高性能和现代化特性,为插件开发者带来更强大、更灵活的开发体验。
MinecraftConnection - 为 NetherGate 的 RCON 命令封装和游戏操作 API 设计提供了重要参考。该项目展示了如何优雅地封装 Minecraft 命令,NetherGate 在此基础上进一步扩展,实现了烟花系统、音乐播放器、箱子操作等高级功能,为开发者提供更便捷的游戏交互 API。
CTM's AATool - 为 NetherGate 的成就追踪和统计分析系统提供了设计灵感。AATool 是一个优秀的 Minecraft 成就追踪工具,展示了如何优雅地读取和追踪玩家数据。NetherGate 借鉴了其文件读取优化技术(安全的文件访问、避免锁定)和实时追踪机制,并结合 .NET 的异步特性,为插件开发者提供了强大的数据追踪和分析能力。
感谢以下优秀的开源项目: