guarzo/wanderer-notifier repository overview

⁠Wanderer Notifier

Wanderer Notifier is a lightweight, real-time notification service for Discord. It aggregates and enriches in-game event data from ESI, zKillboard, and your wanderer map API

⁠Features

• Real-Time Alerts: Immediate notifications for significant in-game events.
• Smart Filtering: Kill alerts are sent only if the event occurs in a system visible on your map or involves a character from your tracked list.
• Rich Embeds: Detailed alerts with titles, descriptions, links, images, and additional context.
• Easy Deployment: Hassle-free setup using our pre-built Docker image with Docker Compose.

⁠How to Deploy

1. Download the Docker Image

   Pull the latest image:

   docker pull guarzo/wanderer-notifier:v1
   

   Copy

2. Configure Your Environment

   Create a .env file with your settings (replace placeholder values with your actual credentials):

   # .env file
   DISCORD_BOT_TOKEN=your_discord_bot_token
   DISCORD_CHANNEL_ID=your_discord_channel_id
   MAP_URL=https://your.map.url
   MAP_NAME=your_map_slug
   MAP_TOKEN=your_map_api_token
   ZKILL_BASE_URL=https://zkillboard.com
   ESI_BASE_URL=https://esi.evetech.net/latest
   

   Copy

3. Set Up Docker Compose

   Create a docker-compose.yml file:

   version: "3.8"
   
   services:
     wanderer-notifier:
       image: guarzo/wanderer-notifier:v1
       env_file: .env
       restart: always
       ports:
         - "4000:4000"
   

   Copy

4. Start the Service

   Run the following command in your project directory:

   docker-compose up -d
   

   Copy

⁠Notifications

WandererNotifier monitors key in-game events and sends you notifications:

• Kill Alerts: If a kill occurs in a mapped system or involving a tracked character, you'll receive a detailed message about the kill including a link to zkill
• New Tracked Character Alerts: Get notified when a new character is added to your tracked list.
• New System Alerts: Be alerted when a new system is discovered by your map API.

Stay informed with timely, filtered notifications that focus on what matters most.