You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Flying Kiwi 785252c3fd Ignore configs folder 3 years ago
.vscode Hook up bot commands 3 years ago
filters Merge branch 'feature/select-filters' 3 years ago
logs Start rewrite 3 years ago
test More logging and testing 4 years ago
util Merge branch 'feature/select-filters' 3 years ago
.gitattributes Ignores 4 years ago
.gitignore Ignore configs folder 3 years ago
ChikunRadar.supervisor.conf Update supervisor config 3 years ago
alertProcessor.py Rename folder to filters and prepare DB functions 3 years ago
alertWorker.py Add filter commands and functionality 3 years ago
config.example.toml logging and ESI awaiting 3 years ago
launcher.py Add filter commands and functionality 3 years ago
radarBot.py Merge branch 'feature/select-filters' 3 years ago
readme.md Out with the old, the new is working 3 years ago
requirements.txt Fix !+range, filter out HS by default, function to create a system json file so we don't have to import all systems everytime 3 years ago
systems.json Fix !+range, filter out HS by default, function to create a system json file so we don't have to import all systems everytime 3 years ago
zkillSocket.py Create a manager for alert workers 3 years ago

readme.md

ChickunRadar

Too many foxes in your hen house? This app is for you, find those pesky foxes so you can get the Chikun Space Force on them.

##Criteria

The radar has several criteria that it can check for. All criterion use a range check to limit alerts to local systems within jump range.

Capitals on kill mail

Is met if a capital (dread, carrier, FAX, supercarrier, or titan) is on a killmail

Fighter death

Is met if there is a fighter wing that is killed (indicates that a carrier or supercarrier is present)

Small Gang

If there is a fight involving a small gang of players.

##Program Flow

zKill Thread

  1. A kill is recieved by the zKillboard websocket
  2. It is passed to the alertProcessor which does the following:
  • Determines if the kill ocurred in any of the watched systems
  • Determines if it matches any criteria (Using classes that extend the BaseCriteria object)
  • If both match it will gather data about the kill to send it on to the discord bot

###Discord thread

The discord bot does the following:

  • Listens to commands to change configuration
  • Emits alerts