CommandYouWant

「你想要的插件」系列作品

重定向命令，统一机器人命令格式。

灵感来源于 Minecraft 服务端插件 OhMyCmd

简介

各大插件作者对于机器人命令的命名方式各不相同，同时，有的插件年久失修，且没有提供命令修改方法。这时，CommandYouWant 派上了用场，你可以逐一部署各个命令的别名，将这个命令的参数任意映射到另一个命令上。

安装

到 Releases 下载插件并放入 plugins 文件夹进行安装

2.11 或以上下载 CommandYouWant-*.mirai2.jar

2.11 以下下载 CommandYouWant-legacy-*.mirai.jar

安装完毕后，编辑配置文件作出你想要的修改。在控制台执行 /cmduw reload 重载配置即可~

使用方法和示例

以调用 cssxsh 大佬的 NovelAi Helper 为例，先到文件夹 config/top.mrxiaom.commandyouwant/commands，第一次启动这个插件会创建这个文件夹并把示例配置 sample.yml 放进去。首先把 sample.yml 复制一份，取任意名放在同一文件夹中。然后打开编辑：

# 是否使用事件模式
# 有些插件并不是标准地注册命令，故需要伪造发送消息事件让插件响应
# 警告: 这可能会干扰聊天记录类的插件
event-mode: false
perm: test
perm-desc: 获取图片
deny-tips: '权限不足'
keyword: '{at:bot}画画 {next}'
# 参数屏蔽词
keyword-block:
  # 第二个参数 {next} 中禁止出现的字符列表
  1: 
    - '#'
keyword-block-tips: 你输入的参数不合规
actions: 
  - 'cmd:/nai {1}'
  - 'send:可以像这样一次执行多条指令'
# false 的时候忽略执行以上两条命令的权限检查
is-action-check-perm: false

首先我们设置权限，比如将 perm 设为 test，填写后用户需要有权限 top.mrxiaom.commandyouwant:command.test 才能执行这个命令。

然后，我们需要定义用户要怎样才能触发这个命令，将格式写到 keyword 里

在 keyword 中插入 {} 包围的内容作为命令参数，如图中的例子，有两个参数 {at:bot} 和 {next} (都能填什么参数可以在后面的表格看到)，

如果用户发送了

@机器人 画画 初音未来 可爱(任意字符都行)

插件就会把其中的参数提取出来，从0开始按顺序排好，这里的参数是

索引	内容
0	@机器人
1	"初音未来可爱(任意字符都行)"

然后，插件会将这些参数替换掉 actions 里的 {索引}，比如 {1} 会被替换成 初音未来可爱(任意字符都行)。然后模拟用户执行替换好的命令。

说白了，就是给其他插件的命令套壳。

写要执行的命令到 actions 之前，需要添加前缀。不添加前缀将默认以 cmd: 方式执行。

前缀	说明
`cmd:`	使用 mirai-console 的命令系统，以该命令发送者身份执行命令
`console:`	使用 mirai-console 的命令系统，以控制台身份执行命令
`msg:`	模拟消息事件，触发其他插件收到群消息/好友消息
`send:`	发送消息，后面填写的内容即发送的内容

在 actions 中，你可以使用这些基础变量，如有需要其他变量，欢迎 PR。

变量(不区分大小写)	说明
`{at}`	@发送命令的人，好友消息时将为空白
`{quote}`	回复消息
`{botId}`	机器人QQ号
`{groupId}`	群号，好友消息时将为空白
`{friendId}`	好友QQ号，群消息时将为空白
`{senderId}`	命令发送者QQ号
`{subjectId}`	好友消息时为QQ号，群消息时为群号

如果无法通过索引补充参数到要模拟执行的命令里，将会在后台报错。如果你有特别需求忽略这个错误，请在后面再加个 ?，如 {0}?

在完成了命令的基础设置后，你可以更改一些进阶设置，注释在默认配置文件里都有。

keywords/keyword 中所有可用的参数如下

内容	解释
{arg}	单个文字参数，识别到空格或消息末尾就终止
{next}	长段文字参数，识别到其他类型的消息元素或消息末尾就终止
{at}	@某人，@所有人都可以
{at:QQ号}	@某人，只能@特定某个人
{at:bot}	@机器人
{img}	图片
{face}	表情