diff options
| author | Andrew Lee <andrew@alee14.me> | 2025-03-02 01:04:07 -0500 |
|---|---|---|
| committer | Andrew Lee <andrew@alee14.me> | 2025-03-02 01:04:07 -0500 |
| commit | 9d2e7b26ad067fd13fb6862eb48a6b86a5bb8afd (patch) | |
| tree | 3c0b55a6185c3c03a73dc3b2899dfc221c06f942 /CONTRIBUTING.md | |
| parent | 7df6aafb17a79f278047a244d48c9fdde620811d (diff) | |
| download | AleeBot-9d2e7b26ad067fd13fb6862eb48a6b86a5bb8afd.tar.gz AleeBot-9d2e7b26ad067fd13fb6862eb48a6b86a5bb8afd.tar.bz2 AleeBot-9d2e7b26ad067fd13fb6862eb48a6b86a5bb8afd.zip | |
Starting AleeBot 4.0!
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 2799fb4..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,51 +0,0 @@ -# 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-2023 Andrew Lee & (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: '- [Category] 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",
- "mongoPath": "mongodb://127.0.0.1:27017/aleebot",
- "port": 3000
-}
-```
-Then get your token from discord and replace `token` with your token. After that, install MongoDB and run it. Finally, run this in linux `./run_linux.sh` or for windows `run_win.bat` or `npm/yarn start`.
|