# Welcome
SeedBot Documentation
## [Installing SeedBot](/bot-install/guide-directory)
SeedBot is compatible with many operating systems, we suggest using a \*nix operating system that can support Node.JS and the Node Package Manager, If you would like to check if your operating system is compatible then look at the Guide Directory!
## [API Documentation](/api/api-directory)
If you want more information about the SeedBot Bot API then just click on the title above!
\
# SeedBot Install Guide
APT Package Manager (Debian Based Distros)\
Brew \[Darwin/macOS]\
MacPorts \[Darwin/macOS]\
PacMan Package Manager (Arch-based, etc...)\
Portage Package Manager (Gentoo-based, etc...)\
Zypper Package Manager (openSUSE/SUSE-based)\
YUM Package Manager (Fedora, RedHat, CentOS, etc...)
# APT Package Manager
Debian-based
## Installing SeedBot and its Dependencies
To Install and Download everything you need put this into your console first:
```
$ sudo apt-get install curl -y
```
**Before you put this command in make sure you are in the directory that you want SeedBot in!**
```
$ curl -sL http://install.cdn.seedbot.xyz/apt | sudo -E bash -
```
Now, Once you have executed that this should show in your console, if this does not show then you have done something wrong or I have done something wrong, If you need any help feel free to Join my [Discord Server](https://discord.gg/VMszsux) to get some help!
Once you have ran this you can start getting your tokens for the bot!
## Configuring SeedBot
The first thing you need to do is Create a Discord Application and a Bot User to get your Bot Token, to do this I suggest [this guide](https://www.digitaltrends.com/gaming/how-to-make-a-discord-bot/).
Now to get your bot token you need to go onto your Application Page, Click Bot on the left, then click `Copy` below `Click to Reveal Token`
Once you have your Bot Token Go into the folder where you installed SeedBot and open the file `config.json` in your perfered text editor, I'll be using GNU Nano, now replace `token-here` on the second like with your token that you just copied!
After you have done that you now need to get your Youtube API v3 Token if you want the music commands to work.
To go to your credential page [click here](https://console.developers.google.com/apis/credentials), then click on `Create Project`
Enter a Project Name of your choice
Now it is time to enable the YouTube Data API, First off you need to click on Library on the left hand side of the website.
After you have done that search for `YouTube Data API v3`
Once you have done that, Click on `YouTube Data API v3` and click on the Enable Button
And Select the YouTube API with the Web Server Setting under `Where will you be calling the API from?`
Now you can Copy your API Key by clicking on the copy button on the far right side of the text box where the API Key is (circled in red).
Now you can go back into your perfered text editor of choice then open back up the `config.json` file, then replace `youtube-api-token` on line 3 with the token you just copied.
Now once you have done that you can start SeedBot!
To start SeedBot just type in your terminal
```
$ node bot.js
```
Now this should show in your console if you have done everything correctly.
```bash
jyles@JylesDesktop:~/seedbot$ node bot.js
ℹ INFO Starting SeedBot...
ℹ INFO Copyright 2018-2019, jyles.club and DARiOX.club
ℹ INFO Branch: Stable
ℹ INFO Running SeedBot Stable (1.3.0, build856)
ℹ INFO Bot started at Mon Oct 07 2019 23:47:12 GMT+0800 (GMT+08:00)
ℹ INFO Bot has started, with 21251 users, in 679 channels of 27 guilds.
------- Music Bot -------
> Version: 13.8.1
> Extra Logging: false.
> Node.js Version: v12.10.0
------- Music Bot -------
```
Congratulations! You have successfully installed SeedBot!
If you have any problems feel free to join my [Support Discord Server](https://discord.gg/VMszsux) or send us an [E-mail!](mailto:contact@dariox.club)
# Brew
macOS/Darwin
## Installing SeedBot and its Dependencies
To Install and Download everything you need put this into your console first:
```
$ /usr/bin/ruby -e "$(curl -fsSL http://install.cdn.seedbot.xyz/darwin-brew)"
```
Now, Once you have executed that this should show in your console, if this does not show then you have done something wrong or I have done something wrong, If you need any help feel free to Join my [Discord Server](https://discord.gg/VMszsux) to get some help!
Once you have ran this you can start getting your tokens for the bot!
## Configuring SeedBot
The first thing you need to do is Create a Discord Application and a Bot User to get your Bot Token, to do this I suggest [this guide](https://www.digitaltrends.com/gaming/how-to-make-a-discord-bot/).
Now to get your bot token you need to go onto your Application Page, Click Bot on the left, then click `Copy` below `Click to Reveal Token`
Once you have your Bot Token Go into the folder where you installed SeedBot and open the file `config.json` in your perfered text editor, I'll be using GNU Nano, now replace `token-here` on the second like with your token that you just copied!
After you have done that you now need to get your Youtube API v3 Token if you want the music commands to work.
To go to your credential page [click here](https://console.developers.google.com/apis/credentials), then click on `Create Project`
Enter a Project Name of your choice
Now it is time to enable the YouTube Data API, First off you need to click on Library on the left hand side of the website.
After you have done that search for `YouTube Data API v3`
Once you have done that, Click on `YouTube Data API v3` and click on the Enable Button
And Select the YouTube API with the Web Server Setting under `Where will you be calling the API from?`
Now you can Copy your API Key by clicking on the copy button on the far right side of the text box where the API Key is (circled in red).
Now you can go back into your perfered text editor of choice then open back up the `config.json` file, then replace `youtube-api-token` on line 3 with the token you just copied.
Now once you have done that you can start SeedBot!
To start SeedBot just type in your terminal
```
$ node bot.js
```
Now this should show in your console if you have done everything correctly.
```bash
jyles@JylesLaptop:~/seedbot$ node bot.js
ℹ INFO Starting SeedBot...
ℹ INFO Copyright 2018-2019, jyles.club and DARiOX.club
ℹ INFO Branch: Stable
ℹ INFO Running SeedBot Stable (1.3.0, build856)
ℹ INFO Bot started at Mon Oct 07 2019 23:47:12 GMT+0800 (GMT+08:00)
ℹ INFO Bot has started, with 21251 users, in 679 channels of 27 guilds.
------- Music Bot -------
> Version: 13.8.1
> Extra Logging: false.
> Node.js Version: v12.10.0
------- Music Bot -------
```
Congratulations! You have successfully installed SeedBot!
If you have any problems feel free to join my [Support Discord Server](https://discord.gg/VMszsux) or send us an [E-mail!](mailto:contact@dariox.club)
# MacPorts
macOS/Darwin
# PacMan Package Manager \[WIP]
Arch-based
## Installing SeedBot and its Dependencies
To Install and Download everything you need put this into your console first:
```
$ sudo pacman -S --noconfirm curl
```
**Before you put this command in make sure you are in the directory that you want SeedBot in!**
```
$ curl -sL http://install.cdn.seedbot.xyz/pacman | sudo -E bash -
```
Now, Once you have executed that this should show in your console, if this does not show then you have done something wrong or I have done something wrong, If you need any help feel free to Join my [Discord Server](https://discord.gg/VMszsux) to get some help!
Once you have ran this you can start getting your tokens for the bot!
## Configuring SeedBot
The first thing you need to do is Create a Discord Application and a Bot User to get your Bot Token, to do this I suggest [this guide](https://www.digitaltrends.com/gaming/how-to-make-a-discord-bot/).
Now to get your bot token you need to go onto your Application Page, Click Bot on the left, then click `Copy` below `Click to Reveal Token`
Once you have your Bot Token Go into the folder where you installed SeedBot and open the file `config.json` in your preferred text editor, I'll be using GNU Nano, now replace `token-here` on the second like with your token that you just copied!
To Exit and Save the Config File hold down this following Key Combination `Ctl + X`
After you have done that you now need to get your Youtube API v3 Token if you want the music commands to work.
To go to your credential page [click here](https://console.developers.google.com/apis/credentials), then click on `Create Project`
Enter a Project Name of your choice
Now it is time to enable the YouTube Data API, First off you need to click on Library on the left hand side of the website.
After you have done that search for `YouTube Data API v3`
Once you have done that, Click on `YouTube Data API v3` and click on the Enable Button
And Select the YouTube API with the Web Server Setting under `Where will you be calling the API from?`
Now you can Copy your API Key by clicking on the copy button on the far right side of the text box where the API Key is (circled in red).
Now you can go back into your perfered text editor of choice then open back up the `config.json` file, then replace `youtube-api-token` on line 3 with the token you just copied.
Now once you have done that you can start SeedBot!
To start SeedBot just type in your terminal
```
$ node bot.js
```
Now this should show in your console if you have done everything correctly.
```bash
[jyles@SeedBot-Yum-Dev seedbot]$ node bot.js
ℹ INFO Starting SeedBot...
ℹ INFO Copyright 2018-2019, jyles.club and DARiOX.club
ℹ INFO Branch: Stable
ℹ INFO Running SeedBot Stable (1.3.0, build856)
ℹ INFO Bot started at Mon Oct 07 2019 23:47:12 GMT+0800 (GMT+08:00)
ℹ INFO Bot has started, with 21251 users, in 679 channels of 27 guilds.
------- Music Bot -------
> Version: 13.8.1
> Extra Logging: false.
> Node.js Version: v12.10.0
------- Music Bot -------
```
Congratulations! You have successfully installed SeedBot!
If you have any problems feel free to join my [Support Discord Server](https://discord.gg/VMszsux) or send us an [E-mail!](mailto:contact@dariox.club)
# YUM Package Manager
Fedora, RedHat, CentOS, etc...
## Installing SeedBot and its Dependencies
To Install and Download everything you need put this into your console first:
```
$ sudo yum install curl -y
```
**Before you put this command in make sure you are in the directory that you want SeedBot in!**
```
$ curl -sL http://install.cdn.seedbot.xyz/yum | sudo -E bash -
```
Now, Once you have executed that this should show in your console, if this does not show then you have done something wrong or I have done something wrong, If you need any help feel free to Join my [Discord Server](https://discord.gg/VMszsux) to get some help!
Once you have ran this you can start getting your tokens for the bot!
## Configuring SeedBot
The first thing you need to do is Create a Discord Application and a Bot User to get your Bot Token, to do this I suggest [this guide](https://www.digitaltrends.com/gaming/how-to-make-a-discord-bot/).
Now to get your bot token you need to go onto your Application Page, Click Bot on the left, then click `Copy` below `Click to Reveal Token`
Once you have your Bot Token Go into the folder where you installed SeedBot and open the file `config.json` in your preferred text editor, I'll be using GNU Nano, now replace `token-here` on the second like with your token that you just copied!
To Exit and Save the Config File hold down this following Key Combination `Ctl + X`
After you have done that you now need to get your Youtube API v3 Token if you want the music commands to work.
To go to your credential page [click here](https://console.developers.google.com/apis/credentials), then click on `Create Project`
Enter a Project Name of your choice
Now it is time to enable the YouTube Data API, First off you need to click on Library on the left hand side of the website.
After you have done that search for `YouTube Data API v3`
Once you have done that, Click on `YouTube Data API v3` and click on the Enable Button
And Select the YouTube API with the Web Server Setting under `Where will you be calling the API from?`
Now you can Copy your API Key by clicking on the copy button on the far right side of the text box where the API Key is (circled in red).
Now you can go back into your perfered text editor of choice then open back up the `config.json` file, then replace `youtube-api-token` on line 3 with the token you just copied.
Now once you have done that you can start SeedBot!
To start SeedBot just type in your terminal
```
$ node bot.js
```
Now this should show in your console if you have done everything correctly.
```bash
[jyles@SeedBot-Yum-Dev seedbot]$ node bot.js
ℹ INFO Starting SeedBot...
ℹ INFO Copyright 2018-2019, jyles.club and DARiOX.club
ℹ INFO Branch: Stable
ℹ INFO Running SeedBot Stable (1.3.0, build856)
ℹ INFO Bot started at Mon Oct 07 2019 23:47:12 GMT+0800 (GMT+08:00)
ℹ INFO Bot has started, with 21251 users, in 679 channels of 27 guilds.
------- Music Bot -------
> Version: 13.8.1
> Extra Logging: false.
> Node.js Version: v12.10.0
------- Music Bot -------
```
Congratulations! You have successfully installed SeedBot!
If you have any problems feel free to join my [Support Discord Server](https://discord.gg/VMszsux) or send us an [E-mail!](mailto:contact@dariox.club)
# Portage Package Manager
# Zypper Package Manager
openSUSE/SUSE-based
## Installing SeedBot and its Dependencies
To Install and Download everything you need put this into your console first:
```
> sudo zypper -n install nano curl
```
**Before you put this command in make sure you are in the directory that you want SeedBot in!**
```
> curl -sL http://install.cdn.seedbot.xyz/zypper | sudo -E bash -
```
Now, Once you have executed that this should show in your console, if this does not show then you have done something wrong or I have done something wrong, If you need any help feel free to Join my [Discord Server](https://discord.gg/VMszsux) to get some help!
Once you have ran this you can start getting your tokens for the bot!
## Configuring SeedBot
The first thing you need to do is Create a Discord Application and a Bot User to get your Bot Token, to do this I suggest [this guide](https://www.digitaltrends.com/gaming/how-to-make-a-discord-bot/).
Now to get your bot token you need to go onto your Application Page, Click Bot on the left, then click `Copy` below `Click to Reveal Token`
Once you have your Bot Token Go into the folder where you installed SeedBot and open the file `config.json` in your preferred text editor, I'll be using GNU Nano, now replace `token-here` on the second like with your token that you just copied!
To Exit and Save the Config File hold down this following Key Combination `Ctl + X`
After you have done that you now need to get your Youtube API v3 Token if you want the music commands to work.
To go to your credential page [click here](https://console.developers.google.com/apis/credentials), then click on `Create Project`
Enter a Project Name of your choice
Now it is time to enable the YouTube Data API, First off you need to click on Library on the left hand side of the website.
After you have done that search for `YouTube Data API v3`
Once you have done that, Click on `YouTube Data API v3` and click on the Enable Button
And Select the YouTube API with the Web Server Setting under `Where will you be calling the API from?`
Now you can Copy your API Key by clicking on the copy button on the far right side of the text box where the API Key is (circled in red).
Now you can go back into your perfered text editor of choice then open back up the `config.json` file, then replace `youtube-api-token` on line 3 with the token you just copied.
Now once you have done that you can start SeedBot!
To start SeedBot just type in your terminal
```
> node bot.js
```
Now this should show in your console if you have done everything correctly.
```bash
jyles@SeedBot-Zypper-Dev:~/seedbot> node bot.js
ℹ INFO Starting SeedBot...
ℹ INFO Copyright 2018-2019, jyles.club and DARiOX.club
ℹ INFO Branch: Stable
ℹ INFO Running SeedBot Stable (1.3.0, build856)
ℹ INFO Bot started at Mon Oct 07 2019 23:47:12 GMT+0800 (GMT+08:00)
ℹ INFO Bot has started, with 21251 users, in 679 channels of 27 guilds.
------- Music Bot -------
> Version: 13.8.1
> Extra Logging: false.
> Node.js Version: v12.10.0
------- Music Bot -------
```
Congratulations! You have successfully installed SeedBot!
If you have any problems feel free to join my [Support Discord Server](https://discord.gg/VMszsux) or send us an [E-mail!](mailto:contact@dariox.club)
# API Directory
Hi All! Welcome to the Bot API Directory, if you want to learn about how to use the API in your own website then [>> click here <<](/api/api-usage)
# API Usage
When using the API you need to give the Server a GET Request otherwise it will return a Error 400 Bad Request Message, this will also display if there is to request provided.
If you want to make a request to the server the URI would be `http://[server address]/?req=[request]` In the table below is a list of requests and the expected output.
| Request | Description | Expected Output |
| ------------------ | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| test | Test Response | `It Works!
` |
| userCount | Will Respond with the latest user count from the bot | `18906` |
| channelCount | Latest channel count from the bot | `627` |
| guildCount | Latest Guild/Server Count from the Bot | `27` |
| botBranch | Bot branch defined in `package.json` | `stable` |
| packageName | Package Name defined in `package.json` | `SeedBot` |
| botBuild | Build number defined in `package.json` | `859` |
| packageDescription | Description defined in `package.json` | `A Discord Bot for Developers by Developers, and some basic functions that every bot has.` |
| botOwnerID | ownerID Defined in `package.json` | `230485481773596672` |
| botEngines | Replies with `engines` defined in `package.json` | `{ "node": "8.16.0" }` |
| packageScripts | Replies with `scripts` defined in `package.json` | `{ "start": "node bot.js" }` |
| botDependencies | Replies with `dependencies` defined in `package.json` | `{ "child_process": "^1.0.2", "discord.js": "^11.5.1", "discord.js-musicbot-addon": "^13.5.2", "external-ip": "^2.1.1", "figlet": "^1.2.3", "opusscript": "0.0.6", "signale": "^1.4.0" }` |
| packageRepository | Replies with `repository` defined in `package.json` | `{ "type": "git", "url": "git+`[`https://github.com/discordseedbot/stable.git`](https://github.com/discordseedbot/stable.git)`" }` |
| author | Replies with `author` defined in `package.json` | `Jyles Coad-Ward [jyles@dariox.club]` |
| botLicense | Replies with the Licence that the Bot/Current Branch Uses | `GPL-3.0-or-later` |
| botBugReportUrl | Replies with the Issues Github Page | [`https://github.com/discordseedbot/stable/issues`](https://github.com/discordseedbot/stable/issues) |
| botHomepage | Replies with `homepage` defined in `package.json` | `https://seedbot.xyz` |
| apiVersion | Replies with the varaible `apiVersion` near the top of the API PHP script. | `1.1` |
| | | |
| | When no request is made | `400 Bad Request Please look at the source code of the API to grasp a better understanding!` |