EU-Utility/docs/FEATURE_PACK.md

271 lines
7.4 KiB
Markdown

# EU-Utility Feature Pack
Three high-value plugins for EU-Utility that enhance your Entropia Universe gameplay experience.
## 📦 Features Included
1. **Session Exporter** - Export hunting/mining sessions to CSV/JSON
2. **Price Alerts** - Monitor Nexus API prices with smart alerts
3. **Auto-Screenshot** - Capture screenshots on Global/HOF automatically
---
## 📊 Session Exporter
Automatically track and export your hunting, mining, or crafting sessions.
### Features
- **Automatic Tracking**: Captures loot, skills, globals, and HOFs in real-time
- **Export Formats**: CSV for spreadsheets, JSON for advanced analysis
- **Session Statistics**: Track totals, unique items, damage dealt/received
- **Auto-Export**: Automatically save sessions at configurable intervals
- **Hotkey Support**: `Ctrl+Shift+E` to start/stop sessions
### Usage
1. Open the overlay and navigate to "Session Exporter"
2. Click "Start New" to begin tracking (or use hotkey)
3. Play normally - all events are captured automatically
4. Click "Export CSV" or "Export JSON" when done
5. Files are saved to `Documents/EU-Sessions/` by default
### Data Captured
| Event Type | Data Captured |
|------------|---------------|
| Loot | Mob name, items received, TT value, position |
| Skill Gain | Skill name, new value, gain amount |
| Global/HOF | Player name, achievement type, value, item |
| Damage | Amount dealt/received (in session stats) |
### File Formats
**JSON Export:**
```json
{
"export_info": {
"version": "1.0.0",
"exported_at": "2025-02-14T10:30:00"
},
"session": {
"start_time": "2025-02-14T09:00:00",
"summary": { "total_loot_tt": 150.50, ... },
"entries": [...]
}
}
```
**CSV Export:**
```csv
timestamp,event_type,description,value,details
2025-02-14T09:05:00,Loot,"From Daikiba: Animal Oil",0.05,{...}
2025-02-14T09:10:00,Skill,"Rifle +0.01",0.01,{...}
```
---
## 🔔 Price Alerts
Monitor Entropia Nexus market prices and get notified when items hit your targets.
### Features
- **Smart Monitoring**: Check prices at configurable intervals (1-60 minutes)
- **Flexible Alerts**: Set "below" alerts for buying, "above" for selling
- **Nexus Integration**: Direct API access to real-time market data
- **Price History**: Track price trends over time
- **Notifications**: Visual + sound alerts when conditions are met
- **Hotkey Support**: `Ctrl+Shift+P` to trigger manual price check
### Usage
1. Open "Price Alerts" from the overlay
2. Search for items using the search tab
3. Click "+ Alert" next to an item
4. Set condition (Price Below/Above) and target percentage
5. Wait for notifications when prices hit your targets!
### Alert Types
| Type | Use Case | Example |
|------|----------|---------|
| **Below** | Buy opportunities | Alert when ArMatrix LP-35 drops below 120% |
| **Above** | Sell opportunities | Alert when your loot rises above 150% |
### Settings
- **Check Interval**: How often to query Nexus API (default: 5 minutes)
- **Notifications**: Toast notifications on price triggers
- **Sound**: Audio alert when conditions are met
- **History**: Keep 7 days of price history for trend analysis
### Tips
- Set alerts for items you frequently buy/sell
- Use "below" alerts to stock up when prices dip
- Use "above" alerts to know when to sell your loot
- Check the status bar for next scheduled price check
---
## 📸 Auto-Screenshot
Never miss capturing your big wins! Automatically takes screenshots on Global, HOF, and more.
### Features
- **Event Detection**: Global, HOF, ATH, Discovery, high-value loot, skill gains
- **Smart Delay**: Configurable delay to hide overlay before capture
- **Custom Naming**: Filename patterns with variables
- **Organized Storage**: Automatic folder creation by event type
- **Notifications**: Optional sound and visual confirmation
- **Hotkey Support**: `Ctrl+Shift+C` for manual screenshot
### Usage
1. Enable "Auto-Screenshot" in the plugin settings
2. Configure which events trigger screenshots
3. Set your preferred save location
4. Play normally - screenshots are captured automatically!
### Capture Rules
| Rule | Trigger | Default |
|------|---------|---------|
| **Global** | Any global announcement | ✅ Enabled |
| **HOF** | Hall of Fame (50+ PED) | ✅ Enabled |
| **ATH** | All-Time High | ✅ Enabled |
| **Discovery** | New discovery announced | ✅ Enabled |
| **High Loot** | Loot above threshold | ❌ Disabled |
| **Skill Gain** | Large skill gains | ❌ Disabled |
### Filename Patterns
Use variables to customize screenshot names:
```
{timestamp} - Date/time (20250214_143022)
{event_type} - Type of event (GLOBAL, HOF, ATH)
{player} - Player name
{value} - PED value
```
**Examples:**
- `{event_type}_{timestamp}``HOF_20250214_143022.png`
- `{player}_{event_type}_{value}``PlayerName_GLOBAL_150PED.png`
### Settings
- **Capture Delay**: Time to hide overlay before capture (0-5000ms)
- **Save Location**: Default is `Documents/Entropia Universe/Screenshots/Globals/`
- **Play Sound**: Audio confirmation on capture
- **Show Notification**: Visual confirmation with filename
### Manual Capture
Press `Ctrl+Shift+C` at any time to take a manual screenshot.
---
## 🔧 Installation
1. Copy the three plugin folders to `EU-Utility/plugins/`:
```
plugins/
├── session_exporter/
│ ├── __init__.py
│ └── plugin.py
├── price_alerts/
│ ├── __init__.py
│ └── plugin.py
└── auto_screenshot/
├── __init__.py
└── plugin.py
```
2. Restart EU-Utility
3. The plugins will appear in your overlay automatically
---
## ⌨️ Hotkeys
| Plugin | Hotkey | Action |
|--------|--------|--------|
| Session Exporter | `Ctrl+Shift+E` | Start/Stop session |
| Price Alerts | `Ctrl+Shift+P` | Check prices now |
| Auto-Screenshot | `Ctrl+Shift+C` | Manual screenshot |
---
## 📝 Data Storage
All plugins use the EU-Utility DataStore for persistent storage:
- **Session Exporter**: `data/plugins/session_exporter.json`
- **Price Alerts**: `data/plugins/price_alerts.json`
- **Auto-Screenshot**: `data/plugins/auto_screenshot.json`
---
## 🐛 Troubleshooting
### Session Exporter
**Q: No events are being captured**
- Ensure EU chat.log is being written
- Check that the session is started (green status)
**Q: Export fails**
- Verify the export directory exists and is writable
- Check available disk space
### Price Alerts
**Q: Prices not updating**
- Check internet connection
- Verify Nexus API is accessible
- Try manual refresh with hotkey
**Q: Alerts not triggering**
- Ensure alert is enabled (checkmark in table)
- Verify current price is available
- Check notification settings
### Auto-Screenshot
**Q: Screenshots not being taken**
- Enable the plugin (master toggle)
- Verify capture rules are enabled
- Check save directory permissions
**Q: Overlay appears in screenshots**
- Increase capture delay (500-1000ms recommended)
---
## 🔗 API Integration
These plugins use the following EU-Utility core services:
- **Event Bus**: For real-time game event capture
- **Nexus API**: For market price data
- **Screenshot Service**: For screen capture
- **DataStore**: For persistent settings
- **Notification Service**: For user alerts
---
## 📄 License
Part of EU-Utility - Entropia Universe Tool Suite
---
## 🙏 Credits
Developed for EU-Utility by the Feature Developer Agent
Data provided by [Entropia Nexus](https://entropianexus.com)