crate/garfbot
0
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
abcrate 2023-11-19 20:53:41 -06:00 committed by GitHub
parent 4eeeb0886a
commit 515bdaf2ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
readme.md → README.md
View File

@ -1,4 +1,5 @@
GarfBot is a discord bot that uses openai generative pre-trained AI models to produce text and images for your personal entertainment and companionship. GarfBot is a discord bot that uses openai generative pre-trained AI models to produce text and images for your personal entertainment and companionship.
JonBot is his owner and MoneyBot is his eccentric friend who plays the classic F2P video game Planetside 2. JonBot is his owner and MoneyBot is his eccentric friend who plays the classic F2P video game Planetside 2.
To interact: (not case-sensitive) To interact: (not case-sensitive)
@ -9,6 +10,12 @@ To interact: (not case-sensitive)
`"garfpic"` `"garfpic"`
responds with image. responds with image.
`"hey jon"`
responds with text.
`"hey money"`
responds with text.
To get started, clone this repo and create a `config.py` file in GarfBot's root directory. Open your favorite text editor or IDE and add your various API tokens as such: To get started, clone this repo and create a `config.py` file in GarfBot's root directory. Open your favorite text editor or IDE and add your various API tokens as such:
```python ```python
@ -21,6 +28,7 @@ GIF_TOKEN = "token"
If you want to configure a more secure setup, go ahead. If you want to configure a more secure setup, go ahead.
Next, I recommend building a docker image for each bot using the included DockerFile as a template. Run each container binding /usr/src/app to GarfBot's CWD. Next, I recommend building a docker image for each bot using the included DockerFile as a template. Run each container binding /usr/src/app to GarfBot's CWD.
A terraform file has been included to launch all three containers, or you can do it manually. A terraform file has been included to launch all three containers, or you can do it manually.
Example: Example:
@ -29,7 +37,7 @@ crate@raspberrypi:~/garfbot $ docker build -t garfbot .
crate@raspberrypi:~/garfbot $ docker run -d --restart always -v $PWD:/usr/src/app --name garfbot garfbot crate@raspberrypi:~/garfbot $ docker run -d --restart always -v $PWD:/usr/src/app --name garfbot garfbot
``` ```
Or if you prefer to install dependencies (from requirements.txt) on a host and run as a systemd service: Or if you prefer to install dependencies (from requirements.txt) on you own host and run as a systemd service:
```console ```console
[Unit] [Unit]
Description=garfbot Description=garfbot