aa-metenox

Metenox

AA module for Metenox management.

Features:

• Imports moon scans from the aa-moonmining application
• Import Metenoxes from a corporation
  • Displays remaining fuel
  • Displays currently stored moon materials
• Manager overview of corporation displaying their number of Metenoxes and profit

TODO:

• Setup notifications when the fuel/reagent levels are low

What this app won't do:

• Estimate moon price for athanor. Use aa-moonmining
• Ping when metenox are being reffed Use aa-structures

This module aims to be specific for Metenox management.

Screenshots

Installation

Step 1 - Check prerequisites

1. Metenox is a plugin for Alliance Auth. If you don't have Alliance Auth running already, please install it first before proceeding. (see the official AA installation guide for details)

2. Metenox requires the Alliance Auth module aa-moonmining to function. The moon database and other utilities are imported from this module.

Step 2 - Install app

Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:

pip install aa-metenox

Step 3 - Configure Auth settings

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

• Add 'metenox' to INSTALLED_APPS
• Add below lines to your settings file:

CELERYBEAT_SCHEDULE['metenox_update_prices'] = {
    'task': 'metenox.tasks.update_prices',
    'schedule': crontab(minute='0', hour='*/12'),
}
CELERYBEAT_SCHEDULE['metenox_update_moons_from_moonmining'] = {
    'task': 'metenox.tasks.update_moons_from_moonmining',
    'schedule': crontab(minute='0', hour='*/3'),
}

CELERYBEAT_SCHEDULE['metenox_update_all_holdings'] = {
    'task': 'metenox.tasks.update_all_holdings',
    'schedule': crontab(minute='0', hour='*/1')
}

CELERYBEAT_SCHEDULE['metenox_send_daily_analytics'] = {
  'task': 'metenox.tasks.send_daily_analytics',
  'schedule': crontab(minute='0', hour='5')
}

Note: the delay of the update_moons_from_moonmining task is intentionally long. If you know moons will be added in your database often you can reduce it for them to appear faster. You can even not use this task at all and only update moon scans with the metenox_update_moons_from_moonmining command.

For the send_daily_analytics refer to analytics

Optional: Alter the application settings. The list can be found in Settings

Step 4 - Finalize App installation

Run migrations & copy static files

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

Restart your supervisor services for Auth.

Setp 5 - Load Goo from ESI

Run the following management command to load all moon materials from ESI. This only has to be run once.

python manage.py metenox_load_eve

Wait until the command is finished before continuing.

Step 5 - Load data

First load the data from the moonmining module using

python manage.py metenox_update_moons_from_moonmining

Once it's done update their prices with

python manage.py metenox_update_all_prices

Analytics

This application will send anonymous analytic data using Alliance Auth built-in analytics module. If you wish to disable the analytics for this application you can easily do so by removing the metenox_send_daily_analytics task.

The collected analytics are

• number of owners
• number of moons
• number of metenoxes

Permissions

Permissions overview.

Name	Description
view_moons	This permissions allow to see all scanned moons of the database
view_metenoxes	This permissions allow to add owners and see all metenoxes from the owners corporations
corporation_manager	This permission allows to add webhooks to corporations and edit when a corporation should get fuel pings
auditor	This permission allows to see all metenoxes regardless of having an owner in the corporation

Users need to have at least view_moons or view_metenoxes to be able to have any interactions with the application. For the permissions corporation_manager and auditor to work properly the user needs to also have the view_metenoxes permission.

Settings

List of settings that can be modified for the application. You can alter them by adding them in your local.py file.

Name	Description	Default
METENOX_ADMIN_NOTIFICATIONS_ENABLE	Whether admins will get notifications about important events like when someone adds a new owner.	True
METENOX_MOON_MATERIAL_BAY_CAPACITY	Volume of the Metenox's Moon material Output Bay. Used to calculate how long a metenox takes before being full. This value shouldn't be edited	500_000
METENOX_HOURLY_HARVEST_VOLUME	Hourly volume in m3 that a metenox will harvest. This value shouldn't be edited	30_000
METENOX_HARVEST_REPROCESS_YIELD	Yield at which the metenox reprocess the harvested materials. This value shouldn't be edited	0.40
METENOX_FUEL_BLOCKS_PER_HOUR	How many fuel blocks a running Metenox consumes every hours. This value shouldn't be edited	5
METENOX_MAGMATIC_GASES_PER_HOUR	How many magmatic gases a running Metenox consumes every hours. This value shouldn't be edited	88

Commands

The following commands can be used when running the module:

Name	Description
metenox_load_eve	Loads up the data from eveuniverse this command should only be ran once
metenox_update_all_holdings	Fetches all holdings in the database and updates their metenoxes with the ESI
metenox_update_all_prices	Fetches new prices from fuzzwork and update the price of all known moons
metenox_update_moons_from_moonmining	Checks the moonmining application and adds all missing moons