使用指南:修订间差异

来自Moonlark
无编辑摘要
标签wikieditor
无编辑摘要
标签wikieditor
第2行: 第2行:


本指南将帮助您了解如何与 Moonlark 互动,及获得更好的体验。
本指南将帮助您了解如何与 Moonlark 互动,及获得更好的体验。
== 寻找节点 ==
{{main|节点}}
您需要先找到一个可用的 Moonlark 节点,并了解该节点的特性(如果有)。


== 指令 ==
== 指令 ==

2024年5月16日 (四) 00:58的版本

首先,欢迎您使用 Moonlark!

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

寻找节点

您需要先找到一个可用的 Moonlark 节点,并了解该节点的特性(如果有)。

指令

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

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

/指令名 子命令 参数

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

指令前缀

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

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

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

参数

Moonlark 中参数分为四种:

必要参数

使用时必须填入的参数。

可选参数

使用时可以不填写或有默认值的参数。

选择参数

需要在给定的值中选择其一的参数。

选项

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

--选项名称 选项参数

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

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

阅读帮助

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

用法中的符号

为了便于阅读,Moonlark 会在用法中使用一些符号。

这些符号主要用于表示参数,不需要将这些符号键入指令中。

必须的

使用尖括号 <> 包围,表示这个参数在用法中必须填入。

可选的

使用方括号 [] 包围,表示这个参数在用法中不必要填入,或已经有默认值。

选择其一

使用管道符 | 分隔的两个或多个参数,表示需要在这些参数中选择一个填入,一般不含有空格。

部分情况下会使用花括号 {} 包围。

备注

使用圆括号 () 包围,用于解释用法,不用填入指令。

无需更改的

用法中除此之外的字符都可以原封不动的写在指令中。

阅读指令列表

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

以 preview 为例,其用法如下:

!preview <URL> [-w|--wait <等待时间>] (截图URL)
注:示例来自测试服,所以前缀是 !
  • ! 为指令前缀;
  • preview 为指令名;
  • <URL> 是一个必选参数;
  • [-w|--wait <等待时间>] 是一个可选选项;
  • <等待时间>--wait 选项的必选参数;
  • (截图URL) 是这个用法的说明。

所以,一个合法的 preview 用法应该是这样:

!preview https://baidu.com --wait 2

这个用法表示截图 https://baidu.com 并在网页打开后等待 2 秒

注:可选选项的必选参数 的意思是,选项可以不提供,但是一旦在参数中包含了这个选项,就必须填入它的必选参数。