1 个稳定版本
1.0.0 | 2024年7月31日 |
---|
#272 在 命令行工具
106 每月下载量
17KB
218 代码行
minebot
一个简单的 Discord 机器人,用于与您的 Minecraft 服务器交互。
安装
有多种运行机器人方式,或者您可以从源代码构建。
Docker Compose(推荐)
- 创建一个包含以下内容的
compose.yaml
文件
version: "3.8"
services:
minebot:
image: ghcr.io/the-noah/minebot:latest
container_name: minebot
restart: unless-stopped
environment:
- DISCORD_TOKEN=your_discord_bot_token
- GUILD_ID=your_discord_guild_id
- MINECRAFT_IP=your_minecraft_server_ip
- 运行机器人
docker compose up -d
Docker
- 运行机器人
docker run -d --name minebot \
-e DISCORD_TOKEN=your_discord_bot_token \
-e GUILD_ID=your_discord_guild_id \
-e MINECRAFT_IP=your_minecraft_server_ip \
ghcr.io/the-noah/minebot:latest
二进制文件(通过 Cargo)
- 安装机器人
cargo install minebot
- 在项目的根目录中创建一个
.env
文件并添加以下内容
DISCORD_TOKEN=your_discord_bot_token
GUILD_ID=your_discord_guild_id
MINECRAFT_IP=your_minecraft_server_ip
- 运行机器人
minebot
用法
机器人启动时会自动注册斜杠命令。您可以使用以下命令
/ping
- 检查机器人是否在线/status
- 获取包含玩家信息的 Minecraft 服务器的状态/say
- 以服务器身份在 Minecraft 聊天中发送消息(需要 Discord 管理员权限)/whitelist
/whitelist add <username>
- 将玩家添加到白名单(需要 Discord 管理员权限)/whitelist remove <username>
- 从白名单中移除玩家(需要 Discord 管理员权限)/whitelist list
- 列出白名单上的所有玩家(需要 Discord 管理员权限)
机器人还将自动更新其状态,显示在线玩家数量。
从源代码构建
- 克隆仓库
git clone https://github.com/The-Noah/minebot.git
- 构建机器人
cd minebot
cargo build --release
- 在项目的根目录中创建一个
.env
文件并添加以下内容
DISCORD_TOKEN=your_discord_bot_token
GUILD_ID=your_discord_guild_id
MINECRAFT_IP=your_minecraft_server_ip
- 运行机器人
./target/release/minebot
许可证
依赖项
~11–23MB
~353K SLoC