potomark-bot-rb/README.md

23 lines
849 B
Markdown
Raw Permalink Normal View History

2022-09-18 00:01:06 +00:00
# potomark is a simple bookmarking discord bot.
there's no configuration besides a `.env` file that stores the bot's token.
## why?
because we needed a tiny, self hostable bot to remember things of importance for our equally tiny discord server.
## what it do?
DMs a user a link to any message they reacte with 🔖 to (tip: you can change the `EMOJI` constant in `bot.rb` to any built-in emoji). also sends part of the message for quick access. that's it.
## how?
requires [ruby](https://www.ruby-lang.org/) >= 3.0 and [bundler](https://bundler.io) >= 2.3.19. the only two dependencies are `dotenv` and `discordrb`, as specified in the `Gemfile`.
```bash
$ echo 'DISCORD_TOKEN=YOUR.DISCORD.TOKEN.HERE' > .env
$ bundle install
$ ruby bot.rb
```
## license?
the full license text is as follows:
```
you may not use this code for any purpose.
```