NLauncher 服务器同步

NLauncher 服务器同步

服务器端API用于NLaunchers服务器实例。

NLauncher Server Sync

自动将你的整合包同步给每位玩家——无需外部托管,无需手动下载。

NLauncher Server Sync 是一个仅服务端的模组,与 NLauncher Minecraft 启动器配合使用。将其安装在服务器上,你的玩家在启动游戏时便会自动收到每一次模组和配置的更新。


工作原理

  1. 服主在服务器上安装此模组
  2. 玩家在 NLauncher 中添加服务器地址(“添加服务器实例”)
  3. NLauncher 连接到模组内置的同步 API,预览服务器信息,并创建一个匹配的实例
  4. 每次玩家启动时,NLauncher 都会检查更新并自动同步模组/配置

无需 FTP。无需 Dropbox 链接。无需“嘿,各位,重新下载整合包”。只需更新你的服务器,玩家就会保持同步。


特性

自动模组与配置同步

该模组会扫描你服务器上的 mods/ 文件夹和已配置的配置文件,构建一个包含 SHA-256 哈希值的清单,并通过一个轻量级的内置 HTTP 服务器将其提供给玩家。玩家只需下载已更改的部分。

Minecraft 账户授权

如果开启了白名单,则只有白名单内的玩家才能同步。 如果关闭,则只有未被服务器封禁的玩家才能同步。 授权使用玩家的 Minecraft UUID — 无需额外账户或令牌。

客户端模组策略

控制玩家可以使用哪些额外模组:

策略 行为
开放 玩家可以添加他们想要的任何客户端模组
允许列表 玩家可以添加与你批准的规则匹配的模组(例如,journeymap-*,sodium-*)
严格 只允许服务端模组 — 额外的模组会在同步时被移除

⚙️ 完全可配置

所有设置都在 config/nlauncher-sync.toml 中:

  • 服务器显示名称,显示在启动器玩家界面上
  • 同步端口(默认 25580)
  • 配置文件规则 — 精确选择要推送哪些配置(支持 glob 通配符)
  • 排除的模组 — 跳过服务端专用模组,不进行同步
  • 客户端模组策略和允许列表

🔧 服务器指令

  • /nlsync reload — 重新扫描模组和配置并重建清单(例如,在添加新模组后)
  • /nlsync status — 显示同步服务器状态、模组数量、配置数量和策略

快速开始

对于服主

  1. 将模组的 JAR 文件放入你服务器的 mods/ 文件夹
  2. 启动服务器 — 会自动生成默认的 config/nlauncher-sync.toml
  3. 编辑配置文件,设置你的服务器名称、配置同步规则和客户端模组策略
  4. 在你的防火墙/主机面板中打开端口 25580(或你配置的端口)
  5. 告诉你的玩家在 NLauncher 中添加你的服务器 — 就完成了!

对于玩家

  1. 打开 NLauncher 并进入添加服务器实例
  2. 输入服务器地址(例如 play.example.com)
  3. 如果你的服务器使用非标准端口,请设置连接端口(默认 25565)和同步端口(默认 25580)
  4. 点击连接 — NLauncher 将预览服务器信息(名称、版本、模组数量)
  5. 确认创建实例 — 模组和配置将自动下载
  6. 启动并开始游戏!将来每次启动时,都会在开始游戏前同步任何更新

配置示例

[server]
name = "我的超棒服务器"
port = 25580

[sync] configs = [ "config/jei-common.toml", "config/create/*.toml", "config/sophisticatedbackpacks-common.toml" ]

exclude_mods = [ "nlauncher_sync-*.jar" ]

[client_mods] policy = "allowlist" allowed = [ "journeymap-", "xaeros-minimap-", "xaeros-worldmap-", "optifine-", "sodium-", "iris-" ]


需求

  • Minecraft 1.16.5+(目前仅支持 1.20.1 和 1.21.11,但计划支持 1.16.5+)
  • 模组加载器: NeoForge、Forge、Fabric 或 Quilt
  • 玩家端需要 NLauncher v0.5.0+
  • 端口 25580(或已配置的端口)必须对玩家可访问

常见问题

这个模组在客户端上有任何作用吗? 没有。这是一个仅服务端的模组。玩家不需要安装它 — 他们使用 NLauncher,它会自动处理同步。

我需要把文件托管在某处吗? 不需要。该模组直接从你的服务器提供文件。不需要外部托管、CDN 或第三方服务。

如果同步服务器无法访问怎么办? NLauncher 会警告玩家,但仍允许他们使用上次同步的内容启动游戏。没有人会被锁定在外。

玩家仍然可以添加诸如小地图或光影之类的客户端模组吗? 可以!将你的客户端模组策略设置为 open 或 allowlist,允许玩家在服务端整合包的基础上添加已批准的客户端模组。

它会同步资源包或光影包吗? 不会。Minecraft 已经原生处理服务端资源包,而光影包属于个人偏好。

这安全吗? 该模组仅向通过 Minecraft UUID 验证的、已在白名单中或曾加入过你服务器的玩家提供文件。整合包文件不属于敏感数据,因此基于 UUID 的认证对于这个用例是合适的。