Home

Welcome to KidsChores Documentation

The most feature-rich and customizable chore management system for Home Assistant.

---

What is KidsChores?

KidsChores is a comprehensive Home Assistant integration that transforms household chore management into an engaging, automated experience for the whole family.

Built for flexibility: Start simple with basic chores and points, or build advanced systems with badges, themes, notifications, and automations.

Local and private: All data stays on your Home Assistant instance.

---

What This Wiki Covers

This documentation is organized to match how you'll use KidsChores.

🚀 Getting Started

New to KidsChores? Start here.

• Installation and Setup - HACS or manual installation
• Quick Start Guide - Your first kid, chore, and approval workflow
• Quick Start Scenarios - Creative family setup ideas
• Dashboard Generation - Use a pre-built auto-populating dashboard
• Backup and Restore Reference - Protect your data

⚙️ Configuration

Core setup: Kids, parents, chores, rewards, points, badges, and notifications.

• Kids and Parents - Create profiles and assign parents
• Chores - Configure chores with scheduling and approval
• Chores - Advanced Features - Per-kid customization and complex scheduling
• Rewards - Set up rewards kids can claim
• Points System - Customize your points currency
• Badges - Cumulative - Progressive achievement badges
• Badges - Periodic - Daily/weekly maintenance badges
• Notifications - Mobile notifications and smart alerts

🔧 Services & Automation

Integrate with Home Assistant: Services, examples, and workflows.

• Services Reference - Complete service documentation
• NFC Tag Chore Claiming - Physical chore cards
• Calendar-Based Scheduling - Sync with calendars
• Overdue Chore Penalties - Automated accountability

📖 Advanced Topics

Power user features: Dashboard, access control, and advanced badge design.

• Dashboard Integration - Auto-populating UI dashboard
• Advanced Access Control - Shared-device and kiosk mode strategy
• Badge Gamification - Motivation design patterns
• Badge Cumulative - Advanced - Advanced cumulative badge patterns
• Badge Periodic - Advanced - Advanced periodic badge patterns

📚 Technical Reference

For developers and advanced users: Entity details and implementation behavior.

• Entities & States - Complete entity documentation
• Chores - Entity mapping and state behavior
• Badge Entities - Badge sensor details
• Configuration Detail - Config/Options flow deep dive
• Notifications - Notification internals and behavior

👩‍🔧 Troubleshooting

• Troubleshooting Guide - Common problems and solutions

---

Quick Links

Most common starting points:

• 🎯 Install KidsChores - Get started in 10 minutes
• 🌟 Creative Setup Ideas - Family setup examples
• 📋 Configure Your First Chore - Step-by-step chore setup
• 🏆 Create Badge System - Motivate with progression
• 🔐 Advanced Access Control - Shared-device and kiosk-mode strategy
• 🤖 Services Overview - Integrate with automations

Ready to get started? → Installation and Setup