vylbot-essentials v1.0.0

VylBot Essentials

Basic commands for use with the VylBot Core Discord Bot Client.

Installation

Download the latest version of VylBot Core, and VylBot Essentials

npm install vylbot-core
npm install vylbot-essentials

Follow the installation of vylbot-core from the repository.

Add to your config json string:

{
    "essentials": true
}

Command List

Here is a list of commands you get, along with the required configurations it needs.

Everyone

Commands anyone can run

• About (Configs: description, version, author, date)
• Help

Moderator Only

Commands only people with the set moderator command can run

• Ban (Configs: modrole, logchannel)
• Clear (Configs: modrole, logchannel)
• Kick (Configs: modrole, logchannel)
• Mute (Configs: modrole, logchannel, muterole)
• Unmute (Configs: modrole, logchannel, muterole)
• Warn (Configs: modrole, logchannel)

Example Config File

{
    "token": "<TOKEN-HERE>",
    "prefix": "v!",
    "essentials": true,
    "commands": [
        "commands"
    ],
    "events": [
        "events"
    ],
    "about": {
        "description": "Example Bot",
        "version": "1.0.0",
        "author": "Vylpes",
        "date": "29-Oct-20"
    },
    "ban": {
        "modrole": "Moderator",
        "logchannel": "logs"
    },
    "clear": {
        "modrole": "Moderator",
        "logchannel": "logs"
    },
    "kick": {
        "modrole": "Moderator",
        "logchannel": "logs"
    },
    "mute": {
        "modrole": "Moderator",
        "logchannel": "logs",
        "muterole": "Muted"
    },
    "unmute": {
        "modrole": "Moderator",
        "logchannel": "logs",
        "muterole": "Muted"
    },
    "warn": {
        "modrole": "Moderator",
        "logchannel": "logs"
    }
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

We will not merge pull requests unless all checks pass and at least one of the repo members approves it.

See CONTRIBUTING.md for more details.