Основы HOCON

HOCON (Human-Optimized Config Object Notation) is an easy-to-use configuration format. It is used by Sponge and individual plugins utilizing SpongeAPI to store important data, such as configuration or player data. HOCON files typically use the suffix .conf.

Компоненты

  • ключ — строка, предшествующая значению
  • значение — строка, число, объект, массив или логическое значение после ключа
  • разделитель — отделяет ключи от значений и может быть : или =
  • комментарий — строка, которая начинается с # или //. Обычно это пояснение или инструкция

Пример:

yellow-thing: "Sponge"

В этом примере ключyellow-thing, значениеSponge, а так же разделитель:.

Работа с HOCON

Формат HOCON более гибкий, нежели JSON (JavaScript Object Notation). Выражается это в том, что существует несколько способов правильно записать HOCON. Ниже приведены два примера допустимых HOCON.

Пример #1:

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

Пример #2:

player {
    name = "Steve"
    level = 30
}

In practice, it is best to follow the formatting conventions of the HOCON configuration you are editing. When editing a HOCON configuration for Sponge or an individual plugin utilizing SpongeAPI, the values are likely the only thing you will be changing unless otherwise specified.

Отладка вашей конфигурации

Если в конфигурации HOCON что-то не работает, то вот несколько советов.

  • Фигурные скобки должны быть сбалансированы
  • Кавычки должны быть сбалансированы
  • Дубликаты ключей, которые появляются позднее, имеют приоритет

Спецификация

Больше информации о формате HOCON можно найти здесь.