使用指南

出自Moonlark

首先,歡迎您使用 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 種形式:

Moonlark 中的參數類型
名稱 說明 在命令幫助中的出現形式
必要參數 使用指令時必須正確填入的參數,不正確填入會導致指令無法執行。 <这是一个必要参数>
可選參數 使用指令時可以不填寫的參數。 [这是一个可选参数]
選擇參數 使用指令時在給出的可以選擇的值中根據需求選擇一個的參數。
{这是一个选择参数|这是另一个选择}
[这是一个可选的选择参数|这是另一个选择]
選項 / 開關 由選項名(這個結構一般是選擇參數)和參數值(有時候是可選參數)組成的參數,一般都是可選的。 [-t <这是一个可选的选项的值>]

閱讀幫助

閱讀指令列表

指令列表中包括每個公開指令的指令名、描述及所有用法。

以 preview 為例,其用法如下:

/preview <URL> [-w|--wait <等待时间>] (截图URL)
  • ! 為指令前綴;
  • preview 為指令名;
  • <URL> 是一個必選參數;
  • [-w|--wait <等待时间>] 是一個可選選項;
  • <等待时间>--wait 選項的必選參數;
  • (截图URL) 是這個用法的說明。

所以,一個合法的 preview 用法應該是這樣:

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

這個用法表示截圖 https://baidu.com 並在網頁打開後等待 2 秒

註:可選選項的必選參數 值可以不提供選項,但是只要提供了這個選項,就必須填入它的必選參數。