Skip to content

USER_GUIDE.md

Latest commit

 

History

History
505 lines (369 loc) · 11 KB

USER_GUIDE.md

File metadata and controls

505 lines (369 loc) · 11 KB

🏀 HoopTracker User Guide

Welcome to HoopTracker! This guide will help you get the most out of your basketball practice tracking.

Table of Contents

  1. Quick Start
  2. Voice Commands
  3. Features Explained
  4. Settings Guide
  5. Tips & Tricks
  6. Troubleshooting

Quick Start

First Time Setup (2 minutes)

  1. Install and open HoopTracker
  2. Grant permissions when prompted:
    • Microphone (required for voice tracking)
    • Bluetooth (optional, for headphones)
    • Notifications (optional, for tracking alerts)
  3. Tap "Start Voice Tracking"
  4. Start shooting! Just say "hit" or "miss" after each shot

That's it! You're tracking your shots.

Voice Commands

Basic Commands (Say these after each shot)

To Record a Make:

  • "hit"
  • "make"
  • "made"
  • "good"
  • "in"

To Record a Miss:

  • "miss"
  • "missed"
  • "no good"
  • "brick"

To Undo Your Last Shot:

  • "undo"
  • "cancel"
  • "take back"

Advanced Commands (Specify shot type)

Say the shot type + result:

  • "three pointer hit" - Records a made 3-pointer
  • "free throw miss" - Records a missed free throw
  • "layup make" - Records a made layup
  • "mid range miss" - Records a missed mid-range shot

Features Explained

📊 Main Screen

Streak Display (Top Card)

  • Shows your current hot or cold streak
  • 🔥 = Making streak (consecutive makes)
  • ❄️ = Missing streak (consecutive misses)
  • Example: "5 🔥 Makes" means you made 5 in a row!

Period Selection (Chips)

  • Today: Stats for today only
  • Week: Last 7 days
  • Month: Last 30 days
  • Year: Last 365 days

Stats Card (Center)

  • Big Percentage: Your shooting percentage
  • Hits: Shots you made
  • Misses: Shots you missed
  • Total: All shots taken

Chart

  • Shows your shooting percentage over time
  • Bars represent each day's performance
  • Hover to see exact percentages

Shot Type Selection

  • Choose what type of shots you're practicing
  • General: Regular mixed shooting
  • 3-Pointer: Three-point shots
  • Mid-Range: Mid-range jumpers
  • Layup: Layups and close shots
  • Free Throw: Free throws

