Household

Household User Guide

Documentation still in progress. Will be fully fleshed out at beta launch.
Beta Launch scheduled for Oct 2025 (Possibly sooner as testing is almost finished!)
Hard launch scheduled for Nov 1 2025

Welcome to your household dashboard! This guide will help you perform common actions. Select any section below to jump right in.

Notifications
Overview
Badges & XP
Prize Counter
Calendar
Chores
Books (Coming soon)
Games (Coming soon)
User Profiles
Admin side

Notifications

What it does:
- View upcoming tasks, level and badge unlocks, and household notes
- Press Clear All at bottom of page to move notifications to archive.

Overview

What it shows:
- See your current levels, XP progress, and next milestone
- Summary of recent activity for books and games* (coming soon)

Badges & XP

All Badges:
- Browse all available badges and see which badges you’ve earned

Create a badge (managers)
Managers can create badges using this form. All fields are mandatory except Set and Number in Set.
  Name (Name of the badge)
  Description (What does this badge do?)
  Icon Original (The picture to use for the badge)
  App Label (The app this badge belongs to.) Choices are:
    - General - Consists of Badges for Levels and Reward Points
    - Chores - Badges for individual chores as well as total earned wages if toggled on for this household.
    - Books (coming soon) - Badges for words read and number of books read.
    - Games (coming soon) - Badges for hours played and specific games beaten or mastered.
  Milestone Type (Specific badge type for selected app label)
  Milestone Value (number to unlock badge at. For example, a badge for leveling with a Milestone Value of 10 will unlock at level 10. A badge for Mopping 10 times would require a Milestone Value of 10)
  Set (Badge Set that this belongs to.)
    - Badge Sets used for grouping alike badges, for example:
      - Achieving Level 5, then the next badge in the set would be Achieving Level 10
      - Mopping 5 times, then the next badge being mopping 20 times, and so on.
      - Badge sets are important for the displaying of the highest in a set on the User's Profile and the All Badges page sorting.
    - If Badge Set for the current badge doesn't exist, and manager would like to create it, they can add it here.
  - Number in Set (the number the badge comes in sequentially in the set)     - Suggest will automatically grab the next number if a Badge Set is selected.
  - Select Save and address any input issues. Badges can also be added through Admin Side.

Edit Badges
1. Navigate to All Badges in sidebar menu, Badges and XP dropdown.
2. Select All Badges List at bottom of page.
3. Click Edit on the right side of the badge you wish to edit. 4. Delete or edit badge as needed.

XP:
- Configure XP settings (managers only)
- Use by selecting base and curve exponents.
- Different XP types (Chores, Reading, Gaming) can each have unique base and curves.
- XP Settings and Levels are regenerated on save.

How to earn XP:
- Complete chores
- Log reading sessions and complete books
- Track game playtime and milestones

Prize Counter

Rewards
- Users can redeem rewards created here.

Add Rewards (managers only)
- Fill out New Rewards fields
  - Name (mandatory)
  - Description (optional)
  - Cost of reward points (mandatory)
  - Inventory (how many on hand, leave blank for infinite)
  - Active toggle (can users redeem currently?)

Reward Redemptions Page (managers) - When users redeem a reward, the reward redemption must be actioned in the Redemption Moderations page.
- Household managers can follow the below steps to action redeemed rewards:
1. Navigate to the Redemption Moderations page by clicking the Prize Counter dropdown and selecting Redemptions.
2. Select the reward that the user redeemed from the list and press Approve or Reject
3. Don't forget to give the user the reward in real life!

Calendar

Features:
- View scheduled tasks and events
- Add new chores or reminders (managers)

How to schedule a chore
1. Navigate to Calendar in the sidebar, click/tap to activate the dropdown, and select "Schedule a Chore"
2. Fill in:
- Chore to Schedule
- Who to assign this Chore to. If left on Anyone, it will be claimable by anyone in the Household.
- What day to set this chore to.
- What time to set it to.
- How often this chore should reoccur.
- How many times to let this repeat.
- Optional field for Notes.
3. Hit Schedule and a notification will go out to all Household users in the "Workers" group.

This functionality is not recommended to be configured from the Admin side.

Chores

Where to find: Expand Chores (if enabled).

Features:
- View all household chores by category
- Claim or complete chores
- Track payouts and balances
- Add chores (Privileged members)

How to
Log a Chore
1. Go to Chores > All Chores.
2. Click/Tap a chore to mark it complete.
3. Click/Tap Add New Entry
4. Click/Tap

Conduct Payouts
1. Check Payouts to see earned XP or rewards.
2. Select a user to payout

Books

Coming sooner

Games

Coming soon

User Profiles

Where to find: Expand Users > Profile.

Features:
- Upload or change your profile picture
- See Activity Feed on the bottom of page
- Link external accounts (RetroAchievements, Xbox Live)*

How to…
1. Go to Users > Profile.
2. Upload a new image under Profile Picture.
3. Enter your RA Username or XBL Gamertag.
4. Click Save*.

Settings

Settings for minimal Household tweaking through frontend.
Currently, frontend settings exist for setting your Household timezone, turning off earned wages and disabling/enabling certain apps (will be Chores, Books, and Games)

Admin Side

All settings and functionalities can now be configured and edited from the "frontend", but we left the admin side as some users may find it easier to use.

Authentication and Authorization
- Groups
- Groups consist of Privileged and Workers
  - Assign anyone you want to have "admin" privileges to the Privileged group.
  - Privileged users can:
     1. Add chores
     2. Schedule chores on Calendar
     3. Create badges
     4. Add Users to Household
     5. Access admin side
  - Workers group will receive notifications when chores added to Calendar
  - Nothing needs to be explicitly set in permissions. Assigning groups is all that is necessary.
- Users
  - Edit User settings here.
  - Reset Passwords here as well.

Badges
- Badge Sets
  -Add and Edit Badge Sets here.
  -Badge Sets used for grouping alike badges, for example:
    - Achieving Level 5, then the next badge in the set would be Achieving Level 10
    - Mopping 5 times, then the next badge being mopping 20 times, and so on.
    - Badge sets are important for the displaying of the highest in a set on the User's Profile and the All Badges page sorting.

Badges   - Add new Badges through the backend if preferred to the frontend.
  - Only Icon Original field needs to have a picture when saving.
  - Always doublecheck Milestone Type to ensure it did not change before saving.
  - Automatic Badge Set numbering only works in frontend.
User Badges - Used for assigning already created badges to users, also known as "manual unlocking".

Chores
(docs in progress)

Tenant Settings
(docs in progress)

User Stats
(docs in progress)

XP System
(docs in progress)

Credits: Emoji from OpenMoji — CC BY-SA 4.0.
For additional help or to report issues, please contact your household admin or open a support ticket via the Help section.