使用指南
出自Moonlark
首先,歡迎您使用 Moonlark!
本指南將幫助您了解如何與 Moonlark 互動,及獲得更好的體驗。
尋找節點
您需要先找到一個可用的 Moonlark 節點,您可以點擊上方連結訪問關於此內容的條目獲取關於 Moonlark 的節點的更多信息。
指令使用說明
指令是一種用於操作 Moonlark 的特殊消息,有時也稱為「命令」,一般以命令前綴 / 開頭。
大部分指令遵循以下格式:
/指令名 子命令或参数
不是每個指令有子命令和參數,一條指令至少由指令前綴和指令名組成。
指令前綴
一條指令的標識符,一般為 /。
部分節點指令前綴有所不同(如 0x07 節點的前綴為 @Moonlark /
參數
Moonlark 中參數是需要用戶填入的內容,填入不同的參數可能導致指令執行結果不同,主要有如下 4 種形式:
名稱 | 說明 | 在命令幫助中的出現形式 |
必要參數 | 使用指令時必須正確填入的參數,不正確填入會導致指令無法執行。 | <這是一個必要參數> |
可選參數 | 使用指令時可以不填寫的參數。 | [這是一個可選參數] |
選擇參數 | 使用指令時在給出的可以選擇的值中根據需求選擇一個的參數。 | 這是另一個選項} [這是一個可選的選擇參數,這是默認值|這是另一個選項,不是默認值] |
選項 / 開關 | 由選項名(這個結構一般是選擇參數)和參數值(有時候是可選參數)組成的參數,一般都是可選的。 | [-t <這是一個可選的選項的值>] |
閱讀幫助
使用 /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 秒。
- 註:可選選項的必選參數 的意思是,選項可以不提供,但是一旦在參數中包含了這個選項,就必須填入它的必選參數。