Star 历史趋势
数据来源: GitHub API · 生成自 Stargazers.cn
README.md

Questboard

Turn household chores into a pixel art RPG adventure for the whole family.

Each family member gets a hero and a daily monster to fight. Complete chores to deal damage - defeat the monster before midnight to earn gold, or it strikes back. Spend gold on rewards you've agreed on as a family.

Built to run on a kitchen tablet, locked to a browser, always-on.

Questboard main screen

Release License ko-fi


What it looks like

The interface runs fullscreen in the browser. Each player gets a card with their hero, live HP bar, and current monster. Completing chores hits the monster - chain them fast for combo damage, score a crit, or find loot drops.

Player card - hero class, gold, XP bar, crit %, streak
Monster section - animated pixel art enemy, segmented HP bar, kill = gold reward
Chore grid - daily / weekly / monthly quests shown with damage values
Dungeon map - per-player fog-of-war grid; chores earn moves, rooms hide gold, traps, and mini-bosses
Reward shop - spend gold on family rewards you configure in setup
History - full log of kills, loot drops, rewards redeemed, badges earned


Features

FeatureDescription
⚔ Monster battlesEach player fights a date-seeded monster every day
💥 Crit hits5% base crit chance, increases as you level up
🔥 Kill streaksMulti-day streaks multiply gold rewards (up to 2×)
🎯 Combo attacksChain chores within 8 seconds for up to 2.5× bonus
🎲 Loot dropsChance to find bonus gold or XP on any chore
⚡ Overkill systemAfter the kill, extra chores charge a bar to bank Power Tokens
🔮 Power-upsGold Rush, Double Damage, Shield Aura, Treasure Magnet, Forge Reward
🛡 Shield AuraActive power-up blocks the midnight gold penalty
🏅 Badges & titlesUnlock achievements and choose your hero title
⭐ PrestigeReset XP at level 10 for a permanent gold % bonus
🗺 Dungeon mapExplore a per-player fog-of-war dungeon - chores = moves
🏆 Weekly leaderboardSee who earned the most gold this week
⚡ Auto-resetsDaily/weekly/monthly chores reset at exactly the right time
🌙 Overnight penaltyFail to kill your monster and lose gold at midnight
👥 Up to 6 playersEach with their own hero, monster, gold, XP, and dungeon
👤 Solo choresPersonal tasks (brushing teeth, homework) tracked per player
📱 Kids & adults modesSeparate difficulty scaling - kids get easier monsters
🎮 CRT overlayOptional scanline filter for maximum retro vibes
🔍 UI ScaleMini / Heroic / Epic zoom modes for any screen size

📖 Full game guide → - hero classes, dungeon mechanics, combat details, badges, power-ups, and more.


Quick Reference

Hero Classes

Classes are cosmetic - they change your hero's sprite but don't affect stats. Available: Warrior, Mage, Witch, Rogue, Paladin, Ranger, Frost Knight.

Midnight Monster Penalty

If you don't defeat your daily monster before midnight, it attacks - you lose gold equal to its attack power. Tougher monsters hit harder. Shield Aura power-up blocks the penalty.

Dungeon

A per-player fog-of-war dungeon you explore by earning moves from chores. Use the on-screen d-pad to navigate. Find gold, treasure chests, keys, and fight dungeon monsters - but watch out for traps. Deeper floors have better rewards.

Reset Week

Manual full reset: clears all gold, chore progress, streaks, and power-ups for every player. History, XP, levels, and badges are kept. Triggers immediately (not aligned to a specific day).


Install on Home Assistant

Step 1 - Run the container

In the HA Terminal add-on:

mkdir -p /mnt/data/supervisor/questboard/data docker run -d --restart unless-stopped -p 8099:8099 \ -v /mnt/data/supervisor/questboard/data:/data \ ghcr.io/thillygooth/questboard:latest

Step 2 - Add to the HA sidebar

In configuration.yaml (use the File Editor add-on):

panel_iframe: questboard: title: "Questboard" url: "http://<your-ha-ip>:8099" icon: mdi:sword-cross require_admin: false

Replace <your-ha-ip> with your Home Assistant IP (e.g. 192.168.1.34). Find it under Settings → System → Network.

Restart HA (Settings → System → Restart). Questboard appears in your sidebar.


Manual Install (Docker)

mkdir -p /opt/questboard/data docker run -d --restart unless-stopped -p 8099:8099 \ -v /opt/questboard/data:/data \ ghcr.io/thillygooth/questboard:latest

Open http://localhost:8099.

Use any writable absolute path for the data volume. On Home Assistant OS use /mnt/data/supervisor/questboard/data instead of /opt/questboard/data since most of the filesystem is read-only.


Running on a Separate Host

Questboard is a standalone web app - no connection to Home Assistant required. Run it on any machine on your network.

panel_iframe: questboard: title: "Questboard" url: "http://<docker-host-ip>:8099" icon: mdi:sword-cross require_admin: false

Replace <docker-host-ip> with the IP of whichever machine is running the container.


First-Run Setup

A setup wizard runs the first time you open the app:

  1. Set the number of players (1–6)
  2. For each player: name, difficulty (kids / adults), avatar class
  3. Choose which chores to track - toggle on/off, set solo vs. shared, adjust values
  4. Configure the reward shop - enable/disable rewards, set custom costs
  5. Configure power-ups and display options (CRT overlay, UI scale)

After launch, tap Settings for a tabbed editor: Party, Quests, Rewards, Power-Ups, and Display - no need to re-run the wizard.


Development

# Frontend (hot-reload dev server on :5174) cd frontend && npm install && npm run dev # Backend (auto-reload API server on :5050) cd backend && pip install -r requirements.txt uvicorn main:app --reload --port 5050

The dev server proxies /api/* to the backend automatically.


License

CC BY-NC 4.0 - free to share and adapt for non-commercial purposes with attribution. Commercial use is prohibited.

Sprite assets from OpenGameArt.org under CC-BY / CC0 licenses. Font: Pixelated Elegance by GGBotNet (CC0).


Credits

Overkill system, power-ups, solo chore mode, tabbed settings, new hero classes, and gold economy rebalancing contributed by TreasuryMatt - thanks for the excellent fork!

关于 About

A gamified family chore tracker built with React, FastAPI, and Docker. Family members claim daily and weekly chores to earn points, then redeem them for real-world rewards. Features per-player profiles, age-appropriate chore filtering, auto daily/weekly resets, and a shared backend for real-time sync across devices.

语言 Languages

JavaScript76.4%
CSS13.1%
Python8.5%
HTML1.1%
Dockerfile0.6%
Shell0.3%

提交活跃度 Commit Activity

代码提交热力图
过去 52 周的开发活跃度
44
Total Commits
峰值: 44次/周
Less
More

核心贡献者 Contributors