HOCON 介紹

HOCON(Human-Optimized Config Object Notation)是一種易於使用的設定格式。它被用於 Sponge 以及使用了 SpongeAPI 的獨立插件以儲存重要資料,例如設定或玩家資料。HOCON 檔案中常以 .conf 作為結尾。

組成元件

  • 一個 key 是在一個值之前的字串
  • 一個 value 是一個緊隨 key 之後的字串、數字、物件、陣列或布林值。
  • 一個 key-value separator 把鍵與值分離,可以是 :=
  • 一個 comment#// 作為開頭,通常用來提供回饋或說明。

範例:

yellow-thing: "Sponge"

在此範例中,keyyellow-thingvalueSponge,而 key-value separator:

使用 HOCON

HOCON 是比 JSON(JavaScript Object Notation)更靈活的格式,因為有數種撰寫出有效 HOCON 的方法。以下是兩個有效 HOCON 的範例。

範例 #1:

player: {
    name: "Steve",
    level: 30
}

範例 #2:

player {
    name = "Steve"
    level = 30
}

在實際使用中,最好遵守你所編輯的 HOCON 設定檔的格式慣例。當你在編輯一個 Sponge 或使用了 SpongeAPI 的獨立插件的 HOCON 設定檔時,除非有特別要求,否則請不要動值(value)以外的部分。

為你的設定除錯

如果一個 HOCON 設定檔似乎不會工作,這裡有一些小提示。

  • 大括號必須平衡
  • 引號必須平衡
  • 重複的鍵會以較後面的優先

規範

更多關於 HOCON 格式的資訊可在這裡找到。