paper-telegram-bridge

插件

· 作者 pbl0

无缝连接 Telegram 聊天和 Minecraft 服务器。

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

最新 0.22.4 · 26.3 · Paper

一键开服(送7天)

Paper Telegram Bridge

源自 spigot-tg-bridge 的分支,增加了一些新功能。

image

此插件将把 Minecraft 中的聊天消息发送到 Telegram,并将 Telegram 中的消息转发到 Minecraft。

使用方法:

  1. 从 modrinth 下载并将其放入服务器的 plugins/ 目录 或者 克隆此仓库并在仓库目录内运行 gradle。

  2. 如果您已经有 Telegram 机器人,请跳过此步骤。否则,通过 BotFather 创建一个新的机器人。 您将按照逐步说明操作,为机器人设置一个 用户名,最重要的是获取机器人的 令牌(token)。 保存此令牌以备将来使用。注意: 为了让您的机器人接收纯文本消息(而非命令),您必须 禁用默认开启的 隐私模式。进入机器人的 设置:Bot Settings -> Group Privacy 并点击 Turn Off。

  3. 接下来,您需要告知插件有关新机器人的信息。您可以选择以下任一方式:

    • 启动 Paper 服务器,插件会记录 "No config file found! Saving default one."。之后,停止服务器并 进行第 4 步。
    • 复制 config.yml 到您的服务器目录下的 plugins/PaperTelegramBridge/ 中。
  4. config.yml 只是一个 有效的 YAML 文件,是 JSON 的替代方案,但更具 可读性。 现在,将您在第 2 步中获得的机器人的 令牌 粘贴到 config.yml 中,使其看起来像这样:

    botToken: abcdefghijklmnopq123123123
    # other configuration values...
    
  5. 启动 Paper 服务器。

  6. 将您的机器人添加到您计划使用的聊天群组中。在每个群组中运行 /chat_id 命令。机器人应做出响应并提供一个特殊的值——聊天 ID。现在,打开 config.yml 并将此 ID 粘贴到 chats 部分下,使其看起来像这样:

    botToken: abcdefghijklmnopq123123123
    chats: [
        -123456789,
        987654321,
        # other chat id's...
      ]
    
  7. (可选)要启用管理员命令如 /whitelist,您需要将 Telegram 用户 ID 添加到 config.yml 中的 admins 列表中。

    admins: [
        123456789,
        987654321,
        # other admin user ids...
      ]
    
  8. 您可以通过下表描述的更多调整来扩展 config.yml,但这并非必要,如果缺少这些配置,插件将使用默认值。此外,查看 示例。

  9. 重新启动服务器或在服务器控制台中输入 tgbridge_reload。

插件配置:

字段 描述 类型 必填 默认值
enable 是否启用该插件 boolean :x: true
botToken Telegram 机器人令牌(如何创建机器人) string :heavy_check_mark: -
chats 机器人将工作的聊天列表(以防止未知聊天使用机器人) number[] or string[] :heavy_check_mark: []
topics Telegram 论坛主题,如果留空则使用“General”主题。 number[] or string[] :x: []
admins 被授权使用管理员命令(如 /whitelist)的 Telegram 用户 ID 列表 number[] or string[] :x: []
serverStartMessage 服务器启动时发送到聊天的内容 string :x: 'Server started.'
serverStopMessage 服务器停止时发送到聊天的内容 string :x: 'Server stopped.'
logJoinLeave 如果为 true,当玩家加入或离开服务器时,插件会向聊天发送相应消息 boolean :x: true
logFromMCtoTG 如果为 true,插件会将服务器上玩家的聊天消息发送到 Telegram 聊天 boolean :x: true
logFromTGtoMC 如果为 true,插件会将聊天中的消息发送到 Minecraft 服务器 boolean :x: true
logPlayerDeath 如果为 true,当玩家死亡时,插件会向 Telegram 发送消息 boolean :x: false
logPlayerAsleep 如果为 true,当玩家入睡时,插件会向 Telegram 发送消息 boolean :x: false
logPlayerAdvancement 如果为 true,当玩家获得成就时,插件会向 Telegram 发送消息 boolean :x: true
logInventory 如果为 true,插件会发送背包、物品或末影箱的图片 阅读更多 boolean :x: true
logWhitelistKick 如果为 true,当玩家因未列入白名单而被踢出时,插件会发送通知 boolean :x: true
strings 用于插件国际化 (i18n) 的标记-字符串字典 Map<string, string> :x: 见默认配置
commands 在 Telegram 机器人中使用的命令文本字典 Map<string, string> :heavy_check_mark: 见下文
telegramMessageFormat TGtoMC 聊天消息的格式字符串 string :x: 见默认配置
minecraftMessageFormat MCtoTG 聊天消息的格式字符串 string :x: 见默认配置
silentMessages 禁用 Telegram 聊天中的通知 boolean :x: false
apiOrigin 为机器人使用不同的 API 端点 string :x:
disableConfigWatch 不监听配置文件的变化 string :x: false

Telegram 机器人命令:

命令可通过配置文件自定义。如果配置文件中不存在某条命令,则该命令将被禁用。

命令 描述
/online 获取当前在线的玩家
/time 获取服务器上的时间
/chat_id 获取当前运行命令所在聊天的 ID(用于 config.yml)
/whitelist (仅限管理员)管理服务器白名单 - 列出已列入白名单的玩家或添加/移除玩家

格式字符串:

+--------+ >--minecraftMessageFormat(message)-> +--------------+
| Paper |                                      | Telegram bot |
+--------+ <--telegramMessageFormat(message)--< +--------------+

适用于 telegramMessageFormat 和 minecraftMessageFormat 配置。 必须包含 %username% 和 %message%。 你可以使用它来自定义消息颜色(着色仅适用于 telegramMessageFormat)。你可以自定义加粗/斜体/删除线格式(仅适用于 minecraftMessageFormat)。 有关更多信息,请参阅 Minecraft 消息颜色代码 和 Telegram 消息格式。 此功能与 此问题 相关

插件命令:

命令 描述
tgbridge_reload 无需停止服务器即可重新加载插件配置。仅通过服务器控制台有效
tgbroadcast 向所有 Minecraft 玩家和已配置的 Telegram 频道广播消息;玩家、命令方块以及拥有 bukkit.command.say 权限的数据包均可使用

权限

权限 描述
tg-bridge.silentjoinleave 设置为 true 时,机器人不会为该玩家发送加入和离开消息。该玩家也不会出现在 /online 命令中。

物品栏

类似于 InteractiveChat 插件的行为(非依赖项!)。 已实现的命令:

  • [inv]
  • [item]
  • [ender]

分享书籍示例

白名单管理

服务器管理员可以直接通过 Telegram 使用 /whitelist 命令管理白名单:

  • /whitelist - 列出所有已列入白名单的玩家
  • /whitelist <player_name> - 切换玩家的白名单状态(如果未列入白名单则添加,如果已列入则移除)

此命令仅对 admins 配置字段中列出的用户可用。当玩家因未被列入白名单而被踢出时,插件还会发送通知(可通过 logWhitelistKick 配置)。

白名单示例

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源