https://github.com/fspoettel/pomodoro-discord-bot
🍅 A Discord bot for the pomodoro technique
https://github.com/fspoettel/pomodoro-discord-bot
bot discord discord-bot nodejs pomodoro pomodoro-timer
Last synced: 11 months ago
JSON representation
🍅 A Discord bot for the pomodoro technique
- Host: GitHub
- URL: https://github.com/fspoettel/pomodoro-discord-bot
- Owner: fspoettel
- Created: 2020-03-24T11:54:13.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T22:43:31.000Z (over 3 years ago)
- Last Synced: 2025-03-31T23:51:16.670Z (about 1 year ago)
- Topics: bot, discord, discord-bot, nodejs, pomodoro, pomodoro-timer
- Language: JavaScript
- Homepage:
- Size: 399 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
pomodoro-discord-bot
Discord bot that enables you to use and manage [🍅 pomodoro timers](https://en.wikipedia.org/wiki/Pomodoro_Technique) within channels and direct messages. It is written in Node.js and uses MongoDB as database layer. The bot currently runs on [fly.io](https://fly.io/).
## Usage
1. [Invite the bot to your server](https://discordapp.com/oauth2/authorize?client_id=689784623592505372&scope=bot&permissions=51264)
2. Direct message `help` to user `pom#2785` or ping via `@pom help` to see a list of commands and usage instructions
## Available Commands
**Timers**
`start {min}` a 🍅 of a given duration. It is **25** minutes long by default. pom will send you a direct message once it completes.
Shortcuts: `s`, `new`
`break {min}` starts a ☕. It is **5** minutes long by default. pom will send you a message once it completes.
Shortcuts: `b`, `short`, `shortbreak`
`longbreak {min}` starts a long ☕. It is **30** minutes long by default. pom will send you a message once it completes.
Shortcuts: `lb`, `long`
`timeleft` displays the time left on the current 🍅 or ☕.
Shortcuts: `t`, `status`
`complete` a 🍅 or ☕ in progress.
Shortcuts: `c`, `stop`
`restart` a 🍅 or ☕ in progress.
Shortcuts: `r`, `reset`
**Stats**
`stats {today|all}` displays the amount of 🍅 and ☕ you have completed. By default, all stats will be shown.
`clearstats {today|all}` clears your stats. By default all stats will be cleared. This does not affect 🍅 or ☕ that are currently in progress.
**Documentation & Misc.**
`help` displays this help again.
Shortcuts: `h`, `about`
`issue` displays a link to the issue tracker for this bot.
Shortcuts: `bug`
`motivation` will try its best to help with lazy days.