Skip to main content

Discord Ping Formatter for Alliance Auth

Project description

AA Discord Ping Formatter

App for formatting pings for Discord in Alliance Auth

Contents

Installation

Important: This app 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)

Step 1 - Install app

Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the latest version:

pip install aa-discord-ping-formatter

Step 2 - Update your AA settings

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

  • Add 'discordpingformatter', to INSTALLED_APPS

Step 3 - Finalize the installation

Run migrations & copy static files

python manage.py collectstatic
python manage.py migrate

Restart your supervisor services for AA

Step 4 - Setup permissions

Now you can setup permissions in Alliance Auth for your users. Add discordpingformatter | aa discord ping formatter | Can access this app to the states and/or groups you would like to have access.

Updating

To update your existing installation of AA Discord Ping Formatter first enable your virtual environment.

Then run the following commands from your AA project directory (the one that contains manage.py).

pip install -U aa-discord-ping-formatter
python manage.py collectstatic
python manage.py migrate

Finally restart your AA supervisor services.

Screenshots

View in Alliance Auth

AA View

Discord Ping

Discord Ping

Configuration

Adding Ping Targets

Per default you have 2 ping targets you can select from. That's @everyone and @here. If you need more than these 2, you can add them to your local.py and override the default behaviour that way.

Open your local.py in an editor of your choice and add the following at the end.

## AA Discord Ping Formatter
AA_DISCORDFORMATTER_ADDITIONAL_PING_TARGETS = [
    '@Member',
]

Adding Fleet Types

Per default you have 4 fleet types you can select from. That's Roam, Home Defense, StratOP and CTA. If you need more than these 4, you can add them to your local.py and override the default behaviour that way.

Open your local.py in an editor of your choice and add the following at the end.

## AA Discord Ping Formatter
AA_DISCORDFORMATTER_ADDITIONAL_FLEET_TYPES = [
    'Mining',
    'Ratting',
]

Adding Ping Channels

Per default, your ping will just be formatted for you to copy and paste. But, if your FCs are too lazy even for that, you can configure webhooks. One for each channel you might want to ping.

Open your local.py in an editor of your choice and add the following at the end.

AA_DISCORDFORMATTER_ADDITIONAL_PING_WEBHOOKS = [
    {
        'discordChannelName': 'Fleet Pings (#fleet-pings)',
        'discordWebhookUrl': 'https://discordapp.com/api/webhooks/xxxxxxxxxxxxxxxxxx/yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
    },
    {
        'discordChannelName': 'Pre Pings (#pre-pings)',
        'discordWebhookUrl': 'https://discordapp.com/api/webhooks/xxxxxxxxxxxxxxxxxx/yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
    }
]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aa-discord-ping-formatter-0.1.5.tar.gz (280.3 kB view hashes)

Uploaded Source

Built Distribution

aa_discord_ping_formatter-0.1.5-py3-none-any.whl (282.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page