📓YAML

Documentation pour l'API (YAML).

---

Gestion des fichiers YAML

Introduction

Les fichiers YAML sont essentiels pour stocker des données de configuration telles que des messages, des paramètres ou des statistiques. Grâce à la modularité de dAPI, vous pouvez facilement :

• Créer des fichiers YAML.

• Facilité de création, soit dans le code ou bien dans le dossier "resources" de votre plugin.

• Obtenir des valeurs, listes, rechargé le fichier et bien d'autres méthodes là pour vous aider.

---

Création d'un fichier YAML

Étape 1 : Importer YamlFile

Pour commencer, importez la classe YamlFile dans votre projet :

import fr.kirosnn.dAPI.utils.YamlFile;

---

Étape 2 : Initialisation

Dans la classe principale de votre plugin, initialisez vos fichiers YAML dans le constructeur ou la méthode onEnable :

private YamlFile langFile;
private YamlFile configFile;

@Override
public void onEnable() {
    this.langFile = new YamlFile(this, null, "lang.yml"); // Fichier dans le dossier racine, au lieu de null, vous pouvez aussi simplement utiliser " "
    this.configFile = new YamlFile(this, "configs", "config.yml"); // Fichier dans un sous-dossier "configs"
}

Note : Si le fichier ou le dossier n'existe pas, il sera automatiquement créé.

---

Étape 3 : Getters pour vos fichiers YAML

Ajoutez des méthodes pour accéder facilement à vos fichiers :

public YamlFile getLangFile() {
    return langFile;
}

public YamlFile getConfigFile() {
    return configFile;
}

---

Utilisation des fichiers YAML

Lecture de données

Récupérez une valeur avec son chemin :

String message = langFile.get("messages.welcome", "Bienvenue par défaut !");

Vous pouvez aussi récupérer une liste ou un ensemble de clés :

List<String> items = configFile.getList("game.items", Arrays.asList("épée", "bouclier"));
Set<String> keys = configFile.getKeys("game.settings", false);

---

Écriture de données

Pour définir une valeur dans le fichier :

configFile.set("game.maxPlayers", 10); // Non obligatoire, l'API prendra sinon le fichier YAML dans le dossier resources de votre plugin

---

Sauvegarde et rechargement

Enregistrez vos modifications avec :

configFile.save(); // Non obligatoire

Rechargez le fichier pour synchroniser les changements effectués directement dans le fichier :

configFile.reload(); // Envoi automatiquement un message de confirmation à la console avec gestion des erreurs

---

Exemple complet

Voici un exemple pratique d'utilisation de YamlFile dans votre plugin :

import fr.kirosnn.dAPI.utils.YamlFile;
import org.bukkit.plugin.java.JavaPlugin;

public class dAPI extends JavaPlugin {

    private YamlFile configFile;

    @Override
    public void onEnable() {
        // Initialisation du fichier
        this.configFile = new YamlFile(this, null, "config.yml");

        // Lecture du fichier
        String welcomeMessage = configFile.get("messages.welcome", "Bienvenue !");
        getLogger().info(welcomeMessage);

        // Écriture du fichier si vous souhaitez "hardcoder" directement en Java plutôt que dans le dossier "resources"
        configFile.set("plugin.enabled", true);
        configFile.save();

        // Rechargement du fichier
        configFile.reload();
    }
}

---

Méthodes disponibles

Lecture

Méthode	Description
get(String path, T defaultValue)	Récupère une valeur avec une valeur par défaut.
getList(String path, List<T> defaultValue)	Récupère une liste d'éléments avec une valeur par défaut.
getKeys(String path, boolean deep)	Récupère toutes les clés enfants d'un chemin donné.
getTranslated(String path, String defaultValue, Map<String, String> placeholders)	Récupère une chaîne avec codes couleur et placeholders remplacés.

---

Écriture

Méthode	Description
set(String path, Object value)	Définit une valeur pour une clé donnée.
save()	Sauvegarde le fichier YAML sur le disque.
reload()	Recharge le fichier YAML depuis le disque.

---

Avec cette fonctionnalité, gérer vos configurations YAML devient intuitif et simple. Ajoutez vos propres ajustements ou fonctionnalités selon vos besoins ✨ !