garfbot/README.md
2024-10-25 11:13:34 -05:00

81 lines
2.0 KiB
Markdown

Who is GarfBot?
======
![garfield](https://www.crate.zip/garfield.png)
GarfBot is a discord bot that uses OpenAI's generative pre-trained models to produce text and images for your personal entertainment and companionship. There are a few ways you can interact with him on discord, either in a public server or by direct message:
`hey garfield {prompt}`
Responds with text.
`garfpic {prompt}`
Responds with an image.
`garfping {target}`
Responds with iputils-ping result from target.
`garfpic {target}`
Responds with dns lookup result from target.
`garfpic {target}`
Responds with nmap scan result from target.
`garfshop {item} {zip}`
Responds with 10 grocery {item}s from the nearest Kroger location, listed from least to most expensive.
Installation
======
To get started, clone this repo and create a config file.
```console
$ git clone https://git.crate.zip/crate/garfbot.git && cd garfbot/ && nano config.py
```
Add your various API tokens:
```python
GARFBOT_TOKEN = "Discord API token"
OPENAI_TOKEN = "OpenAI API token"
GIF_TOKEN = "tenor.com API token"
```
I recommend building a docker image using the included DockerFile as a template. Run the container binding /usr/src/app to GarfBot's CWD:
```console
$ docker build -t garfbot .
$ docker run -d --restart always -v $PWD:/usr/src/app --name garfbot garfbot
```
In case you'd rather not do it manually, a `garfbot.tf` file has been included to launch GarfBot and his friends' containers.
If you prefer to install dependencies on you own host and run as a systemd service:
```console
$ sudo nano /etc/systemd/system/garfbot.service
```
Replace {user} with your username:
```console
[Unit]
Description=garfbot
After=multi-user.target
[Service]
Type=simple
Restart=always
User={user}
WorkingDirectory=/home/{user}/garfbot
ExecStart=/usr/bin/python garfbot.py
[Install]
WantedBy=multi-user.target
```
And finally:
```console
$ sudo systemctl daemon-reload
$ sudo systemctl enable garfbot
$ sudo systemctl start garfbot
```