Giter VIP home page Giter VIP logo

clem-fandango-bot's Introduction

Clem Fandango Bot

npm version

ClemBot is the health check for your Discord bot connection, that you never knew you needed. Much like Alexander Graham Bell's pioneering message to Watson, ClemBot will send a message to a random member (read: victim) in your configured Discord channel if the handshake with Discord's API was successful.

Installation

To install ClemBot, simply use your preferred node package management library to pull the binary from the npm registry.

With npm:

npm install -g clem-fandango-bot

or, with yarn:

yarn install -g clem-fandango-bot

Setup

To utilize ClemBot with your Discord server, hop in to the Discord Developer Portal and create a new application.

Next, generate a secret in the bot tab for your application, and grant your bot (at a minimum) Send Message and Read Message History permissions. Usage of ClemBot will require this bot token. Keep it secret, keep it safe!

Usage

$ clembot                                                                               
Token (-t) required to authenticate clembot.
usage: clembot [-t=<token>]
-t     token for authentication
$ clembot -t {token-redacted}  
  ,--,  ,-.    ,---.            ,---.    .---.  _______ 
.' .')  | |    | .-'  |\    /|  | .-.\  / .-. )|__   __|
|  |(_) | |    | `-.  |(\  / |  | |-' \ | | |(_) )| |   
\  \    | |    | .-'  (_)\/  |  | |--. \| | | | (_) |   
 \  `-. | `--. |  `--.| \  / |  | |`-' /\ `-' /   | |   
  \____\|( __.'/( __.'| |\/| |  /( `--'  )---'    `-'   
        (_)   (__)    '-'  '-' (__)     (_)             

You will see logging from ClemBot whenever a member is notified.

[Sun Oct 27 2019 23:30:57 GMT-0500 (Central Daylight Time)] Notifying Clyde in general

Future Development

The bot is fairly simple for now. I intend to allow future customization of the bot with additional flags for specifying notification frequency, which message to notify, etc. Pull Requests and Issues are welcome if you would like to assist with development!

clem-fandango-bot's People

Contributors

dbelling avatar dependabot[bot] avatar

Stargazers

 avatar

Watchers

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