Git Product home page Git Product logo

scenarioalerter's Introduction

ScenarioAlerter

Inspired by the original ScenarioAlerter. It monitors the log file that the ScenarioAlerter addon creates and sends a message via the provided Discord Webhook or sends a push notification via Pushover which will alert you of a scenario pop.

ScenarioAlerter is made up of two parts:

  • A Warhammer Online AddOn that when a scenario pops writes the event to a log file.
  • A .NET console app that monitors the log file for new events and when a new event is written sends an alert in the form of either a Discord webhook or Pushover notification.

Both parts are needed.

Usage

  1. Download and install the .NET 6.0 Runtime.
  2. Download and extract a release from the Releases section.
  3. Inside the zip you downloaded, copy over the ScenarioAlerter folder in the WarhammerAddOn folder to Interface\AddOns\ under your Warhammer Online game folder.
  4. Rename app.config.example to app.config.
  5. Define the location of the logFile (modify the path to where you have Warhammer Online installed but keep \logs\ScenarioAlerter.log), the method you want to recieve the alert by in alertMethod (Pushover or Discord), and the method-specific settings. Read further for information on each method.
  6. After correctly defining the values in app.config, start ScenarioAlerter.exe and test the alert method via executing /script ScenarioAlerter.RecordScPop() ingame. You should get the message "Pop! Scenario: " via your selected alert method (when a scenario actually pops, the name of the scenario will be included in the alert.)

Discord

NOTE: If you are looking to use Discord as a way to get notified on a mobile device, be aware that mobile push notifications will only be sent when you are inactive at your computer for a certain amount of time (determined by the value set as Push Notification Inactive Timeout in the desktop app: App Settings > Notifications > Push Notification Inactive Timeout.) At the moment, there is no way to recieve mobile push notifications for each message without closing Discord completely.

Using a webhook, this method will alert via a message to a Discord text channel when a scenaro pops ingame. For the Discord channel you want the message to be posted in, provide the webhook URL in app.config for the value of the webhookUri element.

Pushover

Using the Pushover desktop or mobile applications, recieve a push notification on your device when a scenario pops ingame. This requires signing up for a Pushover account, using the desktop and/or mobile applications, and creating your own application to use it's application token along with your user token in sending alerts.

Setting up Pushover

  1. Create a Pushover account.
  2. Use your User Key as the value for the userToken element in app.config.
  3. Create an Application by defining at least a Name (ScenarioAlerter for example.)
  4. Use the API Token/Key for the application as the value for the applicationToken element in app.config.

scenarioalerter's People

Contributors

aaearon avatar

Watchers

 avatar

Forkers

tvbrowntown

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.