使用指南

来自Moonlark
XiaoDeng3386留言 | 贡献2024年5月16日 (四) 00:39的版本 (创建页面,内容为“首先,欢迎您使用 Moonlark! 本指南将帮助您了解如何与 Moonlark 互动,及获得更好的体验。 == 指令 == 指令是一种用于操作 Moonlark 的特殊消息,有时也称为“命令”,一般以命令前缀 '''/''' 开头。 大部分指令遵循以下格式: <pre> /指令名 子命令 参数 </pre> 不是每个指令有子命令和参数,但一个指令一定有一个独立的指令名,所以一条命令至少由指…”)
(差异) ←上一版本 | 最后版本 (差异) | 下一版本→ (差异)

首先,欢迎您使用 Moonlark!

本指南将帮助您了解如何与 Moonlark 互动,及获得更好的体验。

指令

指令是一种用于操作 Moonlark 的特殊消息,有时也称为“命令”,一般以命令前缀 / 开头。

大部分指令遵循以下格式:

/指令名 子命令 参数

不是每个指令有子命令和参数,但一个指令一定有一个独立的指令名,所以一条命令至少由指令前缀和指令名组成。

指令前缀

一条指令的标识符,一般为 /

部分节点指令前缀有所不同,如测试节点使用的是 !,QQ 官方节点还需要在发送指令时提及 Moonlark。

具体可参考 节点#节点表 中的备注。

参数

Moonlark 中参数分为四种:

必要参数

使用时必须填入的参数,在帮助中使用尖括号 <...> 包围。

可选参数

使用时可以不填写或有默认值的参数,在帮助中使用方括号 [...] 包围。

选择参数

需要在给定的值中选择其一的参数,在帮助中使用花括号 {...} 包围,使用管道符 | 隔开选项。

选项

选项可以出现在参数的任何位置,大致格式如下:

--选项名称 选项参数

不是所有选项都有选项参数,没有选项参数的选项也被称为开关。

部分选项存在缩写,在大部分选项中,使用缩写时需将 -- 改为 -

阅读帮助

使用 /help 可以获取 Moonlark 的指令列表。

阅读指令列表

指令列表中包括每个公开指令(部分在开发中的指令可能不存在于列表中)的指令名、描述及所有用法。

以 preview 为例,其用法如下:

!preview <URL> [-w|--wait <等待时间>] (截图URL)
注:示例来自测试服,所以前缀是 !
  • ! 为指令前缀
  • preview 为指令名
  • <URL> 是一个必选参数
  • [-w|--wait <等待时间>] 是一个可选选项
  • -w--wait 选项的缩写
  • <等待时间>--wait 选项的必选参数
  • (截图URL) 是这个用法的说明
注:可选选项的必选参数 的意思是,选项可以不提供,但是一旦在参数中包含了这个选项,就必须填入它的必选参数。