Introductie voor 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.

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 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.

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.