vee-frostbyte

command module
v0.0.0-...-d3e3e2c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2017 License: MIT Imports: 12 Imported by: 0

README

Frostbyte
Build Status Go Report Card Discord Server Invite Echo Discord Gophers

Open Source Discord Bot written in Golang (DiscordGo library by bwmarrin)
Comes with a few commands and a light weight A.R.S

Option Information
Discord Developers Register a bot account with Discord!
Discord Go DiscordGo Library by: bwmarrin
Discord Go (Go Docs) Godocs collection for DiscordGo

Config Frostbyte

When you clone this branch you will see config.json with two entries.
Token -> Discord Bot Token
Guild -> Your Guild ID

Once you setup and run Frostbyte for the first time to initate the databse
You can set your .greet or .autorole
Once you set one of these systems your config.json file will change.

You will have the option to set AutoRole, Greeting, ByeMsg and even the channels right from the config.json!

{
  "Token": "Discord-Token",
  "Guild": "Your Guild ID",
  "System": {
    "Prefix": "!",                        // Bot Prefix
    "Autorole": "Member",                 // Autorole System
    "Greeting": "Testing stuff {/user}!", // Greet Message!
    "ByeMsg": "",                         // Bye Message
    "Channels": {
      "Autorole": "",                     // Channel for Autorole
      "Greeting": "",                     // Channel for greet
      "ByeMsg": ""                        // Channel for bye.
    },
    "Messages": []                        // List of messages in the collection.
  }
}

Commands:

.auto trigger={init}Response
.delauto trigger
.autorole role name
.greet Greet Message
.viewauto
.inspect trigger
.addstatus Message
.delstatus Message
.viewstatus

A.R.S Keys

{pm}           - Pms the user
{user}         - Mentions the user
{/user}        - Says the users name.
{chan}         - Mentions current channel
{listroles}    - Lists all server roles.
{topic}        - Shows current channel topic.
{redirect}     - {redirect:Channel-ID} Redirect msg to another channel.

More commands and keys coming soon!

Want to contribute?

Make a pull request to develop If it passes I will merge!

Code Specifications

1. gofmt -s your code!
2. golint your code!
3. English commenting only!
4. No ineffectual assignments!
5. No suspicious constructs!

You can run your branch through Go Report Card Which will check for all cases above
We need to maintain an A or A+ Standard.

Master branch

Stable build of Frostbyte available for use!
Develop branch will be merged to master every few days.
We will work on a wikipedia explaining features and usage soon!

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL