Introdução ao HOCON
O HOCON (Notação de Configuração de Objetos Otimizada para Humanos) é um formato de configuração de fácil utilização. É utilizada pelo Sponge, e por plugins que utilizam a SpongeAPI para armazenar dados importantes, tais como configurações ou dados de jogadores. Os ficheiros HOCON costumam ter o sufixo .conf
.
Componentes
uma
chave
é uma string que precede um valorum
valor
é uma string, número, objeto, array, ou booleano que segue umachave
um
separador chave-valor
separa chaves de valores e pode ser um:
ou=
um
comentário
é prefixado com#
ou//
e serve normalmente para dar feedback ou instruções
Exemplo:
yellow-thing: "Sponge"
Nesse exemplo, a chave
é yellow-thing
, o valor
é Sponge
, e o separador chave-valor
é :
.
Trabalhando com HOCON
O HOCON é mais flexível que o formato JSON (JavaScript Object Notation) por existirem várias formas de escrever um HOCON válido. Abaixo há dois exemplos de um HOCON válido.
Exemplo #1:
player: {
name: "Steve",
level: 30
}
Exemplo #2:
player {
name = "Steve"
level = 30
}
Na prática, o melhor é seguir a formatação do ficheiro HOCON que estás a editar. Quando editares um ficheiro de configuração HOCON para o Sponge ou para um plugin que utilize a SpongeAPI, o mais provável é que só alteres os valores, a menos que tenhas outras instruções.
Depurando sua configuração
Se uma configuração HOCON parecer não estar funcionando, aqui estão algumas dicas.
As chaves (pontuação) devem estar balanceadas
O número de aspas devem estar equilibradas
Quando há chaves duplicadas, a que aparece depois tem prioridade
Especificação
Mais informação sobre o formato HOCON pode ser encontrado aqui.