alfreda/README.md

23 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2024-07-16 17:28:31 +10:00
### Alfreda
2024-06-10 21:12:52 +10:00
2024-06-10 21:38:06 +10:00
Alfreda is the most cursed discord bot ever.
Read more at https://maxwellj.xyz/alfreda
Issues and more are avaliable in this repo, and feel free to clone and experiment!
2024-06-11 19:08:10 +10:00
*gpl my beloved*
2024-07-16 17:28:31 +10:00
Found issues? Want to test the bot out for yourself? Join the Testing Discord server! https://discord.gg/eDfb5GFRqt
2024-06-11 19:08:10 +10:00
2024-07-16 17:28:31 +10:00
### Quick Setup (for self hosting)
2024-06-11 19:08:10 +10:00
2024-07-16 17:28:31 +10:00
1. If you're using Linux, or another platform that doesn't allow packages install through Pip, make a virtual environment. `python -m venv path/to/venv` and activate it with `source path/to/venv/bin/activate.fish` (if using fish, use activate while using bash or sh). If you're using Windows, install Python. If you're using macOS, check that you have Python 3 installed. If not, install it.
2024-06-11 19:08:10 +10:00
2024-07-16 17:28:31 +10:00
2. Run `pip install anthropic discord python-dotenv` to install the Anthropic API, Discord API and .env file interpreter.
2024-06-11 19:08:10 +10:00
2024-07-16 17:28:31 +10:00
3. Rename .envexample to .env and edit it with your Anthropic and Discord API keys. Get them at https://console.anthropic.com and https://discord.dev (make sure to enable privelaged intents for messages) **Be sure to not share these with anyone, as you might allow someone to use your Anthropic credits or send messages through your Discord bot!**
2024-06-11 19:08:10 +10:00
2024-07-16 17:28:31 +10:00
4. Add your personalities to the .env file
5. Run 'python3 main.py' to start the bot! If all goes well your bot should come online!