Note
GamesAI 插件/模组 QQ 交流群:849544707 — 欢迎加入交流群讨论问题、反馈建议,以及分享 prompt、skills、tools 等配置!
Note
欢迎使用版本 0.6.4!本次更新带来了 AI 工具权限系统(@register_tool 的 perm 参数)、热重载时全量重建工具注册(内置工具重放、自定义 tools.py 重新导入、第三方插件随工具一起重载)以及多项重载与权限修复。白名单与 Minecraft Wiki 工具已迁移至 GamesAI-Extra。见本次更新
目录(点击展示)
安装
在MCDR控制台中使用如下命令以安装插件
!!MCDR plugin install games_ai
或者在MCDR插件仓库中获取并安装到你的插件目录内
如果选择手动安装,请先安装Python包OpenAI、requests和websockets,使用如下命令安装
pip install openai requests websockets
使用
在任何地方输入命令!!gamesai以显示这个插件的所有功能
| 指令 | 用途 |
|---|---|
!!gamesai clear | 清除玩家的历史聊天记录,历史聊天记录与公共数据库无关 |
!!gamesai clearall | 清除所有玩家的历史聊天记录,历史聊天记录与公共数据库无关 |
!!gamesai reload | 重新加载插件配置文件。详见热重载 |
!!gamesai check | 检查插件更新 |
!!gamesai speedtest [model] | 测试 API 服务器连接延迟,不指定模型时测试全部 |
!!gamesai config get <key> | 读取一个配置项的值。 |
!!gamesai config set <key> <value> | 修改一个配置项的值(自动适配旧值类型,修改后自动触发热重载)。 |
你也可以直接输入!!ask向AI提问或者聊天或者帮你做一些事情
| 指令 | 用途 |
|---|---|
!!ask <content> | 向AI提问或者聊天或者帮你做一些事情,content为你想让AI做的事情或者你想问AI的问题 |
!!ask -m <model> <content> | 使用指定的模型向AI提问或者聊天或者帮你做一些事情,model为你想使用的模型的AI_ID或昵称,content为你想让AI做的事情或者你想问AI的问题 |
!!ask -n <content> | 向AI提问但不使用历史记录(当前对话仍会被保存) |
!!ask -n -m <model> <content> | 使用指定的模型且不使用历史记录提问 |
输入!!data获取有关数据库指令的信息
Tip
更新到0.3.0及以上版本时会自动添加数据库
| 指令 | 用途 |
|---|---|
!!data write <key> <value> | 在公共数据库内添加一条数据,其中key不能包含空格,value可以是任意字符串 |
!!data add <key> <value> | 将value追加到公共数据库中的key中,不存在时自动创建新key |
!!data del <key> | 在公共数据库内删除一条数据,无论key是否存在 |
!!data read <key> | 读取公共数据库中key对应的value |
!!data list | 读取公共数据库中的所有内容 |
!!data list keys | 读取公共数据库中的所有key |
使用 Mineflayer Bot
GamesAI 0.6.0 引入了基于 Mineflayer 的全自主 Minecraft 机器人。AI 可以直接控制机器人在游戏世界中寻路、挖掘、建造、合成、战斗和交互。
环境要求
- 服务器需安装 Node.js >= 18 和 npm
- 插件首次启动时自动安装 npm 依赖(
mineflayer、ws、vec3、mineflayer-pathfinder、mineflayer-mcefly),并在已安装的 mineflayer 不支持当前服务器版本时(例如服务器升级后)自动刷新依赖 - 一个用于 Bot 的 Minecraft 账号(Microsoft/Mojang/离线)
指令
| 指令 | 用途 |
|---|---|
!!aibot join | 启用 Bot 并让其加入服务器。 |
!!aibot leave | 让 Bot 离开服务器并禁用。 |
!!aibot set <key> <value> | 配置 Bot 身份(username/password/auth)。 |
工作原理
玩家 !!ask → GamesAI 插件 → WS 客户端 (Python) → WS 服务器 (Node.js) → Mineflayer Bot
↓
Minecraft 服务器
AI(自主控制器):
get_state → 分析状态 → bot_call_action(goto/dig/attack/...) → 循环
插件启动一个 Node.js 进程运行 WebSocket 服务器,Python WebSocket 客户端(插件内置)通过本地连接与其通信,形成 MCDR 与 Mineflayer Bot 之间的桥梁。Bot 启动后,自主 AI 控制器会定时读取机器人状态、检查聊天消息,并自主决定执行什么操作。
支持的操作
Bot 支持 20+ 种操作,通过 bot_call_action AI 工具调用:
| 操作 | 描述 |
|---|---|
goto | A* 寻路到坐标 {x, y, z, range?} |
efly | 鞘翅飞行到坐标(需装备鞘翅) |
dig | 挖掘指定坐标的方块 |
place | 在指定坐标放置方块 |
attack | 按名称攻击附近实体,或攻击最近敌对生物 |
useOn | 右键实体(如村民交易) |
equip / unequip | 装备/卸下盔甲或手持物品 |
mount / dismount | 骑乘或离开载具和动物 |
craft | 合成物品(背包或工作台) |
lookAt | 看向坐标或直接设置 yaw/pitch |
sleep / wake | 在床上睡觉或起床 |
activateBlock | 右键方块(打开箱子、按下按钮) |
setControlState | 控制载具移动(前进/后退/跳跃) |
viewContainer / takeFromContainer / putToContainer | 容器管理 |
openFurnace / furnacePutInput / furnacePutFuel / furnaceTakeOutput | 熔炉操作 |
nearbyEntities / findBlocks / getBlock | 世界查询 |
stop / stopEfly | 停止所有移动或鞘翅飞行 |
Bot 控制 AI 工具
除 bot_call_action 外,还有以下专用 AI 工具:
| 工具 | 描述 |
|---|---|
bot_chat | 让 Bot 在公共聊天中发送消息。 |
bot_whisper | 让 Bot 向某个玩家发送私聊消息。 |
bot_get_state | 获取 Bot 完整状态(30+ 字段)。 |
run_mineflayer_bot / stop_mineflayer_bot | 启动或停止 Bot。需要达到配置的 permission 权限等级(0.6.4+)。 |
delegate_to_bot | 将复杂的 Minecraft 任务委派给自主控制器。 |
配置
完整配置参考见 6.mineflayer_bot。关键要点:
- 将
mineflayer_bot.enabled设为true(或使用!!aibot join)以启动 Bot mineflayer_bot.bot.username/password/auth— Bot 的 Minecraft 登录凭据。用户名必须匹配[a-zA-Z0-9_]+(仅限英文字母、数字和下划线)。mineflayer_bot.cycle_interval— 自主 AI 决策间隔(秒)mineflayer_bot.websocket— 内部设置,除非明确知道用途否则不要修改
Note
修改 Bot 配置后,执行 !!gamesai reload(或使用 !!aibot set / !!gamesai config set)即可自动重启 Bot 并应用新配置。详见热重载。
配置
默认配置文件结构如下:
{
"prefix": "[GamesAI]",
"permission": 3,
"max_history": 10,
"all_ai": {
"<Your AI ID>":{
"prompt": "你是一名成熟、稳重的Minecraft机器人工具,你的名字叫做“GamesAI”",
"ai_name": "[GamesAI]",
"base_url": "<Your API Base URL>",
"ai_model": "<Your AI Model>",
"api_key": "<Your API Key>",
"extra_body": {}
}
},
"default_ai": "<Your AI ID>",
"mineflayer_bot": {
"enabled": false,
"cycle_interval": 15.0,
"websocket": {
"url": "ws://127.0.0.1:8080",
"reconnect_interval": 10,
"timeout": 60
},
"bot": {
"username": "<Your Minecraft Bot Username>",
"password": "<Your Minecraft Bot Password>",
"auth": "microsoft"
}
}
}
以下是每个参数的简介:
1.prefix
值的类型: str
默认值: [GamesAI]
填入插件的名称,以在插件的回复之前加上一个前缀,可以包含Minecraft格式化代码
2.permission
值的类型:int
默认值:3
执行!!data等指令所必须达到的权限,见MCDR权限相关文档
自 0.6.4 起,该值同时决定向玩家 AI 提供哪些工具:perm 高于玩家权限等级的工具不会传给 AI 模型,模型既看不到也无法调用。管理数据、技能、自定义工具或启停 Bot 的内置工具都使用该值(通过 get_plugin_config_perm),并在每次请求时实时读取,重载后立即生效。
3.max_history
值的类型: int
默认值: 10
填入每个玩家最大可保留的历史记录,与公共数据库无关。设置为 0 时完全禁用历史记录功能
4.all_ai
值的类型: dict
默认值:见文件
填入所有的AI信息,由多个字典组成,每个字典为一个AI模型,字典的键即为插件内部的AI_ID
prompt: 这项配置用于为每个AI编写提示词。使用> xxx.md将提示词指向config/games_ai/prompt/xxx.md文件,不限文件类型
ai_name: 这项配置与prefix功能类似,但是你现在需要单独为每一个模型设置,可以包含Minecraft格式化代码
base_url, ai_model, api_key: 与以前的相关配置功能相同,但是你现在需要单独为每一个模型设置
extra_body:请参考各API提供商对 extra_body 项的说明以编写。对于DeepSeek用户,想要移植原有 thinking 的,直接填写 {"thinking": {"type": "enabled"}}。不填时默认 {}(空)。
5.default_ai
值的类型: str
默认值: <Your AI ID>
填入当用户直接使用!!ask时使用的模型,应该填入all_ai字典中的某一个键(即为插件内部的AI_ID),如果错填,会导致无法正常使用!!ask指令
6.mineflayer_bot
值的类型: dict
默认值: 见上方
Mineflayer 自主 Bot 代理的配置项。
enabled: 是否在启动时拉起 Bot。需要 Node.js >= 18。
cycle_interval: 自主 AI 决策循环间隔秒数(默认: 15.0)。
websocket: 内部 WebSocket 连接参数 — url、reconnect_interval、timeout。
Warning
WebSocket 的 url 中 host 必须设为 127.0.0.1。请确保所选端口未被占用——插件会在启动时自动检查端口冲突,若端口被占用将自动禁用 Bot。
除非你明确知道自己在做什么,否则我们不建议你修改 websocket 内的配置。
bot: Minecraft 账号凭据 — username、password、auth(microsoft/mojang/offline)。服务器地址自动从 server.properties 中检测。
Warning
username 必须符合正则表达式 [a-zA-Z0-9_]+(仅限英文字母、数字和下划线,不含空格)。若用户名包含非法字符,!!aibot join 将被拒绝。
Tip
修改配置后,使用 !!gamesai reload 或 !!gamesai config set 使更改生效。详见热重载。
工具与Skills
Tip
部分工具由 GamesAI-Extra 插件提供——坐标点管理与位置追踪,以及(0.6.4 起)白名单管理(get_whitelist_name、add_to_whitelist、remove_from_whitelist)和 search_minecraft_wiki。安装该插件即可获得这些工具。
内置工具
GamesAI插件提供了很多内置的工具,见下表。如果你想要更多的工具,可以选择向作者投稿、在配置文件中自定义工具、或在自己的MCDR插件中注册工具。
点击查看所有的内置工具
| 工具ID | 传入参数 | 用途 |
|---|---|---|
| get_online_players | 无 | 获取服务器内在线的玩家列表。依赖于online_player_api插件,RCON 可用时回退为 RCON list 查询 |
| get_player_position | player | 获取指定玩家的位置和维度。依赖于minecraft_data_api插件,不存在时自动关闭此工具 |
| calculator | expression | 简单的数学表达式计算器 |
| item_caculator | expression,single_limit | 数学表达式计算器,并将最终结果转换为物品计数法,即 盒、组、个,自动适应物品的堆叠数,不存在时默认使用64 |
| ai_read_data | key | 读取一条数据库内容 |
| ai_read_all_keys | 无 | 获取数据库中所有的键 |
| ai_read_all_data | 无 | 一次性读取数据库中所有键值对 |
| ai_write_data | key,value | 向数据库中写入一条数据(覆写模式) |
| ai_add_data | key,value | 向数据库中写入一条数据(追加模式) |
| read_skills | skills | 读取已注册的技能指导文件,引导 AI 执行特定任务 |
| write_skills | skills、summary、content | 创建或覆写一个技能文件并注册到技能索引中 |
| modify_skills | skills、summary、content | 修改已有技能文件并更新索引中的简介 |
| delete_skills | skills | 删除一个技能文件并从技能索引中移除 |
| read_custom_tools | 无 | 读取当前自定义 tools.py 文件的内容 |
| modify_custom_tools | tools | 用新代码替换整个自定义 tools.py 文件 |
| append_custom_tools | tools | 向自定义 tools.py 文件末尾追加新工具代码 |
| setting_timer | duration | 暂停执行指定秒数后再继续下一步操作 |
| reload_plugin | 无 | 热重载插件以应用配置、技能和自定义工具的更改,不会丢失聊天记录。详见热重载 |
| ai_del_data | key | 删除数据库中的一条数据 |
| bot_chat | message | 让 Mineflayer 机器人在 Minecraft 聊天中发送消息。 |
| bot_whisper | username, message | 让机器人私聊某个玩家。 |
| bot_get_state | 无 | 获取机器人完整状态(30+ 字段)。 |
| bot_call_action | action, params | 向机器人发送任意指令(goto,dig,place,attack 等)。 |
| run_mineflayer_bot | 无 | 启动 Mineflayer 机器人(如果未运行)。需要达到配置的 permission 权限等级。 |
| stop_mineflayer_bot | 无 | 停止 Mineflayer 机器人。需要达到配置的 permission 权限等级。 |
| delegate_to_bot | task | 将复杂的 Minecraft 任务委派给自主 Bot 控制器。 |
Note
自 0.6.4 起,perm 高于请求玩家权限等级的工具不会提供给 AI。写入/删除数据、管理技能、管理自定义工具或启停 Bot 的工具需要达到配置的 permission 权限等级。
在配置文件中自定义工具
通过修改config/games_ai/tools/tools.py文件来实现自定义修改工具。
先来看看默认值如何:
from mcdreforged.command.command_source import CommandSource
from games_ai.games_ai_tool import register_tool
@register_tool(description="My Custom Tool")
def my_custom_tool(source: CommandSource, ai_prefix: str):
return "Tool execution completed"
Important
代码中的from games_ai.games_ai_tool import register_tool和函数定义前的@register_tool必须存在。
Tip
在 0.5.7+ 版本中,AI 可以自主读取、修改和追加自定义工具文件。只需让 AI 帮你添加新工具——它会先读取当前文件,编写新代码,然后通过 热重载 使修改生效。
description 是必填项,告诉 AI 此工具的用途。parameters 字典(可选)定义了 AI 应传入的参数,遵循 OpenAI function calling 格式。函数签名必须包含 source: CommandSource 和 ai_prefix: str 作为前两个参数,其后跟随 parameters 中定义的参数。
自 0.6.4 起,可选的 perm 参数用于设置向玩家 AI 提供该工具所需的最低权限等级——可以是 int,也可以是返回 int 的零参可调用对象(如 get_plugin_config_perm,动态跟随插件的 permission 配置)。默认值为 0(所有玩家可用):
from games_ai.games_ai_tool import register_tool, get_plugin_config_perm
@register_tool(description="管理员专用工具", perm=get_plugin_config_perm)
def my_admin_tool(source: CommandSource, ai_prefix: str):
return "仅对达到配置权限等级的玩家可见"
权限高于玩家等级的工具根本不会传给 AI;出于安全考虑,仍应在函数内部保留 source.get_permission_level() 运行时检查。
Tip
在 @register_tool 旁添加 @register_bot_tool() 装饰器(同样从 games_ai.games_ai_tool 导入),可以让该工具被自主 Mineflayer Bot 控制器使用。不加则只能通过 !!ask 由聊天 AI 调用。
在自己的MCDR插件中自定义工具
如果你在开发独立的 MCDR 插件,可以直接在插件代码中注册工具,无需修改 tools.py:
from games_ai.games_ai_tool import register_tool, register_bot_tool
@register_tool(
description="你的自定义工具的描述",
parameters={...} # 可选
)
@register_bot_tool() # 可选 — 让该工具可被 Mineflayer Bot 控制器使用
def my_plugin_tool(source: CommandSource, ai_prefix: str, ...):
source.reply(f'{ai_prefix}正在执行我的工具...')
return "工具执行结果"
Important
你的插件必须在 mcdreforged.plugin.json 中将 games_ai 的版本依赖设为 >= 0.4.1,否则导入会失败。如果使用了 @register_bot_tool(),最低版本应为 >= 0.6.0。
你的插件需要在 mcdreforged.plugin.json 中将 games_ai 列为依赖,以确保 GamesAI 先加载:
{
"id": "my_plugin",
"dependencies": {
"mcdreforged": ">=2.15.0",
"games_ai": ">=0.4.1"
}
}
以此方式注册的工具与内置工具完全相同——AI 可以直接调用,如果需要也可以使用 @register_bot_tool() 标记为 Bot 可用工具。自 0.6.4 起,可选的 perm 参数(int 或返回 int 的零参可调用对象,如 get_plugin_config_perm)用于控制工具对哪个权限等级开放。
Note
自 0.6.4 起,凡是通过 @register_tool 注册过工具的插件,都会在 !!gamesai reload 时自动重载,其工具代码始终保持最新——无需再调用 register_self()。只有当你的插件需要自定义重载逻辑,或者不注册工具也想跟随重载时,才需要使用 register_self()。详见让自己的 MCDR 插件跟随 GamesAI 热重载。
如果你希望你的插件在 GamesAI 执行 !!gamesai reload 时自动重载——例如插件只注册了技能(没有注册工具),或需要自定义重载逻辑——在你的插件 on_load 中调用 register_self():
from games_ai.register_extra_plugin import register_self
def on_load(server, old):
register_self(server.get_self_metadata().id)
这样你的插件会随 GamesAI 的配置和工具一起重载,工具代码的修改会立即生效。更多细节见热重载。
内置Skills
GamesAI 内置了以下技能文件,AI 在执行相关操作前会自动读取:
| 技能文件 | 描述 |
|---|---|
skills_management.md | 指导 AI 如何正确读取、写入、修改和删除技能文件。 |
custom_tools_management.md | 指导 AI 如何安全地读取、修改和追加自定义工具代码。 |
mineflayer_bot_guide.md | 指导 AI 如何操控 Mineflayer 机器人(仅在 Bot 运行时可用)。 |
Tip
Skills 就像 AI 的「标准作业程序 (SOP)」——确保 AI 每次都遵循正确的工作流程。
在配置文件中添加Skills
Skills 技能系统让你可以编写指导文件来规范 AI 处理特定任务的方式——例如白名单管理、假人控制等。
技能文件存放在 config/games_ai/skills/ 目录下,格式为 Markdown(.md)。要注册一项技能,编辑 config/games_ai/skills/skills.json。以下是一个示例配置(whitelist.md 和 player.md 仅为示例文件名,并非插件内置文件):
[
{
"file": "whitelist.md",
"description": "添加/删除/查询白名单时都应读取此技能文件"
},
{
"file": "player.md",
"description": "创建/控制/删除假人时必须读取此技能文件"
}
]
file— 技能文件名(相对于skills文件夹)。description— 展示给 AI 的简短提示,说明何时应当读取此技能。
技能注册后会出现在 AI 的系统提示中。AI 可以使用 read_skills 工具在执行相关任务前读取技能文件的完整内容。
在自己的MCDR插件中注册Skills
你可以从自己的 MCDR 插件中以编程方式注册技能文件,使其自动出现在 AI 的系统提示中:
from games_ai.external_skills_loader import register_skills
def on_load(server, old):
register_skills(
file_name="my_skill.md",
description="执行 XYZ 操作前应读取此技能文件",
content="""## 我的技能
此技能指导 AI 如何...
- 步骤 1:...
- 步骤 2:...
"""
)
Important
你的插件必须在 mcdreforged.plugin.json 中将 games_ai 的版本依赖设为 >= 0.6.1。
file_name— 技能文件名(AI 的read_skills工具通过此名称定位文件)。description— 展示给 AI 的简短提示,说明何时应当读取此技能。content— 技能文件的完整 Markdown 内容。
以此方式注册的技能与 skills.json 中定义的技能完全相同——它们会出现在 AI 的系统提示中的「Available skills」列表里,并可通过 read_skills 工具读取。如果你还希望插件在 GamesAI 热重载时自动刷新,请参考让自己的 MCDR 插件跟随 GamesAI 热重载。
热重载
GamesAI 提供了完善的热重载机制,让你在不重启服务器的情况下应用配置、工具和技能的变更。
触发热重载
热重载可通过以下方式触发:
| 方式 | 说明 |
|---|---|
!!gamesai reload | 管理员手动执行,重新加载全部配置、工具与技能。 |
!!gamesai config set <key> <value> | 修改配置项后自动触发重载。 |
AI 工具 reload_plugin | AI 在修改工具代码或技能文件后调用,确保变更立即生效。 |
!!aibot set <key> <value> | 修改 Bot 配置后自动触发重载。 |
重载期间发生了什么
执行热重载时,插件会依次执行以下操作:
- 重新读取配置文件 (
config/games_ai/config.json) — 应用prefix、permission、max_history、all_ai、default_ai等全部配置变更。 - 全量重建工具注册(0.6.4+) — 彻底清空工具注册表,然后从所有来源重建:内置工具通过注册重放恢复、自定义
tools.py重新导入、注册过工具的插件被重载以重新执行注册代码(见第 4、6 步)。 - 重新加载 Skills (
config/games_ai/skills/skills.json) — 刷新技能索引,AI 系统提示中的可用技能列表同步更新。 - 重新加载自定义工具 (
config/games_ai/tools/tools.py) — 热加载自定义工具代码,无需重启 MCDR。 - 重启 Mineflayer Bot(如已启用)— 停止现有 Bot 进程和 WebSocket 连接,应用新配置后重新启动。
- 重载注册过工具的插件与已注册的扩展插件 — 重载所有通过
@register_tool注册过工具的第三方插件(0.6.4 起自动追踪)以及REGISTER_PLUGIN_LIST中的插件(见下方)。重载失败或找不到的插件会从重载列表中移除。 - 派发
games_ai.reload事件 — 通知所有监听了此事件的其他 MCDR 插件(见下方)。
Note
热重载不会丢失玩家的聊天历史记录。
让自己的 MCDR 插件跟随 GamesAI 热重载
如果你开发了依赖 GamesAI 的 MCDR 插件(例如注册了自定义工具或技能),你可能希望插件在 GamesAI 热重载时同步刷新。GamesAI 提供了两种方式:
方式一:使用 register_self() 自动重载(推荐)
这是最简单的方式。在你的插件 on_load 中调用 register_self(),将插件加入 GamesAI 的重载列表:
Note
自 0.6.4 起,通过 @register_tool 注册过工具的插件在热重载时会自动重载(由工具注册表自动追踪),因此 register_self() 仅适用于未注册工具的插件(如只注册技能的插件)或需要自定义重载逻辑的插件。
from games_ai.register_extra_plugin import register_self
def on_load(server, old):
register_self(server.get_self_metadata().id)
每次执行 !!gamesai reload 时,你的插件会被 MCDR 自动重载(调用 server.reload_plugin())。如果重载失败,插件会被卸载并从重载列表中移除。
如果你的插件需要自定义重载逻辑(不仅仅调用默认的 reload_plugin),可以传入自定义 reloader 函数作为第二个参数。除了普通函数外,也可以传入方法(self.xxx)或 lambda 表达式:
from mcdreforged.command.command_source import CommandSource
from games_ai.register_extra_plugin import register_self
def my_reloader(source: CommandSource):
# 自定义重载逻辑
server = source.get_server()
server.logger.info("执行我的自定义重载逻辑...")
# 例如:重新读取自己的配置文件、重建数据库连接等
def on_load(server, old):
register_self(server.get_self_metadata().id, my_reloader)
Important
自定义 reloader 函数的第一个参数必须为 CommandSource(如上例中的 source),GamesAI 会将触发热重载的命令源传入该参数。
当自定义 reloader 抛出异常时,插件会被自动卸载并从重载列表中移除,同时在日志中记录失败原因。
方式二:通过监听事件响应热重载
如果你的插件不想被卸载/重载,只想在 GamesAI 热重载完成时收到通知并执行一些逻辑,可以监听 games_ai.reload 事件:
from mcdreforged.api.all import *
def on_load(server: PluginServerInterface, old):
server.register_event_listener("games_ai.reload", on_gamesai_reload)
def on_gamesai_reload(server: PluginServerInterface):
server.logger.info("GamesAI 已完成热重载,我正在同步处理...")
# 例如:重新读取 GamesAI 的最新配置
# 例如:刷新自己缓存的工具列表
Note
事件回调的第一个参数始终是 PluginServerInterface,由 MCDR 自动补齐。
Tip
games_ai.reload 事件在重载完成后派发,所以监听器拿到的已经是重载后的最新状态。
两种方式对比
register_self() 根据是否传入第二个参数(自定义 reloader)有不同的行为:
| 特性 | register_self() 不传 reloader | register_self() 传入自定义 reloader | 监听 games_ai.reload 事件 |
|---|---|---|---|
| 触发时机 | 重载过程中(第 6 步) | 重载过程中(第 6 步) | 重载完成后(第 7 步) |
| 插件行为 | MCDR 卸载后重载(on_load 重新执行) | 插件保持加载,仅调用自定义函数 | 插件不受影响 |
| 失败处理 | 插件被卸载,从重载列表移除 | 插件被卸载,从重载列表移除 | 异常不会卸载插件 |
| 工具/Skills | on_load 自动重新注册 | 无需重新注册(插件未卸载,注册保持有效) | 无需处理 |
| 适用场景 | 插件需要完整刷新代码 | 插件只需重读配置、刷新缓存等轻量操作 | 插件只需收到通知或同步状态 |
Note
注册在 GamesAI 中的工具(@register_tool)和 Skills(register_skills())的生命周期与注册它们的插件绑定。只要插件未被 MCDR 卸载,已注册的工具和 Skills 就会一直有效。因此使用自定义 reloader 时无需重新注册。
故障排查
!!ask 错误
| 症状 | 可能原因 | 解决方法 |
|---|---|---|
| HTTP 400 | 请求体格式错误 | 检查 extra_body 格式是否与 API 提供商的要求一致。 |
| HTTP 401 | API Key 无效 | 检查 AI 配置中的 api_key。 |
| HTTP 404 | 模型不存在 | 检查 ai_model 名称是否正确。 |
| HTTP 429 | 请求频率过高 | 稍后重试,或升级 API 套餐。 |
| 超时/无响应 | 网络问题或 API 响应慢 | 使用 !!gamesai speedtest 检查延迟。尝试更换模型。 |
| 「未知函数」回复 | AI 调用了不存在的工具 | 通常无害——AI 会重试其他方法。 |
Mineflayer Bot 错误
| 症状 | 相关日志 | 解决方法 |
|---|---|---|
Bot 未启动(完全没有 [Mineflayer] 日志) | Mineflayer bot is enabled but Node.js was not found | 安装 Node.js >= 18。运行 node --version 验证。 |
| Bot 在启动时被禁用 | Mineflayer requires Node.js >= 18, but found v{X} | 将 Node.js 升级到 18 或更高版本。 |
| Bot 在启动时被禁用 | WebSocket port {X} is already in use! | 在配置文件中修改 websocket.url 为不同端口,然后 !!gamesai reload。 |
[Bot] Kicked from server 伴随认证原因 | [Bot] Kicked from server. Reason: 后跟认证错误 | 通过 !!aibot set 检查 username/password/auth。Microsoft 认证需确保账号已迁移。 |
| Bot 卡住不动 | goto 操作返回 "No path found" 错误 | goto 操作现在会在无路径时返回错误。尝试不同的坐标。 |
[Bot] Disconnected 后自动重连 | [Bot] Disconnected. Reason: ... 后跟 Reconnecting in 5 seconds... | 服务器重启或短暂断网后的正常行为。Bot 会在 5 秒后自动重连。 |
[Bot] Died, respawning... | [Bot] Died, respawning... | 正常——Bot 死亡后会自动重生,无需干预。 |
| Bot 不响应指令 | 日志中无 [WS] 活动 | 使用 !!aibot leave 然后 !!aibot join 重启。若持续存在,检查 websocket.url 端口是否可访问。 |
日志中出现 npm install failed | npm install failed (exit {X}) 或 npm is not installed or not in PATH | 确保 npm 已安装且在 PATH 中。检查日志中的详细错误信息定位具体包问题。 |
Server version '{X}' is not supported | [Bot] Error: Server version ... is not supported. Latest supported version is ... | Minecraft 服务器升级到了已安装 mineflayer 不支持的版本。插件会自动检测到该错误,更新 npm 依赖并重启 Bot。若错误持续存在,请检查服务器能否访问 npm 源,或在 config/games_ai/mineflayer/ 下手动执行 npm install --no-save mineflayer ws vec3 mineflayer-pathfinder mineflayer-mcefly,然后通过 !!aibot leave / !!aibot join 重启 Bot。 |
日志与调试
- 启用调试模式:
!!gamesai debug— 显示完整 AI 提示词和工具调用结果。 - Mineflayer Bot 日志在 MCDR 控制台以
[Mineflayer]前缀显示。 - OpenAI SDK HTTP 日志自动路由至 MCDR 控制台(详见 OpenAI 日志桥接)。
- 如果以上方法均无效,请检查
config/games_ai/config.json是否存在配置错误。
本次更新
Version 0.6.4
🎯 核心亮点
- 🔐 AI 工具权限系统 —
@register_tool新增perm参数;perm高于请求玩家的工具根本不会提供给 AI。perm支持可调用对象(如get_plugin_config_perm),可动态跟随permission配置。 - ♻️ 热重载时全量重建工具注册 —
!!gamesai reload现在会彻底清空并重建工具注册表:内置工具重放恢复、自定义tools.py重新导入、注册过工具的第三方插件被真正重载以刷新工具代码。 - 🧰 工具集调整 — 白名单工具(
get_whitelist_name、add_to_whitelist、remove_from_whitelist)和search_minecraft_wiki迁移至 GamesAI-Extra;get_online_players在缺少online_player_api时回退为 RCONlist查询。
1. AI 工具权限系统
register_tool(description=..., perm=..., parameters=...) — perm 可以是 int 或返回 int 的零参可调用对象(默认 0 表示所有玩家可用)。每次 !!ask 前,插件会从注册表构建工具列表,只把 perm 不高于玩家权限等级的工具传给模型;工具函数内部的运行时权限检查依然生效。管理数据、技能、自定义工具或启停 Bot 的内置工具现在都使用 get_plugin_config_perm(配置中的 permission 值,请求时实时读取)。这修复了旧版"所有工具对所有玩家可见"的问题。
2. 热重载时全量重建工具注册
!!gamesai reload 现在执行完整的工具重置:
- 内置工具 — 通过记录的注册闭包重新注册(不重新执行模块代码,Bot 进程与 WebSocket 句柄不受影响);
- 自定义
tools.py— 旧的外部工具被清除后重新导入,文件中被删除的工具会真正消失; - 第三方插件 — 通过
@register_tool注册过工具的插件按模块顶层名追踪并由 MCDR 重载,重新执行其 import/on_load注册代码。
这取代了旧版对已加载模块调用 importlib.import_module 的做法(该做法是 no-op,重载后内置工具全部丢失)。详见重载期间发生了什么。
3. 工具集调整
- 白名单工具(
get_whitelist_name、add_to_whitelist、remove_from_whitelist)和search_minecraft_wiki迁移至 GamesAI-Extra 插件。 get_online_players在未安装online_player_api插件但 RCON 运行时,回退为 RCONlist查询。
4. 修复
- 修复
perm=plugin_config.allow_permission在 import 时取值的问题——权限现在在请求时惰性解析。 - 修复重载逻辑:旧版清空
TOOL_SCHEMAS后对已导入模块调用importlib.import_module,导致重载后内置工具消失。 - 移除残留的
tr_key参数(会导致工具注册抛出TypeError)。 - 合并扩展插件重载列表与工具注册插件列表,并做失败隔离(
REGISTER_PLUGIN_LIST.pop/TOOL_PLUGIN_IDS.discard)。
Version 0.6.3
🎯 核心亮点
- 🔧 Mineflayer 版本兼容自动修复 — 当 Minecraft 服务器升级到已安装 mineflayer 不支持的版本(
Server version 'X' is not supported)时,插件现在会自动刷新 npm 依赖并重启 Bot;旧版本插件安装的过期依赖也会在下次启动时自动刷新一次 - 🔒 启停 Bot 工具权限校验 — AI 工具
run_mineflayer_bot(bot_start)和stop_mineflayer_bot(bot_stop)现在要求达到配置的权限等级,与!!aibot join/!!aibot leave命令一致 - 🕐 等待服务器启动 — Bot 会先等待 Minecraft 服务器启动再连接,不再因 MCDR 先于服务器启动而连接失败
- 📦 扩展插件随本体卸载 — 插件卸载时一并卸载所有调用过
register_self()的外部插件,并做了失败隔离
1. Mineflayer 版本兼容自动修复
修复 Server version 'X' is not supported. Latest supported version is ... 报错(例如服务器升级到更新的 Minecraft 版本后)。插件检测到该错误后会自动执行 npm install,将 mineflayer/minecraft-data 等依赖刷新到最新版本并重启 Bot。刷新操作受 10 分钟冷却和每会话最多 3 次的限制。详见Mineflayer Bot 错误。
2. 启停 Bot 工具权限校验
启动/停止 Mineflayer Bot 的 AI 工具(bot_start / bot_stop)现在会校验发起请求玩家的权限等级是否达到配置的 permission 值,无权限玩家无法再通过 AI 启停 Bot。!!aibot join / !!aibot leave 命令自 0.6.0 起已有该校验。
3. 等待服务器启动后再启动 Bot
_run_mineflayer_bot 现在会先检查 Minecraft 服务器是否正在运行。若服务器未运行(例如 MCDR 启动时服务器尚未开启),插件会在后台等待,服务器启动后自动启动 Mineflayer Bot——不再出现"服务器未就绪导致 Bot 启动即连接失败"的情况。等待期间插件被卸载会干净地取消等待,重复的启动请求也会被忽略。
4. 插件卸载时卸载已注册的扩展插件
插件本体被卸载时,会一并卸载所有调用过 register_self() 的外部插件。每个卸载操作都有独立的异常处理,单个插件卸载失败不会阻塞其余插件。(卸载循环自 0.6.1 引入,0.6.3 起增加失败隔离与结果校验加固。)
Version 0.6.2
🎯 核心亮点
- 📍 玩家位置查询 — 新增
get_player_position工具,查询在线玩家的坐标和维度(依赖minecraft_data_api) - 📖 强制技能阅读 —
!!ask /<skill> <content>语法,强制 AI 优先读取指定技能文件 - 📡 reload 事件 —
!!gamesai reload完成时派发games_ai.reload事件,其他插件可监听同步 - 📚 热重载文档 — README 新增完整热重载章节
1. 新工具 get_player_position
查询指定在线玩家的坐标(x, y, z)和维度(主世界/下界/末地)。依赖于 minecraft_data_api 插件。Bot 也可调用(@register_bot_tool)。
2. 强制技能阅读 !!ask /<skill>
玩家可使用 !!ask /技能名 <content> 格式,强制 AI 在回答前通过 read_skills 工具读取指定技能文件。插件会验证技能文件是否存在并给出反馈,适用于需要 AI 严格遵循特定 SOP 的场景。
3. games_ai.reload 事件
每次 !!gamesai reload 完成后,插件会派发 games_ai.reload 事件,携带触发重载的 CommandSource。其他 MCDR 插件可注册事件监听器在 GamesAI 热重载完成时同步状态。详见热重载。
Version 0.6.1
🎯 核心亮点
- 🔌 扩展插件系统 — 为 MCDR 插件开发者提供
register_self()和register_skills()API - 🛡️ 输入验证 —
!!aibot join时验证 Bot 用户名合法性 - 📋 日志改进 — 已注册插件重载/卸载生命周期的详细日志
1. 扩展插件系统
第三方 MCDR 插件现在可以更深度地与 GamesAI 集成:
register_self(plugin_id)— 在你的插件on_load中调用,使其在!!gamesai reload时自动重载。这对于注册了自定义工具、需要在 AI 修改后同步配置/Skills 变更的插件至关重要。详见热重载。register_skills(file_name, description, content)— 从插件代码中以编程方式注册技能文件,无需手动编辑skills.json。技能会出现在 AI 的系统提示中,并可通过read_skills工具读取。
2. 验证与稳定性
!!aibot join现在会验证 Bot 用户名——拒绝包含非法字符(非[a-zA-Z0-9_])的用户名。- 修复了遍历
REGISTER_PLUGIN_LIST时删除元素可能导致跳过条目的 Bug。 - 为扩展插件的生命周期(重载/卸载状态)添加了完整的日志记录。
Version 0.6.0
🎯 核心亮点
- 🤖 Mineflayer Bot — 由 AI 通过 WebSocket 全自主控制的 Minecraft 机器人
- ⚙️ 配置系统重制 — 类型自适应配置、
!!aibot管理命令、输入验证 - 📋 日志桥接 — OpenAI/httpx SDK 日志无缝路由至 MCDR 日志系统
1. Mineflayer Bot 集成
0.6.0 最大的新特性:基于 Mineflayer 的全自主 Minecraft 机器人,通过 WebSocket 命令接口由 AI 控制。
支持的操作(20+):goto(A* 寻路)、efly(鞘翅飞行)、dig、place、attack、useOn、equip/unequip(装备/卸下盔甲)、mount/dismount(骑乘/离开)、craft(合成)、容器与熔炉管理、lookAt、setControlState 等。
扩展 get_state:30+ 字段 — 位置、视角 (yaw/pitch)、速度、盔甲 (head/chest/legs/feet)、氧气、经验、世界时间、天气、维度、睡眠状态等。
自定义物理引擎:击退响应(通过 entity_velocity 数据包)和实体碰撞/挤压。寻路时自动暂停物理以避免干扰。
Bot 管理:
!!aibot join/!!aibot leave— 生命周期控制!!aibot set username/password/auth— 配置 Bot 身份,含输入验证bot_start/bot_stop工具 — AI 自主控制delegate_to_bot— 将复杂任务移交给自主控制器
其他改进:死亡自动重生、默认启用物理引擎、path_update noPath 检测(无法到达时立即返回错误)、聊天消息自动去除 § 字符。
2. 配置系统重制
- 类型自适应
set_config:!!gamesai config set现在读取旧值的类型并自动将新值转换为匹配类型。设置 float 为"20"仍保持 float,bool 保持 bool 等。类型不匹配错误会被捕获并报告。 !!aibot set命令:无需手动编辑 JSON 即可管理 Bot 的用户名、密码和认证方式。用户名/密码验证为[a-zA-Z0-9_],auth 限制为microsoft/mojang/offline。
3. OpenAI 日志桥接
Note
彻底解决了旧版 OpenAI SDK 原始日志会占用 MCDR 控制台导致输入失常及显示异常的问题。
openai 和 httpx Python 日志现已完全重定向至 MCDR Logger:
- 所有 HTTP 请求/响应日志出现在 MCDR 控制台
- 原始 handler 已清除、propagation 已禁用 — 无重复 stderr 输出
鸣谢与声明
特别感谢 WangHai Server 为此插件的测试提供了基础
特别感谢 william-song-shy (William Song) 为 !!ask 无历史模式提供的建议。
特别感谢 ZhangZuoqian (张作乾) 为测速指令提供的建议。
AI(LLM)模型生成的一切内容与此插件无关
自定义工具造成的一切后果与本插件无关
赞助与贡献者名单
赞助地址:爱发电
为GamesAI赞助的将会出现在下列的赞助者名单中(当前没有赞助者):
| # | 赞助者 | 金额 | 日期 |
|---|---|---|---|
| - | - | - | - |
许可证
MIT License, Copyright (c) 2026 yello
介绍文本来源:README.zh-CN.md