示例将以如下格式给出:
-> 这是一句指令/事件示例
<- 这是bot对该指令/事件的回复
插件的功能说明将按模块划分来介绍。而每个模块内的功能,按照触发方式又可划分为:指令触发、事件触发、定时触发。
指令语法基于mirai-console的Command规则和配置,默认配置的指令前缀为/
。
/<主指令名> <子指令名> <参数列表>
对于用户级指令,<主指令名>
等于config\具体插件id\proxyConfigRepository.json
里的primaryName
。
例如,在阿米娅插件中,proxyConfigRepository.json
里的primaryName
默认为 "阿米娅"。代入后实际指令语句为:
/阿米娅 ……
以具体功能为例,代入 <子指令>="微博订阅",<参数1>="明日方舟朝陇山" ,实际指令语句为:
/阿米娅 微博订阅 明日方舟朝陇山
授权方式:权限助手模块里群开关
开启后,则该群的所有群员获得所有用户级指令权限。
对于管理级指令,<主指令名>
由具体模块决定,且代入<角色名>
,不受配置文件里的primaryName
影响。
例如,对于权限助手模块,<主指令名>
等于<角色名>权限助手
。代入后实际指令语句为:
/阿米娅权限助手 ……
授权方式:人工通过perm指令授予
对具体指令“阿米娅权限助手”授权样例:
/perm permit u114514 hundun.fleet.amiya:command.阿米娅权限助手对所有管理级指令授权样例:
/perm permit u114514 hundun.fleet.amiya:command.admin*
仅限Console环境输入,所以不需关心权限和授权。每个模块可能若干个Debug级指令,例如让某个定时功能视为满足时间条件(立刻触发),用来调试执行效果。
对于Debug级指令,<主指令名>
由具体模块决定,且代入<角色名>
,不受配置文件里的primaryName
影响。
例如,对于微博模块中的Debug级指令,<主指令名>
等于<角色名>WeiboFunctionDebug
。代入后实际指令语句为:
/阿米娅WeiboFunctionDebug ……
某些功能由事件来触发。例如: 不属于指令格式的任意文本消息事件、戳一戳事件。
某些功能在满足时间条件时触发。例如:整点报时。