-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
53 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| node_modules | ||
| config.json | ||
| config.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,40 @@ | ||
| # CommanderBot | ||
| Discord bot to manage your exaroton servers. New version of PhoenixAPI. | ||
| ## What does it do? | ||
| CommanderBot is an updated and improved version of [PhoenixAPI-Bot](https://github.com/Alex22sv/PhoenixAPI-Bot) which has the same commanods but the difference between both bots is that CommanderBot no longer uses message commands but slash commands. | ||
| ## Slash commands? | ||
| Yes. CommanderBot will only reply through slash commands, e.g. `/help`. | ||
|  | ||
| ## Setting up the bot | ||
| ### Requirements | ||
| - [Node.js](https://nodejs.org/en/download/) | ||
| - [discord.js](https://discord.js.org/) | ||
| - [exaroton API](https://www.npmjs.com/package/exaroton) | ||
|
|
||
| ### What's next? | ||
| 1. Download the code. | ||
|  | ||
| 2. Run `npm install` in the path where you have the main folder. | ||
|  | ||
| 3. Create a Discord application [here](https://discord.com/developers/applications/) | ||
|  | ||
| 4. Click the "Bot" tab and "Add Bot". | ||
|  | ||
| 5. Copy your Discord token. | ||
|  | ||
| 6. Move the file `example.config.json` to the `src` folder and rename it to `config.json`, then paste the Discord token inside the `discordToken` value. | ||
|  | ||
| 7. Go to your [exaroton account](https://exaroton.com/account/), copy the exaroton API token and paste it inside the `exarotonAPIkey` value. | ||
|  | ||
|  | ||
| 8. To invite the bot to your server use [this link](https://discord.com/oauth2/authorize?client_id=ID&scope=bot&permissions=75776) and replace the 'ID' with the client ID of your application which you can find [here](https://discord.com/developers/applications/) | ||
|  | ||
|  | ||
|  | ||
| 9. Paste the client ID you copied from the Discord Developer Portal and paste it inside the `clientId` value in the config file. | ||
|  | ||
|
|
||
| ### Starting the bot | ||
| Once you have the bot on your server and added all the config to the `config.json` file, you can start the bot running the command `node main.js`. Make sure the path is set to the `CommanderBot` folder. | ||
| You'll see this message when the bot is online: | ||
|  | ||
| And done! The bot is set up and online. You can now run `/help` to get the list of commands. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "clientId": "992325156569628732", | ||
| "discordToken": "OTkyMzI1MTU2NTY5NjI4NzMy.GHFm4T.HtIZesN9Atd9WJZN7Rbset5am0h34SXYSUSElg", | ||
| "exarotonAPIkey": "5bVh3735Eevp08EHzQyG4XMFDryatFdPHwPojgjOJx242eTvUhpAu2twJmzTDkD921xAfwN495AEVgpRCy4V0BFSP9sxEpGQHHyQ", | ||
| "botVersionURL": "https://github.com/Alex22-SV/CommanderBot/", | ||
| "botGitHubURL": "https://github.com/Alex22-SV/CommanderBot/", | ||
| "exarotonDocs": "https://developers.exaroton.com/", | ||
| "discord": "", | ||
| "serverManagerRoleId" : "", | ||
| "embedColor": "#19ba19", | ||
| "errorColor": "#f91c1c", | ||
| "loadingEmoji" : "<a:loading:882124504451653652>" | ||
| } |