Git Product home page Git Product logo

xur-notify's Introduction

Go Report Card Build Status license

xur-notify

Push notifications for Xûr's inventory

About

Xûr is the mysterious traveling salesman in Bungie's game Destiny. Each weekend he visits, he brings with him exotic items which he puts up for sale for Guardians.

xur-notify is a little utility, intended to be run on schedule, to instantly notify Guardian's of Xûr's arrival and the particular gifts he bears.

Currently, the following notification methods are supported:

  • Push notifications, with the excellent Pushover
    Note: plans for other notification methods are emerging

What's in the notification

Right now, the notification simply sends a list of the exotic armour/weapons on sale.
In future versions, more detailed information will be provided, such as stat-roll and quality.

Preview

Lockscreen Pushover

Usage

Subscribe via Pushover to receive notifications from xur-notify at 10:00AM UTC every Friday!

Warning: This is an experimental implementation - due to potential influx in users, please bear with me in this initial release. I'm personally hosting the infrastructure triggering the notifications, so there may be some unforeseen problems in early usage

Running your own instance of xur-notify

I have Open Source software and the brilliant community behind it to thank for so much in my life, I'd like to stay true to my roots.
So, if you'd rather just run your own xur-notify, feel free!

In this current implementation, xur-notify requires the following environment variables:

  • BNET_API_KEY - can be obtained from bungie.net
  • PUSHOVER_TOKEN - use your own application token, from pushover.net
  • PUSHOVER_RECIPIENT_KEY - use your user/group token, from pushover.net
  • TIMEZONE - specify your timezone, defaults to Europe/London if unset (use tz database zone format)

Docker

A Docker image (cmacrae/xur-notify) is available, and should be run like so:

docker run --name xur-notify -d -e PUSHOVER_TOKEN=$PUSHOVER_TOKEN -e PUSHOVER_RECIPIENT_KEY=$PUSHOVER_RECIPIENT_KEY -e BNET_API_KEY=$BNET_API_KEY cmacrae/xur-notify:1.0.0-alpha

Note: the relevant environment variables would need to be set in order for this to work

This Docker image simply uses cron to execute xur-notify at 10:00 AM UTC (Xûr's arrival time).
If you'd like to alter this to suit your schedule, you can build your own Docker image changing the following line to your own time in cron format:

RUN echo -e "0\t10\t*\t*\t5\t/bin/xur-notify &> /dev/stdout" > /etc/crontabs/root

Binary

Or, simply head over to the releases page and grab the latest binary for your platform, set your environment variables, and run it!
You'll probably want to have this execute on a schedule, so you get seemless notifications when Xûr arrives.

Licensing

See the LICENSE file

Credit

xur-notify's People

Stargazers

 avatar

Watchers

 avatar  avatar

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.