WhitelistAPI - 通用白名单API
⭐ 功能
WhitelistAPI适用于需要获取服务器白名单的场景.支持常见的白名单操作以及白名单玩家列表获取.
本插件会自动跟踪白名单文件whitelist.json
的变化而自动同步列表,保证通过api调用得到的白名单列表是最新的
- 获取白名单内所有成员
- 获取白名单内所有成员的玩家名
- 获取白名单内所有成员的uuid列表
- 开启服务器白名单功能
- 关闭服务器白名单功能
- 添加正版玩家白名单
- 添加离线玩家白名单
- 移除玩家白名单
- 根据服务器在线/离线自适应添加白名单
📌 依赖
python依赖 | 版本 |
---|---|
mcdreforged | ^2.6.0 |
watchdog | ^5.0.2 |
⌨️ 使用方式
示例代码
def on_load(server, old):
whitelist_api = server.get_plugin_instance('whitelist_api') # 通过MCDR获取API实例
whitelist_api.get_whitelist() # 获取白名单内所有成员
whitelist_api.get_whitelist_uuids() # 获取白名单内所有成员的uuid列表
whitelist_api.get_whitelist_names() # 获取白名单内所有成员的玩家名
whitelist_api.add_player('Aimerny') # 根据目标server的online-mode自适应添加白名单
whitelist_api.add_offline_player('Aimerny') # 添加离线玩家白名单
whitelist_api.add_online_player('Aimerny') # 添加正版玩家白名单
whitelist_api.remove_player('Aimerny') # 移除玩家白名单
whitelist_api.enable_whitelist() # 开启服务器白名单功能
whitelist_api.disable_whitelist() # 关闭服务器白名单功能
🎾 使用此api的插件集合
- Offline Whitelist Reforged: 简单小巧的离线服白名单插件
- KookIn: Kook平台的MC机器人
介绍文本来源:src/whitelist_api/README.md