Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PadawanAmy committed Dec 14, 2023
1 parent 9af115c commit 6a7cec9
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# HelperBot
HelperBot is a Discord bot designed to auto reply to certain phrases in the chat.
There are different types of responses that you can use to fit your needs and many different placeholders you can use.

# Installation
HelperBot uses the Disnake library for Python.
1. Create a Discord application for your bot from https://discord.com/developers/applications
- Click "New Application" in the top right
- Click "Bot" and then "Reset Token"
- Enable "Message Content Intent" under "Privileged Gateway Intents"
2. Put your new Bot Token in the `Config.yml`
3. Set your prefix and bots activity status
4. Install the dependencies and run the bot
```
pip install -r requirements.txt
python Main
```
5. When the bot starts there will be an Invite Link in the console, use it to invite your bot to a server.
6. Head over to the wiki to learn how to use the bot!

By default there are 3 example triggers, you can test the bot works by saying `helper bot test` in a text channel

# Support
If you find any issues with the bot please use the Issues tab.
If you need help using the bot please join my Discord https://discord.gg/2t6N9GwrHy

0 comments on commit 6a7cec9

Please sign in to comment.