https://github.com/rictic/hypnos
simple reminder / events bot for discord
https://github.com/rictic/hypnos
Last synced: 11 months ago
JSON representation
simple reminder / events bot for discord
- Host: GitHub
- URL: https://github.com/rictic/hypnos
- Owner: rictic
- Created: 2021-01-19T07:19:47.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-26T23:18:49.000Z (over 2 years ago)
- Last Synced: 2025-01-12T16:07:03.503Z (over 1 year ago)
- Language: Rust
- Size: 97.7 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### How to use:
1. create a discord app: https://discord.com/developers/applications. take note of the client id (aka application id) of the app
2. create a bot for your app. create a `secrets.env` file in this directory with content like:
```bash
export DISCORD_TOKEN=paste bot token here
```
3. invite your bot to a server by going to https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID_HERE&scope=bot%20applications.commands
4. in your terminal do:
```bash
source secrets.env && cargo run
```
### Image generation
To support DALL-E 3 image generation, also add your OpenAI API key to secrets.env. Note, of course, that your bot's users can run up your OpenAI bill!
```bash
export OPENAI_API_KEY=paste API key here
```
### Low traffic channels
If you have channels that are intended to stay quiet, list their IDs in the
`LOW_TRAFFIC_CHANNELS` environment variable, separated by commas.
```bash
export LOW_TRAFFIC_CHANNELS=1234567890123456,9876543210987654
```
### Prod
To run the prod build, run ./run_prod.sh, which will kill any previous prod hypnos processes and start hypnos as a daemon logging to `nohup.out`, then tail that file in your current terminal. Quitting the tail will not stop hypnos.