omarhachach / snorlax

A general purpose Discord bot. Made with discordgo.

Snorlax - See bear for a better bot. (Rework)

Snorlax is yet another modular Discord bot, with loads of premade modules and other features.

This is still in early development, therefore it is subject to frequent breaking changes and rewrites.

Menu

• Features
• Modules
• Getting Started
• Commands
• Running from source
• Contributing
• License

Premade Modules

• Administration
• Eval
• Gambling (WIP)
• Moderation
• Music
• Role Manager
• More to come!

Getting Started

To get the public bot, you can just click here (invalid link, not public yet).

To run it yourself, grab one of the releases. (Still in early development, see running from source).
Once downloaded go to the location of the downloaded binary, create a config.

This a sample config:

{
    "autoDelete": true,
    "dbPath": "./snorlax.db",
    "debug": false,
    "displayAuthor": false,
    "token": "bot-token",
    "owners": [
        "140254342170148864"
    ]
}

When you've created a config, run the program:

$ ./snorlax

Commands

Visit the website (not finished, see help command) for a full list of commands.

Running From Source

To run the bot from source, you need to have Go installed.
You also need to define a GOPATH.

Follow these instructions to compile and run Snorlax form source.

$ go get github.com/omarhachach/snorlax
$ go install github.com/omarhachach/snorlax/cmd/snorlax

It will install it in the bin folder in your GOPATH ($GOPATH/bin).
If you have $GOPATH/bin in your PATH variable, you will be able to run it like so:

$ snorlax

Remember to create a config before running the bot.

Contributing

If you've found a bug, or have a suggestion feel free to open an issue.

You can contact me (the author) on Discord: Omar H.#6299 or via email.

License

Snorlax is licensed under the MIT License.