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.
vylbot-core/README.md

56 lines
1.3 KiB
Markdown
Raw Normal View History

2020-10-20 10:59:53 +01:00
# VylBot Core
Discord bot client based upon Discord.js
## Installation
2020-11-07 21:23:14 +00:00
Download the latest version from the [releases page](https://github.com/GetGravitySoft/vylbot-core/releases).
2020-10-20 10:59:53 +01:00
Copy the config template file and fill in the strings.
```json
{
"token": "",
"prefix": "",
"commands": [
""
],
"events": [
""
]
2020-10-20 10:59:53 +01:00
}
```
* **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
2020-10-20 10:59:53 +01:00
## Usage
Implement the client using something like:
```js
const vylbot = require('vylbot-core');
const config = require('config.json');
const client = new vylbot.client(config);
client.start();
```
2020-11-07 21:23:14 +00:00
See the [docs](https://github.com/GetGravitySoft/vylbot-core/blob/main/docs/index.md) for more information on how to use vylbot-core
2020-10-20 10:59:53 +01:00
2020-11-03 13:50:55 +00:00
## VylBot Essentials
2020-11-07 21:23:14 +00:00
Want basic commands to add to your bot? Checkout [VylBot Essentials](https://github.com/GetGravitySoft/vylbot-essentials)!
2020-11-03 13:50:55 +00:00
Latest release: `1.0.0` on `3rd November 2020`
2020-10-20 10:59:53 +01:00
## 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.