# EU-Utility Plugins

Complete documentation for all 26 built-in plugins in EU-Utility.

---

## Table of Contents

- [Dashboard & Utility](#dashboard--utility)
- [Search & Information](#search--information)
- [Calculators](#calculators)
- [Trackers](#trackers)
- [Game Integration](#game-integration)
- [External Integration](#external-integration)

---

## Dashboard & Utility

### Dashboard

**Purpose:** Customizable start page with avatar statistics

| Attribute | Value |
|-----------|-------|
| **Name** | Dashboard |
| **Version** | 2.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+Home` |

**Features:**
- PED Balance widget
- Skills Tracked count
- Inventory Items count
- Current DPP display
- Today's Skill Gains
- Professions count
- Active Missions count
- Codex Progress
- Globals/HOFs counter
- Session Time tracker

**Usage:**
1. Press `Ctrl+Shift+Home` to open Dashboard
2. Click **Customize** to enable/disable widgets
3. Arrange widgets to your preference
4. Click **Save** to persist layout

**Available Widgets:**
| Widget | Description |
|--------|-------------|
| PED Balance | Total TT value from inventory |
| Skills Tracked | Number of monitored skills |
| Inventory Items | Total item count |
| Current DPP | Last calculated DPP |
| Today's Skill Gains | Gains in last 24h |
| Professions | Tracked profession count |
| Active Missions | Current mission count |
| Codex Progress | Creatures tracked |
| Globals/HOFs | Today's globals counter |
| Session Time | Play time today |

---

### Calculator

**Purpose:** Standard calculator for quick math

| Attribute | Value |
|-----------|-------|
| **Name** | Calculator |
| **Version** | 1.1.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+C` |

**Features:**
- Basic arithmetic operations
- Clear and backspace functions
- Copy result to clipboard
- Keyboard input support

**Usage:**
- Press `Ctrl+Shift+C` to open
- Use on-screen buttons or keyboard
- Results auto-copy to clipboard

---

### Settings

**Purpose:** Configure EU-Utility preferences

| Attribute | Value |
|-----------|-------|
| **Name** | Settings |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+,` |

**Features:**
- **General Settings:**
  - Theme selection (Dark/Light)
  - Overlay opacity (50-100%)
  - Icon size
  - Start with Windows
  - Minimize to tray
  - Show tooltips

- **Plugin Management:**
  - Enable/disable plugins
  - Plugin info display
  - Version checking

- **Hotkeys:**
  - Customize global hotkeys
  - Reset to defaults
  - Conflict detection

- **Data Management:**
  - Export all data
  - Import from backup
  - Clear all data
  - Set retention days

**Usage:**
1. Press `Ctrl+Shift+,` to open Settings
2. Navigate to desired tab
3. Make changes
4. Click **Save Settings**

---

### Plugin Store

**Purpose:** Community plugin marketplace

| Attribute | Value |
|-----------|-------|
| **Name** | Plugin Store |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | - |

**Features:**
- Browse available plugins
- One-click installation
- Auto-updates
- Plugin ratings and reviews
- Author information

**Usage:**
1. Open Plugin Store from Dashboard
2. Browse or search for plugins
3. Click **Install** to add
4. Restart EU-Utility to load

---

## Search & Information

### Universal Search

**Purpose:** Search all Entropia Nexus entities

| Attribute | Value |
|-----------|-------|
| **Name** | Universal Search |
| **Version** | 2.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+F` |

**Features:**
- Search across all entity types
- Filter by category
- Quick results preview
- Direct links to Nexus
- Recent searches history

**Searchable Types:**
- Items, Weapons, Armors
- Mobs, Pets
- Blueprints, Materials
- Locations, Teleporters
- Shops, Vendors
- Planets, Areas
- Skills
- Enhancers, Medical Tools
- Finders, Excavators
- Vehicles, Decorations

**Usage:**
1. Press `Ctrl+Shift+F`
2. Select search mode
3. Enter search term
4. Double-click result to open on Nexus

---

### Nexus Search

**Purpose:** Search items and market data via Nexus API

| Attribute | Value |
|-----------|-------|
| **Name** | EntropiaNexus |
| **Version** | 1.1.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+N` |

**Features:**
- Real-time market data
- Item details
- Price history
- Buy/sell orders
- Exchange rates

**Tabs:**
- **Market:** Current exchange items and prices
- **Search:** Find specific items
- **Details:** Item statistics and info

**Usage:**
1. Press `Ctrl+Shift+N`
2. Search for item or browse categories
3. View market data and prices
4. Double-click to open on Nexus website

---

### TP Runner

**Purpose:** Teleporter locations and route planner

| Attribute | Value |
|-----------|-------|
| **Name** | TP Runner |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | - |

**Features:**
- Teleporter database
- Route planning
- Distance calculation
- Planet filtering
- Favorite locations

**Usage:**
1. Open TP Runner
2. Select start and destination
3. View suggested routes
4. Save frequently used routes

---

## Calculators

### DPP Calculator

**Purpose:** Calculate Damage Per PEC and weapon efficiency

| Attribute | Value |
|-----------|-------|
| **Name** | DPP Calculator |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+D` |

**Formula:**
```
DPP = Damage / ((Ammo/100) + Decay)
Efficiency = (DPP / 4.0) * 100%
```

**Inputs:**
- Weapon Damage
- Ammo per shot
- Weapon Decay (PEC)
- Amp Damage (optional)
- Amp Decay (optional)

**Efficiency Scale:**
| DPP | Efficiency | Rating |
|-----|------------|--------|
| 4.0+ | 100%+ | Excellent |
| 3.5-4.0 | 85-95% | Very Good |
| 3.0-3.5 | 75-85% | Good |
| 2.5-3.0 | 60-75% | Average |
| < 2.5 | < 60% | Poor |

**Features:**
- Real-time calculation
- Save weapon setups
- Compare setups side-by-side
- Efficiency rating display

**Usage:**
1. Press `Ctrl+Shift+D`
2. Enter weapon stats
3. Click **Calculate**
4. View DPP and efficiency

---

### Crafting Calculator

**Purpose:** Calculate crafting success rates and material costs

| Attribute | Value |
|-----------|-------|
| **Name** | Crafting Calc |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+B` |

**Features:**
- Blueprint database
- Material cost calculation
- Success rate estimation
- QR (Quality Rating) input
- Click count planning
- Cost per success

**Inputs:**
- Blueprint Category
- Blueprint Selection
- Quality Rating (QR)
- Number of Clicks

**Outputs:**
- Expected success rate
- Total material costs
- Cost per successful click
- Estimated TT value

**Usage:**
1. Press `Ctrl+Shift+B`
2. Select blueprint category
3. Choose specific blueprint
4. Enter QR and clicks
5. Click **Calculate**

---

### Enhancer Calculator

**Purpose:** Calculate enhancer break rates and costs

| Attribute | Value |
|-----------|-------|
| **Name** | Enhancer Calc |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+E` |

**Enhancer Types:**
- Accuracy Enhancer
- Damage Enhancer
- Economy Enhancer
- Range Enhancer
- Skill Enhancer

**Inputs:**
- Enhancer Type
- TT Value of Enhancer
- Shots per hour

**Outputs:**
- Expected break rate
- Hourly cost
- Cost per shot
- Break interval estimate

**Usage:**
1. Press `Ctrl+Shift+E`
2. Select enhancer type
3. Enter TT value and usage rate
4. Click **Calculate**

---

## Trackers

### Loot Tracker

**Purpose:** Track hunting loot with statistics and ROI analysis

| Attribute | Value |
|-----------|-------|
| **Name** | Loot Tracker |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+L` |

**Features:**
- Session-based tracking
- Automatic loot detection
- ROI calculation
- Historical data
- Export to CSV

**Statistics:**
- Total kills
- TT value looted
- Ammo spent
- Weapon decay
- Net profit/loss
- ROI percentage

**Usage:**
1. Press `Ctrl+Shift+L`
2. Click **Start Session**
3. Hunt normally
4. Click **Stop Session** when done
5. View statistics

**Data Persistence:**
- Sessions saved to `data/loot_tracker.json`
- View all historical sessions
- Compare session performance

---

### Skill Scanner

**Purpose:** OCR-based skill tracking

| Attribute | Value |
|-----------|-------|
| **Name** | Skill Scanner |
| **Version** | 2.1.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+S` |

**Features:**
- OCR skill window scanning
- Track skill gains over time
- Progress to next level
- Historical skill data
- Skill gain notifications

**Usage:**
1. Open Skills window in-game
2. Press `Ctrl+Shift+S`
3. Click **Scan Skills Window**
4. View scanned skills

**Requirements:**
- EasyOCR installed (`pip install easyocr`)
- Skills window visible on screen
- Good game brightness

---

### Codex Tracker

**Purpose:** Track creature challenges and codex progress

| Attribute | Value |
|-----------|-------|
| **Name** | Codex Tracker |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+X` |

**Features:**
- Creature database
- Current rank display
- Progress tracking
- Kills to next rank
- Reward preview
- OCR codex scanning

**Usage:**
1. Press `Ctrl+Shift+X`
2. Add creatures to track
3. Update progress manually or via OCR
4. View completion estimates

---

### Mission Tracker

**Purpose:** Track missions, challenges, and objectives

| Attribute | Value |
|-----------|-------|
| **Name** | Mission Tracker |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | - |

**Features:**
- Mission list management
- Progress bars
- Completion tracking
- Mission categories
- Time tracking
- Reward notes

**Usage:**
1. Open Mission Tracker
2. Click **Add Mission**
3. Enter mission details
4. Update progress as you complete objectives

---

### Global Tracker

**Purpose:** Track globals, HOFs, and ATHs

| Attribute | Value |
|-----------|-------|
| **Name** | Global Tracker |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | - |

**Features:**
- Auto-detect globals from chat
- HOF and ATH tracking
- Value statistics
- History log
- Personal bests

**Usage:**
1. Enable Global Tracker
2. It automatically monitors chat
3. View statistics and history
4. Get notifications on new globals

---

### Mining Helper

**Purpose:** Track mining finds, claims, and hotspot locations

| Attribute | Value |
|-----------|-------|
| **Name** | Mining Helper |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | - |

**Features:**
- Claim logging
- Hit rate calculation
- Resource type tracking
- Location notes
- TT value estimation
- Claim depth recording

**Usage:**
1. Open Mining Helper
2. Click **Add Claim** when you find resources
3. Enter claim details
4. View statistics and hotspots

---

### Auction Tracker

**Purpose:** Track auction prices and markups

| Attribute | Value |
|-----------|-------|
| **Name** | Auction Tracker |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | - |

**Features:**
- Item price tracking
- Markup calculation
- Historical trends
- Price alerts
- Export data

**Usage:**
1. Open Auction Tracker
2. Search for items
3. Add to watchlist
4. Track price changes over time

---

### Inventory Manager

**Purpose:** Track items, TT value, and weight

| Attribute | Value |
|-----------|-------|
| **Name** | Inventory |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | - |

**Features:**
- Item catalog
- TT value tracking
- Weight calculation
- Category filtering
- Value statistics
- Export inventory

**Usage:**
1. Open Inventory Manager
2. Add items manually or via OCR
3. View total TT value
4. Manage item categories

---

### Profession Scanner

**Purpose:** Track profession ranks and progress

| Attribute | Value |
|-----------|-------|
| **Name** | Profession Scanner |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | - |

**Features:**
- Profession list
- Rank tracking
- Progress to next rank
- Skill requirements
- Standings comparison

**Usage:**
1. Open Profession Scanner
2. Scan professions window
3. Track progress over time

---

## Game Integration

### Game Reader

**Purpose:** OCR scanner for in-game menus and text

| Attribute | Value |
|-----------|-------|
| **Name** | Game Reader |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+R` |

**Features:**
- Screen capture with OCR
- Text extraction
- Copy to clipboard
- Save screenshots
- Region selection

**Common Uses:**
- Read NPC dialogue
- Capture mission text
- Extract item stats
- Read shop prices
- Copy coordinates

**Usage:**
1. Open menu in Entropia Universe
2. Press `Ctrl+Shift+R`
3. Click **Capture Screen**
4. View extracted text
5. Click **Copy Text** to copy

**Requirements:**
- EasyOCR installed
- Game window visible

---

### Chat Logger

**Purpose:** Log, search, and filter chat messages

| Attribute | Value |
|-----------|-------|
| **Name** | Chat Logger |
| **Version** | 1.0.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | - |

**Features:**
- Real-time chat logging
- Channel filtering (Main, Team, Society, etc.)
- Search functionality
- Export logs
- Custom alerts

**Usage:**
1. Enable Chat Logger
2. Select channels to monitor
3. Search historical messages
4. Set up keyword alerts

---

### Event Bus Example

**Purpose:** Demonstrates Enhanced Event Bus features

| Attribute | Value |
|-----------|-------|
| **Name** | Event Bus Example |
| **Version** | 1.0.0 |
| **Author** | EU-Utility |
| **Hotkey** | - |

**Features:**
- Example event publishing
- Subscription demonstrations
- Event filtering examples
- Event statistics display

**Usage:**
1. Open Event Bus Example
2. View real-time events
3. Test event publishing
4. Learn event system patterns

---

## External Integration

### Spotify Controller

**Purpose:** Control Spotify and view current track info

| Attribute | Value |
|-----------|-------|
| **Name** | Spotify |
| **Version** | 1.1.0 |
| **Author** | ImpulsiveFPS |
| **Hotkey** | `Ctrl+Shift+M` |

**Features:**
- Play/Pause control
- Next/Previous track
- Volume adjustment
- Current track display
- Album artwork

**Requirements:**
- Spotify desktop app running
- Windows: No additional requirements
- Linux: `playerctl` installed (`sudo apt install playerctl`)

**Usage:**
1. Start Spotify and play music
2. Press `Ctrl+Shift+M`
3. Use controls to manage playback

---

## Creating Custom Plugins

Want to create your own plugin? See the [Plugin Development Guide](./docs/PLUGIN_DEVELOPMENT_GUIDE.md) for complete documentation.

### Quick Start Template

```python
from plugins.base_plugin import BasePlugin
from PyQt6.QtWidgets import QWidget, QVBoxLayout, QLabel

class MyPlugin(BasePlugin):
    """My custom EU-Utility plugin."""
    
    name = "My Plugin"
    version = "1.0.0"
    author = "Your Name"
    description = "What my plugin does"
    hotkey = "ctrl+shift+y"
    
    def initialize(self):
        """Called when plugin is loaded."""
        self.config = self.load_data("config", {})
    
    def get_ui(self):
        """Return the plugin's UI widget."""
        widget = QWidget()
        layout = QVBoxLayout(widget)
        
        label = QLabel(f"Hello from {self.name}!")
        layout.addWidget(label)
        
        return widget
    
    def shutdown(self):
        """Called when app closes."""
        self.save_data("config", self.config)
```

---

## Plugin Support

For plugin-related issues:

1. Check plugin documentation
2. Review [TROUBLESHOOTING.md](./TROUBLESHOOTING.md)
3. Check plugin logs in `data/logs/`
4. Report issues on GitHub

---

*Last Updated: 2025-02-14*