Housing Lumber Helper

# Changelog

All notable changes to Housing Lumber Helper will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [2.1.5] - 2026-01-09

### Added
- Compass HUD: "Hide in cities" setting - automatically hides the compass overlay when entering any resting area (cities, inns, sanctuaries) and restores when leaving. Correctly handles edge cases like attacking training dummies in Dornogal (combat + city overlap)
- Session Tracker: current expansion row now always shows a goal progress line below bag/warband counts - displays crafting goal (anvil icon) when TSM/PSL has items queued, or target goal (crosshair icon) as fallback when no crafting is queued
- TSM/PSL Integration: real-time queue updates - Inventory Panel and Session Tracker now refresh within 1 second when you add or remove items from your TSM crafting queue or PSL shopping list (no need to close/reopen the profession window)

### Fixed
- Blizzard UI Style: addon logo no longer hidden beneath title bar (now uses OVERLAY draw layer)
- Session Tracker: target goal display now updates immediately when changing global or expansion-specific targets in settings (was not refreshing until zone change)

---

## [2.1.4] - 2026-01-08

### Added
- Settings: UI Style dropdown (Custom/Blizzard) - comprehensive style switching:
  - Custom: warm amber theme with red title, yellow glow, addon logo, custom icons, red glowing dividers
  - Blizzard: standard WoW appearance with thin rounded border (tooltip-style), dark title bar, gold/yellow centered title, standard close button (red X), standard cogwheel, play/pause from TimeManager, reset button (yellow dot), toolbar icons (lumber, treasure map, coin, compass, orb), standard mail envelope icon, simple grey dividers, grey time border
- Settings: "Show in Addon Compartment" checkbox - toggles visibility in Blizzard's addon dropdown (independent of minimap button)
- Settings: "Show expansion abbreviations in Inventory Panel" checkbox - displays community-standard abbreviations (TWW, DF, SL, BfA, etc.) instead of logo images in Inventory Panel rows (Session Tracker always shows logos)
- Compass HUD: "Hide during combat" setting - automatically hides the compass overlay when entering combat and restores when leaving

### Changed
- Settings: AH-related options now grouped under "Auction House" sub-header in Session & Timers panel for better organization
- Settings: renamed "Play sound at threshold" to "AH timer sound alert" and "Reset timer on login" to "Reset AH timer on login" for clarity
- Expansion logos: fixed 2:1 aspect ratio and increased sizes for better visibility (Session: 80x40→100x50, Inventory: 56x28→80x40)
- Compass HUD: "Hide during combat" setting now defaults to ON (most players prefer this behavior)

---

## [2.1.3] - 2026-01-06

### Added
- AH Timer: "Reset timer on login" setting - automatically resets the AH timer to zero when logging in (useful for multi-character workflows where you check the AH on a different character)
- AH Timer: manual reset button next to the timer display - click to reset the timer without visiting the Auction House

### Fixed
- Inventory Panel: sorting Craft or Craft% columns ascending no longer puts "-" (no crafting queued) rows at the top - irrelevant rows now always appear at the bottom regardless of sort direction
- Compass HUD: can no longer remain open when Session Tracker is closed (HUD now requires Session Tracker to be visible, preventing loss of minimap access)

---

## [2.1.2] - 2026-01-05

### Fixed
- Speed Tracker: flying speed no longer requires ground walking first to calibrate (now accurate position-based calculation)
- Speed Tracker: speed now correctly recalculates after zone changes (cached map dimensions are properly refreshed when mapID changes)
- Compass HUD: speed bar freezing when entering cities like Stormwind (calculation returns nil in city zones, speed bar now updates before early returns)

---

## [2.1.1] - 2026-01-05

### Fixed
- Compass HUD: minimap buttons from MBB (Minimap Button Bag) addon remaining clickable but invisible around the HUD ring
- Compass HUD: speed bar not visible (segments were rendering behind ring texture due to wrong draw layer)
- Database: added missing SetClusterRadius setter (previously only had getter)

### Improved
- Warband Bank auto-deposit: added protection against orphaned timer callbacks when bank is closed mid-deposit
- Session Tracker: reduced garbage collection by avoiding temporary table creation during initialization
- FrameFactory: extracted mail icon glow animation into reusable CreatePulsingGlowOverlay helper

---

## [2.1.0] - 2026-01-05

