Files
SupportBot/README.md
T

95 lines
3.3 KiB
Markdown
Raw Permalink Normal View History

2019-06-11 17:56:47 -06:00
<h1 align="center">SupportBot v3.4</h1>
<h4 align="center">A Self Hosted discord application</h4>
<p align="center">
<a href="https://discord.gg/hmWgxdF">
<img src="https://discordapp.com/api/guilds/516345301985132552/widget.png?style=shield" alt="Discord Server">
</a>
<img src="https://img.shields.io/badge/Made%20with-NodeJS-blue.svg" alt="Made with NodeJS">
</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-10 00:41:18 +01:00
| Version | Supported | Type |
| ------- | ------------------ |--------------------|
2019-06-10 19:59:51 +01:00
| 1.0.x | ❌ | None |
| 2.0.x | ⚠ | Community |
| 3.0.x | ✅ | Priority |
| 4.0.x | ❌ | N/A |
| Premium | ❌ | N/A |
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.
# 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-10 20:17:50 +01:00
"prefix": "!",
"botname": "SupportBot",
"colour": "#42f477",
"footer": "Support Bot, By Emerald",
2019-06-10 20:16:41 +01:00
2019-06-10 20:17:50 +01:00
"BotStatus": "Support Bot",.
2019-06-10 20:16:41 +01:00
2019-06-10 20:20:37 +01:00
"staff": "Staff",
"support": "Support Team",
"everyone": "@everyone",
2019-06-18 16:23:13 +01:00
"Auto_Role": "Member",
2019-06-10 20:16:41 +01: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",
"Announcement_Title": "SupportBot Announcement",
"Announcement_Channel": "announcements",
"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": "✅",
2019-06-10 20:17:50 +01:00
"suggestno": "❎",
2019-06-10 20:16:41 +01:00
"LINK_1_NAME": "Discord",
"LINK_2_NAME": "Twitter",
"LINK_3_NAME": "Website",
"LINK_1": "https://dicord.gg/changemeinconfig",
"LINK_2": "https://twitter.com/changemeinconfig",
"LINK_3": "https://www.example.com/",
"LINKS_TITLE": "SupportBot Links",
"Ticket_Command": "ticket",
"Suggest_Command": "suggest",
"Say_Command": "say",
"Remove_Command": "remove",
"Add_Command": "add",
"Ping_Command": "ping",
"Close_Command": "close",
"Forceclose_Command": "forceclose",
"Rename_Command": "rename",
"Help_Command": "help",
"Link_Command": "links",
"Lockchat_Command": "lock",
"UnLockchat_Command": "unlock",
2019-06-10 20:20:37 +01:00
"Poll_Command": "poll"
```
2019-06-10 20:19:51 +01:00
# Contributors List
# Donators List