himbot/README.md

118 lines
2.1 KiB
Markdown
Raw Normal View History

2023-05-28 20:20:00 -06:00
# HimBot
A discord bot written in Typescript.
## It's dangerous to go alone! Take this!
2023-06-05 23:07:43 -06:00
- Install Nodejs 18 or later [here](https://nodejs.org/en/download) (required)
- The pnpm package manager `npm i -g pnpm` (recommended)
2023-05-28 20:20:00 -06:00
## Structure
Commands and Listeners are all stored in named files within the src/commands and src/listeners directories respectively.
## Running Locally
- Copy .env.example and rename to .env
- Create a Discord Bot with all gateway permissions enabled
- Generate a token for this discord bot and paste it in the .env for DISCORD_TOKEN
2023-07-09 17:39:58 -06:00
- Generate and provide an OpenAPI token and paste it in the .env for OPENAI_API_KEY
2023-05-28 20:20:00 -06:00
- Run `pnpm dev` to run locally
## Adding the bot to a server
Use the following link (replacing DISCORD_CLIENT_ID with your own bot's client ID of course...) to add your bot:
https://discord.com/oauth2/authorize?client_id=DISCORD_CLIENT_ID&scope=bot&permissions=8
2023-07-09 17:39:58 -06:00
## Commands
2023-07-09 17:42:49 -06:00
### **ask**
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
##### Description
2023-07-09 17:39:58 -06:00
2023-11-10 18:58:01 -07:00
A command that returns the answer to your prompt for OpenAI's GPT 4.0 turbo model.
2023-07-09 17:39:58 -06:00
#### Usage
`/ask prompt:prompt_text`
2023-07-09 17:42:49 -06:00
### **borf**
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
#### Description
2023-07-09 17:39:58 -06:00
A command that returns a random picture of a dog.
#### Usage
`/borf`
2023-07-09 17:42:49 -06:00
### **dad**
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
#### Description
2023-07-09 17:39:58 -06:00
A command that returns a random dad joke.
#### Usage
`/dad`
2023-07-09 17:42:49 -06:00
### **fancypic**
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
#### Description
2023-07-09 17:39:58 -06:00
2023-11-10 18:58:01 -07:00
A command that return an image using DALL.E with "hd" quality.
2023-07-09 17:39:58 -06:00
#### Usage
2023-11-10 18:58:01 -07:00
`/fancypic prompt`
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
### **pic**
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
#### Description
2023-07-09 17:39:58 -06:00
2023-11-10 18:58:01 -07:00
A command that return an image using DALL.E with "standard" quality.
2023-07-09 17:39:58 -06:00
#### Usage
2023-11-10 18:58:01 -07:00
`/pic prompt`
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
### **ping**
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
#### Description
2023-07-09 17:39:58 -06:00
A command that returns the latency for the bot, and the latency for the Discord API. Useful for bot debugging.
#### Usage
`/ping`
2023-07-09 17:42:49 -06:00
### **quack**
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
#### Description
2023-07-09 17:39:58 -06:00
A command that returns a random picture of a duck.
#### Usage
`/quack`
2023-07-09 17:42:49 -06:00
### **support**
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
#### Description
2023-07-09 17:39:58 -06:00
A command that returns a Stripe link that can be used to fund credits for the AI commands.
#### Usage
`/support`
2023-07-09 17:42:49 -06:00
### **wryna**
2023-07-09 17:39:58 -06:00
2023-07-09 17:42:49 -06:00
#### Description
2023-07-09 17:39:58 -06:00
A command that returns "my nickname in highschool" response given your prompt
#### Usage
`/wryna nickname:butts`