LumberJack

*LumberJack v1.0 - Your reliable lumber tracking companion*

# LumberJack User Guide

## Overview
LumberJack is a World of Warcraft addon that tracks lumber quantities in your bags and notifies you when target quantities are reached.

## Installation
1. Extract the LumberJack folder to your WoW AddOns directory
2. Restart World of Warcraft or reload the UI (`/reload`)
3. Enable the addon in the AddOn list if needed

## Getting Started

### Accessing LumberJack
- **Configuration Panel**: Right-click the minimap icon or use `/lj config`
- **Quick Status**: Left-click the minimap icon or use `/lj`
- **Chat Commands**: All commands start with `/lj` (case-insensitive)

### Default Lumber Types
LumberJack tracks these lumber types by default:
- **Ironwood** (Classic)
- **Olemba** (Outland) 
- **Coldwind** (Northrend)
- **Ashwood** (Cataclysm)
- **Bamboo** (Pandaria)
- **Shadowmoon** (Draenor)
- **Fel-Touched** (LEGION)
- **Darkpine** (BFA)
- **Arden** (Shadowlands)
- **Dragonpine** (Dragonflight)
- **Dornic Fir** (Khaz Algar)

## Configuration

### Lumber Targets
Set target quantities for each lumber type:
1. Open configuration: `/lj config` or right-click minimap icon
2. Expand "Lumber Targets" section
3. Enter target numbers for each lumber type
4. **Press Okay** after setting each target to save it
5. Changes are saved automatically and shared across all characters

### Set All Targets
Quickly set all lumber targets to the same value:
1. In configuration panel, expand "Set All Targets"
2. Enter a number in the input field
3. Click "Apply to All"
4. All lumber targets will be set to that value

### Notifications
Control how and when notifications appear:

#### Notification Settings
- **Enable Notifications**: Turn notifications on/off
- **Duration**: How long notifications stay visible (1-30 seconds, default: 15)
- **Auto-Hide**: Automatically hide notifications after duration
- **Show Minimap Icon**: Toggle minimap button visibility

#### Notification Appearance
- **Box Width/Height**: Resize notification boxes (default: 209x30)
- **Background Color**: Change notification background (default: black with transparency)
- **Border Color**: Change notification border (default: orange)
- **Text Color**: Change notification text (default: yellow)
- **Preview**: Test your notification settings

#### Notification Position
Notifications appear at your specified position:
- **Draggable**: Click and drag notifications to reposition
- **Position Saved**: New positions are automatically saved

## Chat Commands

### Basic Commands
- `/lj` - Show current lumber status
- `/lj config` - Open configuration panel
- `/lj toggle` - Enable/disable notifications
- `/lj status` - Show lumber status
- `/lj reset` - Reset all targets to defaults

### Command Examples
```
/lj                    # Show lumber in bags
/lj config              # Open settings
/lj toggle             # Turn notifications on/off
/lj reset              # Reset targets to defaults
```

## How It Works

### Automatic Scanning
LumberJack automatically scans:
- **Inventory Bags**: All character bags (0-4) and the reagent bag
- **Bank Bags**: Bank slots when bank is open
- **Guild Bank**: Guild bank when accessible

### Notifications
When you reach a lumber target:
- **Notification Appears**: Shows lumber type and current count
- **Visual Indicator**: Checkmark (✓) when target is reached
- **Auto-Hide**: Disappears after set duration (if enabled)
- **Manual Close**: Right-click to dismiss immediately

### Data Persistence
- **Shared Storage**: All characters share the same lumber targets
- **Automatic Saving**: Changes are saved immediately
- **Cross-Character**: Settings apply to all your characters
- **No Profile Conflicts**: Uses clean SavedVariables structure

## Tips and Tricks

### Efficient Usage
1. **Set Realistic Targets**: Base targets on your actual needs
2. **Use Status Command**: Quick check before farming sessions
3. **Adjust Duration**: Set notification duration for your play style
4. **Position Notifications**: Place them where you'll notice them
5. **Use Set All**: Quickly update multiple targets at once

### Troubleshooting
- **No Notifications**: Check if notifications are enabled in settings
- **Wrong Position**: Drag notifications to preferred location
- **Missing Lumber**: Ensure lumber is in bags/bank
- **Settings Not Saving**: Be sure to click Okay after individual targets are modified

## Technical Details

### SavedVariables
- **LumberJack_Options**: Character-specific settings (notifications, appearance, position)
- **LumberJack_Targets**: Shared lumber targets (all characters, account-wide)

### Dependencies
- **Ace3**: Framework for configuration and data management
- **LibDataBroker-1.1**: Minap icon support
- **LibDBIcon-1.0**: Minimap icon functionality

## Version History
- **Version 1.0**: Initial release with core functionality
- **Compatible with**: World of Warcraft 11.2.7 (War Within)

## Support
For issues or suggestions, please contact the addon author.