Git Product home page Git Product logo

vatsim-notify's Introduction

VatsimNotify

This project allows Discord to be able to recieve notifications when a controller logs into VATSIM.
Filtering is also supported, so you will only see alerts for specific airports/facilities.

Notice

This is not an API of any sort, I would highly recommend against using this in another application. 
Most of this project is incomplete (specifically the Controller model). It works as it is, if you modify
it, it may not work the same or at all.

Configuration file

Setting Description
DISCORD_TOKEN The Bot token you want the Discord bot to login with.
POSITION_OPEN_NOTIFICATION The message you want to be sent when a controller connects to the VATSIM network
POSITION_CLOSED_NOTIFICATION The message you want to be sent when a controller who was online goes offline (optional)
CLOSING_NOTIFICATIONS Enable (by setting it to yes or no) controller logoff notifications.
POSITIONS Positions you want the discord bot to announce (example for KMEM, use MEM)
FILTER_POSITIONS Enable position filtering (yes or no)
TEXT_CHANNEL The channel id of the channel you want the bot to use.
VATSIM_DATA_SOURCE The VATSIM data server you want to use (status.vatsim.net for more info)

Setup Tutorial:

You will need at Java 8 (or higher) for this to work. 

Create a Bot "account" at https://discordapi.com (Google it if you don't know how).

Run the jar file (usually java -jar Filename.jar)
On the first run it will give you an error, but the configuration file will have generated.

Edit the config.properties file which was generated (add your Discord Token, and Text Channel)
You can learn more about the options above.

To get a Text Channel ID make sure you have "Developer mode" on Discord enabled, you can enable it
by going to Settings -> Appearance, and enabling Developer mode, then right click the channel you want to use
and click "Copy ID", put that in the TEXT_CHANNEL option in the config.properties file.

Now you can run the Bot.

You then need to add the Bot to your Discord server, you can look this up on Google, its not hard.

vatsim-notify's People

Contributors

jordanndev 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.