DiscordBridge 文档
插件描述
DiscordBridge 是一个高性能、生产级标准的 Discord ↔ Minecraft 桥接平台,专为 Paper 1.21+ 和 Java 21+ 设计。它通过完全异步的安全机制、模块化架构以及广泛的配置选项,将你的 Minecraft 服务器与 Discord 连接起来。
主要特性
- 实时聊天桥接: 实现你的 Minecraft 全局聊天与专用 Discord 频道之间无缝的双向通信。
- 玩家事件通知: 完全可自定义的公告,用于播报玩家加入、离开、首次加入以及死亡等事件。
- 服务器状态警报: 当服务器启动或关闭时自动发送通知。
- 现代 Paper 与 Java 支持: 利用 Java 21 的特性和 Paper 的高级异步调度器 API,防止主线程卡顿。
- 模块化配置: 设置被清晰地分离到
config.yml、channels.yml、features.yml、messages.yml 和 permissions.yml 中。
- JDA 集成: 基于 JDA 5.2.2,具备安全网关意图(gateway intents)和优雅的连接处理机制。
配置文件概览
config.yml:核心设置、Discord 机器人令牌(Bot Token)以及服务器标识。
channels.yml:将桥接功能(聊天、日志、状态)映射到 Discord 频道 ID。
features.yml:开启或关闭各个模块以节省内存和提升性能。
messages.yml:集中化的文本模板和本地化系统,支持 Minecraft 的 MiniMessage 格式和 Discord 的 Markdown 格式。
permissions.yml:配置 Minecraft 权限节点和授权的 Discord 角色 ID。
命令
| 命令 |
别名 |
描述 |
权限 |
/discordbridge |
/db, /dbridge, /mc |
显示插件状态和版本信息。 |
discordbridge.admin |
/discordbridge reload |
/db reload |
重新加载所有配置文件。 |
discordbridge.admin |
权限
Minecraft 权限
discordbridge.admin — 授予对管理命令(如 /db reload)的访问权限。(默认:op)
Discord 权限
- 在
permissions.yml 下的 discord.admin-roles 中进行配置。
快速安装指南
- 通过 Discord Developer Portal 创建 Discord 应用程序和机器人(Bot)。
- 在你的 Bot 设置下启用 消息内容意图(Message Content Intent) 和 服务器成员意图(Server Members Intent)。
- 邀请该机器人到你的 Discord 服务器,并赋予其读取/发送消息的权限。
- 将
DiscordBridge.jar 放入你的 Paper 服务器的 plugins/ 目录中。
- 启动服务器一次以生成默认的配置文件。
- 打开
plugins/DiscordBridge/config.yml 并填入你的 Discord Bot Token 和 Guild ID。
- 打开
plugins/DiscordBridge/channels.yml 并设置你想要的 Discord 文本频道 ID。
- 在 Minecraft 控制台或游戏聊天中运行
/db reload 以应用更改。
DiscordBridge Documentation
Plugin Description
DiscordBridge is a high-performance, production-grade Discord ↔ Minecraft bridge platform designed specifically for Paper 1.21+ and Java 21+. It connects your Minecraft server to Discord with full asynchronous safety, modular architecture, and extensive configuration options.
Key Features
- Real-time Chat Bridge: Seamless two-way communication between your Minecraft global chat and a dedicated Discord channel.
- Player Event Notifications: Fully customizable announcements for player joins, leaves, first-time joins, and deaths.
- Server Status Alerts: Automated notifications when the server starts up or shuts down.
- Modern Paper & Java Support: Leverages Java 21 features and Paper's advanced asynchronous scheduler APIs to prevent main-thread lag.
- Modular Configuration: Clean separation of settings into
config.yml, channels.yml, features.yml, messages.yml, and permissions.yml.
- JDA Integration: Powered by JDA 5.2.2 with secure gateway intents and graceful connection handling.
Configuration Files Overview
config.yml: Core settings, Discord bot token, and server identification.
channels.yml: Maps bridge functions (chat, logs, status) to Discord Channel IDs.
features.yml: Toggles individual modules on or off to save memory and performance.
messages.yml: Centralized text template and localization system supporting MiniMessage formatting for Minecraft and Markdown for Discord.
permissions.yml: Configures Minecraft permission nodes and authorized Discord role IDs.
Commands
| Command |
Aliases |
Description |
Permission |
/discordbridge |
/db, /dbridge, /mc |
Displays plugin status and version info. |
discordbridge.admin |
/discordbridge reload |
/db reload |
Reloads all configuration files. |
discordbridge.admin |
Permissions
Minecraft Permissions
discordbridge.admin — Grants access to administrative commands like /db reload. (Default: op)
Discord Permissions
- Configured inside
permissions.yml under discord.admin-roles.
Quick Installation Guide
- Create a Discord Application and Bot via the Discord Developer Portal.
- Enable the Message Content Intent and Server Members Intent under your Bot settings.
- Invite the bot to your Discord server with permissions to read/send messages.
- Drop
DiscordBridge.jar into your Paper server's plugins/ directory.
- Start your server once to generate default configuration files.
- Open
plugins/DiscordBridge/config.yml and insert your Discord Bot Token and Guild ID.
- Open
plugins/DiscordBridge/channels.yml and set your desired Discord Text Channel IDs.
- Run
/db reload in your Minecraft console or game chat to apply changes.
评论 0
登录后参与评分
还没有评论,来抢沙发吧