使用指南
首先,欢迎您使用 Moonlark!
本指南将帮助您了解如何与 Moonlark 互动,及获得更好的体验。
开始使用
跟随以下步骤能帮助您快速的开始使用 Moonlark。当然,我们建议您先阅读下方的指令使用指南。
1. 寻找一个可用的节点
您需要先找到一个可用的 Moonlark 节点,添加 Moonlark 或直接在已经部署了 Moonlark 的群聊或服务器使用 Moonlark。您可以点击上方链接访问关于此内容的条目获取关于 Moonlark 的节点的更多信息。
确认可用性
您可以向 Moonlark 发送 status
指令确认其状态,如果 Moonlark 正常回复,则说明状态良好。此指令响应慢(约 30s 之内)是正常现象。
/status
对于 Moonlark 0x07
节点,您需要将指令更改成这样:
@Moonlark /status
2. 注册 Moonlark UID
向 Moonlark 发送 register
指令,根据提示填写数据并提交注册请求。
/register
对于 Moonlark 0x07
节点,您需要将指令更改成这样,并在每一个数据填写时提及 Moonlark(@Moonlark ):
@Moonlark /register
3. 获取指令列表
此步骤能帮助您更好了解 Moonlark 包含的功能,只需要向 Moonlark 发送 help
指令。
/help
对于 Moonlark 0x07
节点,您需要将指令更改成这样:
@Moonlark /help
指令使用说明
指令是一种用于操作 Moonlark 的特殊消息,有时也称为“命令”,一般以命令前缀 / 开头。
大部分指令遵循以下格式:
/指令名 子命令或参数
不是每个指令有子命令和参数,一条指令至少由指令前缀和指令名组成。
指令前缀
一条指令的标识符,一般为 /。
部分节点指令前缀有所不同(如 0x07 节点的前缀为 @Moonlark /
参数
Moonlark 中参数是需要用户填入的内容,填入不同的参数可能导致指令执行结果不同,主要有如下 4 种形式:
名称 | 说明 | 在命令帮助中的出现形式 |
---|---|---|
必要参数 | 使用指令时必须正确填入的参数,不正确填入会导致指令无法执行。 | <这是一个必要参数>
|
可选参数 | 使用指令时可以不填写的参数。 | [这是一个可选参数]
|
选择参数 | 使用指令时在给出的可以选择的值中根据需求选择一个的参数。 | {这是一个选择参数|这是另一个选择}或 [这是一个可选的选择参数|这是另一个选择] |
选项 / 开关 | 由选项名(这个结构一般是选择参数)和参数值(有时候是可选参数)组成的参数,一般都是可选的。 | [-t <这是一个可选的选项的值>]
|
阅读帮助
阅读指令列表
指令列表中包括每个公开指令的指令名、描述及所有用法。
以 preview 为例,其用法如下:
/preview <URL> [-w|--wait <等待时间>] (截图URL)
!
为指令前缀;preview
为指令名;<URL>
是一个必选参数;[-w|--wait <等待时间>]
是一个可选选项;<等待时间>
是--wait
选项的必选参数;(截图URL)
是这个用法的说明。
所以,一个合法的 preview 用法应该是这样:
/preview https://baidu.com --wait 2
这个用法表示截图 https://baidu.com 并在网页打开后等待 2 秒。
- 注:可选选项的必选参数 值可以不提供选项,但是只要提供了这个选项,就必须填入它的必选参数。