Introduksjon til HOCON

HOCON (Human-Optimized Config Object Notation, menneskeoptimalisert konfigurasjonsobjektsnotasjon) er et konfigurasjonsformat som er enkelt å bruke. Det brukes av Sponge og individuelle SpongeAPI-plugins til å lagre viktig data, slik som konfigurasjons- eller spillerdata. HOCON-filer slutter vanligvis på .conf.

Komponenter

  • en nøkkel er en tekststreng som kommer før en verdi
  • en verdi er en streng, et tall, et objekt, en liste eller en boolsk verdi som etterfølger en nøkkel
  • en nøkkel-verdi-separator deler nøkler fra verdier, og kan være enten : eller =
  • en kommentar begynner med # eller //, og brukes vanligvis til å gi tilbakemelding eller instruksjoner

Eksempel:

yellow-thing: "Sponge"

I dette eksempelet er nøkkelen lik yellow-thing, og verdien er Sponge. Nøkkel-verdi-separatoren er :.

Jobbe med HOCON

HOCON er mer fleksibelt enn JSON-formatet (JavaScript Object Notation, JavaScript-objektnotasjon) i den forstand at det er flere måter å skrive riktig HOCON. Nedenfor er to eksempler på gyldig HOCON.

Eksempel 1:

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

Eksempel 2:

player {
    name = "Steve"
    level = 30
}

I praksis er det best å følge formateringskonvensjonen til den HOCON-konfigurasjonsfilen du redigerer. Når du redigerer en HOCON-konfigurasjon til Sponge eller en plugin som bruker SpongeAPI, vil du mest sannsynlig kun endre verdiene med mindre du får beskjed om noe annet.

Finne feil i konfigurasjonen din

Her er noen tips hvis det virker som en HOCON-konfigurasjon ikke fungerer.

  • Krøllparenteser må være balanserte
  • Sitattegn må være balanserte
  • Dupliserte nøkler som dukker opp lenger ned i konfigurasjonen overskriver de som står lenger opp

Spesifikasjon

Mer informasjon om HOCON-formatet kan du finne her.