### Fixed
- Rare bug where addon minimap icons could remain visible/clickable on the Compass HUD ring (added 5-second delayed re-hide to catch slow-loading addon buttons)
- Total Looted display showing 0 (0/Hour) after /reload until first lumber loot (session data was preserved but runtime totals weren't recalculated on login)

### Changed
- All expansions now visible by default (including Midnight)
- Default max pins per map increased from 100 to 500 (preserves full map coverage)
- Default cluster radius increased from 0.5% to 1.5% (~15-30 yard grouping, reduces icon spam)
- World map pin pool increased from 50 to 200 pre-allocated frames
- Settings panel reorganized into 5 subcategories for easier navigation:
  - General: language, session tracker visibility, minimap button, transparency, glow color
  - Session & Timers: auto-pause, AH refresh timer settings, work complete sound
  - Goals: global target, expansion-specific targets, expansion visibility
  - Integrations: TSM, PSL, Warband Bank auto-deposit
  - Compass & Map: world map markers, compass HUD, speed bar settings
- Settings layout improvements: sliders positioned inline with labels, numeric inputs right-aligned with padding
- Settings panel header styling: larger addon title, aligned author info with logo

### Added
- Close button on inventory panel
- Expansion-specific lumber targets: override the global target for individual expansions
  - New "Expansion-Specific Targets" section in Settings below global target
  - Two-column grid showing all 12 expansions with numeric input fields
  - Leave input empty to use global target, enter a value (1-10000) to override
  - Each expansion's Target% column now calculates against its own effective target
  - Warband column coloring uses expansion-specific targets for accurate progress indication
  - Session tracker current expansion row uses expansion-specific target for coloring
  - Summary row averages Target% values with each expansion capped at 100% (prevents over-collection from inflating the total - e.g., 200% on one expansion counts as 100% in the average)
  - Tooltips show current global target value for reference
  - Fully localized (English and German)
- "Max Pins Per Map" slider in Location Tracking settings (0-1000 range)
- Setting to 0 enables unlimited pins (no automatic removal of old pins)
- "Looted N times" tooltip data now preserved long-term since pins merge rather than delete
- Comprehensive tooltips for all settings panel options explaining functionality, usage tips, and related features (reduces need for external documentation)

---

## [2.0.1] - 2026-01-04

### Fixed
- AH refresh timer no longer resets when clicking the session reset button (AH timer is now fully independent and only resets when the Auction House is closed)

### Improved
- Performance optimizations across multiple modules for smoother gameplay
  - Faster compass HUD updates with pre-cached speed bar colors
  - Reduced memory allocations when recording loot coordinates
  - Smarter session stats calculations (only recalculates when loot changes)
  - More efficient pin limit enforcement for map markers

---

## [2.0.0] - 2026-01-03

### Added
- Inventory panel summary row: "Total" row at bottom showing summed Bags/Warband/Craft counts and averaged Target%/Craft% across all visible expansions (respects expansion visibility settings, stays fixed regardless of column sorting)
- Mail indicator: pulsing icon next to local time display when you have unread mail
  - Shows sender names on hover (up to 3 senders via GetLatestThreeSenders API)
  - Event-driven (UPDATE_PENDING_MAIL) - no polling required
- Configurable glow color setting with 9 options (Cyan, Blue, Green, Yellow, Orange, Red, Purple, Pink, White)
  - Applies to both mail indicator and AH mount button timer glow
- Compass HUD speed bar: curved progress arc around the lava ring showing current movement speed
  - Red-orange-yellow-green gradient fill based on speed percentage
  - Scales from 0% to 1000% speed (covers dragonriding dives)
  - Dim outline visible when stationary, fills as you move faster
  - Configurable opacity slider in Location Tracking settings (default 70%)
  - Toggle on/off in settings

### Changed
- Toolbar icons replaced with custom-designed icons (lumber, map, AH mount, compass, warband bank)
- Header icons replaced with custom-designed icons (close, settings, play, pause, reset, mail) with matching style
- Toolbar buttons enlarged from 32x32 to 40x40 for better visibility
- All header icons standardized to 20x20 pixels with minor position tweaks for consistent alignment
- Speed display simplified to single line below Total Looted showing "Current Speed: [icon] X%" with tooltip for average speed and distance traveled
- Close button now has tooltip explaining how to reopen the window (/hlh or minimap icon)

### Fixed
- Speed tracking (average speed and distance) now only accumulates while session timer is running (pausing the session no longer inflates stats with non-farming movement)
- Steady flight speed now capped at API-reported maximum (fixes impossible 700%+ speeds from calibration drift, adapts automatically to mount changes; dragonriding speeds remain uncapped)
- Removed misleading "Resumed: Left Auction House" (and similar) feedback messages that displayed when closing AH/mailbox/menus even though the timer doesn't auto-resume (timer only resumes via play button or looting lumber)

---

## [1.0.9] - 2026-01-02

### Added
- Reload UI prompt when changing language in settings (offers to reload immediately or later)
- Local time display under expansion logo in session tracker (24-hour HH:MM format) - replaces hidden minimap clock when Compass HUD is active to prevent losing track of time while farming
- Speed tracking in session stats: current speed, average speed, and distance traveled (uses position-based calculation for accurate dragonriding/flight speeds, persists across logouts until reset)

### Changed
- Zone tracker header now shows full localized lumber name (e.g., "Coldwind Lumber") instead of shortened version (required for non-English locales where suffix stripping doesn't work)

### Fixed
- Integration warning in inventory panel now only appears when no crafting integration is working (previously showed misleading "PSL not installed" even when TSM was providing data)

### Improved
- Minor code quality and performance optimizations (reduced garbage generation, proper timer lifecycle management)

---

## [1.0.8] - 2026-01-01

### Added
- **Localization system**: UI strings can now be translated to other languages
  - Language dropdown in Settings (Auto/English/German)
  - German (deDE) translation included
  - Material names use WoW API for automatic localization based on game client language
  - Expansion names use WoW API for automatic localization based on game client language
  - Adding new languages requires only creating a locale file and adding to dropdown
- Instance auto-hide: Session tracker and Compass HUD automatically hide when entering dungeons, raids, battlegrounds, arenas, or scenarios, and restore when exiting (only restores frames that were visible before entry)
- Session timer automatically pauses in instanced content (new `pausedByInstance` flag)

### Changed
- Settings panel buttons now auto-size to fit translated text

### Fixed
- Warband Bank auto-deposit intermittently failing when opening bank (container data for warband tabs wasn't fully loaded yet, added 0.2s initialization delay)

---

## [1.0.7] - 2025-12-31

### Added
- ProfessionShoppingList (PSL) integration - tracks lumber requirements from PSL shopping lists alongside TSM crafting queue (combined totals shown in Craft column)
- Integrations section in settings panel grouping TSM and PSL toggles under a styled header
- Session auto-pause setting to control whether the timer pauses during AFK, Auction House, Mailbox, and menu access (enabled by default, disable to keep timer running during all activities)

### Changed
- World Map no longer pauses the session timer (commonly used during farming, was causing inaccurate lumber/hour stats)

### Fixed
- TSM crafting column taking ~20 seconds to update when clearing/repopulating TSM crafting queue (added fingerprint-based change detection for instant response)
- Screen stutter every 2 seconds when inventory panel is open (cached GetExpansionDisplayInfo API calls and item counts)
- "Error loading Utils/Profiler.lua" on addon load (removed development-only profiler from production build)
- Severe lag (2-second freezes + 50% CPU on loot) when TSM/PSL enabled with empty crafting queue (cache wasn't storing nil results, causing expensive database searches on every update cycle)

---

## [1.0.6] - 2025-12-30

### Added
- Compass HUD "Lock north to top" setting for players sensitive to motion (north stays up, player arrow rotates instead of map)
- Compass HUD refresh rate setting (15/20/30/45/60 FPS) to control how smoothly pins track your position while flying - higher values give smoother pin movement but use more CPU, default is 20 FPS (balanced)

### Fixed
- Compass HUD fighting WoW's layout system when restoring minimap (caused squished/off-screen minimap on high-resolution monitors)
- Minimap button now aligns with other addon buttons
- Inventory panel progress bars not updating when target lumber setting changes
- Inventory panel progress bars stuck at 120px instead of full column width (340px with TSM, 210px without)
- Compass HUD toggle causing minimap to enter Edit Mode state (blue selection highlight and "All Objectives" filter appearing)
- Inventory panel position not saving between reloads (now persists per-character like session window)

---

## [1.0.5] - 2025-12-28

### Fixed
- Reset button not clearing session lumber list

### Removed
- Legacy API fallback code for pre-TWW clients

---

## [1.0.4] - 2025-12-28

### Changed
- Compass HUD pins now limited to closest 20 (was 30) to reduce visual clutter
- Compass HUD update rate increased from 20 FPS to 30 FPS for smoother movement

### Fixed
- Compass pins jumping/stuttering when flying in a straight line (tick rate incorrectly dropped to 4 FPS)
- Eliminated memory allocation hotspots causing garbage collection stutter (ItemAPI caching, table reuse, CompassHUD position caching)
- Inventory panel column sorting now responds instantly (was delayed by 2-second throttle)
- World map pins now scale based on canvas size (fixes tiny/invisible pins on Shadowlands, Dragonflight, and continent maps)
- Compass HUD minimap terrain and icons now stay inside the lava ring border (was extending beyond ring edge)
- Warband Bank deposit now shows which items failed (was only showing count)

### Optimized
- Compass HUD pin calculations reduced by 97% using rotation matrix instead of per-pin trigonometry

---

## [1.0.3] - 2025-12-25

### Added
- Compass HUD now relocates minimap to screen center with transparent terrain
- Minimap rotates around player (arrow always points up)
- Custom red player arrow texture replaces default minimap arrow
- Lava/obsidian ring border around compass display
- Lumber pins now constrained to inner ring edge for cleaner visuals
- Inventory panel shows warning when TSM is enabled but addon not loaded
- HUD ring transparency slider in Location Tracking settings (0-100%, default 15%) with live value indicator

### Changed
- Compass ring radius reduced from 220 to 145 pixels (pins stay inside ring)
- Ring border opacity reduced to 15% for subtle effect

### Fixed
- AH mount button not working on non-English clients (was using English mount names instead of mount IDs)
- Warband Bank button not working on non-English clients (was using English spell name instead of localized name)
- Compass HUD now auto-disables when session tracker is closed (prevents losing minimap access)
- Warband Bank button visibility now properly syncs with session tracker (fixes rare orphaned icon)
- Major performance optimization: reduced CPU usage from 6-8% to <0.5% when idle
- Compass HUD now uses timer-based updates instead of OnUpdate (eliminates per-frame overhead)
- Compass pins update in-place instead of releasing/reacquiring every tick
- Session timer now stops when idle (frame hidden + session inactive)
- Reduced garbage generation by reusing tables instead of creating new ones
- Inventory panel now reuses pre-allocated tables instead of creating new ones each update
- Minimap button now positions on outer border edge (adapts to TWW's larger minimap size)

---

## [1.0.2] - 2025-12-23

### Fixed
- TSM crafting data intermittently showing "-" after /reload (was finding wrong TSM table)

---

## [1.0.1] - 2025-12-22

### Fixed
- Session timer not resuming when looting lumber after being paused (stale inventory baseline)
- Session timer not resuming after cycling through AH/Mail/Bank frames (stuck suppression flags)
- Map pins not recording when looting lumber while timer is paused

---

## [1.0.0] - 2025-12-22

### Added

#### Session Tracking
- Live session timer with lumber-per-hour statistics
- Auto-start when looting lumber
- Smart auto-pause when AFK, at mailbox, auction house, or in menus
- Per-character session persistence across logins
- Session looted lumber displayed in descending order by quantity

#### Current Zone Display
- Auto zone detection showing current expansion's lumber
- Live feedback with bag count, warband total, and TSM crafting needs
- Expansion logo with hover tooltip

#### Inventory Panel
- All 12 expansion lumber types in one view
- Bags vs. Warband total with color-coded progress (red to green gradient)
- Sortable columns (click headers to sort)
- Visual ember progress bars under each row
- Goal percentages showing progress toward target lumber threshold
- TSM queue tracking across all professions

#### Loot Map Markers
- Automatic recording of loot positions when gathering lumber
- World map pins with smart clustering for repeated nodes
- Hover tooltips showing "Looted N times" for each location
- Configurable pin limit per map (default 100)

#### Compass HUD
- Screen-center overlay showing nearby loot locations
- Pins rotate based on player facing direction
- Distance indicator - closer pins appear larger and move toward center
- Auto-hides when opening map, bank, auction house, or other major frames
- Toggle via toolbar button

#### Warband Bank Auto-Deposit
- Automatically deposits lumber when opening any bank
- Scans all bags including reagent bag
- Sequential processing with slot collision prevention
- Status messages showing deposit results

#### Auction House Timer
- Tracks time since last AH visit
- Visual color gradient (green to red) as time passes
- Configurable warning threshold (1-1440 minutes)
- Optional sound alerts with 7 different sound options
- One-shot sound trigger when threshold reached

#### Toolbar
- Quick access buttons for inventory panel, zone map, AH mount, compass, and Warband Bank spell
- AH mount button with animated glow when timer threshold reached
- Warband Bank button with cooldown display
- Buttons show checked state when active

#### TSM Integration
- Reads TradeSkillMaster crafting queue
- Shows lumber needed for queued crafts in inventory panel
- Craft% column showing progress toward crafting goals
- Auto-disables gracefully if TSM errors occur

#### Work Complete Sound
- Audio notification when farming goal is reached
- Prioritizes TSM crafting goal over target lumber goal
- Zone-based tracking for current expansion's lumber

#### Quality of Life
- Minimap button for quick access (left-click toggle, right-click settings)
- Draggable frame with position persistence
- Configurable transparency (20% - 100%)
- Expansion visibility toggles in settings
- Target lumber goal setting (0 - 10,000)

#### Slash Commands
- `/hlh` - Toggle session tracker
- `/hlh settings` - Open settings panel
- `/hlh reset` - Reset window position
- `/hlh hud` - Toggle compass HUD overlay
- `/hlh help` - Show available commands