Introductie voor HOCON

HOCON (Human-Optimized Config Object Notation) is een makkelijk te gebruiken configuratie formaat. Het wordt gebruikt door Sponge en individuele plugins die de Sponge API gebruiken om belangrijke gegevens op te slaan, zoals de configuratie of spelergegevens. HOCON bestanden hebben gewoonlijk het suffix .conf.

Componenten

  • Een key (sleutel) is een string die een waarde voorafgaat.

  • Een value (waarde) is een string, nummer, object, lijst of boolean dat een key opvolgt.

  • Een key-value seperator scheidt de sleutels en waardes en kan oftewel : of = zijn.

  • Een comment wordt voorafgegaan door een # of // en wordt gebruikt om feedback of instructies mee te geven.

Voorbeeld:

yellow-thing: "Sponge"

In dit voorbeeld is de key yellow-thing, de value Sponge en de key-value seperator :.

Werken met HOCON

HOCON is flexibeler dan het JSON (JavaScript Object Notation) formaat doordat er meerdere manieren zijn om geldige HOCON te schrijven. Hieronder zijn twee voorbeelden van geldige HOCON.

Voorbeeld #1:

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

Voorbeeld #2:

player {
    name = "Steve"
    level = 30
}

In praktijk is het een goede gewoonte om de opmaak conventies van de HOCON configuratie die je aanpast te volgen. Wanneer je een HOCON configuratie aanpast voor Sponge of een individuele plugin die gebruik maakt van de Sponge API zijn de waardes waarschijnlijk het enige dat je moet veranderen tenzij het anders is gespecificeerd.

Jouw Configuratie Debuggen

Hier zijn enkele tips indien een HOCON configuratie niet blijkt te werken.

  • Accolades moeten gebalanceerd zijn.

  • Aanhalingstekens moeten gebalanceerd zijn.

  • Duplicate sleutels die later in de configuratie verschijnen overschrijven de eerdere.

Specificatie

Meer informatie over het HOCON formaat kan je hier vinden.