Introducción a HOCON

HOCON (Human-Optimized Config Object Notation) es un formato de configuración fácil de usar. Es utilizado por Sponge y los complementos individuales que utilizan la API de Sponge para almacenar datos importantes, como la configuración o los datos del jugador. Los archivos HOCON normalmente usan el sufijo .conf.

Componentes

  • una key es una cadena que precede a un valor

  • un value es una cadena, número, objeto, matriz o booleano que sigue a una key

  • un key-value separator separa las claves de los valores, y puede ser : o =

  • un comment tiene el prefijo # `` o ``//, que típicamente sirve para proporcionar comentarios o instrucciones

Ejemplo:

yellow-thing: "Sponge"

En este ejemplo, la key es yellow-thing, el value es `` Sponge``, y el key-value separator es ``: ``.

Trabajando con HOCON

HOCON es más flexible que el formato JSON (JavaScript Object Notation) ya que hay varias formas válidas de escribir HOCON. A continuación hay dos ejemplos válidos de HOCON.

Ejemplo #1:

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

Ejemplo #2:

player {
    name = "Steve"
    level = 30
}

En la práctica, es mejor seguir las convenciones de formato de la configuración HOCON que usted está editando. Al editar una configuración de HOCON para Sponge o un complemento individual utilizando la API de Sponge, es probable que los valores sean los únicos que usted cambiará a menos de que se especifique lo contrario.

Depurando su configuración

Si una configuración HOCON parece no estar funcionando, aquí hay algunos consejos.

  • Las llaves deben ser balanceadas

  • Las comillas deben ser balanceadas

  • Las claves duplicadas que aparezcan más tarde toman prioridad

Especificación

Se puede encontrar más información sobre el formato HOCON aquí.