diff --git a/docs/2.modules/27.giveaways.md b/docs/2.modules/27.giveaways.md index 441ddc12e..08e737875 100644 --- a/docs/2.modules/27.giveaways.md +++ b/docs/2.modules/27.giveaways.md @@ -1,48 +1,291 @@ --- title: Giveaways -description: Grâce à DraftBot, lancez des giveaways pour faire gagner de superbes récompenses à vos membres ! +description: Organisez des giveaways pour faire gagner de superbes récompenses à vos membres ! navigation.icon: 'twemoji:party-popper' -contributors: ['kicoulapic314', 'imroxxor', 'draftproducts'] -updatedAt: '2025-03-01' +contributors: ['kicoulapic314', 'imroxxor', 'draftproducts', 'erwangit'] +updatedAt: '2026-01-18' --- +## Présentation + +La fonctionnalité de giveaways vous permet d'organiser des tirages au sort et d'offrir des récompenses aux membres de votre serveur qui y participent. + +![Exemple de giveaway avec une récompense personnalisée](../assets/giveaways/preview_giveaway.png) + +Pour chaque giveaway, vous pourrez offrir l'une de ces récompenses : +- De l'expérience dans le système de [niveaux](/docs/modules/niveaux). +- De l'argent dans le système d'[économie](/docs/modules/economie). +- Un objet provenant du système d'[inventaire](/docs/modules/inventaire). +- Un rôle (temporaire ou non). +- Une récompense personnalisée. + +## Interagir avec un giveaway + +### Participer + +Vous pouvez participer à un giveaway en cours en cliquant sur le bouton "Participer" en dessous des détails de celui-ci. + +![Exemple de giveaway non terminé](../assets/giveaways/simple_giveaway.png) + +Votre participation est alors prise en compte pour le tirage au sort à la fin du giveaway. + +::hint{ type="info" } + Nous ne proposons pas actuellement de fonctionnalités permettant à un membre de participer plusieurs fois à un giveaway. + + Tous les participants d'un giveaway ont donc les mêmes chances de victoire. +:: + +### Se désinscrire + +Si vous avez décidé de rejoindre un giveaway, mais que vous ne souhaitez plus y participer avant la fin de celui-ci, vous le pouvez en cliquant de nouveau sur le bouton "Participer". + +Une confirmation est alors demandée, cliquez sur le bouton "Se désinscrire" pour confirmer. + +![Demande de confirmation de désinscription](../assets/giveaways/confirm_desinscription.png) + +::hint{ type="warning" } + Si une condition de collecte (rôle, argent ou objet) est définie sur le giveaway et que vous décidez de vous désinscrire, l'élément collecté ne vous sera pas restitué. +:: + +### Voir les participants + +Si le créateur du giveaway l'a autorisé, vous pouvez voir la liste des participants en cliquant sur le bouton "Participants" du giveaway. + +![Interface de visualisation des participants d'un giveaway](../assets/giveaways/giveaway_participants_member.png) + +L'interface se découpe en pages suivant le nombre de participants. Vous pouvez alors cliquer sur les boutons "Précédent", "Suivant" ou choisir le numéro de page avec le bouton "Page". + +::hint{ type="info" } + Si vous êtes administrateur, vous avez aussi accès au bouton "Retirer" qui permet de supprimer la participation d'un membre. Plus d'informations dans la [partie dédiée](#retirer-un-participant). +:: + +## Accès à la commande /giveaway + +La commande \ nécessite la permission **Administrateur** par défaut. + +Néanmoins, il est possible de donner accès à certains rôles ou personnes indépendamment de leurs permissions sur le serveur l'accès à cette commande. + +Pour réaliser cela, vous pouvez retrouver plus d'informations sur cette page de la documentation : + +::card +--- +title: Gestion des permissions de commandes +icon: material-symbols:build +to: /docs/installation#configuration-des-commandes +target: _blank +color: '#cd6e57' +--- + Configurer les permissions des commandes Slash sur votre serveur. +:: + ## Créer un giveaway -Vous pouvez créer un giveaway avec les commandes \. Suivant ce que vous voulez faire gagner, les commandes à faire sont : +Vous pouvez créer un giveaway en utilisant la commande \, en complétant les options de la commande : + +| Option | Description | Obligatoire | +|--------|-------------|-------------| +| `récompense` | Le [type de récompense](#présentation). | ✅ Oui | +| `durée` | La durée du giveaway comprise entre une minute et un mois (ex : 2h, 7j) ou une date (ex : demain à 17h). | ✅ Oui | +| `gagnants` | Le nombre de gagnants compris entre 1 et 10 (jusqu'à 50 pour les serveurs [premium](/premium) <:icon_premium_:1096140508625125417>). | ✅ Oui | +| `titre` | Le titre du giveaway. | ❌ Non | +| `salon` | Le salon textuel où sera envoyé le giveaway. | ❌ Non (par défaut le salon de la commande) | + +::hint{ type="info" } + Vous pouvez lancer jusqu'à 3 giveaways en simultané. Les serveurs [premium](/premium) <:icon_premium_:1096140508625125417> n'ont pas de limite. +:: + +Une fois la commande \ exécutée, la récompense du giveaway vous est demandée : + +![Formulaire de saisie pour une récompense de rôle](../assets/giveaways/modal_reward_role.png) + +### Prévisualiser le giveaway + +Lorsque la récompense a été définie, une prévisualisation du giveaway vous est affichée. Elle vous permet de le configurer et de le modifier avant sa publication. + +![Interface de prévisualisation et de configuration d'un giveaway](../assets/giveaways/giveaway_config.png) + +### Configurer les options + +Depuis l'interface de prévisualisation, vous pouvez configurer des options à l'aide des boutons présents ainsi que du sélecteur "Configurer des options avancées...". + +L'ensemble des options est détaillé dans la [partie dédiée](#options-dun-giveaway). + +### Publier le giveaway -- \ ➜ Faire gagner de l'expérience (pour les [niveaux](/docs/modules/niveaux)). -- \ ➜ Faire gagner de l'argent (voir le système d'[économie](/docs/modules/economie)). -- \ ➜ Faire gagner un objet d'inventaire (voir le système d'[inventaire](/docs/modules/inventaire)). -- \ ➜ Faire gagner un rôle (temporaire ou non). -- \ ➜ Faire gagner une récompense personnalisée. +Lorsque vous souhaitez le publier, cliquez sur le bouton "Lancer le giveaway". ::hint{ type="info" } - Dans chaque cas, vous devez définir le **nom** du giveaway, le **nombre de gagnants**, sa **durée** et éventuellement le **salon** où a lieu le giveaway (par défaut, celui où la commande est faite). + Une fois le giveaway terminé, le créateur reçoit un message privé de <@DraftBot> l'informant du gagnant et lui rappelant la récompense. +:: + +## Options d'un giveaway + +### Titre et description + +Vous pouvez définir un titre qui est utilisé dans le message du giveaway ainsi que dans les messages envoyés aux membres de l'équipe (ex : message de fin, logs, etc.). + +::hint{ type="info" } + Si le titre n'est pas défini, le nom de la récompense est utilisé pour nommer le giveaway. +:: + +Vous pouvez également définir une description pour décrire votre récompense aux participants. + +![Giveaway avec un titre et une description personnalisée](../assets/giveaways/giveaway_description_title.png) + +### Durée + +La durée correspond au temps alloué aux membres pour participer à un giveaway. + +Vous pouvez indiquer : +- soit une durée, comme `1h`, `7 jours` ou encore `2 semaines` +- soit une date, comme `demain à 20h` ou `20/01 à 10h`. + +::hint{ type="info" } + La durée du giveaway doit être comprise entre une minute et un mois. :: +### Récompense + +Vous avez la possibilité de sélectionner l'une de ces récompenses pour un giveaway : + +- De l'expérience dans le système de [niveaux](/docs/modules/niveaux). +- De l'argent dans le système d'[économie](/docs/modules/economie). +- Un objet provenant du système d'[inventaire](/docs/modules/inventaire). +- Un rôle (temporaire ou non). +- Une récompense personnalisée. + +### Gagnants + +Vous devez définir le nombre de gagnants pour votre récompense. + ::hint{ type="info" } Vous pouvez choisir jusqu'à 10 gagnants. Les serveurs [premium](/premium) <:icon_premium_:1096140508625125417> peuvent aller jusqu'à 50 gagnants. :: -![Aperçu d'un giveaway pour une récompense personnalisée.](../assets/giveaways/bot_message.png) +### Salon -::hint{ type="success" } - Une fois le giveaway terminé, le créateur reçoit un message privé de <@DraftBot> l'informant du gagnant et lui rappelant la récompense. +Vous devez définir un salon textuel pour envoyer le giveaway. Vous avez le choix d'utiliser un salon existant ou d'en créer un dédié. + +::hint{ type="info" } + Par défaut, le salon utilisé est celui où est exécutée la commande \. +:: + +#### Sélection d'un salon existant + +Vous pouvez sélectionner un salon existant à l'aide du sélecteur de salon. + +![Sélection d'un salon existant](../assets/giveaways/exist_channel_choose.png) + +::hint{ type="warning" } + Le créateur du giveaway et <@DraftBot> doivent disposer des permissions **Envoyer des messages** et **Voir le salon**. <@DraftBot> doit également disposer de la permission **Intégrer des liens**. +:: + +#### Création d'un salon lors de la publication + +::hint{ type="warning" } + Vous devez disposer de la permission **Gérer les salons** pour créer un salon de cette manière. +:: + +Vous pouvez demander à <@DraftBot> la création d'un salon dédié lors de la publication en cliquant sur le bouton "Nouveau salon dédié". Vous pouvez alors définir un nom personnalisé et sa catégorie. + +![Création d'un salon lors de la publication du giveaway](../assets/giveaways/create_new_channel.png) + +### Organisateur + +L'organisateur permet de signaler aux participants quel membre offre la récompense. + +![Giveaway avec un organisateur défini](../assets/giveaways/giveaway_with_host.png) + +::hint{ type="warning" } + L'organisateur doit être présent sur le serveur au moment de la configuration pour être sélectionné. :: ::hint{ type="info" } - Vous pouvez lancer jusqu'à 3 giveaways en simultané. Les serveurs [premium](/premium) <:icon_premium_:1096140508625125417> n'ont pas de limite. + Le pseudo de l'organisateur est uniquement affiché sur le message et n'a pas d'autre effet sur le giveaway. :: -## Gérer les giveaways +### Condition -Une fois que vous avez créé un giveaway, vous pouvez le gérer avec plusieurs commandes : +Vous pouvez définir une condition d'accès pour participer au giveaway : -- \ ➜ Voir les participants d'un giveaway. -- \ ➜ Mettre fin à un giveaway. -- \ ➜ Désigner un nouveau gagnant pour un giveaway terminé. +| Condition | Description | +|-----------|-------------| +| [Objet](/docs/modules/inventaire) | Posséder un objet, avec possibilité de le retirer. | +| [Niveau](/docs/modules/niveaux) | Niveau compris entre un seuil minimum ou maximum. | +| [Argent](/docs/modules/economie) | Quantité d'argent minimum ou maximum, avec possibilité de faire payer la somme. | +| Rôles | Posséder (ou non) un ou plusieurs rôle(s), avec possibilité de les retirer. | ::hint{ type="warning" } - Les récompenses gagnées ne sont pas retirées aux anciens gagnants lorsque vous en désignez un nouveau. + En cas de retrait d'un élément (objet, niveau ou rôles) pour participer, celui-ci ne sera pas restitué en cas de [désinscription](#se-désinscrire) ou si le membre ne gagne pas le giveaway. :: +### Images + +Vous pouvez ajouter une vignette ainsi qu'une image principale à votre giveaway pour l'égayer. + +![Giveaway avec image et vignette (en haut à droite) configurées](../assets/giveaways/giveaway_image_thumbnail.png) + +### Mentions + +Vous pouvez définir des rôles à notifier lors de la publication du giveaway. + +![Giveaway avec deux rôles mentionnés](../assets/giveaways/giveaway_with_mentions.png) + +::hint{ type="info" } + - Vous pouvez définir jusqu'à **10** rôles mentionnés. + - Sans la permission **Mentionner @everyone, @here et tous les rôles**, vous ne pouvez mentionner que les rôles pouvant être mentionnés par tous les membres. +:: + +### Couleur + +::hint{ type="info" } + Cette option est réservée aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>. +:: + +Vous pouvez configurer la couleur latérale de l'embed pour correspondre à la charte de votre serveur ou de la récompense. + +![Giveaway avec une couleur personnalisée](../assets/giveaways/giveaway_custom_color.png) + +### Bouton Participants + +Le bouton "Participants", activé par défaut, permet aux membres de [consulter la liste des participants](#voir-les-participants). + +![Giveaway avec le bouton Participants activé](../assets/giveaways/simple_giveaway.png) + +Il est possible de retirer ce bouton. Les membres ne verront alors que le nombre total de participants. + +![Giveaway sans bouton Participants](../assets/giveaways/giveaway_no_participants_button.png) + +::hint{ type="info" } + Les administrateurs du serveur pourront toujours voir la liste des participants avec la commande \. +:: + +## Gérer un giveaway existant + +### Arrêter un giveaway + +Vous pouvez arrêter un giveaway avant sa fin initiale avec la commande \, en indiquant l'[identifiant](/docs/autres/recuperer-un-identifiant#identifiant-dun-message) ou le lien du message. + +Le tirage au sort aura alors lieu immédiatement et le ou les gagnants seront annoncés dans le salon du giveaway. + +### Relancer un giveaway + +Pour désigner un nouveau gagnant sur un giveaway terminé, vous pouvez utiliser la commande \, en indiquant l'[identifiant](/docs/autres/recuperer-un-identifiant#identifiant-dun-message) ou le lien du message du giveaway. + +::hint{ type="info" } + Vous pouvez remplacer un gagnant spécifique en utilisant l'option `gagnant` de la commande. +:: + +::hint{ type="warning" } + Les récompenses déjà distribuées ne sont pas retirées automatiquement aux anciens gagnants. +:: + +### Retirer un participant + +Vous pouvez retirer un participant d'un giveaway avec la commande \ ou le bouton "Participants" (si activé), puis cliquez sur "Retirer un participant". + +![Interface de gestion des participants pour les administrateurs](../assets/giveaways/giveaway_participants_admin.png) + +::hint{ type="info" } + Le membre retiré ne reçoit pas de notification, mais il conserve la possibilité de s'inscrire à nouveau avant la fin du tirage. +:: \ No newline at end of file diff --git a/docs/assets/giveaways/bot_message.png b/docs/assets/giveaways/bot_message.png deleted file mode 100644 index 0ff5f0578..000000000 Binary files a/docs/assets/giveaways/bot_message.png and /dev/null differ diff --git a/docs/assets/giveaways/confirm_desinscription.png b/docs/assets/giveaways/confirm_desinscription.png new file mode 100644 index 000000000..573db256a Binary files /dev/null and b/docs/assets/giveaways/confirm_desinscription.png differ diff --git a/docs/assets/giveaways/create_new_channel.png b/docs/assets/giveaways/create_new_channel.png new file mode 100644 index 000000000..318466bf1 Binary files /dev/null and b/docs/assets/giveaways/create_new_channel.png differ diff --git a/docs/assets/giveaways/exist_channel_choose.png b/docs/assets/giveaways/exist_channel_choose.png new file mode 100644 index 000000000..1ba405174 Binary files /dev/null and b/docs/assets/giveaways/exist_channel_choose.png differ diff --git a/docs/assets/giveaways/giveaway_config.png b/docs/assets/giveaways/giveaway_config.png new file mode 100644 index 000000000..4d091e01d Binary files /dev/null and b/docs/assets/giveaways/giveaway_config.png differ diff --git a/docs/assets/giveaways/giveaway_custom_color.png b/docs/assets/giveaways/giveaway_custom_color.png new file mode 100644 index 000000000..fa423226b Binary files /dev/null and b/docs/assets/giveaways/giveaway_custom_color.png differ diff --git a/docs/assets/giveaways/giveaway_description_title.png b/docs/assets/giveaways/giveaway_description_title.png new file mode 100644 index 000000000..384414ce7 Binary files /dev/null and b/docs/assets/giveaways/giveaway_description_title.png differ diff --git a/docs/assets/giveaways/giveaway_image_thumbnail.png b/docs/assets/giveaways/giveaway_image_thumbnail.png new file mode 100644 index 000000000..c953063e8 Binary files /dev/null and b/docs/assets/giveaways/giveaway_image_thumbnail.png differ diff --git a/docs/assets/giveaways/giveaway_no_participants_button.png b/docs/assets/giveaways/giveaway_no_participants_button.png new file mode 100644 index 000000000..b0d773e13 Binary files /dev/null and b/docs/assets/giveaways/giveaway_no_participants_button.png differ diff --git a/docs/assets/giveaways/giveaway_participants_admin.png b/docs/assets/giveaways/giveaway_participants_admin.png new file mode 100644 index 000000000..ccc52ddbe Binary files /dev/null and b/docs/assets/giveaways/giveaway_participants_admin.png differ diff --git a/docs/assets/giveaways/giveaway_participants_member.png b/docs/assets/giveaways/giveaway_participants_member.png new file mode 100644 index 000000000..90927d097 Binary files /dev/null and b/docs/assets/giveaways/giveaway_participants_member.png differ diff --git a/docs/assets/giveaways/giveaway_with_host.png b/docs/assets/giveaways/giveaway_with_host.png new file mode 100644 index 000000000..d830b97ab Binary files /dev/null and b/docs/assets/giveaways/giveaway_with_host.png differ diff --git a/docs/assets/giveaways/giveaway_with_mentions.png b/docs/assets/giveaways/giveaway_with_mentions.png new file mode 100644 index 000000000..471db3965 Binary files /dev/null and b/docs/assets/giveaways/giveaway_with_mentions.png differ diff --git a/docs/assets/giveaways/modal_reward_role.png b/docs/assets/giveaways/modal_reward_role.png new file mode 100644 index 000000000..26ccf7ed8 Binary files /dev/null and b/docs/assets/giveaways/modal_reward_role.png differ diff --git a/docs/assets/giveaways/preview_giveaway.png b/docs/assets/giveaways/preview_giveaway.png new file mode 100644 index 000000000..faad93b5f Binary files /dev/null and b/docs/assets/giveaways/preview_giveaway.png differ diff --git a/docs/assets/giveaways/simple_giveaway.png b/docs/assets/giveaways/simple_giveaway.png new file mode 100644 index 000000000..cf68263cd Binary files /dev/null and b/docs/assets/giveaways/simple_giveaway.png differ