Туториал [Туториал] Описание формата HOCON

Основы HOCON
HOCON (Human-Optimized Config Object Notation) — это формат easy-to-use конфигурации. Он используется для хранения важных данных, таких как конфигурации или данных игрока Sponge, а так же для конфигурации отдельных плагинов, которые используют Sponge API. HOCON файлы обычно используют суффикс ‘’ .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
}

На практике лучше придерживаться правил форматирования HOCON того файла, который вы редактируете. При изменении HOCON конфигурации Sponge или других плагинов, использующих Sponge API, значения - это единственное, что вы будете менять (если не указано иное).

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

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

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

 

Данные об игроках можно хранить и с помощью data api.