diff --git a/docs/2.modules/.archives/13.salons-de-statistiques.md b/docs/2.modules/.archives/13.salons-de-statistiques.md index 7251c7873..1beb0da46 100644 --- a/docs/2.modules/.archives/13.salons-de-statistiques.md +++ b/docs/2.modules/.archives/13.salons-de-statistiques.md @@ -1,61 +1,179 @@ --- -title: Compteur de membres -description: Cette fonctionnalité vous permet d'afficher le nombre de membres présents sur votre serveur. +title: Salons de statistiques +description: Les salons de statistiques permettent d’afficher en temps réel différentes informations sur votre serveur (membres, bots, rôles, salons…), directement dans des salons vocaux ou des catégories. navigation.icon: 'twemoji:abacus' -contributors: ['iibey'] -updatedAt: '2023-06-28' +contributors: ['iibey', 'imroxxor'] +updatedAt: '2026-01-13' --- -## Configuration +## Apparence des salons de statistiques -Lors de la configuration de la fonctionnalité en vous rendant dans la commande \ ➜ **"🧮 Compteur de membres"**, vous aurez le choix entre deux designs : +### Salons vocaux -- **En plusieurs salons** : Sous la forme de salons vocaux qui pourra indiquer le nombre de membres, salons, rôles, etc. -- **En catégorie** : Sous la forme d'une catégorie où sera affiché uniquement le nombre de membres. +![Aperçu d'un salon vocal de statistiques](../../assets/salons-de-statistiques/bot_vocalcount.png) -![Aperçu de la question](../assets/salons-de-statistiques/membercount1.png) +::hint{ type="info" } + Un délai de **15 minutes** est imposé entre chaque actualisation. Les serveurs [premium](/premium) <:icon_premium_:1096140508625125417> ont un délai de **10 minutes** imposé. +:: + +### Catégorie + +![Aperçu d'une catégorie de statistiques](../../assets/salons-de-statistiques/bot_categorycount.png) ::hint{ type="info" } - Un délai de **10 minutes** est imposé entre chaque actualisation. + Un délai de **15 minutes** est imposé entre chaque actualisation. Les serveurs [premium](/premium) <:icon_premium_:1096140508625125417> ont un délai de **10 minutes** imposé. +:: + +## Configuration du système + +::tabs + ::tab{ label="Via la commande /config" } + + ## Créer un salon + + Pour créer un salon de statistique, il vous suffira d'aller dans le menu **Salons de statistiques** de la commande /config. Si vous n'avez pas d'autres salons de statistiques configurés, **DraftBot** vous proposera de cliquer sur deux boutons : + + - **Configuration rapide** + - **Configuration avancée** + + ::hint{ type="info" } + Si vous choisissez la **Catégorie** comme type de salon et que vous souhaitez prendre une **catégorie existante**, vous devrez remettre à **DraftBot** l'[identifiant](/docs/autres/recuperer-un-identifiant) de cette catégorie. + :: + + Une fois la méthode choisie (rapide ou avancée), vous devrez sélectionner la cible du compteur (membres, bots, rôle spécifique, etc.). + + ::collapse{ label="Afficher / masquer la liste des cibles" } + + | **NOM** | **EXPLICATION** | | + |---------|-----------------|--| + | **Membres** | Tous les utilisateurs *(humains et bots)* étant dans votre serveur. | | + | **Membres (sans bot)** | Tous les utilisateurs humains étant dans votre serveur. | | + | **Bots** | Tous les utilisateurs bots étant dans votre serveur. | | + | **Rôles** | Tous les rôles dans votre serveur. | | + | **Salons** | Tous les salons dans votre serveur. | | + | **Membres ayant un rôle** | Tous les membres ayant un certain rôle dans votre serveur. | | + | **Salons d'une catégorie** | Tous les salons dans une certaine catégorie. | | + | **API personnalisée** | Données d'une API web. | <:icon_premium:1096140508625125417> | + :: + + Lorsque vous avez créé votre salon, vous pourrez alors [configurer](#configurer-les-salons) vos salons. + + ## Configurer les salons + + ![Aperçu des boutons du /config](../../assets/salons-de-statistiques/config_choose.png) + + - **Créer :** Créer un nouveau salon de statistiques. + - **Modifier :** Modifier un salon existant. + - **Supprimer :** Supprimer un salon existant. + - **Réinitialiser :** Remettre à zéro le système. + :: + + ::tab{ label="Depuis le panel" } + [⫸ Accéder au panel de **DraftBot**](/dashboard/first/community) + + ## Créer un salon + + Pour créer un salon de statistiques, il suffit de cliquer sur le bouton "**Créer un salon**". Vous pouvez ensuite choisir une cible. + + ::collapse{ label="Afficher / masquer la liste des cibles" } + + | **NOM** | **EXPLICATION** | | + |---------|-----------------|--| + | **Membres** | Tous les utilisateurs *(humains et bots)* étant dans votre serveur. | | + | **Membres (sans bot)** | Tous les utilisateurs humains étant dans votre serveur. | | + | **Bots** | Tous les utilisateurs bots étant dans votre serveur. | | + | **Rôles** | Tous les rôles dans votre serveur. | | + | **Salons** | Tous les salons dans votre serveur. | | + | **Membres ayant un rôle** | Tous les membres ayant un certain rôle dans votre serveur. | | + | **Salons d'une catégorie** | Tous les salons dans une certaine catégorie. | | + | **API personnalisée** | Données d'une API web. | <:icon_premium:1096140508625125417> | + :: + + ## Configurer les salons + + Lorsque vous décidez de modifier un salon de statistiques, une série de paramètres apparaît. Vous pourrez **Modifier** ou **Supprimer** les salons de votre choix. + :: :: +## Personnaliser le format du nom + +### Salon + +![Aperçu d'un salon vocal de statistiques](../../assets/salons-de-statistiques/bot_vocalcount.png) + +Vous pouvez modifier le nom d'un salon vocal en mettant ce que vous souhaitez, à condition qu'il soit mis avant le " : ". + ::hint{ type="warning" } Faites bien attention à ne pas toucher au compteur de membres, sinon vous serez obligé de refaire une nouvelle configuration. :: -## Salons vocaux - -Une fois le design choisi, pour le cas présent, ce sera le design avec **les salons vocaux**. Vous devrez soit sélectionner une catégorie existante, soit faire une nouvelle catégorie pour que **les différents salons des statistiques** puissent être créés. +### Catégorie -Diverses questions s'offriront à vous afin que **DratfBot** puisse finaliser la création de ces salons : +![Aperçu d'une catégorie de statistiques](../../assets/salons-de-statistiques/bot_categorycount.png) -- L'affichage du nombre de **Membres présents** sur votre serveur (Utilisateurs + Bots). -- L'affichage du nombre **d'utilisateurs présents** sur votre serveur (Humains). -- L'affichage du nombre de **Bots présents** sur votre serveur (Bots). -- L'affichage du nombre de **Rôles créés** sur votre serveur (Rôles totaux). -- L'affichage du nombre de **Salons créés** sur votre serveur (Salons totaux). -- L'affichage du nombre de membres ayant un **rôle spécifique**. +Vous pouvez modifier le nom d'une catégorie en mettant ce que vous souhaitez, à condition qu'il soit mis avant le " – ". -::hint{ type="success" } - Une fois que vous aurez répondu à l'ensemble de ces questions, votre compteur de membres en forme de salons vocaux sera prêt ! +::hint{ type="warning" } + Faites bien attention à ne pas toucher au compteur de membres, sinon vous serez obligé de refaire une nouvelle configuration. :: +## API personnalisée + ::hint{ type="info" } - Tous les caractères avant le " : " dans le nom des salons peuvent être modifiés. + Cette fonctionnalité est réservée aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>. :: -## Catégorie - -Pour configurer le compteur de membres sous la forme d'une catégorie, il vous suffit de faire la commande \ ➜ **"🧮 Compteur de membres"** et de cliquer sur le bouton **"Catégorie"**. +La cible **API personnalisée** permet d’afficher une statistique provenant d’un **service externe**, via une requête HTTP/HTTPS vers une API web. -Une question vous sera posée dans le but de savoir si vous souhaitez comptabiliser les bots parmi le nombre de membres. +Cela peut servir par exemple à afficher : -![Résultat de la configuration](../assets/salons-de-statistiques/categorycount.png) +- Le nombre d’utilisateurs inscrits sur un site +- Une donnée issue d'une backend +- Toute autre valeur numérique accessible via une API ::hint{ type="info" } - Il ne vous manquera plus que de changer le nom de la catégorie **"xxxxxx"** comme vous le souhaitez, en plus d'ajouter de nouveaux salons, sans dérégler le compteur de membres dans la catégorie. + Quelques petits points à savoir / faire attention : + + - L’API doit être accessible via une requête **HTTP GET**. + Les identifiants peuvent être inclus directement dans l’URL, mais les **headers personnalisés ne sont pas pris en charge**. + + - Vérifiez que la réponse contient bien une **valeur numérique**. + + - Un délai de **10 minutes** est imposé entre chaque actualisation. :: +### Format + +L’API doit renvoyer un objet JSON contenant une valeur exploitable. + +**Exemple de réponse valide** +``` +{"count": 42} +``` + +Dans cet exemple, DraftBot affichera `42` dans le salon de statistiques. + ::hint{ type="info" } - Tous les caractères avant le " - " dans le nom de la catégorie peuvent être modifiés. + La valeur doit être un nombre et les chaînes de caractères ou objets complexes ne sont pas pris en charge. :: + +### Exemple concret + +Si votre API est accessible à l’adresse : + +``` +https://api.draftbot.fr/base/stats +``` + +et renvoie : + +``` +{"guilds":1008140,"users":53253590} +``` + +Le salon pourra afficher par exemple : + +``` +👤 Serveurs : 1008140 +``` + diff --git a/docs/assets/salons-de-statistiques/categorycount.png b/docs/assets/salons-de-statistiques/bot_categorycount.png similarity index 100% rename from docs/assets/salons-de-statistiques/categorycount.png rename to docs/assets/salons-de-statistiques/bot_categorycount.png diff --git a/docs/assets/salons-de-statistiques/bot_vocalcount.png b/docs/assets/salons-de-statistiques/bot_vocalcount.png new file mode 100644 index 000000000..3e4e96832 Binary files /dev/null and b/docs/assets/salons-de-statistiques/bot_vocalcount.png differ diff --git a/docs/assets/salons-de-statistiques/config_choose.png b/docs/assets/salons-de-statistiques/config_choose.png new file mode 100644 index 000000000..607c2a7a0 Binary files /dev/null and b/docs/assets/salons-de-statistiques/config_choose.png differ diff --git a/docs/assets/salons-de-statistiques/membercount1.png b/docs/assets/salons-de-statistiques/membercount1.png deleted file mode 100644 index 8f47fb469..000000000 Binary files a/docs/assets/salons-de-statistiques/membercount1.png and /dev/null differ