127 lines
4.7 KiB
Markdown
127 lines
4.7 KiB
Markdown
<h1 align="center">SupportBot v5</h1>
|
|
<h4 align="center">#1 Discord Support System</h4>
|
|
|
|
<p align="center">
|
|
<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">
|
|
<img src="https://img.shields.io/github/package-json/dependency-version/EmeraldRusher/SupportBot/discord.js.svg" alt="GitHub package.json dependency version (prod)">
|
|
</p>
|
|
|
|
SupportBot is a free & open source discord bot for your server that has the capability to control & manage your servers support.
|
|
|
|
| Version | Supported | Status |
|
|
| ------- | ------------------ |--------------------|
|
|
| 1.x | 🚫 | Discontinued |
|
|
| 2.x | 🚫 | Discontinued |
|
|
| 3.x | ✔️ | Supported |
|
|
| 4.x | ✔️ | Supported |
|
|
| 5.x | ✔️ | Supported |
|
|
|
|
# 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.
|
|
|
|
# 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.
|
|
|
|
# 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).
|
|
|
|
# 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:
|
|
|
|
```
|
|
{
|
|
"SupportBot": "v4.0.0",
|
|
|
|
"token": "BOT_TOKEN_HERE",
|
|
"prefix": "!",
|
|
"botname": "SupportBot",
|
|
"colour": "#13bd2a",
|
|
"footer": "Support Bot, By Emerald Services",
|
|
|
|
"BotStatus": "Support Bot",
|
|
|
|
"staff": "Staff",
|
|
"support": "Support",
|
|
"everyone": "@everyone",
|
|
"Auto_Role": "Member",
|
|
|
|
"LINKS": {
|
|
"Discord": "https://discord.gg/",
|
|
"Twitter": "https://twitter.com/",
|
|
"Website": "https://example.com/",
|
|
"AddMore": "AddMoreIfYouWant"
|
|
},
|
|
|
|
"LINKS_TITLE": "SupportBot Links",
|
|
|
|
"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",
|
|
"Default_Ticket_Reason": "No Subject",
|
|
"Ticket_React_Message": ":mailbox: React to create your support ticket.",
|
|
|
|
"Commands_Log_Title": "SupportBot Logs",
|
|
"Command_Log_Channel": "command-logs",
|
|
|
|
"Announcement_Title": "SupportBot Announcement",
|
|
"Announcement_Channel": "announcements",
|
|
"Announcement_Tag_Role": "@everyone",
|
|
|
|
"Welcome_Message": "Welcome to the server!",
|
|
"Welcome_Channel": "welcome",
|
|
|
|
"Leave_Message": "Thank you for visiting us!",
|
|
"Leave_Channel": "welcome",
|
|
|
|
"Poll_Channel": "polls",
|
|
"Poll_Title": "📊 Polls",
|
|
"Reaction_Poll_1": "✅",
|
|
"Reaction_Poll_2": "❎",
|
|
|
|
"Suggestion_Title": "SupportBot Suggestions",
|
|
"Suggestion_Channel": "suggestions",
|
|
"suggestyes": "✅",
|
|
"suggestno": "❎",
|
|
|
|
"Report_Channel": "reports",
|
|
"Report_Title": "SupportBot Report",
|
|
|
|
|
|
"Announcement_Command": "announce",
|
|
"Say_Command": "say",
|
|
"Suggest_Command": "suggest",
|
|
"Ping_Command": "ping",
|
|
"Ticket_Command": "ticket",
|
|
"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"
|
|
}
|
|
|
|
```
|
|
|
|
# Contributors List
|
|
<p>
|
|
<a href="https://github.com/RedstoneGamez">
|
|
<img src="https://cdn.discordapp.com/avatars/282610987801247744/9567e0674a5a6d371bb5d6efb956d57b.png?size=32" alt="RedstoneGamez Profile">
|
|
<strong>RedstoneGamez</strong>
|
|
</a>
|
|
</p>
|
|
|
|
# Donators List
|
|
|
|
# Community
|
|
<p align="center">
|
|
<a href="https://discord.gg/tNt95Ba">
|
|
<img src="https://discordapp.com/api/guilds/516345301985132552/widget.png?style=banner1" alt="Discord Server">
|
|
</a>
|
|
</p>
|