使用指南

出自Moonlark
於 2024年5月16日 (四) 00:39 由 XiaoDeng3386對話 | 貢獻 所做的修訂 (创建页面,内容为“首先,欢迎您使用 Moonlark! 本指南将帮助您了解如何与 Moonlark 互动,及获得更好的体验。 == 指令 == 指令是一种用于操作 Moonlark 的特殊消息,有时也称为“命令”,一般以命令前缀 '''/''' 开头。 大部分指令遵循以下格式: <pre> /指令名 子命令 参数 </pre> 不是每个指令有子命令和参数,但一个指令一定有一个独立的指令名,所以一条命令至少由指…”)
(差異) ←上個修訂 | 最新修訂 (差異) | 下個修訂→ (差異)

首先,歡迎您使用 Moonlark!

本指南將幫助您了解如何與 Moonlark 互動,及獲得更好的體驗。

指令

指令是一種用於操作 Moonlark 的特殊消息,有時也稱為「命令」,一般以命令前綴 / 開頭。

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

/指令名 子命令 参数

不是每個指令有子命令和參數,但一個指令一定有一個獨立的指令名,所以一條命令至少由指令前綴和指令名組成。

指令前綴

一條指令的標識符,一般為 /

部分節點指令前綴有所不同,如測試節點使用的是 !,QQ 官方節點還需要在發送指令時提及 Moonlark。

具體可參考 節點#節點表 中的備註。

參數

Moonlark 中參數分為四種:

必要參數

使用時必須填入的參數,在幫助中使用尖括號 <...> 包圍。

可選參數

使用時可以不填寫或有默認值的參數,在幫助中使用方括號 [...] 包圍。

選擇參數

需要在給定的值中選擇其一的參數,在幫助中使用花括號 {...} 包圍,使用管道符 | 隔開選項。

選項

選項可以出現在參數的任何位置,大致格式如下:

--选项名称 选项参数

不是所有選項都有選項參數,沒有選項參數的選項也被稱為開關。

部分選項存在縮寫,在大部分選項中,使用縮寫時需將 -- 改為 -

閱讀幫助

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

閱讀指令列表

指令列表中包括每個公開指令(部分在開發中的指令可能不存在於列表中)的指令名、描述及所有用法。

以 preview 為例,其用法如下:

!preview <URL> [-w|--wait <等待时间>] (截图URL)
註:示例來自測試服,所以前綴是 !
  • ! 為指令前綴
  • preview 為指令名
  • <URL> 是一個必選參數
  • [-w|--wait <等待时间>] 是一個可選選項
  • -w--wait 選項的縮寫
  • <等待时间>--wait 選項的必選參數
  • (截图URL) 是這個用法的說明
註:可選選項的必選參數 的意思是,選項可以不提供,但是一旦在參數中包含了這個選項,就必須填入它的必選參數。