Welcome Mod

模组

· 作者 tsunddev

一个简单、可配置的 Fabric 服务端模组,在玩家加入时给予欢迎提示——公开地、私密地或两者兼有。

0 本站下载 0 关注 更新于 1 年前

最新 1.0.0 · 1.21.10 · Fabric

一键开服(送7天)

? Welcome Mod

一款简单、可配置的 Fabric 服务端模组,用于在玩家加入时发送欢迎信息——可以是公开广播、私聊或两者兼有。
轻量级:MidnightLib 已打包在 JAR 文件内部(jar-in-jar),因此无需外部依赖。


目录


功能特性

  • ? 广播欢迎消息 向服务器上的所有玩家发送。
  • ? 个人欢迎消息 直接发送给加入的玩家。
  • ? 可选的覆盖层显示用于广播消息。
  • ? 自定义占位符 用于插入玩家/服务器信息。
  • ⚙️ 在游戏中编辑配置 通过 MidnightLib GUI 或直接编辑 JSON 文件。
  • ? 无外部依赖 — MidnightLib 及其他所需部分已包含在模组 JAR 中。

安装

  1. 下载 welcome-mod.jar(来自你的构建或发布版本)。
  2. 将 welcome-mod.jar 放入服务器的 mods/ 文件夹中。
  3. 启动(或重启)你的 Fabric 服务器。
  4. 通过游戏内的 MidnightLib 配置 GUI 或编辑位于 config/welcome-mod.json 的配置文件进行配置。

配置

你可以通过在游戏中(MidnightLib GUI)或直接编辑服务器 config/ 文件夹中的 JSON 配置文件来更新模组配置。如果 MidnightLib 支持实时配置更新,更改应立即生效而无需重启服务器。

默认配置 (JSON)

{
  "enableBroadcastWelcomeMessage": true,
  "enablePersonalWelcomeMessage": true,
  "broadcastWelcomeOverlay": true,
  "broadcastMessage": "§fEveryone welcome §a%player§f to §a%server§r!",
  "personalMessage": "Welcome §9%player§r, to §a%server§r!"
}

注意:消息中支持 Minecraft 颜色代码(例如 §a, §f, §9, §r)。

在游戏中或通过文件更新配置

  • 游戏中:打开 MidnightLib 的配置命令,找到 welcome-mod 条目并编辑字段。按回车键即可更新正在运行的配置。
  • 配置文件:编辑 config/welcome-mod.json 并保存。如果服务器/模组支持热重载,更改将立即生效。否则,请重启服务器。

占位符

在 broadcastMessage 和 personalMessage 中使用这些占位符。模组将在运行时自动替换它们:

placeholders.put("%player", player.getDisplayName().getString());
placeholders.put("%server", server.getName());
placeholders.put("%permission", String.valueOf(player.getPermissionLevel()));
placeholders.put("%max", String.valueOf(server.getMaxPlayerCount()));
placeholders.put("%cur", String.valueOf(server.getCurrentPlayerCount()));
占位符 描述 输出示例
%player 玩家显示名称 Notch
%server 服务器名称 My Awesome Server
%permission 玩家权限等级 (op 等级) 4
%max 服务器上配置的最大玩家数量 100
%cur 当前在线玩家数量 12

使用占位符的消息示例:

"broadcastMessage": "Welcome %player to %server! There are %cur/%max players online."

使用方法

  • 当玩家加入时:

    • 如果 enablePersonalWelcomeMessage 为 true,玩家会收到 personalMessage。
    • 如果 enableBroadcastWelcomeMessage 为 true,服务器会向所有人广播 broadcastMessage。
    • 如果 broadcastWelcomeOverlay 为 true,广播将以覆盖层形式显示(在支持的客户端上)。
  • 消息支持 Minecraft 格式化代码。使用 §r 重置格式。


清单 / 模组元数据 (示例)

将此保存为 fabric.mod.json(或包含在你的构建输出中)。此示例符合你提供的模组结构:

{
  "schemaVersion": 1,
  "id": "welcome-mod",
  "version": "${version}",
  "name": "Welcome Mod",
  "description": "A simple, server-side mod to greet new players. Configure a custom message to be broadcast server-wide, sent directly to the player, or both.",
  "authors": [
    "Ben L Martin"
  ],
  "contact": {
    "email": "ben@lmartin.dev",
    "sources": "https://github.com/tsunddev/welcome-mod"
  },
  "license": "MIT",
  "icon": "assets/welcome-mod/icon.png",
  "environment": "*",
  "entrypoints": {
    "main": [
      "dev.lmartin.Main"
    ]
  },
  "mixins": [
    "welcome-mod.mixins.json"
  ],
  "depends": {
    "fabricloader": ">=0.17.3",
    "minecraft": "~1.21.10",
    "java": ">=21",
    "fabric-api": "*"
  },
  "suggests": {}
}

技术细节

  • 模组 ID: welcome-mod
  • 入口点 (主类): dev.lmartin.Main
  • 构建目标: Fabric Loader (版本限制见清单)
  • Java: 需要 Java 21 或更高版本(如清单中指定)
  • 配置存储: 位于 config/welcome-mod.json 下的 JSON 文件,通过 MidnightLib GUI 暴露。

开发与贡献

欢迎贡献!典型的工作流程如下:

  1. Fork 仓库。
  2. 创建功能分支。
  3. 进行修改并更新测试(如果有)。
  4. 提交 PR,并清晰描述你的更改。

如果您添加了更改配置格式或占位符的功能,请更新 README 并相应地提升 schema/version。


作者与联系方式

Ben L Martin


许可证

本项目采用 MIT License 发布。详情请参阅 LICENSE。


? “一句温暖的欢迎语能带来深远的影响——即便在 Minecraft 中也是如此。”
— Welcome Mod

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源