GitBook: [master] 14 pages and one asset modified
This commit is contained in:
Itz Emerald authored and 
gitbook-bot committed
1 parent
951cedb190
commit
65156d4b20
15 files changed
+292
-32
No files matched your search
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
@@ -1,23 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a bug report to help us improve SupportBot.
|
||||
title: "[BUG]"
|
||||
labels: bug
|
||||
assignees: EmeraldRusher
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of the bug you found and how you found it.
|
||||
|
||||
**How did you find it**
|
||||
Please could explain what you did to find the bug?
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Additional context**
|
||||
Feel free to notify with us with anything else about the problem here.
|
||||
@@ -1,15 +1,17 @@
|
||||
|
||||
# SupportBot
|
||||
|
||||
SupportBot the #1 self-hosted discord ticket system with any customizations and features to help make your support system look clean, tidy and professional. It's self-hosted! No need to use someone's public discord bot thats used in a handful of servers. Create, Configure & Use your own discord bot installed with SupportBot.
|
||||
Welcome to the Official Documentation for SupportBot.
|
||||
|
||||
SupportBot is a free discord application that can be easily customised to your own brand. Yes you heard me. This documentation will explain you how to setup & install SupportBot.
|
||||
|
||||
### SupportBot Compatibility
|
||||
If you require any assistance one of our support agents you'd have to contact us over at discord and create a support ticket.
|
||||
|
||||
> Anything older than v6 we will no longer be supporting, However our terms & conditions still remain valid for all copies of our product "SupportBot".
|
||||
**Important Links:**
|
||||
|
||||
|---------|---------|
|
||||
| Version | |
|
||||
|---------|---------|
|
||||
| 6.0. | ✅ |
|
||||
|---------|---------|
|
||||
🤖 **SupportBot
|
||||
GitHub:** [**https://github.com/1tzEmerald/SupportBot/**](https://github.com/1tzEmerald/SupportBot/)
|
||||
**MC-Market:** [**https://www.mc-market.org/resources/8940/**](https://www.mc-market.org/resources/8940/)
|
||||
**Revenact:** [**https://revenact.io/resources/supportbot-1-support-system-for-discord.2**](https://revenact.io/resources/supportbot-1-support-system-for-discord.27/updates)\*\*\*\*
|
||||
|
||||
\*\*\*\*
|
||||
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
# Table of contents
|
||||
|
||||
* [SupportBot](README.md)
|
||||
|
||||
## 🎫SupportBot
|
||||
|
||||
* [Commands](supportbot/untitled.md)
|
||||
* [Changelog](supportbot/changelog.md)
|
||||
* [Download](supportbot/download.md)
|
||||
* [Setup](supportbot/dependencies/README.md)
|
||||
* [Installation](supportbot/dependencies/installation/README.md)
|
||||
* [Hosting Provider](supportbot/dependencies/installation/hosting-provider.md)
|
||||
* [Self-Hosting Installation](supportbot/dependencies/installation/ubuntu-installation.md)
|
||||
* [Addons](supportbot/addons/README.md)
|
||||
* [Creating your own Addon](supportbot/addons/creating-your-own-addon.md)
|
||||
|
||||
## 👮Legal
|
||||
|
||||
* [MIT License](legal/mit-license.md)
|
||||
* [Terms & Conditions](legal/terms-and-conditions.md)
|
||||
|
||||
## 📱Download
|
||||
|
||||
---
|
||||
|
||||
* [Minecraft Market](https://www.mc-market.org/resources/8940/)
|
||||
* [Minemen](https://minemen.com/resources/167/)
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
---
|
||||
description: >-
|
||||
SupportBot is developed by Emerald Services and is installed with an MIT
|
||||
License
|
||||
---
|
||||
|
||||
# MIT License
|
||||
|
||||
**`MIT License`**
|
||||
|
||||
`Copyright (c) 2020` **`Emerald SRV`**
|
||||
|
||||
`Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:`
|
||||
|
||||
`The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.`
|
||||
|
||||
`THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.`
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
description: Terms
|
||||
---
|
||||
|
||||
# Terms & Conditions
|
||||
|
||||
Our terms and conditions apply to all of our products where we publically give you the source code. By using SupportBot we'd appreciate it if you'd take our terms into considersation.
|
||||
|
||||
* SupportBot is free, Do not claim it as your own work.
|
||||
* Do not redistribute SupportBot without permission.
|
||||
* There is no guarantee that all errors/bugs get fixed within a timly manner.
|
||||
* There is no guarantee to keep the resource up to date.
|
||||
* Please contact me before removing any branding.
|
||||
* No refunds for my work.
|
||||
|
||||
#### **SupportBot Addons**
|
||||
|
||||
* 3rd-Party addons are not created by Emerald Services are to be used at your own risk.
|
||||
* There is a No-Refund-Policy for any addons created by Emerald Services
|
||||
|
||||
#### Support
|
||||
|
||||
* Our Support Team can only support you via our Discord Server.
|
||||
* We may strive to provide the best support however we cannot promise every request is done quickly.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
description: SupportBot addons! They are all optional. 3rd-Party & 1st-Party.
|
||||
---
|
||||
|
||||
# Addons
|
||||
|
||||
Addons! What are they? They are additional features that you can add into SupportBot easily created by either the community developers or the official development team.
|
||||
|
||||
Where can addons be found? At this moment in time you can find all our addons via our main website. [https://emeraldservices.xyz/resources/](https://emeraldservices.xyz/resources/)
|
||||
|
||||
{% page-ref page="creating-your-own-addon.md" %}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
# Creating your own Addon
|
||||
|
||||
Creating your own SupportBot may sound easy but you'd need to the knowledge of the programming language \(NodeJS\) and the library \(DiscordJS\).
|
||||
|
||||
**Enough Rambling, On with the guide!**
|
||||
|
||||
1. Start by downloading the [example addon](https://emeraldservices.xyz/resources/resource/6-example-addon/?do=download) and extracting the files into the addons folder
|
||||
2. Rename the example-addon.js file to the name of your choice
|
||||
3. Rename the configuration file under settings to the name of your choice \(if required\)
|
||||
4. Now open the file you named in **Step 2** file in a text editor of your choice
|
||||
5. Change the configuration path in the file you opened in **Step 4**
|
||||
|
||||
```text
|
||||
// We recommend changing the variable below named "example" to a name that relates to your addon
|
||||
// Only change the name exampleaddon.yml to whatever you named the configuration file in Step 3
|
||||
|
||||
const example = yaml.load(fs.readFileSync('./addons/settings/exampleaddon.yml', 'utf8'));
|
||||
```
|
||||
|
||||
Insert your functions inside the following code snippet:
|
||||
|
||||
```text
|
||||
// Ensure to change the variables named "example" below to whatever you changed it to in Step 5
|
||||
|
||||
module.exports = {
|
||||
name: "insert addon name here",
|
||||
description: "insert addon name here",
|
||||
|
||||
execute(message, args) {
|
||||
// Insert your functions here, the below line is not required and is just an example usage of variables
|
||||
message.channel.send(example.ExampleAddonMessage)
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
If your addon requires static variables, We recommend creating them in the configuration file and referencing them inside your addon using.
|
||||
|
||||
```text
|
||||
// The message.channel.send event below is used as an example
|
||||
// Quote marks are not required when referencing a variable, only when a string is present
|
||||
|
||||
message.channel.send(example.VariableName)
|
||||
```
|
||||
|
||||
### Publishing your Addon
|
||||
|
||||
Your addon is you're addon. We Emerald Services are not resposibile for anything to do your addons. So when you've finished developing and you're happy with your work you can share your addon on our official marketplace.
|
||||
|
||||
[https://emeraldservices.xyz/resources/](https://emeraldservices.xyz/resources/)
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# Changelog
|
||||
|
||||
## 6.0.2 - 2020-09-27
|
||||
|
||||
### Fixed
|
||||
|
||||
* This is a small big fix/security update. Updated a dependancy `node-fetch` as well fixing all users being able tickets when ticket departments are enabled.
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# Setup
|
||||
|
||||
## Dependencies <a id="dependencies"></a>
|
||||
|
||||
SupportBot requires few different dependencies in order for the bot work. There isn't many to install but we still require you to have these dependencies installed.
|
||||
|
||||
### Global Dependencies
|
||||
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
If that doesn't work:
|
||||
|
||||
```bash
|
||||
npm install discord.js --save
|
||||
|
||||
npm install js-yaml
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
# Installation
|
||||
|
||||
## Creating your Application
|
||||
|
||||
So assuming you've downloaded SupportBot and installed the required node modules we will move on to creating your application through discord and inviting it to your server.
|
||||
|
||||
{% hint style="info" %}
|
||||
**Login to Discord Developers** [https://discordapp.com/developers/applications](%20https://discordapp.com/developers/applications)
|
||||
{% endhint %}
|
||||
|
||||
Perfect! Now you're logged click on **"New Application"** and follow the steps shown on your screen.
|
||||
|
||||
Created? Now open your application by clicking on it and select the **Bot** tab. Select **Add Bot** and you bot will appear on that page where you can change the icon and view its private information known as a the token.
|
||||
|
||||
{% hint style="danger" %}
|
||||
**Never!** Share your bot's token with anyone. It's at your own risk.
|
||||
{% endhint %}
|
||||
|
||||
## Inviting your Bot
|
||||
|
||||
So we've created the bot, Continuing on go to the **OAuth2** tab and check **Bot** then scroll down a little and check all the permissions you want your bot to have, We'd recommend **Administrator** as you're more likely to not run into any permission errors with the bot.
|
||||
|
||||
Ok so then scroll back up and you should be able to see an long url, Copy that and paste into a new tab and it should take you to your bot's invite page and just select your server.
|
||||
|
||||
## Setting up the Bot
|
||||
|
||||
Ok so now it is time we actually setup the bot assuming you have already downloaded SupportBot & installed the dependencies.
|
||||
|
||||
**Configuration -** The configuration file is stated supportbot-config.yml, This file is very important if you wan't to be able to customise your bot to you're liking and to of cause place your token.
|
||||
|
||||
When you first open the file you'll see at the top it states the version of SupportBot, make sure that you are using 6.0 or newer as thats what this documentation supports.
|
||||
|
||||
### Applying Bot Information
|
||||
|
||||
Ok so theres some important information we need to include in the configuration file before you can start customising it. If you remember from earlier when we made an application go back to that page and head to the bot tab and copy your bot's token and paste it where it says:
|
||||
|
||||
**`Token: "BOT_TOKEN_HERE"`**
|
||||
|
||||
Another setting you'll need is to set a prefix for the bot, This is what you must enter before typing the name of the command for example `-help`.
|
||||
|
||||
**`Prefix: "-"`**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# Hosting Provider
|
||||
|
||||
To make hosting SupportBot nice and simple for you we'd recommend ordering discord bot hosting from Plox Host. Order today pre-installed with SupportBot as long as you've selected SupportBot on the checkout page.
|
||||
|
||||
Plox Host allows you to easily manage SupportBot from a simple control panel.
|
||||
|
||||
### \*\*\*\*[**Order Today**](https://billing.plox.host/aff.php?aff=52) **\|** [**Discord**](https://discord.gg/XzgXu9N)\*\*\*\*
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# Self-Hosting Installation
|
||||
|
||||
Installing on on ubuntu can be simple. Firstly upload SupportBot files to somewhere safe and easy to access on your system. Within the terminal you'd run the following commands:
|
||||
|
||||
#### Installing Node Modules
|
||||
|
||||
```text
|
||||
npm install
|
||||
```
|
||||
|
||||
#### Starting the Bot
|
||||
|
||||
Now you've configured the bot from previous steps & you've installed your node modules lets get the bot to start. By using the command:
|
||||
|
||||
```text
|
||||
node index.js
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# Download
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Download SupportBot" %}
|
||||
#### **SupportBot is a 100% free & customisable discord bot that fits the need of your servers, It has the capability to help your manage your support simply and quickly and with your own brand. Yes you heard you me, your own brand.**
|
||||
|
||||
**Downloads:**
|
||||
[**Minecraft Market**](https://www.mc-market.org/resources/8940/)
|
||||
****[**Minemen**](https://minemen.com/resources/167/)
|
||||
****[**Revenact**](https://revenact.io/resources/supportbot-1-support-system-for-discord.27/)
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# Commands
|
||||
|
||||
## General Commands
|
||||
|
||||
* `-help` \| View all of SupportBot's commands
|
||||
* `-links` \| View some important links
|
||||
* `-suggest` \| Create a server suggestion
|
||||
* `-ping` \| Get the bot's latency
|
||||
|
||||
## Ticket Commands
|
||||
|
||||
* `-ticket [reason]` \| Create a new support ticket
|
||||
* `-close [reason]` \| Close your support ticket **\(Command is for inside ticket channels\)**
|
||||
|
||||
## Staff Commands
|
||||
|
||||
* `-add <user#0000>` \| Add a user to a support ticket
|
||||
* `-remove <user#0000>` \| Remove a user from a support ticket
|
||||
* `-say` \| Say something with the bot
|
||||
* `-announce` \| Create a server announcement
|
||||
|
||||
Reference in new issue
Block a user