nonebot-plugin-mc-whitelist-controller 0.1.5

nonebot-plugin-mc-whitelist-controller

nonebot-plugin-mc-whitelist-controller

✨一个控制管理Minecraft服务器白名单的机器人插件✨

[!NOTE] 该项目目前还处于开发中，还不属于完全体，还不是很稳定！

📖 介绍

这是一个控制管理Minecraft服务器白名单的机器人插件，将mc服务器中的玩家id与QQ号绑定，实现对服务器内所有玩家的追根溯源，支持正版服务器和离线服务器。本插件可以在QQ中将玩家id注册入服务器白名单，同时会生成一个包含每个玩家id与其绑定的QQ号信息的json文件，供服务器管理员参看。

💿 安装

使用pip安装

在nonebot2项目插件目录下，打开命令行，输入以下安装命令

pip install nonebot-plugin-mc-whitelist-controller

使用git clone安装

可以将本项目克隆到你已经建立好的Nonebot机器人的目录内，并在project.toml中配置好本插件的安装目录

git clone https://github.com/leaf2006/nonebot-plugin-mc-whitelist-controller.git

⚙️ 配置

在 nonebot2 项目的.env文件中添加下表中的必填配置

配置项	必填	默认值	说明
WHITELIST_PATH	是	无	服务器whitelist.json的绝对路径
PROFILE_PATH	否	profile.json	存放玩家id和QQ号的文件的绝对路径（若不存在该文件会自动创建），如果未填该配置会自动在机器人根目录创建profile.json
SERVER_STATUS	否	offile	填写服务器状态（正版/离线服务器）：online/offline

• WHITELIST_PATH配置示例：

# .env
# 本示例中给出的地址为虚构地址，仅供演示
WHITELIST_PATH=C:\Users\Minecraft\whitelist.json

• PROFILE_PATH配置示例：

# .env
# 本示例中给出的地址为虚构地址，仅供演示
PROFILE_PATH=C:\Users\Minecraft\profile.json

此处PROFILE_PATH可以是绝对路径内的任意路径，但是在路径最后必须包括文件名，即使这个文件还未被创建

🎉 使用

指令表

指令	权限	需要@	范围	说明
/注册 或 /register + [玩家id]	群员	否	群聊	向服务器白名单注册玩家信息
/指令列表	群员	否	群聊	查看指令列表

[!IMPORTANT] 在首次使用本插件前，或切换过SERVER_STATUS参数后，请务必手动清除whitelist.json中除"[]"号外的所有内容，防止出现错误；且非必要情况请不要修改nonebot_plugin_mc_whitelist_controller/data/profile.json文件，以免出现问题！

效果图

注：以下示例展示的是在离线服务器环境下的实机演示

此时whitelist.json会自动添加以下语句：

[
    // whitelist.json
    ...
    {
        "uuid": "dbc89c79-8236-36b0-b2cf-7dd0b9989b27",
        "name": "leaf2006"
    }
]

此时profile.json会自动添加以下语句，包括注册者的玩家id与QQ号：

[
    ...
    // nonebot_plugin_mc_whitelist_controller/data/profile.json
    {
        "name": "leaf2006",
        "qq": "此处代表该人的QQ号"
    }
]

Copyright © Leaf developer 2023-2026，遵循MIT开源协议