discord-连接-模板

Discord 连接模板

Discord 连接模板是一个服务端 Minecraft Forge 模组，可将 Minecraft 服务器和玩家事件发送到可自定义的 Discord 集成 API。

本项目作为模板提供给服务器管理员和开发者，方便他们使用自己的 API 实现将 Minecraft 与 Discord 连接起来。

功能特性

• 发送服务器启动和停止事件
• 发送玩家加入和离开事件
• 发送定期心跳事件
• 通过 /discord link 生成 Discord 账户关联代码
• 支持游戏内英文和日文消息
• 使用可配置的 API 端点和身份验证
• 未配置 API URL 时跳过 API 请求

配置

本模组不包含托管 API、数据库、数据库凭据或私有服务器配置。

首次启动服务器后，编辑生成的配置文件：

config/discord_connector-server.toml

配置以下值：

server_id = "your-server-id"
api_url = "https://your-api.example.com"
api_key = "your-api-key"

默认配置中，api_url 和 api_key 为空。在您提供自己的兼容 API 之前，API 通信将保持禁用状态。

游戏内使用

在 Minecraft 中运行以下命令：

/discord link

模组将生成一个临时关联代码并显示要使用的 Discord 命令：

/link code:YOUR_CODE

关联代码有效期为 10 分钟。

API 端点

兼容的 API 应实现以下端点：

• POST /v1/minecraft/events/server-start
• POST /v1/minecraft/events/server-stop
• POST /v1/minecraft/events/join
• POST /v1/minecraft/events/leave
• POST /v1/minecraft/heartbeat
• POST /v1/minecraft/link-code

请求和响应格式已在项目源代码和 README 中说明。

重要说明

• 本模组不提供托管 API 或数据库。
• 您需要自行托管和保护您的 API。
• 切勿发布 API 密钥、数据库凭据或私有配置文件。
• 本模组适用于服务端和客户端使用。

许可证

有关使用和再分发的条款，请参阅附带的许可证文件。