Introduction
Welcome to the Pomofy documentation. Pomofy is a powerful Discord bot designed to gamify productivity through focus timers, task management, and RPG-like progression.
Quick Start
Get up and running in less than a minute.
/timer start in a text channel.Focus Timer
The timer is the heart of Pomofy. It tracks your sessions and calculates rewards based on duration.
Commands
| Command | Description |
|---|---|
| /timer start [time] | Start a session. Default 25m. |
| /timer stop | End session and save stats. |
| /timer pause | Pause current timer. |
| /stats | View your personal stats. |
Task Management
Link specific tasks to your focus sessions for better tracking and XP bonuses.
| Command | Description |
|---|---|
| /task add [text] | Create a new todo item. |
| /task list | View pending tasks. |
| /task complete [id] | Finish a task (XP Bonus). |
Economy
PomoCoins are the currency of Pomofy. You earn 10 PC per minute of focus.
- Shop: Buy roles and profile upgrades.
- Trading: Trade rare items with other users.
- Leaderboard: Ranked by Total Focus Time & Wealth.
| Command | Description |
|---|---|
| /shop | Open global item shop. |
| /inventory | View your items. |
| /daily | Claim daily reward. |
Twitch Integration
Connect Pomofy to your Twitch channel to display live timers, tasks, and engage with your chat using interactive commands.
Setup Checklist
- Log in to the Dashboard.
- Navigate to the Twitch tab.
- Enter your Channel Name (e.g., heading_north).
- Click Join Channel to summon the bot.
Overlays & Themes
Customize the look of your stream with browser source overlays. All overlays support real-time updates and multiple themes.
Available Overlays
- Timer OverlayDisplays current timer countdown, focus state, and session progress (Pomo count).
- Task List OverlayShows your active todo list. Tasks added via chat or dashboard appear here instantly.
How to Add to OBS
1. In the Dashboard > Twitch tab, find the Broadcast Overlays section.
2. Click Copy URL for the desired overlay.
3. In OBS, add a Browser Source.
4. Paste the URL. Recommended Size: 500x300 (Timer), 400x600 (Tasks).
Dashboard Controls
The new Controls tab in the dashboard provides a central command center for your stream workflow.
Live Timer Control
Start, Stop, or manually set a custom duration for your timer without using chat commands.
Session Manager
Manually adjust your Pomo Session counts (e.g., set to 3/4) to fix sync issues or skip ahead.
Task Moderation
View all pending tasks in real-time. Delete individual tasks (moderation) or Wipe All to clear the queue.
Chat Commands (Twitch)
Viewers and Mods can interact with the bot directly from Twitch Chat.
Everyone Public Commands
| Command | Description |
|---|---|
| !task add <text> | Add a task to the queue. |
| !task list | View your current tasks. |
| !task edit <#> <text> | Edit one of your tasks. |
| !task finish <#> | Mark a task as done. |
| !pomo | Check current timer status & session count. |
Mods Only Mod Commands
| Command | Description |
|---|---|
| !timer start [min] | Start the focus timer (Default: 25m). |
| !timer break [min] | Start a break timer (Default: 5m). |
| !timer stop | Stop the timer. |
| !timer cycle <count> | Reset session and start a new cycle (e.g. !timer cycle 4). |
| !timer add <min> | Add or remove time (e.g. !timer add 5m or !timer add -2m). |
| !pomo set <num> | Manually set current session count. |
| !task wipe | Clear ALL tasks from the list. |