Skip to content

Wurby/RoguePickPocketTracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

47 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

RoguePickPocketTracker

The ultimate pickpocketing companion for World of Warcraft Classic rogues! Track your thievery with style, compete for achievements, and optimize your routes with detailed analytics.

๐Ÿš€ Key Features at a Glance

  • ๐Ÿ’ฐ Automatic Money & Item Tracking - Never lose track of your ill-gotten gains
  • โฑ๏ธ Earnings Tracking (Stopwatch) - Track per-minute and per-hour rates with start/stop controls
  • ๐Ÿ† Achievement System - Funny milestone rewards from "Finger Exercises" to "Scrooge McDuck"
  • ๐Ÿ“ Location Analytics - Heat-map style zone and location-based statistics
  • ๐Ÿ“Š Session Reports - Detailed summaries after each stealth session
  • ๐ŸŽฏ Success Rate Monitoring - Track attempts vs. successes for optimization
  • ๐Ÿ’ฌ Group Sharing - Broadcast your accomplishments to party/guild chat
  • โš™๏ธ Rich Options Panel - Customizable settings and detailed statistics view
  • ๐Ÿ”ง Granular Reset Options - Reset specific data types without losing everything
  • ๐ŸŽ‰ Toast Notifications - Beautiful achievement and session completion alerts
  • ๐Ÿ“ˆ Persistent Coin Tracker - Real-time coinage display with tracking controls
  • ๐Ÿ”ง Debug Tools - Money tracking diagnostics and troubleshooting commands
  • โฑ๏ธ Stopwatch Feature - Track your pickpocketing sessions with a built-in stopwatch
  • ๐Ÿ“Š Session Analytics - In-depth analysis of each pickpocketing sessio

๐Ÿ“‹ Getting Started

Installation

  1. Download the latest release from GitHub or curseforge.
  2. Extract to your World of Warcraft\_classic_era_\Interface\AddOns\ directory
  3. Restart WoW or type /reload in-game
  4. Start pickpocketing - the addon begins tracking automatically!

First Steps

  • Type /pp to see your current statistics
  • Visit /pp options to configure settings and view achievements
  • Try /pp zone to see location-based analytics
  • Use /pp share to show off your progress to friends

๐Ÿ† Achievement System

Earn bragging rights with our comprehensive achievement system featuring funny names and difficulty scaling:

๐ŸŽฏ Session Challenges

Master single-session pickpocketing sprees:

  • Finger Exercises โ†’ Shadow Lord (1 to 25 mobs per session)
  • Shiny Trinket โ†’ Treasure Hunter (1 to 5 items per session)

๐Ÿ“ˆ Lifetime Milestones

Build your criminal empire over time:

  • Getting Started โ†’ Legendary Thief (10 to 10,000 total pickpockets)
  • Coin Collector โ†’ Scrooge McDuck (1 silver to 1,000 gold earned)
  • First Find โ†’ Museum Curator (1 to 1,000 total items)
  • Tourist โ†’ Globe Trotter (pickpocket across 1 to 20+ zones)

Access achievements via /pp achievements or the options panel!


๐Ÿ“ Location Analytics

Optimize your pickpocketing routes with detailed zone and location tracking:

  • Zone Statistics - See which areas are most profitable
  • Location Breakdown - Sub-zone analysis for pinpoint accuracy
  • Success Rate Analysis - Identify the best farming spots
  • Heat-Map Data - Build comprehensive area-by-area strategies

Zone Commands

  • /pp zone - Current zone stats
  • /pp zone all - All zones overview
  • /pp zone Stormwind City - Detailed zone breakdown
  • /pp zone location - Specific location stats

๐Ÿ’ฌ Slash Commands

Main Commands:

  • /pp - Show current statistics and help
  • /pp options - Open the comprehensive options panel
  • /pp achievements - View your achievement progress

Sharing & Social:

  • /pp share - Share totals and recent session summary
  • /pp share achievements - Share achievement progress
  • /pp share locations - Share your top 3 pickpocket spots
  • /pp auto share - Toggle automatic sharing to chat

