-
Notifications
You must be signed in to change notification settings - Fork 2
Settings
All TaskMate settings are configured via Settings → Integrations → TaskMate → Configure → Settings.
| Setting | Default | Range | Description |
|---|---|---|---|
| Points Currency Name | Stars |
— | Display name for the points currency (Stars, Coins, Bucks, Tokens, etc.). Shown on all cards and notifications. |
| Points Currency Icon | mdi:star |
Any MDI icon | Icon shown next to point values throughout the UI. |
| Weekend Points Multiplier | 2.0 |
1.0–5.0 | Multiplier applied to chore points on Saturday and Sunday. Set 1.0 to disable. Formula: weekend_bonus = round(base_points × (multiplier − 1.0)). The bonus is logged as a separate transaction. |
| Streak Reset Mode | reset |
reset / pause
|
What happens when a child misses a day. Reset: streak goes back to 0. Pause: streak freezes and resumes on the next completion. |
| Streak Milestone Bonuses | on |
on / off | Master toggle for streak milestone point bonuses. |
| Streak Milestone Configuration | 3:5, 7:10, 14:20, 30:50, 60:100, 100:200 |
days:points CSV |
Custom milestone thresholds. Each entry awards bonus points when the child's streak reaches that day count. Milestones reset when the streak resets, so they can be re-earned. |
Streak needs all tasks (streak_requires_all_chores) |
off |
on / off | When on, a day only extends the streak once every chore due that day is done. When off (default), completing any one chore keeps the streak alive. |
| Perfect Week Bonus | on |
on / off | Award bonus points when a child completes at least one chore every day Mon–Sun. Checked Monday at midnight. |
| Perfect Week Bonus Points | 50 |
10–500 | Points awarded per perfect week. |
Perfect week needs all tasks (perfect_week_requires_all_chores) |
off |
on / off | When on, a day counts toward a perfect week only when every chore due that day is done. When off (default), one completed chore is enough for the day to count. |
| Notification Service | (empty) | Any notify.* service |
Optional HA notify service for push notifications on pending chore approvals and reward claims. e.g. notify.mobile_app_johns_phone. Leave empty to use persistent notifications only. See Notifications. |
Calendar projection (calendar_projection_days) |
14 |
1–90 | Days ahead each chore publishes to the per-child calendar entities. Higher values give more planning visibility but create more calendar entries. See Calendar. |
| History Days to Keep | 90 |
30–365 | Number of days of completion history to retain. Older records are pruned daily at 00:01. |
Each chore carries a difficulty tier; the points it awards are the base points × the tier's multiplier. medium is the neutral baseline (×1.0) so chores created before this feature keep their exact award value. See Difficulty Tiers. Settings stored under keys difficulty_multiplier_easy / difficulty_multiplier_medium / difficulty_multiplier_hard.
| Setting | Default | Range | Description |
|---|---|---|---|
| Easy multiplier | 0.5 |
0.0–10.0 | Points multiplier applied to easy chores |
| Medium multiplier | 1.0 |
0.0–10.0 | Baseline multiplier for medium chores |
| Hard multiplier | 2.0 |
0.0–10.0 | Points multiplier applied to hard chores |
| Setting | Default | Range | Description |
|---|---|---|---|
XP per Level (level_xp_step) |
100 |
1–100000 | Lifetime points needed to advance one level. level = (total_points_earned // step) + 1. |
A daily (16:00) opt-in roll that may award each child a random bonus, fires the taskmate_surprise_bonus event. See Points Economy.
| Setting | Default | Range | Description |
|---|---|---|---|
Surprise Bonus (surprise_bonus_enabled) |
false (off) |
on / off | Master toggle for the random surprise bonus |
Surprise chance (surprise_bonus_chance) |
15 |
0–100 | Percent chance per child each day |
Surprise min (surprise_bonus_min) |
5 |
0–10000 | Minimum points awarded when it triggers |
Surprise max (surprise_bonus_max) |
20 |
0–10000 | Maximum points awarded when it triggers |
Anti-hoarding: periodically decay each child's spendable points. Logs a transaction; does not touch career score. See Points Economy.
| Setting | Default | Range | Description |
|---|---|---|---|
Points Decay (points_decay_enabled) |
false (off) |
on / off | Master toggle |
Decay period (points_decay_period) |
monthly |
weekly / monthly
|
weekly runs Mondays, monthly runs on the 1st |
Decay percent (points_decay_percent) |
10 |
0–100 | Percent of the balance removed each period |
Rewards saving: periodically credit interest on each child's spendable balance. Fires taskmate_interest_paid. See Points Economy.
| Setting | Default | Range | Description |
|---|---|---|---|
Savings Interest (interest_enabled) |
false (off) |
on / off | Master toggle |
Interest period (interest_period) |
weekly |
weekly / monthly
|
weekly runs Mondays, monthly runs on the 1st |
Interest percent (interest_percent) |
5 |
0–100 | Percent of the balance credited each period |
Limit how many points a child can spend on rewards per period. Enforced at reward approval. See Points Economy.
| Setting | Default | Range | Description |
|---|---|---|---|
Spending Cap (spend_cap_enabled) |
false (off) |
on / off | Master toggle |
Cap period (spend_cap_period) |
weekly |
weekly / monthly
|
weekly resets Mondays, monthly resets on the 1st |
Cap amount (spend_cap_amount) |
0 |
0–1000000 | Max points spendable per period (0 = unlimited) |
Optional celebratory notifications for big moments (level-ups, streak milestones, perfect weeks, quest/challenge completions). The taskmate_celebration event always fires regardless of these settings; these control whether a notification is sent. See Celebrations.
| Setting | Default | Range | Description |
|---|---|---|---|
Celebration notifications (celebration_notify) |
false (off) |
on / off | Send a notification on celebration moments |
Minimum celebration tier (celebration_notify_min_tier) |
2 |
1–3 | Only notify for moments at this tier or higher: 1 = small, 2 = medium, 3 = epic |
These settings control the time windows used for morning, afternoon, evening, and night chores when publishing to HA calendar entities. Configurable via the Admin Panel.
| Setting | Default | Format | Description |
|---|---|---|---|
| Morning Start | 06:00 |
HH:MM |
Start of the morning time window |
| Morning End | 12:00 |
HH:MM |
End of the morning time window |
| Afternoon Start | 12:00 |
HH:MM |
Start of the afternoon time window |
| Afternoon End | 17:00 |
HH:MM |
End of the afternoon time window |
| Evening Start | 17:00 |
HH:MM |
Start of the evening time window |
| Evening End | 21:00 |
HH:MM |
End of the evening time window |
| Night Start | 21:00 |
HH:MM |
Start of the night time window |
| Night End | 23:59 |
HH:MM |
End of the night time window |
Invalid values fall back to the defaults. anytime chores are published as all-day calendar events.
v4.0.0 generalises the four fixed windows above into a fully customisable period list (time_periods). Each period has an id, a label (empty = use the built-in translated name), a start/end in HH:MM, and an icon. The built-in morning / afternoon / evening / night ids ship as the defaults shown above; you can rename them, change their windows, or add up to 24 periods total. The anytime category is implicit (all-day, always available) and never appears in the list. The legacy four *_start/*_end boundary keys are still mirrored on the overview sensor for backward compatibility.
| Setting | Default | Range | Description |
|---|---|---|---|
Default card design (card_design) |
classic |
classic / playroom / console / cleanpro
|
The style new cards use unless overridden per card. A selector offering Classic / Playroom / Console / Clean Pro. Every card left on Use global default follows this value. See Card Design Styles. |
Define named vacation periods (vacation_periods) — each with id, name, start, and end (inclusive ISO dates). While today falls inside a vacation period, streaks are frozen (missed days don't break the streak) and the daily streak check is skipped. The overview sensor exposes vacation_active, vacation_name, vacation_end, and the full vacation_periods list. See Vacation Mode.
- Currency name and icon — shown on all cards, sensors, and notifications
-
Weekend multiplier — applied automatically when
approve_choreruns on a Saturday or Sunday - Streak settings — checked at midnight (00:00:05) daily; milestones checked on each chore approval
- Perfect week — checked Monday at midnight for the previous Mon–Sun period
- Notification service — fires on every pending chore approval and pending reward claim
- Calendar projection — recalculated at midnight and whenever a chore is created or edited
- History pruning — runs daily at 00:01
- Time-of-day boundaries / periods — affect calendar event windows and the time-category each chore falls into
- Difficulty multipliers — applied to base points at chore approval
- Surprise bonus — rolled per child daily at 16:00 when enabled
- Points decay / savings interest — applied on the configured period boundary (Monday for weekly, the 1st for monthly)
- Spending cap — checked when a reward claim is approved
- Celebrations — notifications fire on level-ups, milestones, perfect weeks, and quest/challenge completions
- Vacation mode — checked at midnight during the daily streak check
- Default card design — the style applied to every card left on Use global default
- Bonus Points — detailed explanation of weekend multiplier, streaks, and perfect week
- Difficulty Tiers — difficulty multipliers
- Points Economy — surprise bonus, points decay, savings interest, and the spending cap
- Levels and XP — the XP-per-level setting
- Celebrations — celebration notification tiers
- Vacation Mode — vacation periods and streak freezing
- Card Design Styles — the global Default card design selector and per-card overrides
- Weekly Digest — the Sunday parent summary
- Notifications — notification setup and examples
- Calendar — per-child calendar entities and publishing details
- Getting Started — initial currency setup