Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve README.md #98

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 58 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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]. \
Soheab marked this conversation as resolved.
Show resolved Hide resolved
(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. \
Soheab marked this conversation as resolved.
Show resolved Hide resolved
(Source: [cogs/discorddoc.py ][DDOCSPY] (Discord) | [cogs/docs.py][DOCSPY] (Python & Nextcord))

- **Help System:**
An help system using buttons for the [Nextcord server][NEXTCORDSERVER]. \
Soheab marked this conversation as resolved.
Show resolved Hide resolved
(Source: [cogs/help.py][HELPPY]))

- **Others:**
- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe bot linking isn't just for bots added by boosting, it's for special bots as well- might want to change that to accomodate that

(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.
Soheab marked this conversation as resolved.
Show resolved Hide resolved
## 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.
Soheab marked this conversation as resolved.
Show resolved Hide resolved


[CONSUL]: https://www.consul.io/
[NEXTCORDSERVER]: https://discord.gg/ZebatWssCB
Soheab marked this conversation as resolved.
Show resolved Hide resolved
[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