Earnings Tracking:

  • /pp track start/stop/toggle - Control earnings tracking (stopwatch)
  • /pp track status - Show current tracking statistics
  • /pp track report - Detailed tracking report as toast notification
  • /pp track reset - Reset current tracking session

Session & Notifications:

  • /pp session [toast/print] - Show last session summary as toast or text
  • /pp toggletoasts - Toggle session completion toast notifications

UI & Display:

  • /pp tracker - Toggle persistent coin tracker display
  • /pp ui coinage [show/hide/toggle/reset] - Manage coinage tracker

Data Management:

  • /pp reset [type] - Granular reset options:
    • achievements - Reset only achievements
    • coins - Reset only money and items
    • locations - Reset only zone/location data
    • all - Reset everything (requires confirmation)

Detailed Analytics:

  • /pp items - Show cumulative item breakdown
  • /pp zone - Current zone statistics
  • /pp zone all - All zones overview
  • /pp zone [name] - Specific zone details
  • /pp zone [name] all - Complete location breakdown

Utilities:

  • /pp tracker - Toggle persistent coin tracker display
  • /pp togglemsg - Toggle loot notification messages
  • /pp toggletoasts - Toggle session completion toast notifications
  • /pp debug - Toggle debug mode for troubleshooting
  • /pp moneycheck - Check money tracking state (for debugging)
  • /pp ui - Open standalone options window
  • /pp version - Show addon version information

๐ŸŽ‰ Toast Notification System

Experience your achievements with beautiful, non-intrusive notifications:

Achievement Toasts

  • Milestone Celebrations - Elegant popups when you unlock new achievements
  • Progress Tracking - Visual feedback for your pickpocketing accomplishments
  • Customizable Opacity - Adjust transparency to match your UI preferences

Session Completion Toasts

  • Stealth Session Summary - Automatic notification when stealth sessions end
  • Loot Summary - Shows money gained and items obtained at a glance
  • Smart Timing - Appears after combat ends to avoid UI clutter during fights
  • Manual Control - Use /pp session toast to replay your last session summary

Toast Features

  • Queue System - Multiple toasts display in sequence without overlap
  • Achievement-Style Design - Familiar look and feel like Blizzard's achievement system
  • Fade Animations - Smooth fade-in, hold, and fade-out transitions
  • Combat-Safe - Won't interrupt gameplay during critical moments

Toggle toast notifications with /pp toggletoasts or in the options panel.


๐Ÿ’ฐ Enhanced Persistent Coin Tracker

The coin tracker has evolved into a comprehensive earnings display:

Real-Time Display Features

  • Total Coinage - Your lifetime pickpocketing earnings always visible
  • Session Earnings - Current stealth session progress (when applicable)
  • Tracking Stats - Live per-minute and per-hour rates during tracking sessions
  • Timer Display - Shows elapsed time when tracking is active
  • Control Buttons - Integrated start/stop controls for earnings tracking

Advanced UI Features

  • Moveable & Resizable - Drag to position, automatically sizes to content
  • Anchor System - Optional visible anchor for precise positioning
  • Background Customization - Adjustable colors and transparency
  • Smart Visibility - Shows relevant information based on current state
  • Session Integration - Displays session info when active, tracking when enabled

Tracker Commands

  • /pp tracker - Quick toggle for the display
  • /pp ui coinage [show/hide/toggle/reset] - Full control options
  • Options panel has complete customization settings

Access tracker settings in the options panel under "Display Options".


๐ŸŽฎ How It Works

The addon seamlessly integrates with your gameplay by monitoring:

  • ๐Ÿฅท Stealth Detection - Automatically starts sessions when you enter stealth
  • โœ‹ Spell Casting - Detects Pick Pocket usage and attempts
  • ๐Ÿ’ฐ Money Changes - Tracks increases to your character's money with safety checks
  • ๐Ÿ“ฆ Loot Messages - Parses chat for pickpocketed items
  • โš”๏ธ Combat Log - Records successes and failures for analytics
  • โฑ๏ธ Earnings Tracking - Optional stopwatch feature for performance measurement

