https://github.com/travisk-codes/hotbot

Get notifications when channels become active! See who's talking with a summary of the conversation.
https://github.com/travisk-codes/hotbot

Last synced: 19 days ago
JSON representation

Get notifications when channels become active! See who's talking with a summary of the conversation.

• Host: GitHub
• URL: https://github.com/travisk-codes/hotbot
• Owner: travisk-codes
• Created: 2023-09-17T14:49:00.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-14T14:08:25.000Z (5 months ago)
• Last Synced: 2024-10-14T03:53:46.747Z (about 1 month ago)
• Language: JavaScript
• Size: 127 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# HotBot

## Get notifications when channels become active! See who's talking with a summary of the conversation

### Parameters

- `threshold`: the number of messages per minute to trigger a notification

- `cooldown`: the number of minutes to wait before sending another notification

- `lookback`: the number of previous messages used to calculate messages per minute

- `id?`: the id of the server/channel/user to be notified of

- `users?`: the minimum number of active users required to trigger a notification

- `summary?`: the kind of summary to generate (short|long|bulleted)

### Example

`/notify threshold:1 cooldown:5 lookback:10 id:[channel_id] users:3`

### Codeflow

1. User runs the `/notify` command, `execute` runs in `commands/util/notify.js`, settings are saved in the databse

2. A `Events.MessageCreate` handler in `index.js` runs on each new message, checks the database to see if any relevant settings have been set, and sends that user a direct message notifying them if their setting's criteria have been met