aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 473704aa77198098f71b0f669f18ec39b770274c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# Contributing to AleeBot
If you want to help me make AleeBot you must get NodeJS to make AleeBot work.
Include the GPL-3.0 license too and follow the following format when you create a new file:
```js
/****************************************
 * 
 *   [Command/Plugin]: (Command or Plugin) for AleeBot
 *   Copyright (C) 2017-2020 Alee Productions & (your name here)
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * *************************************/

 module.exports.run = async (client, message) => {
  // Code here
};

exports.conf = {
  aliases: [],
  guildOnly: false,
};
exports.help = {
  name: 'name here',
  description: 'Description here.',
  usage: 'Usage [here]',
  category: '- General Commands',
};
```

# Testing the bot

First get NodeJS then clone this repo then do `npm install` or `yarn install` in the AleeBot folder. Now add a file called `tokens.json` then copy and paste this follow code.
```json
{
  "abtoken": "token"
}
```
Then get your token from discord and replace `token` with your token and finally run this in linux `./run_linux.sh` or for windows `run_win.bat` or `npm/yarn start`.