Darkbot - Introduction#

logo

  • It implements Discord bot to track player bases, players themselves and forum posting with notifications to Discord.
  • The logic of it: User connects darkbot to some discord channel, and sets settings which space bases, player tags or space systems to track. Darkbot repeatedly updates information to discord channel

Features#

  • Adding player bases for tracking in discord channel
  • Adding players for tracking based on tag in nickname or star systems / regions to track
  • Adding configurable alert triggers to base, player of forum tracking
  • Adding forum post for tracking

Important links#

How to get started#

  • invite both to server by link
  • You must be Server owner or having bot_controller role in order to command the bot.
  • add to some channel by writing . connect (if u wish to disconnect bot from channel, write .disconnect)
    • ensure you use bot on dedicated channel created for it. It automatically erases all not related msgs to bot operation after some time.
  • get help which commands are available by . --help or requesting help on sub commands . base --help
  • add base tag for tracking . base tags add Research Station
  • confirm it was added . base tags list
  • in around 20 seconds you should see rendered and constantly updated view at this channel

  • remove tag by . base remove Research Station or by . base tags clear

Continue with checking tabs at the left, regarding each feature details.

Permissions for running#

  • By default it is offered running by admin invite link. That ensures both has sufficient permissions for sure.

  • If you don't want to run as admin, then you need to use less permissive invite, like this one offered below:

    • Bot expects having sufficient permissions for its working, which is seeing the channel it works in, writing, editing, deleting msgs and reading msg history. Here is non admin inviting link configured for permissions that should be enough in theory:
      • Read Messages
      • Send Messages
      • Manage Messages
      • Read Message History
      • Mention everyone here and all roles
      • Embed links (probably super necessay for sending forum msgs)
      • Manage channels (Probably not needed permission)
      • Add reactions (Just added for future if ever will be needed)
    • WARN: there is known issue with non admin link potentially having problem to send embedded message for forum tracking features. Ensure u granted plentiful of all possible permissions to be able sending embeds/msgs in channel.

Development specific stuff#

See Github Readme.md for details

Contacts#