跳至主要內容

外掛 ​

外掛透過自訂 UI 頁面、後端處理、事件掛鉤和設定面板擴充 Ogma,所有功能都受外掛宣告的權限限制。

深色模式下的外掛檢視淺色模式下的外掛檢視

外掛可新增的內容 ​

  • 可從左側導覽存取的自訂 UI 頁面。
  • 處理請求或回應的後端路由。
  • 由擷取流量觸發的事件掛鉤。
  • 用於外掛專屬設定的設定頁面。
  • 可註冊至命令選擇區的指令。

從資料夾安裝 ​

  1. 在外掛檢視中按一下安裝。
  2. 選擇資料夾路徑。
  3. 選擇外掛的根目錄。該目錄必須包含有效的外掛資訊清單,以及資訊清單宣告的檔案。
  4. Ogma 會驗證套件並註冊外掛。
  5. 啟用外掛,使其開始運作。

從 ZIP 封存檔安裝 ​

  1. 在外掛檢視中按一下安裝。
  2. 選擇 ZIP 檔案。
  3. 選擇外掛的 .zip 檔案。
  4. 檢查偵測到的外掛名稱和版本。
  5. 按一下安裝,再啟用外掛。

ZIP 安裝會將檔案複製至 Ogma 管理的外掛目錄。安裝後可以刪除原始封存檔。

相容性警告 ​

安裝後,Ogma 可能在外掛詳細資料頁面顯示警告。這些警告只是提供資訊,不會阻止外掛執行。

常見警告:

  • 未參照的檔案 - 套件中存在,但資訊清單未宣告的檔案。
  • 缺少執行階段相容層 - 外掛使用的 API 需要相容層,但目前 Ogma 版本不包含該相容層。

啟用不熟悉的外掛前,請檢查警告。

啟用和停用 ​

切換外掛列上的已啟用開關,即可啟用或停用外掛。停用的外掛仍維持安裝狀態,但不會執行。重新啟用即可恢復運作,不必重新安裝。

外掛詳細資料索引標籤 ​

選擇外掛,開啟其詳細資料面板。面板包含以下索引標籤。

索引標籤內容
總覽外掛名稱、版本、作者、描述和來源。
警告安裝或啟用時偵測到的相容性問題。
權限外掛要求的權限,以及 Ogma 在執行階段授予的權限。
檔案外掛套件中的檔案清單。
記錄外掛的執行階段輸出,結構化記錄行帶有語法醒目提示。
UI直接呈現在面板中的外掛自訂頁面。

權限 ​

權限索引標籤列出外掛在資訊清單中宣告的各項權限,以及目前的授權狀態。後端呼叫會在伺服器端強制檢查權限。UI 會反映各項權限的即時狀態。

如果外掛未如預期運作,請檢查權限索引標籤,確認所需權限已授予。

開發模式 ​

從資料夾安裝的外掛會顯示開發徽章和重新載入按鈕。

按一下重新載入,即可套用程式碼變更,不必重新安裝。外掛會重新啟動,並重新註冊所有掛鉤和路由。這是外掛開發者的標準迭代流程。

開發模式外掛會保持與來源資料夾的連結。該資料夾內的檔案變更,會在下一次重新載入時生效。

市集 ​

市集索引標籤列出 Awesome Ogma Plugins 登錄清單中的社群外掛。

  1. 瀏覽或搜尋外掛清單。
  2. 按一下外掛,檢視描述、版本和相容性中繼資料。
  3. 按一下安裝,直接安裝。
  4. 已安裝的市集外掛若有較新且相容的版本,操作會變更為更新。

從市集安裝需要網路連線,以取得套件。

專有軟體。保留所有權利。