Skip to content

Notifications Module

Jump to bottom
Alexander Smirnov edited this page Aug 7, 2019 · 2 revisions

Updated for V1.4.2

RELATED CONFIG SECTIONS

  • webServerModule
  • notificationFeedModule

DESCRIPTION

Notifications utilize the ESI API which require user responsible for feeding to authenticate in a special manner at least once before being able to supply notifications data.

CONFIG

  • checkIntervalInMinutes - time interval in minutes to run new notifications check. Due to natural delay on CCP ESI side it is not wise to set it lower than 2 minutes.
  • groups
    • groupName1 - group names must be UNIQUE as atabase check depends on this name
      • characterID - list of numeric EVE character IDs who are authorized to feed notifications
      • defaultDiscordChannelID - numeric default Discord channel ID. All notifications filters will use this channel to send messages by default.
      • fetchLastNotifDays - numeric number of days to fetch old notifications for newly registered feeder. 0 by default meaning no old notifications will be feeded.
      • filters - the list of filters to sort incoming notifications.
        • filter1 - filter names must be UNIQUE as database check depends on this name
          • DefaultMention - default Discord mention text to use for this group
          • channelID - numeric Discord channel ID to redirect messages. Leave 0 to use group default channel.
          • charMentions - list of numeric EVE CHARACTER IDs to mention them in the message. Characters must be authed on the server for this to work thus allowing to get their Discord IDs. Leave empty to use default mention.
          • roleMentions - list of Discord role names to mention. Role must be configured in Discord to be mentionable.
          • notifications - list of text notification types this filter has access to. Refer to default config file for the full list of available notifications.

Each entry represents EVE official notification type name and channel value defining where to send the message. Only notification types listed in the default settings file are supported.

SETUP

  1. Prepare corresponding config section in settings.json file
  2. Prepare web server
  3. Enable these modules in config section:
  • "moduleWebServer": true
  • "moduleNotificationFeed": true
  1. Go to web server main page and press Notifications Auth button or type !authnotify Discord command and follow the link.
  2. Auth on the CCP web site under the authorized character.
  3. That's all. At this point the bot will get ESI refresh token and will use it to fetch notifications.

WARNING: Due to CCP restrictions citadel names can only be resolved if the feeding character or his corporation is added to the citadel ACL (access list).

Note: If feeder wants to stop feeding notifications he should remove the bot access rights from EVE account settings here. This will invalidate provided ESI token and user ID can be removed from config file.

Clone this wiki locally