术语表
关于本机器人所使用的术语/特殊词汇的详细解释。
XME-Deon-Bot / XME-Bot / bot
用于代表本机器人的任意实例。例如正在某个 qq 群运行的 XME-Bot 机器人。
本机器人可通过 Deon、deon、漠月 中任意名称调用,相关用法在下面的指令里会提及。
指令
以 特定符号 开头的特殊语句,符合某种格式的用户消息。指令消息会被 XME-Bot 解析并且执行对应的程序。
在 XME-Bot 中,特定的符号可以是 。、.、/ 之中的任何一个。
例如:
/weather 南京建邺以及,在指令中 @bot 或在指令前输入 bot 的名字也可以调用指令,例如:
漠月 /weather 南京建邺
@漠月 /weather 南京建邺WARNING
由于 Nonebot1 框架本身的原因,如果在指令参数里 @bot,第一个参数会被忽略。例如:/info @漠月 会被框架解析成 /info,若需要知道 /info @漠月 的内容,则需要使用 /info @漠月 @漠月
XME-Bot 在接收到上面的消息后会返回例如:
@发送者
======※现在天气:江苏省 南京 建邺※======
- 天气:阴,东北风 3 级
- 当前天空上有盈凸月
- 空气质量指数:37 (优)
- 温度:8℃,体感 5℃
- 相对湿度 50%
- 过去 1 小时降水量 0.0 mm
- 气压 1022 hPa
- 数据更新时间:2025年12月31日 15:00
======※预警信息※======
🟨 海区大风黄色预警
可以使用 "/wea 南京建邺 -w" 来查看预警的详细信息哦 嗷呜!
==========
数据来自于和风天气 API~ 嗷呜!不是所有类似指令的消息都会被 XME-Bot 执行,或者说 只有 XME-Bot 设置的指令才可能会被解析执行。
指令参数 / 参数
跟在指令语句后面以某种格式分隔的内容被称作 参数。
例如:
/weather 扬州 3在这个指令里,南京建邺 是 weather 指令的参数,weather 指令的参数以 空格 分隔。
关于参数标记
参数在帮助文档里会以特定的括号括起来,但是用户在输入指令时后的参数不需要加任何括号(除非你希望参数本身就有括号)。
可选参数
代表在指令中某些情况不填写也不会报错的参数。例如之前 weather 指令参数中的 南京建邺。
可选参数在本文档的参数提示里会以 <> 括起来。
例如:
/help <指令名>其中 指令名 是可选参数的内容,如果不输入指令名的参数,只输入 /help,并不会阻止 XME-Bot 正常运行。
必要参数
代表在指令中必须填写,否则会出错的参数。
必要参数在本文档的参数提示里会以 () 括起来。
例如:
/count (输入的文字)其中 输入的文字 是必要参数的内容,如果参数为空,XME-Bot 会提醒用户输入参数,否则不可使用这个指令。
类 Shell 参数
代表在指令中类似 Shell 指令参数语法的参数,格式为 - 加上一个字母 或 -- 加上一个单词,例如 -h、--help。
类 Shell 参数在本文档的参数提示里会以 [] 括起来。
例如,这是一个简单 weather 指令的帮助:
指令 weather
简介:查询天气
作用:查看指定地区的天气,每 5 分钟限制五次
用法:
/weather <地点名> [OPTIONS]
OPTIONS:
-h, --help 输出帮助,等同于 "/help weather"
-w, --warn 单独使用这个参数以查看预警详细信息
权限/可用范围:无
别名:当前天气, 天气, 查看天气, wea其中 OPTIONS 是类 Shell 参数的内容,用户可以输入 /weather -h 或 /weather -w 之类的方法调用 OPTIONS 里说明的参数。
有的类 Shell 参数内容里需要在指定了参数后再输入内容以作为实际的参数内容,例如
/game guess -a r=1~100, t=8此时,r=1~100, t=8 为 -a 参数的具体内容,同理还有例如:
/ai -c clear在这里,clear 为 -c 参数的具体内容。
权限
由于 XME-Bot 基于 Nonebot1 制作,使用的也是 Nonebot1 的权限系统。
权限是用于限制用户在调用指令时的条件是否符合,例如是否是管理员、是否在私聊等。
SUPERUSER
SUPERUSER 指 XME-Bot 配置中设置的用户 QQ 号白名单。默认为 1795886524 也就是 Xme-Bot 的开发者九镹
角色
角色是 XME-Bot 里用于决定 bot 输出的文字内容的设置,通过不同的角色文件决定,功能某种程度有点类似语言模块。
开发者若想自定义 bot 输出的文本风格,即可创建一个自己的角色文件。
对 bot 使用 whoru 指令就可以看到 bot 当前的角色信息。