Session Management

  • Session Start: Entering stealth or casting Pick Pocket
  • Session End: Stealth expires + 2-second grace period
  • Session Reports: Automatic summary if anything was gained
  • Toast Notifications: Achievement-style popups for session completion and milestones
  • Combat Awareness: Smart session handling during and after combat encounters
  • Tracking Integration: Optional earnings tracking with start/stop controls

โš™๏ธ Configuration

All settings auto-save and include:

Setting Description
Show Messages Toggle pickup notifications
Show Session Toasts Toggle achievement-style session completion notifications
Show Coin Tracker Toggle persistent real-time coinage display
Enable Earnings Tracking Enable/disable the stopwatch tracking feature
Show Session Info Display session information in the coin tracker
Auto Share Automatically share session summaries
Debug Mode Enable detailed logging
Alert Opacity Customize achievement notification transparency
Tracker Position Customize coin tracker anchor point and position
Background Color Customize tracker background color and transparency

Plus comprehensive tracking of coins, attempts, items, zones, locations, and achievement progress.


๐Ÿ”ง System Requirements

  • Game Version: World of Warcraft Classic Era (Interface 11507+)
  • Character Class: Rogue (addon designed specifically for rogues)
  • Dependencies: None - completely standalone

โ“ Troubleshooting

Addon not tracking?

  1. โœ… Verify you're playing a Rogue character
  2. โœ… Enable debug mode with /pp debug
  3. โœ… Check addon is loaded in your AddOns menu
  4. โœ… Ensure you're pickpocketing
  5. โœ… Try /reload to refresh the UI

Money tracking issues?

  • Use /pp moneycheck to diagnose money tracking state
  • Check if earnings tracking is enabled in options (/pp options)
  • Verify you're in a pickpocketing session when expecting tracking

Need help? Check the Issues page or submit a bug report!


๐Ÿš€ Future Features

Exciting features in development:

  • ๐Ÿ”“ Lockbox Tracking - Monitor lockpicking statistics and success rates
  • ๐Ÿ† Lockbox Achievements - New milestone categories for lockpicking mastery
  • ๐Ÿ’ฌ Lockpicking Services - Auto-advertise your skills in trade chat
  • ๐ŸŽฏ Target Highlighting - Visual indicators for pickpocketable targets
  • ๐Ÿ“Š Advanced Analytics - Heat maps and time-based statistics dashboards
  • ๐ŸŽจ Theme Customization - Multiple UI themes and color schemes

Recently Completed โœ…

  • โฑ๏ธ Earnings Tracking (Stopwatch) - Real-time per-minute/hour rate tracking
  • ๐Ÿ› ๏ธ Enhanced Money Tracking - Improved safety checks and diagnostics
  • ๐ŸŽจ Advanced UI Customization - Moveable tracker with custom backgrounds
  • ๐Ÿ”ง Debug Tools - Comprehensive troubleshooting commands

๐Ÿค Contributing

We welcome contributions from the community! Here's how to get involved:

๐Ÿ› Reporting Issues

  • Use the GitHub Issues page
  • Include your WoW version, addon version, and steps to reproduce
  • Check existing issues before submitting duplicates

๐Ÿ’ป Development Setup

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Make changes and test thoroughly in-game
  4. Submit a Pull Request with a clear description

๐Ÿ—๏ธ Building Releases

./buildAndRelease.sh  # Automated packaging and GitHub release

Safety Features:

  • Only allows releases from the main branch for consistency
  • Automated data version bumping for breaking changes
  • Interactive version selection (patch/minor/major/custom)
  • GitHub Actions integration for automated distribution

The project uses GitHub Actions for automated releases when tags are pushed.

๐Ÿ“ Code Style

  • Follow existing Lua conventions in the codebase
  • Comment complex logic clearly
  • Test changes with multiple scenarios before submitting

๐Ÿ’ก Feature Requests

  • Open an Issue with the "enhancement" label
  • Describe the feature and its benefits clearly
  • Consider contributing the implementation yourself!

Happy Pickpocketing! ๐Ÿฅท๐Ÿ’ฐ

Created with โค๏ธ by Wurby for the WoW Classic community

About

A simple pick pocket tracker for rogues in classic wow.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors