aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 8a5036e4e91e2392f471e148506248d0fb8d21c7 (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
# Contributing to AleeBot
<p>If you want to help me make AleeBot you must get NodeJS to make AleeBot work.</p>
Include the GPL-3.0 license too and follow the following format when you create a new file:
```
/****************************************
 * 
 *   [Command/Plugin]: (Command or Plugin) for AleeBot
 *   Copyright (C) 2018 AleeCorp & (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/>.
 * 
 * *************************************/
```

# Testing the bot

First get NodeJS then clone this repo then do `npm install` in the AleeBot folder. Now add a file called `tokens.json` then copy and paste this follow code.
```
{
  "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`.