Cómo usar archivos de configuración

Hoy vamos a ver como crear un fichero de configuración para poder configurar diversas opciones de nuestro plugin.

Archivo YAML

Un archivo YAML es un tipo de archivo con una estructura específica que se usa mucho para temas de archivos de configuración o de declaración de esquemas, etc.

Su forma de usar es muy peculiar. Primero tienes el nombre, sin espacios, dos puntos y el valor. Puedes incluir diferentes bloques dentro del mismo o incluso listas con el guión y el valor al lado.

Un ejemplo de archivo YAML es el que hemos usado anteriormente como plugin.yml.

Configuración de un plugin

Crear el config.yml

Para empezar necesitaremos crear un config.yml en nuestra carpeta de resources. Este es el que se copiará y se usará cuando sea la primera vez que se ejecuta el plugin.

numero_de_la_suerte: 68

Cargar el config.yml

Ahora lo que vamos a hacer es cargar el archivo, para ello, dentro del onEnable, ya que queremos cargar la configuración al inicio del plugin, usaremos el método getConfig().options().copyDefaults(). Luego, llamaremos al método saveDefaultConfig().

El método getConfig y saveDefaultConfig vienen incluidos en la clase JavaPlugin, que es la que extendemos en la clase principal. Esto significa que para obtener la config o para guardar la config otra vez necesitaremos tener una instancia de la clase principal, esto lo hemos hecho en vídeos anteriores pero es básicamente creando una referencia estática a la que el plugin se inicia.

Leer

Ahora crearemos un comando que nos permita leer cosas dentro de la configuración. Para empezar haremos un comando simple que nos envía un mensaje con el número que hemos puesto en la configuración. Para ello utilizaremos la instancia de nuestra main class llamando al método getConfig y a partir de ahí como número de la suerte es un int getInt número de la suerte y ya está, ya lo tendríamos.

CursoSpigot.getInstance().getConfig().getInt("numero_de_la_suerte");