Control Buttons

  • Start Voice Tracking: Begin voice-activated tracking
  • ✓ Hit / ✗ Miss: Manual entry buttons
  • ↶ Undo: Remove the last shot you recorded
  • Export CSV: Download your data as a spreadsheet
  • Clear All Data: Delete everything (can't undo!)

Top Menu Icons

  • History (clock icon): See all your shots
  • Settings (gear icon): Customize the app

🔥 Streak Tracking

What is it? Your streak shows how many shots in a row you've made (or missed).

How it helps:

  • Motivates you to keep a hot streak alive
  • Shows when you're in the zone
  • Helps you recognize patterns

Example:

  • Make 10 shots in a row → "10 🔥 Makes"
  • Miss 3 in a row → "3 ❄️ Misses"

🎯 Shot Types

Why use them? Different parts of your game need different practice. Track each separately to see where you excel and where you need work.

When to use:

  • 3-Pointer: When practicing from behind the arc
  • Mid-Range: For jump shots inside the arc
  • Layup: For close-range finishing
  • Free Throw: At the free throw line
  • General: Mixed practice or warm-ups

How to use:

  1. Select the chip before starting
  2. OR say the type in your voice command
  3. The app remembers your selection

Pro Tip: Track a full free throw session, then switch to 3-pointers. You'll have separate stats for each!

📝 Sessions

What are sessions? A session is one practice period from start to finish.

How they work:

  1. Start voice tracking → Session begins automatically
  2. Practice and record shots
  3. Stop tracking → Session ends

Session features:

  • Tracks start/end time
  • Calculates total duration
  • Shows session statistics
  • Can add notes (in history)

Settings:

  • Turn OFF "Auto-start Session" if you don't want this feature

📖 Shot History

Access: Tap the history icon (top right)

What you see:

  • Every shot you've recorded
  • Timestamp of each shot
  • Shot type (3PT, FT, etc.)
  • Result (Hit or Miss)

Delete shots:

  • Swipe left or right on any shot
  • Useful for removing mistakes

When to use:

  • Review your practice session
  • Remove accidental entries
  • See patterns in your shooting

⚙️ Settings

Access: Tap the settings icon (top right)

Haptic Feedback

  • ON: Phone vibrates when you record a shot
  • Makes: 1 quick vibration
  • Misses: 3 quick vibrations
  • Helps you know it registered without looking

Voice Feedback

  • ON: Phone says "Hit" or "Miss" out loud
  • Great when you can't look at the screen
  • Works with music playing

Auto-start Session

  • ON: Creates a session automatically when tracking starts
  • OFF: No session tracking

Daily Shot Goal

  • Set your target number of shots per day
  • Range: 10 to 500 shots
  • Motivates you to practice more

Daily Percentage Goal

  • Set your target shooting percentage
  • Range: 10% to 100%
  • Aim higher as you improve!

📤 Exporting Data

How to export:

  1. Tap "Export CSV" button
  2. Choose where to share (Email, Drive, etc.)
  3. Your data is saved as a spreadsheet

What's included:

  • Every shot with exact timestamp
  • Result (Hit/Miss)
  • Shot type
  • Session ID

Why export:

  • Share progress with your coach
  • Analyze in Excel/Google Sheets
  • Backup your data
  • Create your own charts

Tips & Tricks

🎧 Best Practices

Use Bluetooth Headphones:

  • Easier to speak commands
  • Music keeps playing
  • Better recognition accuracy

Speak Clearly:

  • Don't shout, just speak normally
  • Be consistent with your words
  • Wait for vibration/sound confirmation

Practice Routine:

  1. Set a shot type
  2. Set a goal (e.g., 100 three-pointers)
  3. Start tracking
  4. Focus on shooting
  5. Review stats afterward

🎯 Goal Setting

Beginner:

  • Goal: 50 shots at 40%
  • Focus on form, not speed

Intermediate:

  • Goal: 100 shots at 50%
  • Mix shot types

Advanced:

  • Goal: 200+ shots at 60%+
  • Separate sessions per shot type

📊 Using Statistics

Daily View:

  • See immediate improvement
  • Adjust form same day

Weekly View:

  • Track consistency
  • Identify good/bad days

Monthly View:

  • See long-term trends
  • Measure real progress

Yearly View:

  • Ultimate progress tracker
  • Set annual goals

🔄 Undo Feature

When to use:

  • Said wrong command
  • Accidentally tapped button
  • Shot doesn't count (foul, etc.)

Three ways to undo:

  1. Tap ↶ Undo button
  2. Say "undo"
  3. Tap "Undo" in notification

Important: Only undoes the LAST shot!

Troubleshooting

Voice Commands Not Working

Check:

  1. ✅ Microphone permission granted
  2. ✅ Google Speech Recognition installed
  3. ✅ Internet connection (first use only)
  4. ✅ Background noise not too loud
  5. ✅ Speaking clearly and not too fast

Try:

  • Restart the app
  • Use manual buttons temporarily
  • Check Bluetooth connection
  • Speak a bit louder/clearer

Tracking Stops

Causes:

  • Phone's battery saver mode
  • App killed by system
  • Lost Bluetooth connection

Solutions:

  • Disable battery optimization for HoopTracker
  • Keep app in foreground
  • Reconnect Bluetooth
  • Restart tracking

Stats Seem Wrong

Check:

  • Selected the right time period (Today/Week/Month/Year)
  • Not looking at a different shot type
  • Didn't accidentally clear data

Fix:

  • Refresh by switching periods
  • Check shot history for details
  • Use undo if you made a recent mistake

App Crashes

Do:

  1. Force close the app
  2. Clear app cache (in phone settings)
  3. Restart your phone
  4. Reinstall if needed (data is saved)

No Vibration Feedback

Check Settings:

  • Haptic Feedback is turned ON
  • Phone is not in silent mode
  • Phone supports vibration

Can't Export CSV

Check:

  • Have shots recorded
  • Storage permission granted (older Android)
  • Have an app to share with (Gmail, Drive, etc.)

Keyboard Shortcuts & Quick Actions

From Notification (While Tracking)

Tap notification: Open app Tap "Stop": End tracking session Tap "Undo": Remove last shot

In-App Quick Actions

Double-tap period chip: Refresh stats Long-press stat card: (Future: detailed breakdown) Swipe shot in history: Delete shot

Privacy & Data

Your Data is Safe

  • ✅ 100% Local: Everything stored on your phone
  • ✅ No Internet Required: Works completely offline
  • ✅ No Tracking: We don't collect anything
  • ✅ No Ads: Pure, clean experience
  • ✅ No Account: No login required

Backup Your Data

Method 1: Export CSV

  • Regular exports save your history
  • Store in cloud (Drive, Dropbox)

Method 2: Android Backup

  • Automatic with Android backup
  • Restore on new phone

Important: Clearing data is permanent!

Getting Help

Still Need Help?

  1. Re-read relevant section of this guide
  2. Check the troubleshooting section
  3. Try restarting the app
  4. Check for app updates

Feature Requests

Love HoopTracker? Have ideas? Contributions welcome on GitHub!

Practice Plans

Plan 1: Form Focus (30 min)

  • Shot Type: Mid-Range
  • Goal: 50 shots at 60%+
  • Focus: Perfect form on every shot
  • Track: Look for consistency day-to-day

Plan 2: Game Simulation (45 min)

  • Switch between all shot types
  • Goal: 100 total shots at 50%+
  • Mimics real game variety
  • Track: Which types need work?

Plan 3: Free Throw Master (20 min)

  • Shot Type: Free Throw
  • Goal: 50 shots at 80%+
  • Routine practice
  • Track: Daily consistency

Plan 4: Three-Point Challenge (1 hour)

  • Shot Type: 3-Pointer
  • Goal: 100 shots at 40%+
  • Move around the arc
  • Track: Weekly improvement

Glossary

Streak: Consecutive makes or misses Session: One practice period Shot Type: Category of shot (3PT, Layup, etc.) CSV: Spreadsheet file format Haptic: Vibration feedback TTS: Text-to-speech (voice feedback)

Quick Reference Card

VOICE COMMANDS CHEAT SHEET
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Make:  hit | make | made | good | in
Miss:  miss | missed | no good | brick
Undo:  undo | cancel | take back

SHOT TYPES
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
"three pointer [result]"
"free throw [result]"
"layup [result]"
"mid range [result]"

MAIN BUTTONS
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
✓ Hit          Record make manually
✗ Miss         Record miss manually
↶ Undo         Remove last shot
🕐 History     View all shots
⚙️ Settings     Customize app
📤 Export      Download CSV

Now get out there and improve your game! 🏀

Remember: The app tracks stats, but YOU make the shots. Practice consistently, track honestly, and watch yourself improve!

Got questions? Check the troubleshooting section or the main README.md for technical details.

Happy Shooting! 🔥