This repository has been archived on 2023-08-07. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
2021-07-14 13:55:36 +01:00
.github Create FUNDING.yml 2020-10-20 11:28:10 +01:00
src Rewrite in TypeScript 2021-07-14 13:55:36 +01:00
.env.template Rewrite in TypeScript 2021-07-14 13:55:36 +01:00
.eslintignore Tests 2021-01-16 19:06:35 +00:00
.eslintrc Tests 2021-01-16 19:06:35 +00:00
.gitignore Rewrite in TypeScript 2021-07-14 13:55:36 +01:00
.gitlab-ci.yml Tests 2021-01-16 19:06:35 +00:00
.npmignore Rewrite in TypeScript 2021-07-14 13:55:36 +01:00
cmd-config.json Update util to check if folder exists 2021-02-07 14:12:56 +00:00
CODE_OF_CONDUCT.md Update documentation with a contact email 2020-11-07 11:22:43 +00:00
CONTRIBUTING.md Adjust links 2020-11-07 21:23:14 +00:00
jest.config.js Tests 2021-01-16 19:06:35 +00:00
LICENSE Initial commit 2020-10-20 10:42:08 +01:00
package.json Rewrite in TypeScript 2021-07-14 13:55:36 +01:00
README.md Fixed some issues 2021-02-01 17:49:08 +00:00
tsconfig.json Rewrite in TypeScript 2021-07-14 13:55:36 +01:00
yarn.lock Rewrite in TypeScript 2021-07-14 13:55:36 +01:00

VylBot Core

Discord bot client based upon Discord.js

Installation

Download the latest version from the releases page.

Copy the config template file and fill in the strings.

{
    "token": "",
    "prefix": "",
    "commands": [
        ""
    ],
    "events": [
        ""
    ]
}
  • Token: Your bot's token
  • Prefix The command prefix
  • Commands: An array of the folders which contain your commands
  • Events: An array of the folders which contain your events

Usage

Implement the client using something like:

const vylbot = require('vylbot-core');
const config = require('config.json');

const client = new vylbot.client(config);
client.start();

See the docs for more information on how to use vylbot-core

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.