evexerxes-discord-bot

Eve corp discord bot notifier

Prerequisite

Create .env file at root directory and fill out the details:

## ./.env
PORT=8002
MONGODB_URL=mongodb://mongodb
MONGODB_USER=
MONGODB_PASS=
CALLBACK_URI=
EVE_CLIENT_ID=
EVE_SECRET=
DISCORD_TOKEN=
DISCORD_TEST_CHANNEL=
DEBUG=
CONTRACT_CRON=0 */5 10,11,12,13,14,15,16,17,18,19,20,21,22 * * *
FUEL_CRON=0 0 10,13,16,19,22 * * *
WAR_CRON=0 0 10,11,12,13,14,15,16,17,18,19,20,21,22 * * *
MOON_EXTRACTION_CRON=0 0 12 * * *
STRUCTURE_HEALTH_CRON=0 */16 10,11,12,13,14,15,16,17,18,19,20,21,22 * * *
INDUSTRY_CRON=0 0 10,11,12,13,14,15,16,17,18,19,20,21,22 * * *
INDUSTRY_NOTIFIER_CRON=0 1 19 * * 5
CHAR_NOTIFICATION_CRON=0 */10 * * * *

Docker Setup

1. Build evexerxes image

   docker build -t evexerxes:latest .

2. Run docker-compose

   docker compose up -d

Teardown

1. Stop docker compose containers

   docker compose down

2. Remove docker compose containers

   docker compose rm

3. Remove docker mongodb volume

   docker volume rm evexerxes-discord-bot_mongodb

Non-Docker Setup

• node v14+
• EVE Online Developer ClientID and ClientSecret
• Discord Developer Token

1. Install npx

   npm install --global npx

2. Setup MongoDB, create a database to be called esi, and make sure that it is accessible at mongo://localhost/esi. Currently tested with Mongo Community Edition V5.

   For Raspberry pi with Ubuntu:

   # Install the MongoDB GPG key:
   wget -qO - https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -
   
   # Add the source location for the MongoDB packages:
   echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list
   
   # Download the package details for the MongoDB packages:
   sudo apt-get update
   
   # Install MongoDB:
   sudo apt-get install -y mongodb-org
   
   sudo systemctl daemon-reload
   sudo systemctl enable mongod
   sudo systemctl start mongod

3. Install Node dependencies

   npm install

How to run

1. Run the service:

   npm run start #development
   #or
   npm run prod #production

2. Login to your Eve accounts

3. Link Bot to discord server: https://discord.com/oauth2/authorize?&client_id=000000000000000000&scope=bot&permissions=8

4. Link Channel to evexerxes-bot:

   Type: !evexerxes-init Into the discord channel you want the notifications to come from.

How to enable as Service

1. Copy service to systemd:

   sudo cp evexerxes-bot.service /etc/systemd/system/

2. Reload systemd daemon:

   sudo systemctl daemon-reload

3. Enable (run on boot) evexerxes-bot service:

   sudo systemctl enable evexerxes-bot.service

4. Start evexerxes-bot service:

   sudo systemctl start evexerxes-bot.service

Icons

https://wiki.eveuniversity.org/UniWiki:Icons

Endpoints

• localhost:8002/login: To authenticate with EVE to use EVE Online API
• localhost:8002/callback Callback URL to retrieve token from EVE Online
• localhost:8002/wipe Debug to wipe all documents in DB
• localhost:8002/wipe/stations Debug to wipe just stations (Structure test)

Support

docker:

• docker compose logs -f

non-docker:

• journalctl -fu evexerxes-bot.service

Features

• notify when corp contracts are created
• notify when at war, changes to wars we're in
• notify when stations are low on fuel
• notify when moon mining is ready
• notify when structures are under attack (not possible to cover POCOs in this.)
• notify details on corporation industry jobs

Ideas

• notify when someone wants to join or has left the corp
• show available corporate blueprints (not necessary, available in game)
• have a onboarding to discord where ranks match discord groups -> promotion in eve automatically enrolls players in discord groups. When players leave, they can be automatically unenrolled
• notify when high number of kills in specified systems
• notify new station anchoring in specified systems
• notify significant changes to corporate containers ( putting in, taking away)
• show / notify on corp wallet changes
• validate contracts if originate from an accepted station..
• use character notifications to:
  • simpler wars updates on corp
  • simpler structures conditions and under attack
  • orbitals under attack (custom offices!)
  • sovereignty?
• use current war method for any corps we're looking out to be a war..
• indy reactions