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/docs/index.md

184 lines
5.1 KiB
Markdown
Raw Normal View History

2020-10-20 12:02:52 +01:00
# VylBot Core Documentation
Welcome to the VylBot Core documentation. In this file we will explain how to setup and use VylBot Core in your project.
## Contents
1. Initial Setup
2. Configuring the client
3. Creating a command
4. Handling an event
5. Configuring command configs
2020-10-20 12:02:52 +01:00
## 1. Initial Setup
To setup the package, download it from `npm`
```bash
cd <project-folder>
npm install vylbot-core
```
Add to your .js file
```js
const vylbot = require('vylbot-core');
2020-11-07 11:09:13 +00:00
const config = require('./config.json');
2020-10-20 12:02:52 +01:00
const client = new vylbot.client(config);
client.start();
```
## 2. Configuring the client
When creating a new `vylbot.client` object you need to pass through some json configuration. This can be either from a .json file or directly written.
> **Note:** We recommend using a .json file and adding it to your `.gitignore` file to prevent accidentally publishing your bot token.
An example configuration:
```json
{
"token": "<YOUR-BOT-TOKEN>",
"prefix": "!",
2020-10-23 18:27:39 +01:00
"commands": [
"commands"
],
"events": [
"events"
],
"cmdconfig": "cmdconfig.json"
2020-10-20 12:02:52 +01:00
}
```
- Make sure the folders that you set for `commands` and `events` exist and are at your project's current working directory.
- Make sure the file set in `cmdconfig` exists and contains json data for the commands (see below)
2020-10-20 12:02:52 +01:00
## 3. Creating a command
A basic command goes as follows:
```js
// commands/test.js
const { command } = require('vylbot-core');
class test extends command {
constructor() {
super("test");
super.description = "Test description";
super.category = "general";
super.configs = "link";
2020-10-20 12:02:52 +01:00
super.roles = "Moderator";
super.roles = "Admin";
super.users = "<ID-HERE>";
2020-10-20 12:02:52 +01:00
}
test(context) {
context.message.channel.send("Hello there, " + context.config.link);
}
}
module.exports = test;
```
1. You create a class and export it using `module.exports` and make it extend the vylbot's `command` class.
2. In the `constructor()` you need to call `super(run)`, replacing `run` with a string of the name of the method which will run when the command runs.
3. Call any of the `super` variables to give it some description, the current ones you can use are: `description`, `category`, `usage`
4. If you want the command to only be allowed to run by people with a role, set the role name in `super.roles`
> **Note:** You can set more than one role to be required by setting `super.roles` again.
5. If you want the command to only be ran by specific users, set their ID in `super.users`
> **Note:** You can set more than one user to be required by settubg `super.users` again.
6. If you want the command to require a variable in the config, set the name in `super.configs`
2020-10-20 12:02:52 +01:00
> **Note:** You can set more than one role to be required by setting `super.configs` again.
2020-10-20 12:02:52 +01:00
7. Create a method using the name you set in `super(run)`, with the `context` as its parameter.
2020-10-20 12:02:52 +01:00
The `context` parameter will be a JSON object of:
```json
{
"command": "<Command Name>",
"arguments": "<Command Arguments>",
"client": "<Bot Client Object",
"message": "Discord.js Message Object",
"config": "The command's config (if any)"
}
```
The command's config will be stored under the command's name, for example, if a command called `test` has set `super.configs = "link"`, it will be set in the config as `test.link`.
2020-10-20 12:02:52 +01:00
## 4. Handling an event
A basic event handling goes as follows:
```js
// events/message.js
const { event } = require('vylbot-core');
class message extends event {
constructor() {
super("message");
}
message(message) {
console.log("Message received: " + message.content);
}
}
module.exports = message;
```
1. You create a class and export it using `module.exports` and make it extend the vylbot's `event` class.
2. In the `constructor()` you need to call `super(run)`, replacing `run` with a string of the name of the method which will run when the event gets triggered.
3. Create a method using the name you set in `super(run)`, with the parameters being as per your event's paramaters in the discord.js documentation.
2020-10-23 18:27:39 +01:00
> **Note:** The name of the event file will determine what event it will be triggered on. For example, if you want to have an event trigger everytime a message is sent, put into your event folder a file called `message.js` and follow the steps above.
## 5. Configuring command configs
The command config json (specified in the main config's `cmdconfig` variable) contiains all the configuration set for the commands.
The syntax is as follows:
```json
{
"Command": {
"Variable": "Value"
}
}
```
- **Command:** The name of the command, such as `ban.js` command would be `ban`.
- **Variable:** The variable name set in the command, this would be one for every `super.configs` in the command's constructor.
- **Value:** The value for the command.
An example would be:
```js
// ban.js
class ban extends Command {
constructor() {
super("ban");
super.configs = "modrole";
// ...
}
// ...
}
```
Would have in the command config file:
```json
{
"ban": {
"modrole": "Moderators"
}
}
```