使用指南

首先，歡迎您使用 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 秒。

註：可選選項的必選參數 的意思是，選項可以不提供，但是一旦在參數中包含了這個選項，就必須填入它的必選參數。