303 lines
8.8 KiB
Markdown
303 lines
8.8 KiB
Markdown
# EU-Utility Frequently Asked Questions (FAQ)
|
|
|
|
**Last Updated:** 2026-02-14
|
|
**Version:** 2.1.0
|
|
|
|
---
|
|
|
|
## General Questions
|
|
|
|
### Q: What is EU-Utility?
|
|
**A:** EU-Utility is a comprehensive overlay utility for Entropia Universe players. It provides quick access to calculators, trackers, search tools, and integrations without leaving the game. Features include loot tracking, skill scanning, price alerts, Discord presence, and much more.
|
|
|
|
### Q: Is EU-Utility free?
|
|
**A:** Yes, EU-Utility is completely free and open source under the MIT License.
|
|
|
|
### Q: Is EU-Utility safe to use?
|
|
**A:** Yes. EU-Utility:
|
|
- Only reads game logs and screen (no game memory access)
|
|
- Stores all data locally on your machine
|
|
- Is an overlay (doesn't modify game files)
|
|
- Follows Entropia Universe's terms of service guidelines
|
|
- All code is open source and auditable
|
|
|
|
### Q: Does EU-Utility work on all platforms?
|
|
**A:** EU-Utility works best on Windows 10/11. Linux support is partial (some features like window management may not work). macOS is not officially supported but may work with modifications.
|
|
|
|
---
|
|
|
|
## Installation & Setup
|
|
|
|
### Q: How do I install EU-Utility?
|
|
**A:**
|
|
1. Install Python 3.11 or higher
|
|
2. Clone the repository: `git clone https://github.com/ImpulsiveFPS/EU-Utility.git`
|
|
3. Install dependencies: `pip install -r requirements.txt`
|
|
4. Run: `python -m core.main`
|
|
|
|
### Q: What are the system requirements?
|
|
**A:**
|
|
- **OS:** Windows 10/11 (recommended), Linux (partial support)
|
|
- **Python:** 3.11 or higher
|
|
- **RAM:** 4GB minimum, 8GB recommended
|
|
- **Storage:** 500MB free space
|
|
- **Internet:** Required for Nexus API and updates
|
|
|
|
### Q: Do I need Administrator privileges?
|
|
**A:** Not for basic operation, but:
|
|
- **Required for:** Global hotkeys to work in all windows
|
|
- **Recommended for:** Best compatibility with game detection
|
|
|
|
### Q: Can I use EU-Utility with multiple monitors?
|
|
**A:** Yes! The floating icon and overlay work on all monitors. The overlay position is saved separately for each monitor configuration.
|
|
|
|
---
|
|
|
|
## Getting Started
|
|
|
|
### Q: How do I open EU-Utility?
|
|
**A:**
|
|
- **Double-click** the floating icon on your screen
|
|
- **Press** `Ctrl + Shift + U` (default hotkey)
|
|
- **Right-click** the system tray icon
|
|
|
|
### Q: How do I move the floating icon?
|
|
**A:** Click and drag the floating icon to your preferred position. It will remember its position across restarts.
|
|
|
|
### Q: What are the default hotkeys?
|
|
**A:**
|
|
- `Ctrl + Shift + U` - Toggle overlay
|
|
- `Ctrl + Shift + F` - Universal Search
|
|
- `Ctrl + Shift + N` - Nexus Search
|
|
- `Ctrl + Shift + C` - Calculator
|
|
- `Ctrl + Shift + L` - Loot Tracker
|
|
- `Ctrl + Shift + S` - Skill Scanner
|
|
|
|
### Q: How do I change hotkeys?
|
|
**A:**
|
|
1. Open Settings plugin
|
|
2. Go to "Hotkeys" tab
|
|
3. Click on the hotkey you want to change
|
|
4. Press your new key combination
|
|
5. Click "Save"
|
|
|
|
---
|
|
|
|
## Plugins & Features
|
|
|
|
### Q: How many plugins are included?
|
|
**A:** EU-Utility comes with **31 plugins**:
|
|
- 24 core plugins (calculators, trackers, tools)
|
|
- 7 new plugins (analytics, auto-updater, Discord, etc.)
|
|
|
|
### Q: Can I disable plugins I don't use?
|
|
**A:** Yes! Go to Settings → Plugins and uncheck the plugins you don't want to load. This improves startup time and reduces memory usage.
|
|
|
|
### Q: How do I create my own plugin?
|
|
**A:** See the [Plugin Development Guide](docs/PLUGIN_DEVELOPMENT_GUIDE.md). The basic structure is:
|
|
```python
|
|
from plugins.base_plugin import BasePlugin
|
|
|
|
class MyPlugin(BasePlugin):
|
|
name = "My Plugin"
|
|
version = "1.0.0"
|
|
def initialize(self): pass
|
|
def get_ui(self): return my_widget
|
|
```
|
|
|
|
### Q: Does the loot tracker work automatically?
|
|
**A:** Yes, the loot tracker reads from your chat.log file automatically. Make sure:
|
|
1. EU-Utility knows your Entropia Universe installation path
|
|
2. The loot tracker plugin is enabled
|
|
3. You're using the in-game loot window
|
|
|
|
### Q: How does the Discord Rich Presence work?
|
|
**A:**
|
|
1. Install `pypresence`: `pip install pypresence`
|
|
2. Create a Discord application at discord.com/developers
|
|
3. Copy the Client ID to the Discord Presence plugin
|
|
4. Enable the plugin
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
|
|
### Q: EU-Utility won't start, what should I do?
|
|
**A:** Try these steps:
|
|
1. Check Python version: `python --version` (need 3.11+)
|
|
2. Reinstall dependencies: `pip install --force-reinstall -r requirements.txt`
|
|
3. Clear settings: Delete `~/.eu-utility/settings.json`
|
|
4. Check logs: Look in `~/.eu-utility/logs/`
|
|
|
|
### Q: Hotkeys aren't working
|
|
**A:**
|
|
1. Run EU-Utility as Administrator
|
|
2. Check if another app is using the same hotkeys
|
|
3. Change hotkeys in Settings → Hotkeys
|
|
4. Restart EU-Utility after changing hotkeys
|
|
|
|
### Q: The overlay disappears when I click the game
|
|
**A:**
|
|
1. Right-click the floating icon
|
|
2. Disable "Click-through" mode
|
|
3. Or pin the overlay using the pin button
|
|
|
|
### Q: OCR isn't working
|
|
**A:**
|
|
1. Install EasyOCR: `pip install easyocr`
|
|
2. Ensure game window is visible (not minimized)
|
|
3. Try increasing game brightness
|
|
4. First run downloads models (may take a few minutes)
|
|
|
|
### Q: I get "ModuleNotFoundError" errors
|
|
**A:** Install missing dependencies:
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
### Q: The floating icon is missing
|
|
**A:**
|
|
1. Check system tray (may be minimized there)
|
|
2. Reset position: Delete `~/.eu-utility/settings.json`
|
|
3. Check if EU-Utility is actually running
|
|
|
|
---
|
|
|
|
## Data & Privacy
|
|
|
|
### Q: Where is my data stored?
|
|
**A:** All data is stored locally in:
|
|
- **Windows:** `%USERPROFILE%\.eu-utility\`
|
|
- **Linux:** `~/.eu-utility/`
|
|
|
|
### Q: Is my data sent to any servers?
|
|
**A:** By default, **no**. EU-Utility:
|
|
- Stores everything locally
|
|
- Only contacts Nexus API for item data (read-only)
|
|
- Only checks GitHub for updates (if you use Auto-Updater)
|
|
- Analytics are opt-in and local-only
|
|
|
|
### Q: How do I backup my data?
|
|
**A:**
|
|
1. Use the Import/Export plugin
|
|
2. Or manually copy `~/.eu-utility/data/`
|
|
3. Backups are created automatically before updates
|
|
|
|
### Q: How do I delete all my data?
|
|
**A:**
|
|
1. Close EU-Utility
|
|
2. Delete the folder: `~/.eu-utility/`
|
|
3. Restart EU-Utility
|
|
|
|
---
|
|
|
|
## Performance
|
|
|
|
### Q: EU-Utility is using too much CPU, how do I fix it?
|
|
**A:**
|
|
1. Disable unused plugins in Settings
|
|
2. Lower OCR quality in Game Reader settings
|
|
3. Reduce update frequency in trackers
|
|
4. Check Analytics plugin for resource usage
|
|
|
|
### Q: How much RAM does EU-Utility use?
|
|
**A:** Typically 100-300MB depending on:
|
|
- Number of enabled plugins
|
|
- OCR operations
|
|
- Background tasks
|
|
- Data history size
|
|
|
|
### Q: Can I run EU-Utility on a low-end PC?
|
|
**A:** Yes, but:
|
|
- Disable Analytics and other non-essential plugins
|
|
- Use fewer background tasks
|
|
- Reduce data retention periods
|
|
|
|
---
|
|
|
|
## Updates
|
|
|
|
### Q: How do I update EU-Utility?
|
|
**A:** Two methods:
|
|
1. **Auto-Updater:** Use the Auto Updater plugin (recommended)
|
|
2. **Manual:** `git pull origin main` and restart
|
|
|
|
### Q: Will I lose my data when updating?
|
|
**A:** No. Updates preserve:
|
|
- All plugin data
|
|
- Settings
|
|
- Custom configurations
|
|
- Automatic backups are created before updating
|
|
|
|
### Q: How do I rollback to a previous version?
|
|
**A:**
|
|
1. Use the Auto Updater plugin
|
|
2. Click "Rollback to Previous Version"
|
|
3. Select the backup to restore
|
|
|
|
---
|
|
|
|
## Advanced
|
|
|
|
### Q: Can I contribute to EU-Utility?
|
|
**A:** Yes! See [CONTRIBUTING.md](CONTRIBUTING.md). We welcome:
|
|
- Bug reports
|
|
- Feature requests
|
|
- Code contributions
|
|
- Documentation improvements
|
|
- Plugin development
|
|
|
|
### Q: How do I report a bug?
|
|
**A:**
|
|
1. Check if it's already reported
|
|
2. Collect logs from `~/.eu-utility/logs/`
|
|
3. Note your OS, Python version, and EU-Utility version
|
|
4. Create a detailed issue on GitHub
|
|
|
|
### Q: Can I use EU-Utility code in my own project?
|
|
**A:** Yes! EU-Utility is MIT Licensed. You can:
|
|
- Use the code
|
|
- Modify it
|
|
- Distribute it
|
|
- Use it commercially
|
|
Just include the license file.
|
|
|
|
### Q: How do I integrate with other tools?
|
|
**A:** EU-Utility provides:
|
|
- Import/Export in JSON format
|
|
- Plugin API for extensions
|
|
- Event bus for real-time data
|
|
- HTTP client for external APIs
|
|
|
|
---
|
|
|
|
## Plugin-Specific
|
|
|
|
### Q: How accurate is the DPP Calculator?
|
|
**A:** The DPP Calculator uses the formula: `Damage / ((Ammo * 0.01 + Decay) / 100)`. It reads weapon stats from the Nexus API for accuracy.
|
|
|
|
### Q: Does the Price Alert system check continuously?
|
|
**A:** Yes, it checks at configurable intervals (default: every 15 minutes). You can change this in the Price Alerts plugin settings.
|
|
|
|
### Q: Can I export my loot tracking data?
|
|
**A:** Yes! The Session Exporter plugin can export to CSV or JSON format for analysis in Excel or other tools.
|
|
|
|
### Q: How does the Skill Scanner work?
|
|
**A:** It uses OCR to read your skill values from the game window. Make sure:
|
|
1. Skills window is visible
|
|
2. Text is clearly readable
|
|
3. OCR service is working
|
|
|
|
---
|
|
|
|
## Still Have Questions?
|
|
|
|
- 📚 **Documentation:** Check the `docs/` folder
|
|
- 🐛 **Bug Reports:** GitHub Issues
|
|
- 💬 **Community:** Discord/Forums
|
|
- 📧 **Contact:** Create an issue on GitHub
|
|
|
|
---
|
|
|
|
*Can't find your question? Ask in the community or create a GitHub issue!*
|