NLauncher服务器同步

NLauncher服务器同步

NLaunchers 服务器实例的服务器端 API。

管理

NLauncher Server Sync

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

NLauncher Server Sync 是一个仅服务端模组,与 NLauncher Minecraft 启动器配合使用。将其安装到你的服务器后,玩家在启动游戏的瞬间即可自动接收到所有模组与配置更新。


工作原理

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

无需 FTP。无需 Dropbox 链接。无需“大家重新下载整合包”。只需更新你的服务器,玩家即可保持同步。


功能

自动同步模组与配置

模组会扫描服务器的 mods/ 文件夹和已配置的配置文件,生成包含 SHA-256 哈希的清单,并通过内置的轻量级 HTTP 服务器提供给玩家。玩家仅下载发生变更的内容。

Minecraft 账号授权

若白名单开启,则只有白名单中的玩家可以同步。 若关闭,则只有未被服务器封禁的玩家可以同步。 授权使用玩家的 Minecraft UUID——无需额外账号或令牌。

客户端模组策略

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

策略 行为
Open 玩家可以添加任意客户端模组
Allowlist 玩家可以添加与你批准的模式匹配的模组(例如 journeymap-*、sodium-*)
Strict 仅允许服务器模组——额外模组会在同步时被移除

⚙️ 完全可配置

所有设置均位于 config/nlauncher-sync.toml:

  • 服务器显示名称,显示给启动器中的玩家
  • 同步端口(默认 25580)
  • 配置文件模式——精确选择要推送的配置(支持通配符)
  • 排除模组——跳过仅服务端的模组,不进行同步
  • 客户端模组策略与允许列表

🔧 服务器命令

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

快速开始

服主指南

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

玩家指南

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

配置示例

[server]
name = "My Awesome Server"
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 的授权适用于此场景。