Introduction à HOCON
HOCON (Human-Optimized Config Object Notation, qui peut se traduire par « La Configuration et Notation d’Objets Optimisés pour les Humains ») est un format de configuration simple d’emploi. Il est utilisé par Sponge et les plugins qui utilisent SpongeAPI pour stocker des données importantes, comme une configuration ou les données d’un ou de plusieurs joueurs. Les fichiers HOCONs utilisent l’extension de fichier .conf
.
Composants
une
key
est une chaîne de caractères identifiant une valeurune
value
est une chaîne de caractère, un nombre, un objet, un tableau, ou un booléen associé à unekey
un
key-value separator
sépare les clés des valeurs, et peut soit être un:
soit un=
un
comment
est précédé d’un#
ou d’un//
, ils servent surtout à fournir des informations ou des retours
Exemple:
yellow-thing: "Sponge"
Dans cet exemple, la key
est yellow-thing
, la value
est Sponge
, et le key-value separator
est :
.
Travailer avec HOCON
HOCON est plus souple que le format JSON (JavaScript Object Notation) car il existe plusieurs façons d’écrire des fichiers HOCON valides. Voici deux exemples de fichier HOCON valide.
Exemple n°1:
player: {
name: "Steve",
level: 30
}
Exemple n°2:
player {
name = "Steve"
level = 30
}
Dans la pratique, il est préférable de suivre les conventions typographiques de la configuration de HOCON que vous êtes en train de modifier. Lorsque vous modifiez une configuration HOCON pour Sponge ou un plugin individuel utilisant SpongeAPI, les valeurs sont probablement la seule chose vous devriez changer sauf indication contraire.
Debugger votre configuration
Si une configuration HOCON ne semble pas fonctionner, voici quelques conseils.
Toute accolade ouverte doit être fermée
Tout guillemet ouvert doit être fermé
Les clés dupliquées qui apparaissent en dernier sont prioritaires
Caractéristiques
Vous trouverez plus d’informations sur le format HOCON ici.