diff --git a/README.md b/README.md index 6937bcd..310f51d 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,83 @@ # 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]) + +- **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]) + + +- **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:** + A help system using buttons for the [Nextcord server][NEXTCORDSERVER]. \ + (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. + (Source: [cogs/botlink.py][BOTLINKPY]) + - Charinfo: command to get information about a (unicode) character. + (Source: [cogs/etc.py][ETCPY]) ## Running the bot ### Development -1. [Install docker](https://docs.docker.com/get-docker/) -2. Copy .env.example 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 4. Start docker `docker-compose up --build` (use `-d` for no output to console but to `docker logs`) -### Stopping +#### Stopping ```bash docker-compose down (or ctrl + c when attached) ``` + +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 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] + + +[DOCKER]: https://docs.docker.com/get-docker/ +[CONSUL]: https://www.consul.io/ +[NEXTCORDSERVER]: https://discord.gg/nextcord +[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