Git Product home page Git Product logo

dyno-status's Introduction

dyno-status

A Discord Bot which will show the real-time status of Dyno

Installation and Startup

  1. Clone the repository
  2. Node 10 is required, so head to the Node.js download page and download/install the LTS version
  3. Run npm install to install the dependencies (Eris, Axios and mathjs)
  4. Create a new bot application (see Creating a bot account)
  5. Open config.json and set your desired channel ID for the status to go to
  6. Start the bot

Creating a bot account

  1. Head to the Discord Developer Portal
  2. Press New Application, call it whatever you want to name your bot
  3. Head to the Bot tab, Add Bot
  4. Copy the bot token - DO NOT SHARE THIS WITH ANYONE
  5. Put the bot token in between the '' on the first line of index.js, save
  6. Head back to the Developer Portal, open the OAuth2 tab
  7. Under Scopes, tick only the bot option
  8. Give the bot Send Messages and Embed Links IMPORTANT!, the rest of the permissions are optional
  9. Copy the URL, then invite the bot to your desired server

About the bot

  • dyno-status serves as an easy way to check the real time status of the public version of Dyno, instead of having to visit their status page
  • Every 20 seconds, dyno-status will send an API request to the status page, fetching the most recent information available. After the information has been received, dyno-status will translate the information relayed into an embed which looks something like this: Status example
  • An API request is sent every 20 seconds and the latest information from the API is updated every 15 seconds. So when a status update is fetched, you will see the uptime jump 15 seconds each refresh rather than 20 seconds. This is not something to worry about

Why did I decide to create this?

  • I wanted a way of easily accessing the real time connection status of Dyno with Discord, and the best way is to check the platform you're using, Discord
  • Doing support, if someone reports an offline server, it takes time to grab their server ID, load the status page and verify what cluster/shard the server is on. Having a bot which has the latest information for you makes this so much more easier
  • I wanted to get myself involved in more JavaScript
  • I was bored. No joke. I had nothing to do.

Disclaimer

  • Although I am a Trusted member of Dyno, Dyno has no affiliation or relation with this project in any way. This was my own personal project, and I may remove this repository at the developer's request.
  • The bot was built on Node.js 10.16.0 LTS. I will support Node versions 10+, however if bugs occur on versions below Node 10, I will not fix them. However, if you wish to fix any bugs relating to this, feel free to make a PR.

Release History

  • 0.0.1 Initial Release

dyno-status's People

Contributors

bsian03 avatar

Stargazers

Tominous avatar

Watchers

James Cloos avatar Tominous avatar

Forkers

tominous

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.