aa-beltradar

AA Belt Radar module for AllianceAuth.

A Belt Survey Analyser to track how fast you mine your belt.

---

• Features
• Highlights
• Installation
  • Step 1 - Install the Package
  • Step 2 - Configure Alliance Auth
  • Step 3 - Add the Scheduled Tasks
  • Step 3.1 - (Optional) Add own Logger File
  • Step 4 - Migrate & Preload EVE SDE Data
  • Step 4.1 - Migrate App and collect static
  • Step 5 - Setting up Permissions
  • Step 6 - (Optional) Setting up Compatibilies
• Translations
• Contributing

Features

• Interactive Live Sessions & Mining Analytics
  • Dynamic live session updates: new survey scans and mining data are automatically loaded and immediately visible
  • Real-time mining speed tracking in m³/s
  • Estimated completion time (ETA) for belt mining
  • Remaining volume and belt size calculation
  • Compressed ore price estimation
• Visual Analytics & Diagrams
  • Ore Progression: Visual chart tracking the progress and composition of mined ore
  • Mining Speed & Volume Chart: XY line & column diagram displaying remaining volume (m³) alongside mining speed (m³/s) over time
• Belt Automation & Timers
  • Automatic belt type and size detection
  • Automatic respawn timer creation when only 10% of the belt volume is left
  • Public and private belt respawn timers
• Collaboration & Notifications
  • Optional session sharing with fleet members or corporation
  • Configurable Discord webhook notifications for belt respawn timers

Highlights

Installation

[!NOTE] AA Belt Radar needs at least Alliance Auth v5 Please make sure to update your Alliance Auth before you install this APP

Step 1 - Install the Package

Make sure you're in your virtual environment (venv) of your Alliance Auth then install the pakage.

pip install aa-beltradar

Step 2 - Configure Alliance Auth

Configure your Alliance Auth settings (local.py) as follows:

INSTALLED_APPS = [
    # other apps
    "eve_sde",  # only if it not already existing
    "beltradar",
    # other apps?
]

# This line is right below the `INSTALLED_APPS` list, if not already exist!
INSTALLED_APPS = ["modeltranslation"] + INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

To set up the Scheduled Tasks add following code to your local.py

CELERYBEAT_SCHEDULE["AA Belt Radar :: Update Belt Radar"] = {
    "task": "beltradar.tasks.update_all_belt_radar",
    "schedule": 600,
}
CELERYBEAT_SCHEDULE["AA Belt Radar :: Update Market Price"] = {
    "task": "beltradar.tasks.update_market_prices",
    "schedule": 86400,
}

Step 3.1 - (Optional) Add own Logger File

To set up the Logger add following code to your local.py Ensure that you have writing permission in logs folder.

LOGGING["handlers"]["beltradar_file"] = {
    "level": "INFO",
    "class": "logging.handlers.RotatingFileHandler",
    "filename": os.path.join(BASE_DIR, "log/beltradar.log"),
    "formatter": "verbose",
    "maxBytes": 1024 * 1024 * 5,
    "backupCount": 5,
}
LOGGING["loggers"]["extensions.beltradar"] = {
    "handlers": ["beltradar_file"],
    "level": "DEBUG",
}

Step 4 - Migrate & Preload EVE SDE Data

AA Skillfarm uses EVE SDE data to map IDs to names for EveTypes. You will need to preload some data from SDE once.

python manage.py migrate eve_sde
python manage.py esde_load_sde

Step 4.1 - Migrate App and collect static

Migrate the app and collect static.

python manage.py migrate beltradar
python manage.py aabeltradar_migrate_market_data
python manage.py collectstatic --noinput

Step 5 - Setting up Permissions

With the Following IDs you can set up the permissions for the Belt Radar

Step 6 - (Optional) Setting up Compatibilies

The Following Settings can be setting up in the local.py

Translations

Help us translate this app into your language or improve existing translations. Join our team!"

Contributing

You want to improve the project? Please ensure you read the Contribution Guidelines