From 7cb1fb78d0d4e49a2c50eea6d19b194404f204c9 Mon Sep 17 00:00:00 2001 From: Maxwell Date: Tue, 16 Jul 2024 17:28:31 +1000 Subject: [PATCH] redo --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5529b10..a392e6e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## Alfreda +### Alfreda Alfreda is the most cursed discord bot ever. @@ -8,14 +8,16 @@ Issues and more are avaliable in this repo, and feel free to clone and experimen *gpl my beloved* -### Setup (for self hosting) +Found issues? Want to test the bot out for yourself? Join the Testing Discord server! https://discord.gg/eDfb5GFRqt -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) +### Quick Setup (for self hosting) -2. Run `pip install anthropic discord` to install the Anthropic and Discord API wrappers. (duh) +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. -3. Clone the repo `git clone https://git.maxwellj.xyz/max/alfreda.git` and `cd alfreda` +2. Run `pip install anthropic discord python-dotenv` to install the Anthropic API, Discord API and .env file interpreter. -3. Edit the main.py file with your Anthropic and Discord API keys. Get them at https://console.anthropic.com and https://discord.dev **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!** +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!** -4. `python3 main.py` \ No newline at end of file +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! \ No newline at end of file