From bb9f5510fac69cf991ee1bfd4233899a29d3010c Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Thu, 19 May 2022 17:12:34 +0200 Subject: [PATCH 1/5] chore: improve README.md --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 58 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3592efc..4f95d51 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,63 @@ # Previous -The bot for ~~annoying nextcord members~~ managing some of nextcord's unique tasks. +The bot managing the Official [Nextcord Discord Server][NEXTCORDSERVER]. + +# Features + +- **Autopaste:** + Automatically paste the contents of a file or codeblock to [our paste service][PASTESERVICE] \ + (Source: [cogs/autopaste.py][AUTOPASTEPY]) + +- **Auto thread:** + Automatically create a thread for each message sent in the [AUTO_THREAD_CHANNEL_ID] channel. \ + (Source: [cogs/autothread.py][AUTOTHREADPY]) + +- **Automatic stars update:** + Automatically pull the stars from the [Nextcord][NEXTCORDREPOSITORY] and [Nextcord v3][NEXTCORDREPOSITORYV3] repoitories and update the [STARS_CHANNEL_ID] channel. \ + (Source: [cogs/stars.py][STARSPY]) + +- **Documentation:** + Search through the [Discord][DISCORDDOCS] and [Python][PYTHONDOCS] & [Nextcord][NEXTCORDDOCS] documentation. \ + (Source: [cogs/discorddoc.py ][DDOCSPY] (Discord) | [cogs/docs.py][DOCSPY] (Python & Nextcord)) + +- **Help System:** + An help system using buttons for the nextcord server. \ + (Source: [cogs/help.py][HELPPY])) + +- **Others:** + - Database: simple powered by [consul.io][CONSUL] + (Source: [cogs/database.py][DATABASEPY]) + - Bot linking: stores whose and which bots are added in the nextcord server by boosting. + (Source: [cogs/botlink.py][BOTLINKPY]) + - Charinfo: Command to get information about a (unicode) character. + (Source: [cogs/etc.py][ETCPY]) # Running the bot -You need a [consul](https://consul.io) instance running. +1. Run a [consul.io][CONSUL] instance. +2. Create or fill in the environment variables shown in the [.env.example][ENVFILE] file. +3. Run the [main.py](./main.py) file to launch the bot. +Any further help regarding setting up the and getting everything working is not provided. ## Contributing -Refer to the [`.env.example`](./.env.example) file for a list of required environment variables. +Refer to [Running the bot](#running-the-bot) for the steps to run the bot and contribute. + + +[CONSUL]: https://www.consul.io/ +[NEXTCORDSERVER]: https://discord.gg/ZebatWssCB +[PASTESERVICE]: https://paste.nextcord.dev +[ENVFILE]: ./.env.example +[AUTO_THREAD_CHANNEL_ID]: ./.env.example#L10 +[STARS_CHANNEL_ID]: ./.env.example#L9 +[DISCORDDOCS]: https://discord.com/developers/docs/intro +[PYTHONDOCS]: https://docs.python.org/ +[NEXTCORDDOCS]: https://docs.nextcord.dev/ +[NEXTCORDREPOSITORY]: https://github.com/nextcord/nextcord +[NEXTCORDREPOSITORYV3]: https://github.com/nextcord/nextcord-v3 +[AUTOPASTEPY]: ./cogs/autopaste.py +[AUTOTHREADPY]: ./cogs/autothread.py +[HELPPY]: ./cogs/help.py +[DDOCSPY]: ./cogs/discorddoc.py +[DOCSPY]: ./cogs/docs.py +[STARSPY]: ./cogs/stars.py +[ETCPY]: ./cogs/etc.py +[DATABASEPY]: ./cogs/database.py +[BOTLINKPY]: ./cogs/bot_linking.py \ No newline at end of file From c2284a28cca22edd838321e18f14932a0ba25514 Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Thu, 19 May 2022 17:20:03 +0200 Subject: [PATCH 2/5] Improve wording bot linking and database --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f95d51..d10ae24 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ The bot managing the Official [Nextcord Discord Server][NEXTCORDSERVER]. (Source: [cogs/help.py][HELPPY])) - **Others:** - - Database: simple powered by [consul.io][CONSUL] + - Database: simple database powered by [consul.io][CONSUL] (Source: [cogs/database.py][DATABASEPY]) - - Bot linking: stores whose and which bots are added in the nextcord server by boosting. + - Bot linking: stores which users bot are added to the nextcord server by boosting. (Source: [cogs/botlink.py][BOTLINKPY]) - Charinfo: Command to get information about a (unicode) character. (Source: [cogs/etc.py][ETCPY]) From b805da06f8caba66b9cc652aab755f1dfad5e0c0 Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Thu, 19 May 2022 17:23:41 +0200 Subject: [PATCH 3/5] dots --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d10ae24..21f7360 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The bot managing the Official [Nextcord Discord Server][NEXTCORDSERVER]. # Features - **Autopaste:** - Automatically paste the contents of a file or codeblock to [our paste service][PASTESERVICE] \ + Automatically paste the contents of a file or codeblock to [our paste service][PASTESERVICE]. \ (Source: [cogs/autopaste.py][AUTOPASTEPY]) - **Auto thread:** @@ -20,15 +20,15 @@ The bot managing the Official [Nextcord Discord Server][NEXTCORDSERVER]. (Source: [cogs/discorddoc.py ][DDOCSPY] (Discord) | [cogs/docs.py][DOCSPY] (Python & Nextcord)) - **Help System:** - An help system using buttons for the nextcord server. \ + An help system using buttons for the [Nextcord server][NEXTCORDSERVER]. \ (Source: [cogs/help.py][HELPPY])) - **Others:** - - Database: simple database powered by [consul.io][CONSUL] + - Database: simple database powered by [consul.io][CONSUL]. (Source: [cogs/database.py][DATABASEPY]) - Bot linking: stores which users bot are added to the nextcord server by boosting. (Source: [cogs/botlink.py][BOTLINKPY]) - - Charinfo: Command to get information about a (unicode) character. + - Charinfo: command to get information about a (unicode) character. (Source: [cogs/etc.py][ETCPY]) # Running the bot From 0a96ea86c47af3c2b3eb1b7d0edb0abd1484322f Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Sat, 28 May 2022 21:18:10 +0200 Subject: [PATCH 4/5] Solve comments --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 21f7360..9b724eb 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ # Previous The bot managing the Official [Nextcord Discord Server][NEXTCORDSERVER]. -# Features - +## Features - **Autopaste:** Automatically paste the contents of a file or codeblock to [our paste service][PASTESERVICE]. \ (Source: [cogs/autopaste.py][AUTOPASTEPY]) +- **Automatic stars update:** + Automatically pull the stars from the [Nextcord][NEXTCORDREPOSITORY] and [Nextcord v3][NEXTCORDREPOSITORYV3] repoitories and update the [STARS_CHANNEL_ID] channel. \ + (Source: [cogs/stars.py][STARSPY]) + - **Auto thread:** Automatically create a thread for each message sent in the [AUTO_THREAD_CHANNEL_ID] channel. \ (Source: [cogs/autothread.py][AUTOTHREADPY]) -- **Automatic stars update:** - Automatically pull the stars from the [Nextcord][NEXTCORDREPOSITORY] and [Nextcord v3][NEXTCORDREPOSITORYV3] repoitories and update the [STARS_CHANNEL_ID] channel. \ - (Source: [cogs/stars.py][STARSPY]) - **Documentation:** Search through the [Discord][DISCORDDOCS] and [Python][PYTHONDOCS] & [Nextcord][NEXTCORDDOCS] documentation. \ (Source: [cogs/discorddoc.py ][DDOCSPY] (Discord) | [cogs/docs.py][DOCSPY] (Python & Nextcord)) - **Help System:** - An help system using buttons for the [Nextcord server][NEXTCORDSERVER]. \ + A help system using buttons for the [Nextcord server][NEXTCORDSERVER]. \ (Source: [cogs/help.py][HELPPY])) - **Others:** @@ -31,18 +31,23 @@ The bot managing the Official [Nextcord Discord Server][NEXTCORDSERVER]. - Charinfo: command to get information about a (unicode) character. (Source: [cogs/etc.py][ETCPY]) -# Running the bot +## Running the bot 1. Run a [consul.io][CONSUL] instance. 2. Create or fill in the environment variables shown in the [.env.example][ENVFILE] file. 3. Run the [main.py](./main.py) file to launch the bot. -Any further help regarding setting up the and getting everything working is not provided. +Any further help regarding setting up the bot and getting everything working is not provided. ## Contributing -Refer to [Running the bot](#running-the-bot) for the steps to run the bot and contribute. +Refer to [Running the bot](#running-the-bot) for the steps on how to run the bot and contribute. + +## Credits +- [Rapptz](https://github.com/Rapptz)' open sourced [RoboDanny](https://github.com/Rapptz/RoboDanny) discord bot for the following commands: + - [charinfo][ETCPY] + - [docs][DOCSPY] [CONSUL]: https://www.consul.io/ -[NEXTCORDSERVER]: https://discord.gg/ZebatWssCB +[NEXTCORDSERVER]: https://discord.gg/nextcord [PASTESERVICE]: https://paste.nextcord.dev [ENVFILE]: ./.env.example [AUTO_THREAD_CHANNEL_ID]: ./.env.example#L10 From e401a898960ab852a18d7ce948e4824f21ba6fc2 Mon Sep 17 00:00:00 2001 From: Oliver Wilkes Date: Mon, 6 Jun 2022 16:54:56 +0100 Subject: [PATCH 5/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c29e324..310f51d 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,8 @@ The bot managing the Official [Nextcord Discord Server][NEXTCORDSERVER]. ### Development -1. [Install docker](DOCKER) -2. Copy [.env.example](ENVFILE) to .env +1. [Install docker][DOCKER] +2. Copy [.env.example][ENVFILE] to .env 3. Set each variable to your values `CONSUL_HOST` by default in dev mode is `http://consul:8500` `CONSUL_TOKEN` is empty in dev mode, set it blank