2019-11-18 16:12:28 +00:00
<h1 align="center">SupportBot v5</h1>
2019-11-18 16:11:23 +00:00
<h4 align="center">#1 Discord Support System</h4>
2019-06-11 17:56:47 -06:00
<p align="center">
2019-08-10 11:52:08 +01:00
<img src="https://img.shields.io/badge/Made%20with-NodeJS-blue.svg" alt="Made with NodeJS">
<img src="https://img.shields.io/github/release/EmeraldRusher/SupportBot.svg" alt="GitHub release">
2019-06-19 12:19:48 -06:00
<img src="https://img.shields.io/github/package-json/dependency-version/EmeraldRusher/SupportBot/discord.js.svg" alt="GitHub package.json dependency version (prod)">
2019-06-11 17:56:47 -06:00
</p>
2019-06-10 00:36:26 +01:00
SupportBot is a free & open source discord bot for your server that has the capability to control & manage your servers support.
2019-06-19 22:56:04 -06:00
| Version | Supported | Status |
2019-06-10 00:41:18 +01:00
| ------- | ------------------ |--------------------|
2019-06-19 22:56:04 -06:00
| 1.x | 🚫 | Discontinued |
| 2.x | 🚫 | Discontinued |
| 3.x | ✔️ | Supported |
2019-07-24 16:51:11 -06:00
| 4.x | ✔️ | Supported |
2019-11-18 16:12:13 +00:00
| 5.x | ✔️ | Supported |
2019-06-10 20:05:57 +01:00
# Getting Started
Firstly you will need to download the resource, Once you have downloaded the resource open a new tab in your browser and go to https://discordapp.com/developers/applications/. Create a new application and then open your app and select bot and then create your bot. Copy the bot token and paste it where it says ``"token": "BOT TOKEN HERE",`` in the ``settings.json`` file.
2019-06-10 20:16:41 +01:00
# Invite the bot
Head back to discord developers portal where your application is and head into the ``OAuth`` tab and select bot and then below select ``Administrator`` then copy the link and paste into your browser and it should as your to invite the bot to a server.
2019-06-19 13:23:37 -06:00
# Help
If you don't understand something, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [Emerald Services Server](https://discord.gg/u47MQJ).
2019-06-10 20:16:41 +01:00
# Configurating SupportBot
Once you have setup your discord application such as invited the bot and added your bot token to the ``settings.json`` we can begin configurating your bot. Firstly open up the ``settings.json`` file and you will see loads of different things to config. You will see the following below:
` ``
2019-06-18 13:09:00 -03:00
{
2019-07-24 16:49:51 -06:00
"SupportBot": "v4.0.0",
"token": "BOT_TOKEN_HERE",
2019-06-18 13:09:00 -03:00
"prefix": "!",
"botname": "SupportBot",
2019-07-24 16:49:51 -06:00
"colour": "#13bd2a",
"footer": "Support Bot, By Emerald Services",
2019-06-19 22:24:37 -06:00
2019-06-18 13:09:00 -03:00
"BotStatus": "Support Bot",
2019-06-19 22:24:37 -06:00
2019-06-18 13:09:00 -03:00
"staff": "Staff",
"support": "Support",
"everyone": "@everyone",
"Auto_Role": "Member",
2019-06-19 22:24:37 -06:00
2019-07-24 16:49:51 -06:00
"LINKS": {
"Discord": "https://discord.gg/",
"Twitter": "https://twitter.com/",
"Website": "https://example.com/",
"AddMore": "AddMoreIfYouWant"
},
"LINKS_TITLE": "SupportBot Links",
2019-06-18 13:09:00 -03:00
"category": "Tickets",
"Ticket_Message": "Your support ticket has been opened successfully\nPlease allow us some time to reach out to you.",
"Ticket_Logs": "ticket-logs",
2019-08-04 20:43:22 -06:00
"Default_Ticket_Reason": "No Subject",
2019-07-24 16:49:51 -06:00
"Ticket_React_Message": ":mailbox: React to create your support ticket.",
2019-06-19 22:24:37 -06:00
2019-07-24 16:49:51 -06:00
"Commands_Log_Title": "SupportBot Logs",
"Command_Log_Channel": "command-logs",
2019-06-18 13:09:00 -03:00
"Announcement_Title": "SupportBot Announcement",
"Announcement_Channel": "announcements",
2019-07-24 16:49:51 -06:00
"Announcement_Tag_Role": "@everyone",
2019-06-19 22:24:37 -06:00
2019-06-18 13:09:00 -03:00
"Welcome_Message": "Welcome to the server!",
"Welcome_Channel": "welcome",
2019-06-19 22:24:37 -06:00
2019-06-18 13:09:00 -03:00
"Leave_Message": "Thank you for visiting us!",
"Leave_Channel": "welcome",
2019-07-24 16:49:51 -06:00
2019-06-18 13:09:00 -03:00
"Poll_Channel": "polls",
"Poll_Title": "📊 Polls",
"Reaction_Poll_1": "✅",
"Reaction_Poll_2": "❎",
2019-06-19 22:24:37 -06:00
2019-07-24 16:49:51 -06:00
"Suggestion_Title": "SupportBot Suggestions",
2019-06-18 13:09:00 -03:00
"Suggestion_Channel": "suggestions",
"suggestyes": "✅",
"suggestno": "❎",
2019-06-19 22:24:37 -06:00
2019-06-18 13:09:00 -03:00
"Report_Channel": "reports",
"Report_Title": "SupportBot Report",
2019-06-19 22:24:37 -06:00
2019-07-24 16:49:51 -06:00
"Announcement_Command": "announce",
2019-06-18 13:09:00 -03:00
"Say_Command": "say",
2019-07-24 16:49:51 -06:00
"Suggest_Command": "suggest",
"Ping_Command": "ping",
"Ticket_Command": "ticket",
2019-06-18 13:09:00 -03:00
"Remove_Command": "remove",
"Add_Command": "add",
"Close_Command": "close",
"Forceclose_Command": "forceclose",
"Rename_Command": "rename",
"Help_Command": "help",
"Link_Command": "links",
"Lockchat_Command": "lock",
"UnLockchat_Command": "unlock",
"Poll_Command": "poll",
"Report_Command": "report"
}
2019-07-24 16:49:51 -06:00
2019-06-10 20:20:37 +01:00
` ``
2019-06-10 20:19:51 +01:00
# Contributors List
2019-06-19 13:23:37 -06:00
<p>
<a href="https://github.com/RedstoneGamez">
<img src="https://cdn.discordapp.com/avatars/282610987801247744/9567e0674a5a6d371bb5d6efb956d57b.png?size=32" alt="RedstoneGamez Profile">
2019-11-01 20:27:24 +00:00
<strong>RedstoneGamez</strong>
2019-06-19 13:23:37 -06:00
</a>
</p>
2019-06-10 20:19:51 +01:00
# Donators List
2019-08-10 11:52:08 +01:00
# Community
<p align="center">
2019-11-18 16:10:19 +00:00
<a href="https://discord.gg/tNt95Ba">
2019-08-10 11:52:08 +01:00
<img src="https://discordapp.com/api/guilds/516345301985132552/widget.png?style=banner1" alt="Discord Server">
</a>
</p>