Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,15 @@ For manual installation and the first-run walkthrough, see [Installation](https:

## What you get

**Chores** — flexible [scheduling](https://github.com/tempus2016/taskmate/wiki/Chore-Scheduling) (specific days, recurring down to every N days, rotation, first-come), [difficulty tiers](https://github.com/tempus2016/taskmate/wiki/Difficulty-Tiers), [dependencies](https://github.com/tempus2016/taskmate/wiki/Chore-Dependencies), [timed tasks](https://github.com/tempus2016/taskmate/wiki/Timed-Tasks), [weekly targets](https://github.com/tempus2016/taskmate/wiki/Weekly-Targets) for "three times this week, any day" with an optional bonus for hitting them, [photo proof](https://github.com/tempus2016/taskmate/wiki/Photo-Proof), [open-ended chores](https://github.com/tempus2016/taskmate/wiki/Open-Ended-Chores) the child describes and you price at approval, [teamwork chores](https://github.com/tempus2016/taskmate/wiki/Teamwork-Chores) that need two or more children, [chore auctions](https://github.com/tempus2016/taskmate/wiki/Chore-Auctions) where the lowest bid wins an unpopular job, a [bounty board](https://github.com/tempus2016/taskmate/wiki/Bounty-Board) of one-off jobs any child can claim, [swaps](https://github.com/tempus2016/taskmate/wiki/Chore-Swaps), [vacation mode](https://github.com/tempus2016/taskmate/wiki/Vacation-Mode), and chores that appear or hide based on [HA entity state](https://github.com/tempus2016/taskmate/wiki/Dynamic-Chore-Visibility) or [the weather](https://github.com/tempus2016/taskmate/wiki/Weather-Aware-Chores). Children can [tap an NFC tag](https://github.com/tempus2016/taskmate/wiki/NFC-Tag-Completion) to tick a chore off, and you can add, move and skip chores straight from [Home Assistant's calendar](https://github.com/tempus2016/taskmate/wiki/Two-Way-Calendar). Missed ticking one? [Log a past job](https://github.com/tempus2016/taskmate/wiki/Logging-Past-Jobs) on the day it was really done, up to a week back.
**Chores** — flexible [scheduling](https://github.com/tempus2016/taskmate/wiki/Chore-Scheduling) (specific days, recurring down to every N days, rotation, first-come), [difficulty tiers](https://github.com/tempus2016/taskmate/wiki/Difficulty-Tiers), [dependencies](https://github.com/tempus2016/taskmate/wiki/Chore-Dependencies), [timed tasks](https://github.com/tempus2016/taskmate/wiki/Timed-Tasks), [weekly targets](https://github.com/tempus2016/taskmate/wiki/Weekly-Targets) for "three times this week, any day" with an optional bonus for hitting them, [photo proof](https://github.com/tempus2016/taskmate/wiki/Photo-Proof), [open-ended chores](https://github.com/tempus2016/taskmate/wiki/Open-Ended-Chores) the child describes and you price at approval, [teamwork chores](https://github.com/tempus2016/taskmate/wiki/Teamwork-Chores) that need two or more children, [chore auctions](https://github.com/tempus2016/taskmate/wiki/Chore-Auctions) where the lowest bid wins an unpopular job, a [bounty board](https://github.com/tempus2016/taskmate/wiki/Bounty-Board) of one-off jobs any child can claim, [swaps](https://github.com/tempus2016/taskmate/wiki/Chore-Swaps), [vacation mode](https://github.com/tempus2016/taskmate/wiki/Vacation-Mode), and chores that appear or hide based on [HA entity state](https://github.com/tempus2016/taskmate/wiki/Dynamic-Chore-Visibility) or [the weather](https://github.com/tempus2016/taskmate/wiki/Weather-Aware-Chores). Children can [tap an NFC tag](https://github.com/tempus2016/taskmate/wiki/NFC-Tag-Completion) to tick a chore off, and you can add, move and skip chores straight from [Home Assistant's calendar](https://github.com/tempus2016/taskmate/wiki/Two-Way-Calendar). Missed ticking one? [Log a past job](https://github.com/tempus2016/taskmate/wiki/Logging-Past-Jobs) on the day it was really done, up to a week back. Chores can carry an [estimated time](https://github.com/tempus2016/taskmate/wiki/Estimated-Minutes) so children see how long is left, a [reference photo](https://github.com/tempus2016/taskmate/wiki/Reference-Photos) of the job done well, or a [quantity](https://github.com/tempus2016/taskmate/wiki/Quantity-Chores) that pays per item, and pending chores can [approve themselves](https://github.com/tempus2016/taskmate/wiki/Auto-Approve) after a set number of hours.

**Points & rewards** — [fixed-cost rewards](https://github.com/tempus2016/taskmate/wiki/Rewards) with a parent approval flow, [savings jars](https://github.com/tempus2016/taskmate/wiki/Pool-Mode-\(Savings-Jars\)), a [wishlist](https://github.com/tempus2016/taskmate/wiki/Wishlist) children save towards and family can pledge to, [bonuses](https://github.com/tempus2016/taskmate/wiki/Bonuses) and [penalties](https://github.com/tempus2016/taskmate/wiki/Penalties), [weekend multipliers and streak milestones](https://github.com/tempus2016/taskmate/wiki/Bonus-Points), [1–3 star quality ratings](https://github.com/tempus2016/taskmate/wiki/Quality-Ratings) that scale the points, [real-money allowance](https://github.com/tempus2016/taskmate/wiki/Allowance), [shared family goals](https://github.com/tempus2016/taskmate/wiki/Family-Goals), [timed device unlocks](https://github.com/tempus2016/taskmate/wiki/Timed-Unlock-Rewards), and [time-locked rewards](https://github.com/tempus2016/taskmate/wiki/Time-Locked-Rewards) that are only claimable on chosen days or between set hours.
**Points & rewards** — [fixed-cost rewards](https://github.com/tempus2016/taskmate/wiki/Rewards) with a parent approval flow, [savings jars](https://github.com/tempus2016/taskmate/wiki/Pool-Mode-\(Savings-Jars\)), a [wishlist](https://github.com/tempus2016/taskmate/wiki/Wishlist) children save towards and family can pledge to, [bonuses](https://github.com/tempus2016/taskmate/wiki/Bonuses) and [penalties](https://github.com/tempus2016/taskmate/wiki/Penalties), [weekend multipliers and streak milestones](https://github.com/tempus2016/taskmate/wiki/Bonus-Points), [1–3 star quality ratings](https://github.com/tempus2016/taskmate/wiki/Quality-Ratings) that scale the points, [real-money allowance](https://github.com/tempus2016/taskmate/wiki/Allowance), [shared family goals](https://github.com/tempus2016/taskmate/wiki/Family-Goals), [timed device unlocks](https://github.com/tempus2016/taskmate/wiki/Timed-Unlock-Rewards), and [time-locked rewards](https://github.com/tempus2016/taskmate/wiki/Time-Locked-Rewards) that are only claimable on chosen days or between set hours. Children can buy tickets for a [raffle](https://github.com/tempus2016/taskmate/wiki/Raffles) with their points, and a [make-it-right penalty](https://github.com/tempus2016/taskmate/wiki/Make-It-Right-Penalties) can be earned back by doing a chore.

**Gamification** — [levels & XP](https://github.com/tempus2016/taskmate/wiki/Levels-and-XP), [achievement badges](https://github.com/tempus2016/taskmate/wiki/Achievement-Badges), [quests](https://github.com/tempus2016/taskmate/wiki/Quests), [challenges](https://github.com/tempus2016/taskmate/wiki/Challenges), [unlockable avatars](https://github.com/tempus2016/taskmate/wiki/Avatars), [celebrations](https://github.com/tempus2016/taskmate/wiki/Celebrations), [leaderboard seasons](https://github.com/tempus2016/taskmate/wiki/Leaderboard-Seasons), [streak freezes](https://github.com/tempus2016/taskmate/wiki/Streak-Freezes) that protect a streak through a missed day, [birthday mode](https://github.com/tempus2016/taskmate/wiki/Birthday-Mode), [surprise inspections](https://github.com/tempus2016/taskmate/wiki/Surprise-Inspections) with a bonus, and "Wrapped"-style [recaps](https://github.com/tempus2016/taskmate/wiki/Recaps) on a schedule you choose.
**Gamification** — a [virtual pet](https://github.com/tempus2016/taskmate/wiki/Virtual-Pets) that hatches and grows as chores get done, [personal weekly goals](https://github.com/tempus2016/taskmate/wiki/Weekly-Goals) with a bonus, [levels & XP](https://github.com/tempus2016/taskmate/wiki/Levels-and-XP), [achievement badges](https://github.com/tempus2016/taskmate/wiki/Achievement-Badges), [quests](https://github.com/tempus2016/taskmate/wiki/Quests), [challenges](https://github.com/tempus2016/taskmate/wiki/Challenges), [unlockable avatars](https://github.com/tempus2016/taskmate/wiki/Avatars), [celebrations](https://github.com/tempus2016/taskmate/wiki/Celebrations), [leaderboard seasons](https://github.com/tempus2016/taskmate/wiki/Leaderboard-Seasons), [streak freezes](https://github.com/tempus2016/taskmate/wiki/Streak-Freezes) that protect a streak through a missed day, [birthday mode](https://github.com/tempus2016/taskmate/wiki/Birthday-Mode), [surprise inspections](https://github.com/tempus2016/taskmate/wiki/Surprise-Inspections) with a bonus, and "Wrapped"-style [recaps](https://github.com/tempus2016/taskmate/wiki/Recaps) on a schedule you choose.

**Parent tooling** — an [admin panel](https://github.com/tempus2016/taskmate/wiki/Admin-Panel) with a Today home page and a [setup wizard](https://github.com/tempus2016/taskmate/wiki/Setup-Wizard) that suggests chores by age, [ready-made dashboards](https://github.com/tempus2016/taskmate/wiki/Ready-Made-Dashboards) for the kids, the parents and a wall tablet, [notifications](https://github.com/tempus2016/taskmate/wiki/Notifications) in your Home Assistant language, with [quiet hours](https://github.com/tempus2016/taskmate/wiki/Quiet-Hours), [reminder escalation](https://github.com/tempus2016/taskmate/wiki/Reminder-Escalation) and [presence-aware reminders](https://github.com/tempus2016/taskmate/wiki/Presence-Aware-Reminders) that wait until a child is home, [reject reasons](https://github.com/tempus2016/taskmate/wiki/Reject-Reasons) the child can see, [multi-parent approval routing](https://github.com/tempus2016/taskmate/wiki/Multi-Parent-Approval-Routing), a [weekly digest](https://github.com/tempus2016/taskmate/wiki/Weekly-Digest), [insight reports](https://github.com/tempus2016/taskmate/wiki/Insights) on fairness and friction, an [audit log](https://github.com/tempus2016/taskmate/wiki/Admin-Audit-Log), [adult profiles](https://github.com/tempus2016/taskmate/wiki/Adult-Profiles) so parents can track their own chores without approving each other's, and [backup & restore](https://github.com/tempus2016/taskmate/wiki/Backup-and-Restore).
**Parent tooling** — an [admin panel](https://github.com/tempus2016/taskmate/wiki/Admin-Panel) with a Today home page and a [setup wizard](https://github.com/tempus2016/taskmate/wiki/Setup-Wizard) that suggests chores by age, [ready-made dashboards](https://github.com/tempus2016/taskmate/wiki/Ready-Made-Dashboards) for the kids, the parents and a wall tablet, [notifications](https://github.com/tempus2016/taskmate/wiki/Notifications) in your Home Assistant language, with [quiet hours](https://github.com/tempus2016/taskmate/wiki/Quiet-Hours), [reminder escalation](https://github.com/tempus2016/taskmate/wiki/Reminder-Escalation) and [presence-aware reminders](https://github.com/tempus2016/taskmate/wiki/Presence-Aware-Reminders) that wait until a child is home, [reject reasons](https://github.com/tempus2016/taskmate/wiki/Reject-Reasons) the child can see, [multi-parent approval routing](https://github.com/tempus2016/taskmate/wiki/Multi-Parent-Approval-Routing), a [weekly digest](https://github.com/tempus2016/taskmate/wiki/Weekly-Digest), [insight reports](https://github.com/tempus2016/taskmate/wiki/Insights) on fairness and friction, an [audit log](https://github.com/tempus2016/taskmate/wiki/Admin-Audit-Log), [sick days](https://github.com/tempus2016/taskmate/wiki/Sick-Days) that pause chores and protect streaks, [event entities](https://github.com/tempus2016/taskmate/wiki/Event-Entities) for building automations in the UI editor, [Repairs issues and a diagnostics download](https://github.com/tempus2016/taskmate/wiki/Repairs-and-Diagnostics), [adult profiles](https://github.com/tempus2016/taskmate/wiki/Adult-Profiles) so parents can track their own chores without approving each other's, and [backup & restore](https://github.com/tempus2016/taskmate/wiki/Backup-and-Restore).

**Made for kids** — a [sticker chart](https://github.com/tempus2016/taskmate/wiki/Sticker-Chart-Card) where today's jobs are stickers to tap and stars fill up towards a reward, [Routine Mode](https://github.com/tempus2016/taskmate/wiki/Routine-Mode) for guided morning and bedtime flows, [Pre-Reader Mode](https://github.com/tempus2016/taskmate/wiki/Pre-Reader-Mode) for children who can't read yet, [Kiosk Mode](https://github.com/tempus2016/taskmate/wiki/Kiosk-Mode) for a shared wall tablet (where they can claim bounties too), a [child undo window](https://github.com/tempus2016/taskmate/wiki/Child-Undo-Window) so they can take back a mistaken tap, [watch complications](https://github.com/tempus2016/taskmate/wiki/Watch-Complications) for Apple Watch and Wear OS, [Read Aloud](https://github.com/tempus2016/taskmate/wiki/Read-Aloud) to a media player, a [printable fridge chart](https://github.com/tempus2016/taskmate/wiki/Printable-Weekly-Chart), each child's [photo](https://github.com/tempus2016/taskmate/wiki/Children#child-photos) on the cards from their Home Assistant person, [custom completion sounds](https://github.com/tempus2016/taskmate/wiki/Completion-Sounds) you can upload and pick per chore, and six [card design styles](https://github.com/tempus2016/taskmate/wiki/Card-Design-Styles) including a high-contrast accessible theme and a clean corporate one. Cards and the panel are translated into 10 languages and support [right-to-left layouts](https://github.com/tempus2016/taskmate/wiki/Localization).
**Made for kids** — a [sticker chart](https://github.com/tempus2016/taskmate/wiki/Sticker-Chart-Card) where today's jobs are stickers to tap and stars fill up towards a reward, [Routine Mode](https://github.com/tempus2016/taskmate/wiki/Routine-Mode) for guided morning and bedtime flows, [Pre-Reader Mode](https://github.com/tempus2016/taskmate/wiki/Pre-Reader-Mode) for children who can't read yet, [Kiosk Mode](https://github.com/tempus2016/taskmate/wiki/Kiosk-Mode) for a shared wall tablet (where they can claim bounties too, hide what's already done, and show the family's day or a photo slideshow while idle), a [child undo window](https://github.com/tempus2016/taskmate/wiki/Child-Undo-Window) so they can take back a mistaken tap, an ["I'm stuck" button](https://github.com/tempus2016/taskmate/wiki/Help-Requests) that asks a parent for help, an end-of-day [mood check-in](https://github.com/tempus2016/taskmate/wiki/Mood-Check-In), [watch complications](https://github.com/tempus2016/taskmate/wiki/Watch-Complications) for Apple Watch and Wear OS, [Read Aloud](https://github.com/tempus2016/taskmate/wiki/Read-Aloud) to a media player, a [printable fridge chart](https://github.com/tempus2016/taskmate/wiki/Printable-Weekly-Chart), each child's [photo](https://github.com/tempus2016/taskmate/wiki/Children#child-photos) on the cards from their Home Assistant person, [custom completion sounds](https://github.com/tempus2016/taskmate/wiki/Completion-Sounds) you can upload and pick per chore, and six [card design styles](https://github.com/tempus2016/taskmate/wiki/Card-Design-Styles) including a high-contrast accessible theme and a clean corporate one. Cards and the panel are translated into 10 languages and support [right-to-left layouts](https://github.com/tempus2016/taskmate/wiki/Localization).

---

Expand All @@ -89,7 +89,7 @@ Lovelace resources register automatically on startup. Edit your dashboard → **

| For kids | For parents |
|----------|-------------|
| Child · Sticker Chart · Rewards · Reward Progress · Points Display · Routine · Kiosk · Streak · Badges · Bounty Board · Wishlist · Recap · Chore Auction | Approvals · Parent Dashboard · Overview · Chore Board · Activity · Points · Reorder · Penalties · Bonuses · Weekly · Graph · Leaderboard · Calendar · Family Goal · Photo Gallery |
| Child · Sticker Chart · Pet · Raffle · Rewards · Reward Progress · Points Display · Routine · Kiosk · Streak · Badges · Bounty Board · Wishlist · Recap · Chore Auction | Approvals · Parent Dashboard · Overview · Chore Board · Activity · Points · Reorder · Penalties · Bonuses · Weekly · Graph · Leaderboard · Calendar · Family Goal · Photo Gallery |

Every card takes a `header_color` and a `card_design` option. See [Dashboard Cards](https://github.com/tempus2016/taskmate/wiki/Dashboard-Cards) for each card's full configuration.

Expand All @@ -108,7 +108,7 @@ Every card takes a `header_color` and a `card_design` option. See [Dashboard Car
| [Getting Started](https://github.com/tempus2016/taskmate/wiki/Getting-Started) | First-time setup walkthrough |
| [Admin Panel](https://github.com/tempus2016/taskmate/wiki/Admin-Panel) | The management hub in the HA sidebar |
| [Settings](https://github.com/tempus2016/taskmate/wiki/Settings) | Every configurable setting in one place |
| [Dashboard Cards](https://github.com/tempus2016/taskmate/wiki/Dashboard-Cards) | All 28 Lovelace cards and their options |
| [Dashboard Cards](https://github.com/tempus2016/taskmate/wiki/Dashboard-Cards) | All 30 Lovelace cards and their options |
| [Services](https://github.com/tempus2016/taskmate/wiki/Services) | Every callable service, with examples |
| [Sensor Reference](https://github.com/tempus2016/taskmate/wiki/Sensor-Reference) | All entities and their attributes |
| [Automations](https://github.com/tempus2016/taskmate/wiki/Automations) | Bus events, blueprints, and examples |
Expand All @@ -134,4 +134,4 @@ Bug reports and feature requests are welcome in [Issues](https://github.com/temp

MIT — see [LICENSE](LICENSE).

> Originally created by [vinnybad/choremander](https://github.com/vinnybad/choremander). This fork adds 28 Lovelace cards, an admin panel, a bonus points system, streak tracking, reward approval flow, a penalty system, and much more.
> Originally created by [vinnybad/choremander](https://github.com/vinnybad/choremander). This fork adds 30 Lovelace cards, an admin panel, a bonus points system, streak tracking, reward approval flow, a penalty system, and much more.
2 changes: 1 addition & 1 deletion custom_components/taskmate/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@
"iot_class": "calculated",
"issue_tracker": "https://github.com/tempus2016/taskmate/issues",
"requirements": [],
"version": "6.4.0"
"version": "7.0.0"
}
Loading