From 858ed6d7a0e43a63c10eedbf69e6a6eff7a231b6 Mon Sep 17 00:00:00 2001 From: UltraLion <49597041+UltraLionfr@users.noreply.github.com> Date: Sun, 6 Nov 2022 00:23:46 +0100 Subject: [PATCH] Update README.md --- README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/README.md b/README.md index 8b13789..afa8cd0 100644 --- a/README.md +++ b/README.md @@ -1 +1,79 @@ +
This discord bot is a bot that allows to send an automatic answer when creating a post on a discord forum
+
+
+This project aims to help the community, it allows to send an automatic response when creating a post through a forum discord (see example picture below)
+The image comes from the official server discord.js.org
+
+
+.env file located at the root of the bot folder.
+```yml
+TOKEN = token_discord
+```
+
+3. Do the command `npm install` to install all the packages of the bot
+4. Now you have to configure the `config.json` file
+```json
+{
+ "default": "test",
+ "forumPostChannelId": [
+ "id_forum_n1", //The id of the first forum
+ "id_forum_n2" //The id of the second forum
+ ],
+ "forumPostMessage": [
+ "message_forum_n1", //The message of the first post
+ "message_forum_n2" //The message of the second post
+ ],
+ "forumPostTitle": [
+ "Title_Embed_post_n1", //The title of the embed for the first post
+ "Title_Embed_post_n2" //The title of the embed for the second post
+ ],
+ "forumPostButtons": {
+ //possibility to have several buttons following the same pattern
+ //The first button of the first post (only a button that redirects to a link)
+ "id_forum_n1": [
+ {
+ "label": "Google",
+ "url": "https://google.fr"
+ }
+ ],
+ //The second button of the first post (only a button that redirects to a link)
+ "id_forum_n2": [
+ {
+ "label": "Google",
+ "url": "https://google.fr"
+ }
+ ]
+ }
+}
+```
+5. To launch the bot once all configured make the command `node .` or the command `node index.js`
+
+