Skip to content

Commit 2db48a2

Browse files
committedMay 22, 2023
docs : translate readme into english
1 parent b7eb696 commit 2db48a2

File tree

1 file changed

+52
-81
lines changed

1 file changed

+52
-81
lines changed
 

‎readme.md

+52-81
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,68 @@
11
# RSS Feed Discord Bot
22

3-
## Description :
4-
Le RSS Feed Discord Bot est un bot Discord qui permet de suivre les flux RSS et de recevoir des notifications sur Discord lorsqu'un nouveau post est publié sur le flux RSS. Par défaut, le bot vérifie le flux RSS toutes les 10 minutes pour le site Space.com.
5-
6-
## Les commandes du bot :
7-
- `!help` : Affiche la liste des commandes du bot. (non implémenté)
8-
- `!stop` : Permet d'arrêter manuellement le bot.
9-
- `!start` : Permet de démarrer manuellement le bot.
10-
- `!status` : Affiche le statut du bot.
11-
- `!ping` : Affiche le ping du bot.
12-
13-
## Prérequis :
14-
- Python 3.6 ou supérieur
15-
- Un compte Discord
16-
- Un serveur Discord
17-
18-
## Installation :
19-
- Téléchargez le code source du bot Discord RSS Feed.
20-
- Installez les dépendances en utilisant la commande `pip install -r requirements.txt`.
21-
- Créez une application bot sur le portail des développeurs Discord.
22-
- Ajoutez le bot à votre serveur Discord.
23-
- Modifiez le fichier `config.ini` et ajoutez les informations requises.
24-
- Exécutez le fichier `main.py` pour démarrer le bot.
25-
26-
## Dépendances :
27-
### Dépendances intégrées à Python :
28-
- time : La bibliothèque time est utilisée pour gérer les dates et les heures.
29-
- configparser : La bibliothèque configparser est utilisée pour lire les fichiers de configuration.
30-
31-
### Dépendances à installer :
32-
33-
- discord.py : La bibliothèque Discord.py permet d'interagir avec l'API Discord et de créer des bots Discord en Python.
34-
- feedparser : La bibliothèque feedparser est utilisée pour analyser les flux RSS. Elle permet de récupérer les données des entrées du flux.
35-
36-
Assurez-vous d'installer ces dépendances avant d'exécuter le code. Vous pouvez les ajouter à votre fichier `requirements.txt` en utilisant les commandes suivantes :
3+
## Description:
4+
The RSS Feed Discord Bot is a Discord bot that allows you to follow RSS feeds and receive notifications on Discord when a new post is published on the RSS feed. By default, the bot checks the RSS feed every 10 minutes for the Space.com website.
5+
6+
## Bot commands:
7+
- `!help`: Displays the list of bot commands. (not implemented)
8+
- `!stop`: Manually stops the bot.
9+
- `!start`: Manually starts the bot.
10+
- `!status`: Displays the bot's status.
11+
- `!ping`: Displays the bot's ping.
12+
13+
## Prerequisites:
14+
- Python 3.8 or higher
15+
- A Discord account
16+
- A Discord server
17+
18+
## Installation:
19+
- Download the source code of the Discord RSS Feed bot.
20+
- Install the dependencies using the command `pip install -r requirements.txt`.
21+
- Create a bot application on the [Discord Developers Portal](https://discord.com/developers/applications).
22+
- You need to enable intents under `*YourApplication*/Bot/Privileged Gateway Intents`.
23+
- Add the bot to your Discord server.
24+
- Modify the `config.ini` file and add the required information.
25+
- Run the `main.py` file to start the bot.
26+
27+
## Dependencies:
28+
### Built-in Python dependencies:
29+
- time: The time library is used to manage dates and times.
30+
- configparser: The configparser library is used to read configuration files.
31+
32+
### External dependencies to install:
33+
- discord.py: The Discord.py library allows interaction with the Discord API and the creation of Discord bots in Python.
34+
- feedparser: The feedparser library is used to parse RSS feeds. It allows retrieving data from feed entries.
35+
36+
Make sure to install these dependencies before running the code. You can add them to your `requirements.txt` file using the following commands:
3737

3838
```
3939
discord.py
4040
feedparser
4141
```
4242

43-
Ensuite, vous pouvez installer toutes les dépendances en une seule fois en utilisant la commande `pip install -r requirements.txt`.
43+
Then, you can install all the dependencies at once by using the command `pip install -r requirements.txt`.
4444

45-
## Créer une application bot sur le portail des développeurs Discord :
46-
- Rendez-vous sur le portail des développeurs Discord et connectez-vous avec votre compte Discord.
47-
- Cliquez sur "New Application" pour créer une nouvelle application.
48-
- Donnez un nom à votre application et cliquez sur "Create".
49-
- Dans le menu de gauche, cliquez sur "Bot".
50-
- Cliquez sur "Add Bot" pour ajouter un bot à votre application.
51-
- Cliquez sur "Yes, do it!" pour confirmer.
52-
- Cliquez sur "Copy" pour copier le token de votre bot.
53-
- Cliquez sur "OAuth2" dans le menu de gauche.
54-
- Dans la section "Scopes", cochez la case "bot".
55-
- Dans la section "Bot Permissions", cochez la case "Send Messages".
56-
- Cliquez sur "Copy" pour copier le lien d'invitation de votre bot.
57-
- Ouvrez le lien d'invitation dans votre navigateur et sélectionnez votre serveur Discord.
58-
- Cliquez sur "Continue" pour confirmer.
59-
- Cliquez sur "Authorize" pour ajouter le bot à votre serveur Discord.
45+
## Configuration:
46+
To configure the bot, you need to modify the `sample.config.ini` file and add the following information:
47+
- `token`: Your Discord bot token.
48+
- `channel_id`: The ID of the Discord channel where you want to receive notifications.
49+
- `rss_url`: The URL of the RSS feed you want to follow.
50+
- `check_interval`: The time interval between each RSS feed check (in minutes).
51+
- `bot_prefix`: The prefix you want to use for the bot commands.
6052

61-
## Configuration :
62-
Pour configurer le bot, vous devez modifier le fichier `sample.config.ini` et ajouter les informations suivantes :
63-
- `token` : Le token de votre bot Discord.
64-
- `channel_id` : L'ID du salon Discord dans lequel vous souhaitez recevoir les notifications.
65-
- `rss_url` : L'URL du flux RSS que vous souhaitez suivre.
66-
- `check_interval` : L'intervalle de temps entre chaque vérification du flux RSS (en minutes).
67-
- `bot_prefix` : Le préfixe que vous souhaitez utiliser pour les commandes du bot.
68-
69-
Renommez ensuite le fichier `sample.config.ini` en `config.ini`.
70-
Par défaut, le bot vérifie le flux RSS toutes les 10 minutes pour le site Space.com. Si vous souhaitez suivre un autre flux RSS, vous devez modifier les informations dans le fichier `config.ini`.
71-
Ainsi que modifier le message envoyé par le bot dans le fichier main.py :
53+
Rename the `sample.config.ini` file to `config.ini`.
54+
By default, the bot checks the RSS feed every 10 minutes for the Space.com site. If you want to follow another RSS feed, you need to modify the information in the `config.ini` file.
55+
Also, modify the message sent by the bot in the `main.py` file:
7256
```python
7357
# Send the message to the Discord channel
7458
message = f"**New post on Space.com!**\nTitle: {title}\nLink: {link}\nSummary: {summary}"
7559
await channel.send(message)
7660
```
7761

78-
## Problèmes connus :
79-
```
80-
WARNING discord.ext.commands.bot Privileged message content intent is missing, commands may not work as expected.
81-
```
82-
83-
Le message d'avertissement que vous avez reçu indique que l'intention "Privileged message content" est manquante. Cela peut affecter le fonctionnement des commandes dans votre bot.
84-
85-
Pour résoudre ce problème, vous devez activer les intentions : "Privileged Gateway Intents" "PRESENCE INTENT" et "SERVER MEMBERS INTENT" dans le portail des développeurs Discord. Voici comment faire :
86-
87-
- Rendez-vous sur le portail des développeurs Discord et connectez-vous avec votre compte Discord.
88-
89-
- Sélectionnez votre application bot dans la liste des applications.
90-
91-
- Dans le menu de gauche, cliquez sur "Bot".
92-
93-
- Dans la section "Privileged Gateway Intents", activez l'intention "Message Content" en cochant la case correspondante.
94-
95-
- Après avoir activé l'intention, générez un nouveau token pour votre bot en cliquant sur "Generate a New Token". Remplacez l'ancien token dans votre code par ce nouveau token.
96-
97-
- Une fois ces étapes effectuées, redémarrez votre bot et vérifiez si les commandes fonctionnent comme prévu.
62+
### Intents
63+
The bot uses all intents by default, which are required for simple things like displaying the member count or take charge of the commands.
64+
You need to enable those intents in the [Discord Developers Portal](https://discord.com/developers/applications)
65+
under `Privileged Gateway Intents`.
66+
It's possible to reconfigure the requested intents in `main.py` if you don't need them.
67+
But I'd suggest using all of them for the beginning, especially if you're relatively new to discord.py.
68+
This will only be an issue if your bot reaches more than 100 servers, then you have to apply for those intents.

0 commit comments

Comments
 (0)
Please sign in to comment.