Giter Club home page Giter Club logo

nfc-info-bot's Introduction

nfc-info-bot

About

The nfc-info-bot exists to assist with providing fast and standardized answers to many of the most common questions asked on the NFC Discord server. The goal is for this information to be community-driven, but still moderated. If you would like to contribute to the project, please feel free to fork it, or open issues (please use the new command, new info, or incorrect info labels for most submissions, as appropriate). If you would like more direct involvement, message @Sm0keWag0n on the NFC Discord server to request access.

Command Data

Data for the commands is stored in JSON format, in the commands.json file. Most of the data is what is required for an Embed object, but some fields have been added. Keeping the commands alphabetized is preferred, although not required and there is no linting to enforce such.

Example:

    "!brickless": {
        "info": "Brickless configurations",
        "color": "#0099ff",
        "title": "Brickless Fitment Info",
        "description": "\"Brickless\" is a configuration where the...",
        "dm": false,
        "fields": [
            {
                "name": "Standard Layout",
                "value": "The most common brickless configuration is....",
                "inline": false
            }
        ]
    }
Section Detail
"!brickless" Command name
"info" Short name for for command list
"color" Color for MessageEmbed object (generally leave this set to "#0099ff")
"title" Header for MessageEmbed
"description" Main block of text in the MessageEmbed
"dm" Set to true if the content is long enough to cause channel congestion issues
"fields" Add a field entry for each subsection, and try to keep subsection content short
"fields"->"name" Header for subsection
"fields"->"value" Text content for subsection
"fields"->"inline" false for large content blocks, true for very small (one-line) data

Bot Command Updates

The bot will automatically refresh its list of commands from the repo hourly at the top of the hour, so once changes have been approved and merged into the master branch, they will be visible in the bot within an hour. If you believe that the change is important enough to warrant immediate update, please ping @Sm0keWag0n on the NFC Discord server.

Environment Variables

Variable Description
BOT_TOKEN Discord bot token used for authentication
COMMAND_URL URL to commands.json for command data
ADMIN_USER ID of discord user who can run restricted commands
LOG_CHANNEL ID of channel to log information to

nfc-info-bot's People

Contributors

mikedalton avatar jonasluks avatar carc1n0gen avatar garymint avatar mendelmaleh avatar dependabot[bot] avatar

Stargazers

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