147 lines
3.4 KiB
Markdown
147 lines
3.4 KiB
Markdown
# EU-Utility Plugins Repository
|
|
|
|
Official plugin repository for EU-Utility - the Entropia Universe addon framework.
|
|
|
|
## About
|
|
|
|
This repository contains plugins that extend EU-Utility's functionality. The core EU-Utility application is a framework-only addon loader - all user-facing features come from plugins.
|
|
|
|
## Plugin Categories
|
|
|
|
### Tools
|
|
- **Calculator** - PED/PEC calculations, DPP, markup
|
|
- **Crafting Calculator** - Crafting success rates and profit
|
|
- **Enhancer Calculator** - Break rate and cost analysis
|
|
- **DPP Calculator** - Advanced weapon efficiency
|
|
- **Universal Search** - Quick search across all plugins
|
|
|
|
### Tracking
|
|
- **Skill Scanner** - OCR-based skill tracking
|
|
- **Loot Tracker** - Real-time loot tracking
|
|
- **Mining Helper** - Mining claim tracking
|
|
- **Mission Tracker** - Mission progress
|
|
- **Codex Tracker** - Mob codex progress
|
|
- **Global Tracker** - Globals and HOFs
|
|
|
|
### Information
|
|
- **Nexus Search** - Entropia Nexus database
|
|
- **Dashboard** - Overview and stats
|
|
- **Chat Logger** - Advanced chat logging
|
|
|
|
### Market
|
|
- **Auction Tracker** - Price tracking and alerts
|
|
- **Inventory Manager** - Item management
|
|
|
|
### Analytics
|
|
- **Analytics** - Charts and visualizations
|
|
|
|
### Media
|
|
- **Spotify Controller** - Music control
|
|
|
|
### Social
|
|
- **Discord Presence** - Rich Discord status
|
|
|
|
### Navigation
|
|
- **TP Runner** - Teleport helper
|
|
|
|
### Data
|
|
- **Import/Export** - Backup and restore
|
|
|
|
## For Developers
|
|
|
|
### Plugin Structure
|
|
```
|
|
plugins/your_plugin/
|
|
├── __init__.py
|
|
└── plugin.py
|
|
```
|
|
|
|
### Minimum Requirements
|
|
```python
|
|
from plugins.base_plugin import BasePlugin
|
|
|
|
class YourPlugin(BasePlugin):
|
|
name = "Your Plugin"
|
|
version = "1.0.0"
|
|
author = "Your Name"
|
|
description = "What your plugin does"
|
|
|
|
def initialize(self):
|
|
# Setup code
|
|
pass
|
|
|
|
def get_ui(self):
|
|
# Return QWidget for UI
|
|
return QWidget()
|
|
```
|
|
|
|
### Adding to Repository
|
|
|
|
1. Create your plugin folder in `plugins/`
|
|
2. Add entry to `manifest.json`
|
|
3. Submit pull request
|
|
|
|
### Manifest Format
|
|
```json
|
|
{
|
|
"id": "your_plugin",
|
|
"name": "Your Plugin",
|
|
"version": "1.0.0",
|
|
"author": "Your Name",
|
|
"description": "Description",
|
|
"folder": "plugins/your_plugin/",
|
|
"icon": "icon_name",
|
|
"tags": ["tag1", "tag2"],
|
|
"dependencies": {
|
|
"core": ["ocr", "log"],
|
|
"plugins": ["other_plugin"]
|
|
},
|
|
"min_core_version": "2.0.0",
|
|
"category": "Tools"
|
|
}
|
|
```
|
|
|
|
## Installation
|
|
|
|
Plugins are installed through the EU-Utility Plugin Store:
|
|
1. Open EU-Utility Settings
|
|
2. Go to Plugin Store tab
|
|
3. Browse and install plugins
|
|
|
|
Or manually:
|
|
1. Clone this repository
|
|
2. Copy plugin folder to EU-Utility's `plugins/` directory
|
|
3. Restart EU-Utility
|
|
|
|
## Core Services Available
|
|
|
|
Plugins can access these core services via PluginAPI:
|
|
|
|
- **OCR** - Screen text recognition
|
|
- **Log Reader** - chat.log parsing
|
|
- **Nexus API** - Entropia Nexus database
|
|
- **Data Store** - Persistent storage
|
|
- **HTTP Client** - Network requests
|
|
- **Window Manager** - Game window detection
|
|
- **Screenshot** - Screen capture
|
|
- **Audio** - Sound playback
|
|
- **Notifications** - Toast notifications
|
|
- **Clipboard** - Copy/paste
|
|
|
|
## License
|
|
|
|
All plugins in this repository are released under MIT License.
|
|
|
|
## Contributing
|
|
|
|
1. Fork this repository
|
|
2. Create your plugin
|
|
3. Test thoroughly
|
|
4. Submit pull request
|
|
|
|
## Support
|
|
|
|
- Issues: Open issue on Gitea
|
|
- Discord: EU-Utility Discord server
|
|
- Documentation: See EU-Utility core docs
|