From 304b83b5bdb770766d222c531a7c66037cc5d19f Mon Sep 17 00:00:00 2001 From: ItzEmerald <26964547+EmeraldRusher@users.noreply.github.com> Date: Mon, 10 Jun 2019 20:16:41 +0100 Subject: [PATCH] Update README.md --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/README.md b/README.md index 0b786a5..60f0f7a 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,73 @@ SupportBot is a free & open source discord bot for your server that has the capa # 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. + +# 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: + +``` +"prefix": "!", - The prefix is what is used to make the bot's commands work, for example !help. +"botname": "SupportBot", - The botname is the name of the what you called your application. +"colour": "#42f477", - The colour is used is within the embeds of the bot, the colour codes must be hexidecimal. +"footer": "Support Bot, By Emerald", - Footer is what will be displayed at the very bottom of the embeds. ``` + +```"BotStatus": "Support Bot", - Bot status is what will be displayed within the bot's discord activity. +``` + +``` +"staff": "Staff", - Anyone who has this role will be able to use commands that are for staff. +"support": "Support Team", - Anyone with this role will be able to use commands that are to do with ticket system only / view tickets. +"everyone": "@everyone", - This role is used for the lock chat command, Recommended to use @everyone``` + +``` +"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": "✅", +"suggestno": "❎",``` + +``` +"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", +"Poll_Command": "poll"```