Package: aa-discord-ping-formatter
AA Discord Ping FormatterApp for formatting pings for Discord in Alliance AuthContentsInstallationUpdatingScreenshotsConfigurationChange LogInstallationImportant: 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 officialAA installation guidefor details)Step 1 - Install appMake sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the latest version:pipinstallaa-discord-ping-formatterStep 2 - Update your AA settingsConfigure your AA settings (local.py) as follows:Add'discordpingformatter',toINSTALLED_APPSStep 3 - Finalize the installationRun migrations & copy static filespythonmanage.pycollectstatic
pythonmanage.pymigrateRestart your supervisor services for AAStep 4 - Setup permissionsNow you can setup permissions in Alliance Auth for your users. Adddiscordpingformatter | aa discord ping formatter | Can access this appto the states and/or groups you would like to have access.UpdatingTo 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 containsmanage.py).pipinstall-Uaa-discord-ping-formatterpythonmanage.pycollectstaticpythonmanage.pymigrateFinally restart your AA supervisor services.ScreenshotsView in Alliance AuthDiscord Ping(Example for embedded ping (top) and non embedded ping (bottom))ConfigurationEmbed Webhook PingsYou have the option to embed your webhook pings. To do so you can enable it via:## AA Discord Ping FormatterAA_DISCORDFORMATTER_WEBHOOK_EMBED_PING=TrueAdding Ping TargetsPer default you have 2 ping targets you can select from. That's@everyoneand@here. If you need more than these 2, you can add them to yourlocal.pyand override the default behaviour that way.Open yourlocal.pyin an editor of your choice and add the following at the end.## AA Discord Ping FormatterAA_DISCORDFORMATTER_ADDITIONAL_PING_TARGETS=[{'roleId':'xxxxxxxxxxxxxxxxxx','roleName':'Member'},{# restricted to "Capital FCs" (GroupID 5) and "Super Capital FCs" (GroupID 7)'restrictedToGroup':[5,7,],'roleId':'xxxxxxxxxxxxxxxxxx','roleName':'Capital Pilots'},]To get theroleIdgo to your Discord Server Settings » Roles and right click the role you need and copy the ID. You might need to activate the Developer Mode for your Discord account in order to do so. You activate the Developmer Mode in your account settings under Appearance » Advanced » Developer Mode.Important:Both,roleIdandroleNameneed to be without the@, it will be added automatically.roleNameneeds to be spelled exactly as it is on Discord.Adding Fleet TypesPer default you have 4 fleet types you can select from. That'sRoam,Home Defense,StratOPandCTA. If you need more than these 4, you can add them to yourlocal.pyand override the default behaviour that way.Open yourlocal.pyin an editor of your choice and add the following at the end.## AA Discord Ping FormatterAA_DISCORDFORMATTER_ADDITIONAL_FLEET_TYPES=[# example for embedded webhook pings{'fleetType':'Mining','embedColor':'#4F545C'# can be empty but needs to be set. Needs to be #hex and 6 digits},# example for non embedded webhook pings'Ratting',]Both examples will work, no matter if you haveAA_DISCORDFORMATTER_WEBHOOK_EMBED_PINGenabled or not. But keep in mind, to set a custom color for your embed, it needs to be defined like in the first example. The color needs to be your standard hex color code like you define it in (for example) CSS as well. Pre-defined fleet types are by default: Roam = green, Home Defense = yellow, StratOP = orange, CTA = redAdding Ping ChannelsPer 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 yourlocal.pyin an editor of your choice and add the following at the end.## AA Discord Ping FormatterAA_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'},{# restricted to "Capital FCs" (GroupID 5) and "Super Capital FCs" (GroupID 7)'restrictedToGroup':[5,7,],'discordChannelName':'Capital Pings (#capital-pings)','discordWebhookUrl':'https://discordapp.com/api/webhooks/xxxxxxxxxxxxxxxxxx/yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'}]Fleet Comms, Formup Location and DoctrineValues for Fleet Comms, Formup Location and Doctrine can be pre-defined as suggestions, so your FCs have a quick selection of the most used comms, stagings and doctrines to select from. These are not fixed values in the form, since we use a combination of input and select fields here. So FCs are absolutely free to something completely different in those 3 fields than the pre-defined suggestions.To define these 3 fields, open yourlocal.pyin an editor of your choice and add the following:Fleet Comms## AA Discord Ping FormatterAA_DISCORDFORMATTER_FLEET_COMMS=['Alliance Mumble','Coalition Mumble','Spy Account Mumble'# :-P]Fleet Staging## AA Discord Ping FormatterAA_DISCORDFORMATTER_FLEET_FORMUP_LOCATIONS=['Alliance Staging System','Coalition Staging System']Doctrine## AA Discord Ping FormatterAA_DISCORDFORMATTER_FLEET_DOCTRINES=['Battle Skiffs','Combat Nereus','Attack Corvettes']