From f79deb1c885897c439fa9ea21f60f61eebcaa04d Mon Sep 17 00:00:00 2001 From: Gravestorm Date: Tue, 22 May 2018 05:00:06 +0300 Subject: [PATCH] Update README.md --- README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 64 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 75e5c99..d74e88d 100644 --- a/README.md +++ b/README.md @@ -1 +1,64 @@ -# Discom +## Setting up + +1. Create a [Github](https://www.github.com) account and Fork Discom. (Button in the top right) + +![Fork](https://cdn.discordapp.com/attachments/154633557606662144/448290067170197524/Fork.png) + + + + +2. Create a [Heroku](https://www.heroku.com) account and Create a New App. (Button in the top right) + +![App](https://cdn.discordapp.com/attachments/154633557606662144/448291245744193538/App.png) + + + + +3. Go to your Heroku app Settings tab, click Add Buildpack and select NodeJS. + +![Settings](https://cdn.discordapp.com/attachments/154633557606662144/448292111880814603/Settings.png) + +![Buildpack](https://cdn.discordapp.com/attachments/154633557606662144/448292646813827073/Buildpack.png) + + + +4. In the Settings tab, click Reveal Config Vars and enter the information for the features you'll want to use from **[here](https://github.com/Gravestorm/Discom/blob/master/config.js.example)**. + + 4a. KEY is the name, VALUE is the ID or other required input. + + 4b. TOKEN is required, everything else is optional. (Token is not Client Secret in the Discord Bot Website, it is near the bottom) + + 4c. To get a Channel ID, you must right click on a Text Channel and select Copy ID. (Need to enable Developer Mode in User Settings -> Appearance) + + 4d. To get a Role ID, you must right click on a Role when you @mention it and select Copy ID. (Need to allow anyone to @mention the role in the Role's settings and enable Developer Mode in User Settings -> Appearance) + +![Config](https://cdn.discordapp.com/attachments/154633557606662144/448296346923827200/Config.png) + +![Channel ID](https://cdn.discordapp.com/attachments/154633557606662144/448296589132431362/Channel_ID.png) + +![Role ID](https://cdn.discordapp.com/attachments/154633557606662144/448297218638741524/Role_ID.png) + +![User Settings](https://cdn.discordapp.com/attachments/154633557606662144/448296046028652544/User_Settings.png) + +![Developer Mode](https://cdn.discordapp.com/attachments/154633557606662144/448296057957384193/Developer_Mode.png) + + + +5. You need to invite your bot to your server, to do so you must go to the [Discord Bot Website](https://discordapp.com/developers/applications/me) and copypaste the Client ID at the top into this URL: https://discordapp.com/oauth2/authorize?client_id=CLIENT_ID_HERE&scope=bot&permissions=268528640 + 5a. You must enable [2 Factor Authentification](https://support.discordapp.com/hc/en-us/articles/219576828-Setting-up-Two-Factor-Authentication) to use the Streaming Role or Twitter features. + 5b. If you do not need to use the Streaming Role or Twitter features, then use this URL: https://discordapp.com/oauth2/authorize?client_id=CLIENT_ID_HERE&scope=bot&permissions=84992 + 5c. You must have **Manage Server** permission on the server you're inviting the bot to, or have someone who has the permission invite it. + + + +6. In the Deploy tab, click on Github to connect your Github account, then search for Discom and click Connect. + +![Deploy](https://cdn.discordapp.com/attachments/154633557606662144/448297712065052672/Deploy.png) + +![Github](https://cdn.discordapp.com/attachments/154633557606662144/448298566512017408/Github.png) + + + +7. Click on Deploy Branch. + +![Branch](https://cdn.discordapp.com/attachments/154633557606662144/448301079583653898/Branch.png)