-
Notifications
You must be signed in to change notification settings - Fork 2
Home
Welcome to the TaskMate documentation. TaskMate is a Home Assistant integration that turns household chores into a gamified reward system for children.
| Topic | Description |
|---|---|
| Installation | How to install via HACS or manually |
| Getting Started | First-time setup walkthrough |
| Admin Panel | Web-based management dashboard in the HA sidebar |
| Children | Managing children, levels, and avatars |
| Settings | All configurable settings in one place |
| Topic | Description |
|---|---|
| Chores | Creating and configuring chores |
| Chore Scheduling | Specific days, recurring, one-shot, rotation, and first-come modes |
| Mandatory Chores | Must-do chores with parent-reviewed late penalties |
| Difficulty Tiers | Easy / medium / hard tiers with a points multiplier |
| Timed Tasks | Duration-based chores with start/pause/stop timers |
| Task Groups | Coordinate rotation chores with sticky or spread policies |
| Bonus Subtasks | Optional extra-credit tasks within a chore |
| Photo Proof | Require a photo as evidence before approval |
| Chore Swaps | Siblings swap a chore with parent approval |
| Vacation Mode | Pause chores and freeze streaks during time off |
| Calendar | Per-child HA calendar entities for chores and away days |
| Dynamic Chore Visibility | Show/hide chores based on HA entity state |
| Topic | Description |
|---|---|
| Rewards | Fixed costs, jackpots, spending caps, auto-restock, and claim flow |
| Managing Rewards | Parent/admin reward workflow |
| Pool Mode (Savings Jars) | Dedicated savings pools for long-term reward goals |
| Bonus Points | Weekend multiplier, streaks, perfect week |
| Bonuses | Reusable point awards for positive behaviour |
| Penalties | Named point deductions for unwanted behaviour |
| Points Economy | Savings interest, points decay, surprise bonus, and undo |
| Gifting Points | Parent-controlled child-to-child point transfers |
| Topic | Description |
|---|---|
| Levels & XP | Lifetime-earned-points progression and level-ups |
| Achievement Badges | Milestone badges with tiers, AND/OR criteria, and point bonuses |
| Quests | Multi-step chore chains with a completion bonus |
| Challenges | Daily and weekly targets that reset automatically |
| Avatars | Unlockable avatars gated by level, points, or streak |
| Celebrations | Tiered celebration moments for big achievements |
| Topic | Description |
|---|---|
| Notifications | Built-in alerts, scheduled notifications, actionable callbacks, and bus events |
| Weekly Digest | A weekly summary sent to parents |
| Admin Audit Log | Who changed what, and when |
| Backup & Restore | Export and import your TaskMate configuration |
| Topic | Description |
|---|---|
| Dashboard Cards | All 18 Lovelace cards |
| Card Design Styles | Per-card visual themes: Classic, Playroom, Console, Clean Pro |
| Services | All callable services with examples |
| Sensor Reference | All entities and their attributes |
| Automations | Bus events, internal tasks, and example automations |
| Localization | Supported languages and translation |
| Troubleshooting | Common issues and fixes |
| FAQ | Frequently asked questions |
Child completes chore → Parent approves (optional) → Points awarded
↓
Child claims reward
↓
Parent approves claim
↓
Reward granted
All data is stored locally in Home Assistant. Nothing is sent to external services.
Points — The currency children earn by completing chores. You choose the name (Stars, Coins, Bucks) and icon during setup.
Chores — Tasks assigned to one or more children. Can require parent approval before points are awarded, and can carry a difficulty tier that multiplies their value.
Rewards — Goals children save up for. You set a fixed point cost — children work toward it at their own pace.
Streaks — How many consecutive days a child has completed at least one chore. Bonus points are awarded at configurable milestones.
Jackpot Rewards — Special rewards where all assigned children's points pool together toward a shared goal.
Timed Tasks — Chores where points are earned based on duration. Children start, pause, and stop a timer; points are calculated from elapsed time.
Task Groups — Coordinate related rotation-mode chores so they're assigned to the same child (sticky) or spread across different children (spread).
Levels & XP — Every point a child has ever earned counts as XP; XP turns into levels automatically, so progress only ever goes up. See Levels & XP.
Achievement Badges — Milestone-based recognition with four tiers (Bronze, Silver, Gold, Platinum). Built-in badges plus custom badges with multi-criterion AND/OR rules.
Quests & Challenges — Quests chain several chores into a single goal with a bonus; Challenges set recurring daily/weekly targets that reset each period.
Bonus Subtasks — Optional extra-credit tasks within a chore that unlock after the parent chore is completed.
Current: 4.3.0
Requires: Home Assistant 2024.1+
License: MIT