Celestial Whitelister

插件

· 作者 KernelFreeze

一个用于白名单管理的 Paper 插件,与 LuckPerms 集成

0 本站下载 0 关注 更新于 9 个月前

需要前置:LuckPerms

最新 1.0.0 · 1.21.11 · Paper

一键开服(送7天)

Celestial Whitelister

一个 Paper 插件,允许玩家通过 Discord /whitelist 斜杠命令将自己添加到白名单。当有人使用此命令时,该插件会将其加入 Minecraft 服务器白名单,并根据其 Discord 角色分配 LuckPerms 用户组。

要求

  • Paper 1.21.4+
  • LuckPerms
  • Discord 机器人令牌(如何创建)

安装

  1. 将插件 JAR 文件放入服务器的 plugins/ 文件夹中。
  2. 启动服务器一次以生成默认的 config.yml。
  3. 编辑 plugins/CelestialWhitelister/config.yml,填入你的 Discord 机器人令牌和角色映射。
  4. 重启服务器或运行 /celestialwhitelister reload。

确保已将你的 Discord 机器人邀请到你的服务器中,并授予了 applications.commands 和 bot 权限范围。

工作原理

  1. 成员在你的 Discord 服务器中运行 /whitelist <nickname>。

  2. 插件检查该成员是否被允许使用此命令(包括频道和角色限制,如果已启用)。

  3. 它根据成员的 Discord 角色以及 role-groups 映射关系,查找其应获得的 LuckPerms 组别。

  4. 它将 Minecraft 用户名解析为 UUID,将玩家添加到服务器白名单中,并分配 LuckPerms 组。

  5. 成员会在 Discord 上收到一条私有的(临时)回复,确认操作结果。

配置

配置文件位于 plugins/CelestialWhitelister/config.yml。

# Discord 机器人令牌
discord-token: "YOUR_BOT_TOKEN_HERE"

# 插件消息的语言。必须与 messages 文件夹中某个 .ftl 文件的名称匹配
#(例如,「en」对应 en.ftl,「es」对应 es.ftl)。
language: "en"

将 Discord 角色 ID 映射到 LuckPerms 组名。

玩家将被添加到与该列表中最高的角色对应的 LuckPerms 组中。

格式:"discord_role_id": "luckperms_group_name"

role-groups: "123456789012345678": "vip" "987654321098765432": "member"

如果用户没有任何已映射的角色,则分配给玩家的默认 LuckPerms 组。

留空表示如果没有匹配的角色,则不分配任何组。

default-group: "default"

UUID 解析,仅适用于离线模式服务器。

启用后,插件将优先尝试解析玩家的在线(Mojang)UUID,

如果玩家没有 Mojang 账户,则回退到离线 UUID。

在在线模式服务器上,无论此设置如何,始终使用在线 UUID。

force-online-uuids: false

频道限制,启用后,/whitelist 命令仅在列出的 Discord 频道 ID 中生效。

channel-restriction: enabled: false channels: - "111111111111111111" - "222222222222222222"

角色要求,启用后,用户必须拥有至少一个列出的 Discord 角色 ID 才能使用 /whitelist。

此检查独立于上述的 role-groups 映射进行。

required-roles: enabled: false roles: - "333333333333333333" - "444444444444444444"

一次性白名单限制。启用后,每个 Discord 用户只能使用一次 /whitelist。

他们的条目存储在本地 SQLite 数据库中。

用户可以使用 /changenick 更改其白名单昵称。

one-time-whitelist: true


## 本地化

CelestialWhitelister 支持使用 [Project Fluent](https://projectfluent.org/) 进行多语言翻译,这是一个专为自然、流畅翻译而设计的本地化框架。

### 支持的语言

当前支持的语言:
- **English** (en)
- **Spanish** (es)

插件会根据 `messages/` 目录中存在的 `.ftl` 文件自动选择相应的语言文件。

### 翻译文件

翻译文件存储在 `plugins/CelestialWhitelister/messages/` 目录下,采用 [Project Fluent](https://projectfluent.org/fluent.html) 格式(`.ftl`)。

每种语言都有自己对应的文件:
- `en.ftl` - English 消息
- `es.ftl` - Spanish 消息

### 添加新语言

要添加新语言:

1. 在 `plugins/CelestialWhitelister/messages/` 中创建一个以语言代码为文件名(例如法语为 `fr.ftl`)的新 `.ftl` 文件。
2. 从英文 `en.ftl` 文件中翻译所有消息键。
3. 使用 `/celestialwhitelister reload` 重新加载插件。

messages 目录中的所有 `.ftl` 文件会按照字母顺序自动加载和处理。

### 选项

| 选项 | 说明                                                                                                                      |
|---|----------------------------------------------------------------------------------------------------------------------------------|
| `discord-token` | 来自 Discord 开发者门户的机器人令牌。                                                                                 |
| `language` | 插件消息的语言。必须与消息文件夹中的 `.ftl` 文件匹配(例如,`"en"` 对应 `en.ftl`)。                   |
| `role-groups` | Discord 角色 ID 到 LuckPerms 组名的映射。成员拥有的第一个出现在此映射中的角色将决定其所属组。 |
| `default-group` | 当没有角色匹配时分配的 LuckPerms 组。设置为 `""` 以拒绝没有匹配角色的用户。                    |
| `force-online-uuids` | 在**离线模式**服务器上启用时,插件将优先尝试解析玩家的在线(Mojang)UUID,              |
| `channel-restriction.enabled` | 当为 `true` 时,`/whitelist` 命令仅在列出的频道中生效。                                                         |
| `channel-restriction.channels` | 允许使用该命令的 Discord 频道 ID 列表。                                                                        |
| `required-roles.enabled` | 当为 `true` 时,成员必须拥有所列角色之一才能使用该命令。                                              |
| `required-roles.roles` | 使用 `/whitelist` 所需的 Discord 角色 ID 列表。                                                                           |
| `one-time-whitelist` | 当为 `true` 时,每个 Discord 用户只能加入白名单一次。使用 `/changenick` 更改已加入白名单的昵称。                    |

## 命令

### 游戏内

| 命令 | 别名 | 说明 |
|---|---|---|
| `/celestialwhitelister reload` | `/cw reload` | 重新加载配置文件并重启 Discord 机器人。 |

### Discord

| 命令 | 说明 |
|---|---|
| `/whitelist <nickname>` | 将 Minecraft 玩家加入白名单并分配其 LuckPerms 组。 |
| `/changenick <nickname>` | 更改你的白名单昵称(仅在启用 `one-time-whitelist` 时可用)。 |

## 权限

| 权限 | 说明 | 默认值 |
|---|---|---|
| `celestialwhitelister.reload` | 允许使用 `/celestialwhitelister reload`。 | OP |

## 构建

需要 Java 21+。

```sh
./gradlew build

编译后的 JAR 文件将位于 build/libs/ 中。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源