3.2.0

Structure Timers II

An app for keeping track of Eve Online structure timers with Alliance Auth and Discord.

Contents

• Overview
• Features
• Screenshots
• Installation
• Settings
• Notification Rules
• Staging system
• Permissions
• Management commands

Overview

Structure Timers II is an enhanced version of the Alliance Auth's Structure Timers app. It offers many additional and useful features and an improved UI. It also provides integrations with several other community apps, e.g. aa-structures.

Features

Here is an overview of Structure Timers II's main features.

• Create and edit timers for structure and moon mining events
• Add notes and screenshots to timers (e.g. with the structure's fitting)
• Get automatic notifications about upcoming timers on Discord
• Restrict timer access to your corporation, alliance or users with special clearance ("OPSEC")
• Find timers quickly with filters and full text search
• Automatic cleanup of elapsed timers
• Integrated with several other community apps

Structure Timers II is integrated with the following community apps:

• aa-structures: Automatically adds new timers from structure and moon mining notifications
• allianceauth-opcalendar: Shows timers in a calendar view and with other events
• allianceauth-restapi: Adds a REST API for fetching and adding timers

Screenshots

List of timers

Details for a timer

Creating a new timer

Notification on Discord

Installation

Step 1 - Check Preconditions

Please make sure you meet all preconditions before proceeding:

1. Structure Timers 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. Structure Timers needs the app django-eveuniverse to function. Please make sure it is installed, before continuing.

Note that Structure Timers is compatible with Alliance Auth's Structure Timer app and can be installed in parallel.

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-structuretimers

Step 3 - Configure settings

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

• Add 'structuretimers' to INSTALLED_APPS
• Add the following lines to your settings file:

CELERYBEAT_SCHEDULE['structuretimers_housekeeping'] = {
    'task': 'structuretimers.tasks.housekeeping',
    'schedule': 10800,  # 3 hours
}
CELERYBEAT_SCHEDULE['structuretimers_dispatch_scheduled_notifications'] = {
    'task': 'structuretimers.tasks.dispatch_scheduled_notifications',
    'schedule': 60,
}

Note: structuretimers_dispatch_scheduled_notifications must be added for scheduled notifications to be delivered at all, since notifications are no longer self-scheduling via Celery ETA. If you are upgrading from an earlier version, make sure to add this periodic task alongside your existing structuretimers_housekeeping entry.

• Optional: Add additional settings if you want to change any defaults. See Settings for the full list.

Step 4 - Finalize installation

Run migrations & copy static files

python manage.py migrate
python manage.py collectstatic

Restart your supervisor services for Auth

Step 5 - Preload Eve Universe data

In order to be able to select solar systems and structure types for timers you need to preload some data from ESI once. If you already have run those commands previously you can skip this step.

Load Eve Online map:

python manage.py eveuniverse_load_data map

python manage.py structuretimers_load_eve

You may want to wait until the data loading is complete before starting to create new timers.

Step 6 - Migrate existing timers

If you have already been using the classic app from Auth, you can migrate your existing timers over to Structure Timers II. Just run the following command:

python manage.py structuretimers_migrate_timers

[!NOTE] We suggest migration timers before setting up notification rules to avoid potential notification spam for migrated timers.

Step 7 - Setup notification rules

If you want to receive notifications about timers on Discord you can setup notification rules on the admin site. e.g. you can setup a rule to send notifications 60 minutes before a timer elapses. Please see Notification Rules for details.

Step 8 - Setup permissions

Another important step is to setup permissions, to ensure the right people have access features. Please see Permissions for an overview of all permissions.

Settings

Here is a list of available settings for this app. They can be configured by adding them to your Auth settings file (local.py).

[!TIP] All settings are optional and the app will use the documented default settings if they are not used.

Notification Rules

In Structure Timers II you can receive automatic notifications on Discord for timers by setting up notification rules. Notification rules allow you to define in detail what event and which kind of timers should trigger notifications.

[!NOTE] In general all rules are independent from each other and all enabled rules will be executed for every timer one by one.

Example setup

Here is an example for a basic setup of rules:

Example 1: Notify about every newly created timer without ping (e.g. into a scouts channel)

• Trigger: New timer created
• Scheduled Time: -
• Webhook: YOUR-WEBHOOK
• Ping Type: (no ping)

Example 2: Notify 45 minutes before any timer elapses with ping (e.g. into the FC channel)

• Trigger: Scheduled time reached
• Scheduled Time: T - 45 minutes
• Webhook: YOUR-WEBHOOK
• Ping Type: @here

Key concepts

Here are some key concepts. For all details please see the onscreen help text when creating rules.

Triggers

Notifications can be triggered by two kinds of events:

• When a new timers is created
• When the remaining time of timer has reached a defined threshold (e.g. 10 minutes before timer elapses)

Webhooks

Each rule has exactly one webhook. You can of course define multiple rules for the same webhook or define rules for different webhooks.

Timer clauses

Almost every property of a timer can be used to define rules. For example you can define to get notifications only for timers which hostile objective or only for final timers.

Setting a timer clause is optional - clauses that aren't set will always match any timer.

Staging system

You can define one or multiple staging systems. Then you can see the distance in jumps and LY from your currently selected staging system to any timer (except for WH systems).

Staging systems can be added or modified on the admin site under: Structure Timers/Staging Systems.

Permissions

Here are all relevant permissions:

Management commands

The following management commands are available:

• structuretimers_load_eve: Preload all eve objects required for this app to function
• structuretimers_migrate_timers: Migrate pending timers from Alliance Auth's Structure Timers app