mattburchett/NadekoBot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Create ComprehensiveGuide.md

Browse Source 
thanks to unlimited saber works :O
This commit is contained in:
Master Kwoth 2016-02-14 14:34:28 +01:00
parent 0afb3cc4eb
commit ebb61f6999
1 changed files with 76 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
ComprehensiveGuide.md Normal file
View File

@ -0,0 +1,76 @@
________________________________________________________________________________
*Thanks to @Unlimited Saber Works for making this guide*
________________________________________________________________________________
#### Setting Up NadekoBot 0.8 b10
###### Prerequisites:
1) Extra Discord account for your bot (log into it and join the server you want the bot to be on, then log out).
2) NET Framework 4.6 (google and download).
- Open up credentials.json.
- For "Username" and "Password", enter the email address and password of the extra Discord account, respectively. Close and save credentials.json.
- Start NadekoBot.exe. In a text channel **not a direct message**, type in [.uid @______] without the brackets, filling in the underlined portion with your bot's name and send the message.
Your bot will reply with a number; this is your bot's ID. Then type in [.uid @_____] without the brackets, filling in the underlined portion with your own name and send the message. Your bot will reply with another number; this is your own ID. Close NadekoBot.exe.
- Reopen credentials.json. For "BotMention", fill in your bot's ID between <@ and > ("BotMention": "\<@78663633663\>"). For "OwnerID", fill in your own ID.
- Close and save credentials.json.
________________________________________________________________________________
#### Setting Up NadekoBot For Music
###### Prerequisites:
1) FFMPEG, Static Build Version (See below) Google Account
2) Soundcloud Account
- Download FFMPEG through the link (https://ffmpeg.zeranoe.com/builds/).
- Go to My Computer, right click and select Properties. On the left tab, select Advanced System Settings. Under the Advanced tab, select Environmental Variables near the bottom. One of the variables should be called "Path". Add a semi-colon (;) to the end followed by your FFMPEG's bin install location. Save and close.
- Go to console.developers.google.com and log in.
- Create a new project (name does not matter). Once the project is created, go into "Enable and manage APIs."
- Under the "Other Popular APIs" section, enable "URL Shortener API". Under the "YouTube APIs" section, enable "YouTube Data API".
- On the left tab, access Credentials. There will be a line saying "If you wish to skip this step and create an API key, client ID or service account." Click on API Key, and then Server Key in the new window that appears. Enter in a name for the server key. A new window will appear with your Google API key. Copy the key.
- Open up credentials.json. For "GoogleAPIKey", fill in with the new key.
- Go to (https://soundcloud.com/you/apps/new). Enter a name for the app and create it. You will see a page with the title of your app, and a field labeled Client ID. Copy the ID. In credentials.json, fill in "SoundcloudClientID" with the copied ID.
________________________________________________________________________________
#### Setting Up NadekoBot Permissions
###### NadekoBot's permissions can be set up to be very specific through commands in the Permissions module.
Each command or module can be turned on or off at:
- a user level (so specific users can or cannot use a command/module)
- a role level (so only certain roles have access to certain commands/module)
- a channel level (so certain commands can be limited to certain channels, which can prevent music / trivia / NSFW spam in serious channels)
- a server level.
Use .modules to see a list of modules (sets of commands).
Use .commands [module_name] to see a list of commands in a certain module.
Permissions use a semicolon as the prefix, so always start the command with a ;.
Follow the semicolon with the letter of the level which you want to edit.
- "u" for Users.
- "r" for Roles.
- "c" for Channels.
- "s" for Servers.
Follow the level with whether you want to edit the permissions of a command or a module.
- "c" for Command.
- "m" for Module.
Follow with a space and then the command or module name (surround the command with quotation marks if there is a space within the command, for example "!m q" or "!m n").
Follow that with another space and, to enable it, type one of the following: [1, true, t, enable], or to disable it, one of the following: [0, false, f, disable].
Follow that with another space and the name of the user, role, channel. (depending on the first letter you picked)
###### Examples
- **;rm NSFW 0 [Role_Name]** Disables the NSFW module for the role, <Role_Name>.
- **;cc "!m n" 0 [Channel_Name]** Disables skipping to the next song in the channel, <Channel_Name>.
- **;uc "!m q" 1 [User_Name]** Enables queuing of songs for the user, <User_Name>.
- **;sm Gambling 0** Disables gambling in the server.
Check permissions by using the letter of the level you want to check followed by a p, and then the name of the level in which you want to check. If there is no name, it will default to yourself for users, the @everyone role for roles, and the channel in which the command is sent for channels.
###### Examples
- ;cp [Channel_Name]
- ;rp [Role_Name]
Insert an **a** before the level to edit the permission for all commands / modules for all users / roles / channels / server.
Reference the Help command (-h) for more Permissions related commands.