Wprowadzenie do HOCON
HOCON (Human-Optimized Config Object Notation) jest prostym w użyciu formatem pliku konfiguracyjnego. Używany jest jest przez Sponge i poszczególne pluginy korzystające z API Sponge do przechowywania ważnych danych, takich jak konfiguracja czy dane gracza. Pliki HOCON zazwyczaj używają przyrostka .conf
.
Element
klucz
to string (ciąg znaków) identyfikujący wartośćwartość
to string, liczba, obiekt, tablica albo boolean przypisany doklucza
separator
oddziela klucze od ich wartości, może nim być:
lub=
komentarz
zaczyna się od#
lub//
, zwykle wykorzystywany jest do umieszczenia dodatkowych informacji lub instrukcji
Przykład:
yellow-thing: "Sponge"
W tym przykładzie kluczem
jest yellow-thing
, wartością
jest Sponge
, a separatorem
jest :
.
Praca z HOCON
HOCON jest bardziej elastyczny niż format JSON (JavaScript Object Notation), gdyż istnieje kilka sposobów na napisanie poprawnego pliku HOCON. Poniżej przedstawiono dwa przykłady jego prawidłowego użycia.
Przykład #1:
player: {
name: "Steve",
level: 30
}
Przykład #2:
player {
name = "Steve"
level = 30
}
W praktyce najlepiej jest dostosować się do konwencji przyjętej w konkretnej konfiguracji HOCON, którą edytujesz. Podczas edycji konfiguracji Sponge albo pojedynczych pluginów korzystających z Sponge API prawdopodobnie będziesz zmieniał tylko wartości.
Debugowanie konfiguracji
Jeżeli konfiguracja HOCON zdaje się nie działać, zobacz poniższe wskazówki.
Wszystkie nawiasy klamrowe muszą być domknięte
Wszystkie cudzysłowy muszą być domknięte
Jeśli klucze się powtarzają to pod uwagę barany jest ten występujący najpóźniej
Specyfikacja
Więcej informacji o formacie HOCON można znaleźć tutaj.