From 001df5d1d1c9ae564edfd1104ee5726faf5fe05f Mon Sep 17 00:00:00 2001 From: Mylloon Date: Sun, 5 Mar 2023 13:14:09 +0100 Subject: [PATCH] Add info about player and his debug event --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1730f67..ca5619c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,7 @@ une [Pull Request](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls). - [Projet](#projet) - [Ajouter une commande](#ajouter-une-commande) - [Ajouter un évènement](#ajouter-un-évènement) + - [Player](#player) - [Modèles](#modèles) - [Boutons](#boutons) - [Modifier du code](#modifier-du-code) @@ -174,6 +175,23 @@ De préférence, merci de mettre un lien en commentaire vers la documentation de discord.js de l'évènement ([exemple ici pour l'évènement `ready`](./src/events/client/ready.ts#L3)) +### Player + +Les évènement du player ont la même logique les autres, mais sont placés +dans le dossier [`player`](./src/events/player/). + +> Pour débogguer le player, il est possible d'ajouter un évènement `debug`, en +> voici un exemple : +> +> ```ts +> import { GuildQueue } from "discord-player"; +> +> /** https://discord-player.js.org/docs/types/discord-player/GuildQueueEvents */ +> export default (_: GuildQueue, message: string) => { +> console.error(message); +> }; +> ``` + ## Modèles Les modèles sont gérés [en dehors séparément du reste](./src/modals/).