diff --git a/README.md b/README.md index 506ac0f..d486561 100644 --- a/README.md +++ b/README.md @@ -63,11 +63,12 @@ You also need to add a DEBUG_GUILD id and a DEBUG_CHANNEL id, the debug guild id ``` OPENAI_TOKEN="" + DISCORD_TOKEN="" + DEBUG_GUILD="974519864045756446" #discord_server_id + DEBUG_CHANNEL="977697652147892304" #discord_chanel_id -ALLOWED_GUILDS="971268468148166697,971268468148166697" -ALLOWED_ROLES="Admin,gpt" ``` Optionally, you can include your own conversation starter text for the bot that's used with `!g converse`, with `CONVERSATION_STARTER_TEXT` @@ -89,45 +90,27 @@ It will then prompt you for your password, which you should enter, and then you After login, we need to install the various dependencies that the bot needs. To do this, we will run the following commands: -*Download the source code.* +Download the source code. ```bash git clone https://github.com/Kav-K/GPT3Discord.git cd GPT3Discord/ -``` - -*Install system packages (python)* -```bash +# Install system packages (python) sudo apt-get update sudo apt install software-properties-common sudo add-apt-repository ppa:deadsnakes/ppa sudo apt install python3.9 python3.9-pip -``` - -*Install project dependencies* -```bash +# Install project dependencies python3.9 -m pip install -r requirements.txt python3.9 -m pip install . -``` - -Copy the sample.env file into a regular .env file. `DEBUG_GUILD` and the ID for `ALLOWED_GUILDS` can be found by right-clicking your server and choosing "Copy ID". Similarly, `DEBUG_CHANNEL` can be found by right-clicking your debug channel. -```bash +# Copy the sample.env file into a regular .env file. `DEBUG_GUILD` and the ID for `ALLOWED_GUILDS` can be found by right-clicking your server and choosing "Copy ID". Similarly, `DEBUG_CHANNEL` can be found by right-clicking your debug channel. cp sample.env .env -``` - -The command below is used to edit the .env file and to put in your API keys. You can right click within the editor after running this command to paste. When you are done editing, press CTRL + X, and then type Y, to save. -```bash +# The command below is used to edit the .env file and to put in your API keys. You can right click within the +# editor after running this command to paste. When you are done editing, press CTRL + X, and then type Y, to save. nano .env -``` - -Run the bot using [screen](https://www.gnu.org/software/screen/manual/screen.html) to keep it running after you disconnect from your SSH session: -```bash +# Run the bot using [screen](https://www.gnu.org/software/screen/manual/screen.html) to keep it running after you disconnect from your SSH session: screen gpt3discord -``` - -Hit `Ctrl+a` then `d` to detach from the running bot. - -The bot's screen session can be reattached: -```bash +# Hit `Ctrl+a` then `d` to detach from the running bot. +# The bot's screen session can be reattached: screen -r ```