Einführung in HOCON
HOCON (Human-Optimized Config Object Notation) ist ein einfach zu nutzendes Konfigurationsformat. Es wird von Sponge und individuellen Plugins, die die SpongeAPI nutzen, genutzt, um wichtige Daten wie z.B. Konfigurationen oder Spielerdaten zu speichern. HOCON-Dateien nutzen üblicherweise die Endung .conf
.
Komponenten
ein
key
ist eine Zeichenfolge, die einem Wert vorgestellt istein
value
ist ein Wert, der aus einer Zeichenkette, einer Zahl, einem Objekt, Array oder einer booleschen Variable bestehen kann. Er folgt auf einenkey
.ein
key-value separator
grenzt Schlüssel von Werten ab und kann entweder:
oder=
als Trennzeichen einsetzen.ein
Kommentar
besitzt ein führendes#
oder//
. Kommentare werden eingesetzt, um Feedback oder Anweisungen mitzuliefern.
Beispiel:
yellow-thing: "Sponge"
In diesem Beispiel ist yellow-thing
der key
, Sponge
der Wert (value
) und das trennende Symbol (key-value-separator
) ist :
.
Arbeiten mit HOCON
HOCON ist flexibler als das JSON-Format (JavaScript Object Notation), da mehrere Möglichkeiten, um valides HOCON zu schreiben, gegeben sind. Hier sind zwei Beispiele für valides HOCON:
Beispiel 1:
player: {
name: "Steve",
level: 30
}
Beispiel 2:
player {
name = "Steve"
level = 30
}
In der Praxis ist es am besten sich an die Formatierungskonvention zu halten, die die editierte HOCON-Datei vorgibt. Wenn eine HOCON-Konfiguration für Sponge oder ein einzelnes Plugin, das die SpongeAPI nutzt, verändert wird, sind die Werte (englisch value) sehr wahrscheinlich das Einzige, was angepasst wird.
Fehlersuche
Falls eine HOCON-Konfiguration scheinbar nicht funktioniert, sind hier ein paar Tipps aufgelistet, um dies zu beheben:
alle geöffneten Klammern müssen auch geschlossen werden
Anführungszeichen müssen ebenfalls in gleicher Anzahl vorhanden sein
Doppelte Keys, die später gelistet sind, erhalten Vorrang.
HOCON-Spezifikation
Weitere Informationen über das HOCON-Format können hier gefunden werden.