Wanderer Notifier

Wanderer Notifier delivers real-time alerts directly to your Discord channel, ensuring you never miss critical in-game events. Whether it’s a significant kill, a newly tracked character, or a fresh system discovery, our notifier keeps you informed with rich, detailed notifications.

In the fast-paced universe of EVE Online, timely information can mean the difference between success and failure. When a hostile fleet enters your territory, when a high-value target appears in your hunting grounds, or when a new wormhole connection opens up valuable opportunities - knowing immediately gives you the edge. Wanderer Notifier bridges this information gap, bringing critical intel directly to your Discord where your team is already coordinating.

Prerequisites

Before setting up Wanderer Notifier, ensure you have the following:

How to Get Started

There are two ways to install Wanderer Notifier: a Quick Install option using a one-liner, or a Manual Setup for those who prefer step-by-step control.

Quick Install Option

For a streamlined installation that creates the necessary directory and files automatically, run:

curl -fsSL https://gist.githubusercontent.com/guarzo/3f05f3c57005c3cf3585869212caecfe/raw/33cba423f27c12a09ec3054d4eb76b283da66ab4/wanderer-notifier-setup.sh | bash

Once the script finishes, update the wanderer-notifier/.env file with your configuration values, then run the container.

Manual Setup

If you’d rather set up everything manually, follow these steps:

1. Download the Docker Image

Pull the latest Docker image:

docker pull guarzo/wanderer-notifier:latest

2. Configure Your Environment

Create a .env file in your working directory with the following content. Replace the placeholder values with your actual credentials:

# Discord Configuration
DISCORD_BOT_TOKEN=your_discord_bot_token
DISCORD_APPLICATION_ID=your_discord_application_id # Optional
DISCORD_CHANNEL_ID=your_discord_channel_id

# Optional Discord Channel Configuration
# DISCORD_SYSTEM_KILL_CHANNEL_ID=your_system_kill_channel_id
# DISCORD_CHARACTER_KILL_CHANNEL_ID=your_character_kill_channel_id
# DISCORD_SYSTEM_CHANNEL_ID=your_system_channel_id
# DISCORD_CHARACTER_CHANNEL_ID=your_character_channel_id

# Map Configuration
MAP_URL="https://wanderer.ltd"
MAP_NAME="your map slug"
MAP_API_KEY=your_map_api_key

# License Configuration
LICENSE_KEY=your_license_key  # Provided with your map subscription

# Feature Flags (default values shown below)
# General Settings
# NOTIFICATIONS_ENABLED=true  # Master switch for all notifications
# ENABLE_STATUS_MESSAGES=false  # Controls startup/status notifications

# Notification Control (tracking is always enabled)
# KILL_NOTIFICATIONS_ENABLED=true  # Controls kill notifications
# SYSTEM_NOTIFICATIONS_ENABLED=true  # Controls system notifications
# CHARACTER_NOTIFICATIONS_ENABLED=true  # Controls character notifications

# Character Configuration
# CHARACTER_EXCLUDE_LIST=character_id1,character_id2

# Priority Systems Configuration
# PRIORITY_SYSTEMS_ONLY=false  # Only send notifications for priority systems

Note: If you don’t have a Discord bot yet, follow our guide on creating a Discord bot or search the web for more information.

Note: The map configuration now uses separate MAP_URL and MAP_NAME variables for cleaner configuration. The application automatically combines these to create the full map URL.

3. Create the Docker Compose Configuration

Create a file named docker-compose.yml with the following content:

services:
  wanderer_notifier:
    image: guarzo/wanderer-notifier:v2
    container_name: wanderer-notifier
    restart: unless-stopped
    env_file:
      - .env
    ports:
      - "${PORT:-4000}:4000"
    deploy:
      resources:
        limits:
          memory: 512M
      restart_policy:
        condition: unless-stopped
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:4000/health"]
      interval: 30s
      timeout: 5s
      retries: 3
      start_period: 15s
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "3"

4. Run It

Start the service with Docker Compose:

docker-compose up -d

Your notifier is now up and running, delivering alerts to your Discord channel automatically!

Discord Slash Commands

Wanderer Notifier supports Discord slash commands for managing your notification preferences directly from Discord:

Available Commands

Setting Up Slash Commands

  1. Ensure your bot has the applications.commands scope when inviting it to your server
  2. Add your Discord Application ID to the .env file
  3. Restart the notifier - commands will be registered automatically
  4. Type /notifier in Discord to see available commands

Priority Systems

Priority systems receive special treatment in notifications:

Configuration Validation

On startup, the application validates all configuration settings. If there are issues with your configuration, detailed error messages will be displayed in the logs to help you resolve them. This ensures that your notifier is properly configured before it begins operation.

Current Features

Learn more about notification types

View on GitHub