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

Merge branch 'dev' of https://github.com/Kwoth/NadekoBot into dev

Browse Source
This commit is contained in:
Kwoth 2016-09-05 22:26:14 +02:00
commit 61390e8530
9 changed files with 172 additions and 209 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
LinuxSetup.md
View File

@ -48,7 +48,7 @@ Note if the command is not being initiated, hit **Enter**
**2.6)** **2.6)**
*ONLY CentOS 7, Fedora 19 (and later)* *ONLY CentOS 7, Fedora 19 (and later)*
`yum install yum-util` `yum install yum-utils`
`rpm --import "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"` `rpm --import "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"`
@ -227,7 +227,7 @@ Type/ Copy and hit **Enter**.
**CHECK THE BOT IN DISCORD, IF EVERYTHING IS WORKING** **CHECK THE BOT IN DISCORD, IF EVERYTHING IS WORKING**
Now time to **move bot to background** and to do that, press **CTRL+B+D** (this will ditach the nadeko session using TMUX), and you can finally close PuTTY now. Now time to **move bot to background** and to do that, press **CTRL+B**,release and press **D** (this will detach the nadeko session using TMUX), and you can finally close PuTTY now.
Copy your CLIENT ID (that's in the same Developer page where you brought your token) and replace `12345678` in this link: `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with it. Go to that link and you will be able to add your bot to your server. Copy your CLIENT ID (that's in the same Developer page where you brought your token) and replace `12345678` in this link: `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with it. Go to that link and you will be able to add your bot to your server.
@ -256,7 +256,7 @@ Open **PuTTY** and login as you have before, type `reboot` and hit Enter.
- **-18** - **-18**
- **-20** - **-20**
HIT **CTRL+B+D** and close **PuTTY** HIT **CTRL+B**,release, press **D** and close **PuTTY**
`IF YOU FACE ANY TROUBLE ANYWHERE IN THE GUIDE JUST FIND US IN NADEKO'S DISCORD SERVER` `IF YOU FACE ANY TROUBLE ANYWHERE IN THE GUIDE JUST FIND US IN NADEKO'S DISCORD SERVER`

4
NadekoBot/Modules/Administration/AdministrationModule.cs
View File

@ -72,9 +72,9 @@ namespace NadekoBot.Modules.Administration
conf.AutoDeleteMessagesOnCommand = !conf.AutoDeleteMessagesOnCommand; conf.AutoDeleteMessagesOnCommand = !conf.AutoDeleteMessagesOnCommand;
await Classes.JSONModels.ConfigHandler.SaveConfig().ConfigureAwait(false); await Classes.JSONModels.ConfigHandler.SaveConfig().ConfigureAwait(false);
if (conf.AutoDeleteMessagesOnCommand) if (conf.AutoDeleteMessagesOnCommand)
await e.Channel.SendMessage("❗`Now automatically deleting successfull command invokations.`"); await e.Channel.SendMessage("❗`Now automatically deleting successful command invokations.`");
else else
await e.Channel.SendMessage("❗`Stopped automatic deletion of successfull command invokations.`"); await e.Channel.SendMessage("❗`Stopped automatic deletion of successful command invokations.`");
}); });

5
NadekoBot/Modules/Searches/Commands/OsuCommands.cs
View File

@ -2,6 +2,7 @@
using NadekoBot.Classes; using NadekoBot.Classes;
using Newtonsoft.Json.Linq; using Newtonsoft.Json.Linq;
using System; using System;
using System.Globalization;
using System.IO; using System.IO;
using System.Net; using System.Net;
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
@ -75,7 +76,7 @@ namespace NadekoBot.Modules.Searches.Commands
var reqString = $"https://osu.ppy.sh/api/get_beatmaps?k={NadekoBot.Creds.OsuAPIKey}&{mapId}"; var reqString = $"https://osu.ppy.sh/api/get_beatmaps?k={NadekoBot.Creds.OsuAPIKey}&{mapId}";
var obj = JArray.Parse(await SearchHelper.GetResponseStringAsync(reqString).ConfigureAwait(false))[0]; var obj = JArray.Parse(await SearchHelper.GetResponseStringAsync(reqString).ConfigureAwait(false))[0];
var sb = new System.Text.StringBuilder(); var sb = new System.Text.StringBuilder();
var starRating = Math.Round(Double.Parse($"{obj["difficultyrating"]}"), 2); var starRating = Math.Round(Double.Parse($"{obj["difficultyrating"]}", CultureInfo.InvariantCulture), 2);
var time = TimeSpan.FromSeconds(Double.Parse($"{obj["total_length"]}")).ToString(@"mm\:ss"); var time = TimeSpan.FromSeconds(Double.Parse($"{obj["total_length"]}")).ToString(@"mm\:ss");
sb.AppendLine($"{obj["artist"]} - {obj["title"]}, mapped by {obj["creator"]}. https://osu.ppy.sh/s/{obj["beatmapset_id"]}"); sb.AppendLine($"{obj["artist"]} - {obj["title"]}, mapped by {obj["creator"]}. https://osu.ppy.sh/s/{obj["beatmapset_id"]}");
sb.AppendLine($"{starRating} stars, {obj["bpm"]} BPM | AR{obj["diff_approach"]}, CS{obj["diff_size"]}, OD{obj["diff_overall"]} | Length: {time}"); sb.AppendLine($"{starRating} stars, {obj["bpm"]} BPM | AR{obj["diff_approach"]}, CS{obj["diff_size"]}, OD{obj["diff_overall"]} | Length: {time}");
@ -120,7 +121,7 @@ namespace NadekoBot.Modules.Searches.Commands
{ {
var mapReqString = $"https://osu.ppy.sh/api/get_beatmaps?k={NadekoBot.Creds.OsuAPIKey}&b={item["beatmap_id"]}"; var mapReqString = $"https://osu.ppy.sh/api/get_beatmaps?k={NadekoBot.Creds.OsuAPIKey}&b={item["beatmap_id"]}";
var map = JArray.Parse(await SearchHelper.GetResponseStringAsync(mapReqString).ConfigureAwait(false))[0]; var map = JArray.Parse(await SearchHelper.GetResponseStringAsync(mapReqString).ConfigureAwait(false))[0];
var pp = Math.Round(Double.Parse($"{item["pp"]}"), 2); var pp = Math.Round(Double.Parse($"{item["pp"]}", CultureInfo.InvariantCulture), 2);
var acc = CalculateAcc(item, m); var acc = CalculateAcc(item, m);
var mods = ResolveMods(Int32.Parse($"{item["enabled_mods"]}")); var mods = ResolveMods(Int32.Parse($"{item["enabled_mods"]}"));
if (mods != "+") if (mods != "+")

6
README.md
View File

@ -1,10 +1,10 @@
![img](https://ci.appveyor.com/api/projects/status/gmu6b3ltc80hr3k9?svg=true) ![img](https://ci.appveyor.com/api/projects/status/gmu6b3ltc80hr3k9?svg=true)
[![Discord](https://discordapp.com/api/servers/117523346618318850/widget.png)](https://discord.gg/0ehQwTK2RBjAxzEY) [![Discord](https://discordapp.com/api/guilds/117523346618318850/widget.png)](https://discord.gg/0ehQwTK2RBjAxzEY)
[![Documentation Status](https://readthedocs.org/projects/nadekobot/badge/?version=latest)](http://nadekobot.readthedocs.io/en/latest/?badge=latest) [![Documentation Status](https://readthedocs.org/projects/nadekobot/badge/?version=latest)](http://nadekobot.readthedocs.io/en/latest/?badge=latest)
# NadekoBot # NadekoBot
## [Click here to invite Nadeko to your Discord server](https://discordapp.com/oauth2/authorize?client_id=170254782546575360&scope=bot&permissions=66186303) ## [Click here to invite Nadeko to your Discord server](https://discordapp.com/oauth2/authorize?client_id=170254782546575360&scope=bot&permissions=66186303)
## [Click here for a list of commands](https://github.com/Kwoth/NadekoBot/blob/master/commandlist.md) ## [Click here for a list of commands](http://nadekobot.readthedocs.io/en/latest/Commands%20List/)
## INSTRUCTIONS, FAQ ---> [Wiki](https://github.com/Kwoth/NadekoBot/wiki) ## Instructions, FAQ, other info ---> [Documentation](http://nadekobot.readthedocs.io/en/latest)
You might want to join my discord server where i can provide help etc. https://discord.gg/0ehQwTK2RBjAxzEY You might want to join my discord server where i can provide help etc. https://discord.gg/0ehQwTK2RBjAxzEY

86
docs/Custom Reactions.md
View File

@ -1,21 +1,69 @@
**After you add/delete custom commands, you should restart the bot. (either by typing `.restart` if you are on WINDOWS or just manually restarting if you prefer/are on other platform)** ##Custom Reactions
<p><strong>Every time you add or remove a custom reaction you will need to restart your bot with either <code>.restart</code> if you are hosting or Nadeko is on VPS, or <code>.die</code> if Nadeko is on Droplet</strong></p>
<h3>Important</h3>
<ul style="list-style-type:disc">
<li><strong><code>.acr</code>,&nbsp;<code>.dcr</code>,&nbsp;and <code>.ecr</code> Require you to be Bot Owner</strong></li>
<li>Adding multiple commands of the same name will make Nadeko randomly select one of the command's responses</li>
</ul>
###Commands and Their Use
<table>
<tr>
<th>Command Name</th>
<th>Description</th>
<th>Example</th>
</tr><tr>
<td align="center"><code>.acr</code></td>
<td>Adds a Custom Reaction</td>
<td><code>.acr Hello Hi!</code></td>
</tr><tr>
<td align="center"><code>.dcr</code></td>
<td>Deletes an entire Custom Reaction or a Specified Response Index Number</td>
<td><code>.dcr "command name"</code>&nbsp;or&nbsp;<code>.dcr "command name" 3</code></td>
</tr><tr>
<td align="center"><code>.lcr</code></td>
<td>Lists a specified page of Custom Commands</td>
<td><code>.lcr Number</code>&nbsp;i.e&nbsp;<code>.lcr 2</code></td>
</tr><tr>
<td align="center"><code>.scr</code></td>
<td>Shows all responses to a command.&nbsp;Index Number will be in brackets <code>[&nbsp;]</code></td>
<td><code>.scr Hello</code></td>
</tr><tr>
<td align="center"><code>.ecr</code></td>
<td>Edit a custom reaction, needs: reaction's name, index to change, and new multiword response.</td>
<td><code>.ecr&nbsp;Hello&nbsp;3&nbsp;What's up</code></td></table>
<h4>Now that we know the commands let's take a look at the arguments and placeholders available for <code>.acr</code>,</h4>
<p><code>.addcustreact</code>&nbsp;(<code>.acr</code>)&nbsp;takes two arguments:
<dl>
<dt><strong>●&nbsp;First, The name of the command; this directly follows the <code>.acr</code></strong></dt>
<dd>-&nbsp;If your command name is more than 1 word use quotation marks;<br> i.e <del><code>.acr Nice weather sure is</code></del> > <code>.acr "Nice weather" sure is</code></dd>
<dd>-&nbsp;Now everytime someone says "Nice weather" the bot will respond with, "sure is"</dd>
<dt><strong>●&nbsp;Next, The Response, this follows the name of the command.</strong><dt>
<dd>-&nbsp;i.e <code>.acr "Nice weather"</code><b><i><code>sure is</code></i></b></dd></dl><p>
###And finally on to the Placeholders
<p>There are currently four placeholders, which we will be looking at, with many more to come in the future.<p>
<table>
<tr>
<th>Placeholder</th>
<th>How the placeholder works</th>
<th>Examples</th>
</tr><tr>
<td align="center"><code>%mention%</code></td>
<td>The&nbsp;<code>%mention%</code>&nbsp;placeholder is triggered when you type <code>@botname</code></td>
<td><code>.acr "%mention% Hello" Hello!</code> > User input: @botname Hello | Bot Replies: Hello!</td>
</tr><tr>
<td align="center"><code>%target%</code></td>
<td>The <code>%target%</code> placeholder is used to make Nadeko Mention another person</td>
<td><code>.acr "%mention% Hello" %target% Hi!</code> > User inputs: "@botname Hello @somebody"
Bot replies: "Hi @somebody"</td>
</tr><tr>
<td align="center"><code>%user%</code></td>
<td>The <code>%user%</code> placeholder mentions the person who said the command</td>
<td><code>.acr "Who am i" You are %user%!</code></td>
</tr><tr>
<td align="center"><code>%rng%</code></td>
<td>The <code>%rng%</code> generates a random number</td>
<td><code>.acr Random %rng%</code>
</tr></table>
`.acr` and `.dcr` require you to be a bot owner. Thanks to Nekai for being creative. <3
`.acr`
Adds a new custom command. **If you add multiple commands with the same name, it will pick random one.** First argument is the name, second one is the response. For example `.acr hello hi`. Now the bot will reply `hi` whenever someone types `hello`. For more than 1 word command, wrap it in `"`.
For example: `.acr "hello there" hi there` - now it will print "hi there" whenever someone types "hello there". Currently you can add this placeholders which will get replaced with appropriate text:
`%mention%` - replaces it with bot mention
`%user%` - replaces it with the user runner's mention
`%target%` - replaces it with a mention of another person from within the original message
`%rng%` replaces it with a random number
for example: `.acr "%mention% hello" Hello %user%`
(we will add much more of these over time)
`.dcr "command name" (optional index)`
Deletes either whole custom command and all its responses or a single command's response via an index (if you have multiple responses for the same command).
For example: `.dcr "hi there"` or `.dcr "hi there" 1`. You can get an index by using `.lcr [page number]`
`.lcr [number]`
Prints a list of custom reactions. Paginated. (for example: `.lcr 1` or `.lcr 4`)

145
docs/guides/DigitalOcean Guide.md
View File

@ -1,145 +0,0 @@
##Setting up NadekoBot on DigitalOcean Droplet
*If you want Nadeko to play music for you 24/7 without having to hosting it on your PC and want to keep it cheap, reliable and convenient as possible, you can try Nadeko on Linux Digital Ocean Droplet using the link [DigitalOcean][DigitalOcean] (and using this link will be supporting Nadeko and will give you **$10 credit**)
Keep this helpful video handy [Linux Setup Video][Linux Setup Video] (thanks to klincheR) it contains how to set up the Digital Ocean droplet aswell.*
Assuming you have followed the link above to created an account in Digital Ocean and video to set up the bot until you get the `IP address and root password (in email)` to login, its time to begin.
#### Prerequisites
- Download [PuTTY][PuTTY]
- Download [CyberDuck][CyberDuck]
####Setting up NadekoBot
- **Open PuTTY.exe** that you downloaded before, and paste or enter your `IP address` and then click **Open**.
If you entered your Droplets IP address correctly, it should show **login as:** in a newly opened window.
- Now for **login as:**, type `root` and hit enter.
- It should then, ask for password, type the `root password` you have received in your **email address registered with Digital Ocean**, then hit Enter.
*(as you are running it for the first time, it will most likely to ask you to change your root password, for that, type the "password you received through email", hit Enter, enter a "new password", hit Enter and confirm that "new password" again.)*
**SAVE that new password somewhere safe not just in mind**. After you done that, you are ready to write commands.
**Copy and just paste** using **mouse right-click** (it should paste automatically)
####FFMPEG for Windows
- To install `FFMPEG` on Windows download and install [FFMPEG][FFMPEG]
####FFMPEG for Linux
`apt-get install ffmpeg`
**Type** `y` **hit Enter**
NOTE: if its "not installing" then, follow the guide here: [FFMPEG Help Guide][FFMPEG Help Guide]
**All you need to do, if you are running UBUNTU 14.04 is initiate these:**
`sudo add-apt-repository ppa:mc3man/trusty-media`
`sudo apt-get update`
`sudo apt-get dist-upgrade`
*Before executing* `sudo apt-get install ffmpeg`
**If you are running Debian 8 Jessie, please, follow these steps:**
`wget http://luxcaeli.de/installer.sh && sudo bash installer.sh` (Thanks to Eleria<3)
In case you are not able to install it with installer ^up there, follow these steps:
`sudo apt-get update`
`echo "deb http://ftp.debian.org/debian jessie-backports main" | tee /etc/apt/sources.list.d/debian-backports.list`
`sudo apt-get update`
`sudo apt-get install ffmpeg -y`
####Installing TMUX
*If on Linux*
`apt-get install tmux`
####Creating Nadeko folder
- Create a new folder “nadeko” or anything you prefer
`mkdir nadeko`
- Move to “nadeko” folder (note `cd --` to go back the directory)
`cd nadeko`
####Getting NadekoBot from Releases
Go to this link: [Releases][Releases] and **copy the zip file address** of the lalest version available,
it should look like `https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
-If on Windows, just download and extract the content in your `Nadeko` folder.
-If on Linux, follow the guide bellow:
Get the correct link, type `wget`, then *paste the link*, then hit **Enter**.
`wget https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
**^Do not copy-paste it**
Now we need to `unzip` the downloaded zip file and to do that, type the file name as it showed in your screen or just copy from the screen, should be like ` NadekoBot.vx.x.zip`
`unzip NadekoBot.vx.x.zip`
**^Do not copy-paste it**
####Setting up NadekoBot
- Open **CyberDuck**
- Click on **Open Connection** (top-left corner), a new window should appear.
- You should see **FTP (File Transfer Protocol)** in drop-down.
- Change it to **SFTP (SSH File Transfer Protocol)**
- Now, in **Server:** paste or type in your `Digital Ocean Droplets IP address`, leave `Port: 22` (no need to change it)
- In **Username:** type `root`
- In **Password:** type `the new root password (you changed at the start)`
- Click on **Connect**
- It should show you the new folder you created.
- Open it.
####Renaming Credentials.json
- Copy the `credentials_example.json` to desktop
- EDIT it as it is guided here: [Setting up Credentials.json](Windows Guide.md#setting-up-credentialsjson-file)
- Read here how to [Create DiscordBot application](https://github.com/miraai/NadekoBot/blob/dev/docs/guides/Windows%20Guide.md#creating-discordbot-application)
- Rename it to `credentials.json` and paste/put it back in the folder. `(Yes, using CyberDuck)`
- You should see two files `credentials_example.json` and `credentials.json`
- Also if you already have nadeko setup and have `credentials.json`, `config.json`, `nadekobot.sqlite`, and `"permissions" folder`, you can just copy and paste it to the Droplets folder using CyberDuck.
####Running NadekoBot
- Go back to **PuTTY**, `(hope its still running xD)`
- Type/ Copy and hit **Enter**.
*If you are on Linux run:*
`tmux new -s nadeko`
**^this will create a new session named “nadeko”** `(you can replace “nadeko” with anything you prefer and remember
its your session name) so you can run the bot in background without having to keep running PuTTY in the background.`
- Enter your Nadeko folder
`cd nadeko`
*If you are on Linux run:*
`mono NadekoBot.exe`
**CHECK THE BOT IN DISCORD, IF EVERYTHING IS WORKING**
Now time to **move bot to background** and to do that, press **CTRL+B+D** (this will ditach the nadeko session using TMUX), and you can finally close PuTTY now.
Copy your CLIENT ID (that's in the same Developer page where you brought your token) and replace `12345678` in this link: `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with it. Go to that link and you will be able to add your bot to your server.
Or check this guide also [Inviting your bot to your server](Windows Guide.md#inviting-your-bot-to-your-server)
####How to restart Nadeko with the server (for science)
- Open **PuTTY** and login as you have before, type `reboot` and hit Enter.
[PuTTY]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
[CyberDuck]: https://cyberduck.io
[Linux Setup Video]: https://www.youtube.com/watch?v=icV4_WPqPQk&feature=youtu.be
[Releases]: https://github.com/Kwoth/NadekoBot/releases
[FFMPEG Help Guide]: http://www.faqforge.com/linux/how-to-install-ffmpeg-on-ubuntu-14-04/
[DigitalOcean]: http://m.do.co/c/46b4d3d44795/
[FFMPEG]: https://github.com/Soundofdarkness/FFMPEG-Installer

109
docs/guides/Linux Guide.md
View File

@ -1,16 +1,33 @@
#Setting up NadekoBot on Linux ##Setting up NadekoBot on Linux
####Setting up NadekoBot on Linux Digital Ocean Droplet ####Setting up NadekoBot on Linux Digital Ocean Droplet
######If you want Nadeko to play music for you 24/7 without having to hosting it on your PC and want to keep it cheap, reliable and convenient as possible, you can try Nadeko on Linux Digital Ocean Droplet using the link [DigitalOcean][DigitalOcean] (and using this link will be supporting Nadeko and will give you **$10 credit**) If you want Nadeko to play music for you 24/7 without having to hosting it on your PC and want to keep it cheap, reliable and convenient as possible, you can try Nadeko on Linux Digital Ocean Droplet using the link [DigitalOcean][DigitalOcean] (and using this link will be supporting Nadeko and will give you **$10 credit**)
######Keep this helpful video handy [Linux Setup Video][Linux Setup Video] (thanks to klincheR) it contains how to set up the Digital Ocean droplet aswell and follow this [Guide](DigitalOcean Guide.md) Keep this helpful video handy [Linux Setup Video][Linux Setup Video] (thanks to klincheR) it contains how to set up the Digital Ocean droplet aswell.
####Setting up NadekoBot ####Setting up NadekoBot
Assuming you have followed the link above to created an account in Digital Ocean and video to set up the bot until you get the `IP address and root password (in email)` to login, its time to begin.
Note: When you install mono, please run update once more to check for any missing repos and dependencies. #### Prerequisites
- Download [PuTTY][PuTTY]
- Download [CyberDuck][CyberDuck]
#### Follow these steps
- **Open PuTTY.exe** that you downloaded before, and paste or enter your `IP address` and then click **Open**.
If you entered your Droplets IP address correctly, it should show **login as:** in a newly opened window.
- Now for **login as:**, type `root` and hit enter.
- It should then, ask for password, type the `root password` you have received in your **email address registered with Digital Ocean**, then hit Enter.
*(as you are running it for the first time, it will most likely to ask you to change your root password, for that, type the "password you received through email", hit Enter, enter a "new password", hit Enter and confirm that "new password" again.*
**SAVE that new password somewhere safe not just in mind**. After you done that, you are ready to write commands.
**Copy and just paste** using **mouse right-click** (it should paste automatically)
####Installing Mono ####Installing Mono
######MONO (Source: [Mono Source][Mono Source]) MONO (Source: [Mono Source][Mono Source])
**1)**
`sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF` `sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF`
`echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list` `echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list`
@ -18,21 +35,26 @@ Note: When you install mono, please run update once more to check for any missin
Note if the command is not being initiated, hit **Enter** Note if the command is not being initiated, hit **Enter**
`echo "deb http://download.mono-project.com/repo/debian wheezy-apache24-compat main" | **2)**
sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list`
`echo "deb http://download.mono-project.com/repo/debian wheezy-apache24-compat main" | sudo
tee -a /etc/apt/sources.list.d/mono-xamarin.list`
####Mono on Debian 8 and later ####Mono on Debian 8 and later
**2.5)**
`echo "deb http://download.mono-project.com/repo/debian wheezy-libjpeg62-compat main" | `echo "deb http://download.mono-project.com/repo/debian wheezy-libjpeg62-compat main" | sudo
sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list` tee -a /etc/apt/sources.list.d/mono-xamarin.list`
####Mono on CentOS 7, Fedora 19 (and later) and later ####Mono on CentOS 7, Fedora 19 (and later) and later
**2.6)**
`yum install yum-util` `yum install yum-util`
`rpm --import "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"` `rpm --import "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"`
`yum-config-manager --add-repo http://download.mono-project.com/repo/centos/` `yum-config-manager --add-repo http://download.mono-project.com/repo/centos/`
####Mono Devel ####Mono Devel
**3)**
`apt-get install mono-devel` `apt-get install mono-devel`
@ -47,17 +69,17 @@ sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list`
`mozroots --import --sync` `mozroots --import --sync`
####Installing Opus Voice Codec ####Installing Opus Voice Codec
**4)**
- Opus Voice Codec
`sudo apt-get install libopus0 opus-tools` `sudo apt-get install libopus0 opus-tools`
**Type** `y` **hit Enter** **Type** `y` **hit Enter**
**5)**
`sudo apt-get install libopus-dev` `sudo apt-get install libopus-dev`
####FFMPEG ####FFMPEG
**6)**
`apt-get install ffmpeg` `apt-get install ffmpeg`
**Type** `y` **hit Enter** **Type** `y` **hit Enter**
@ -85,42 +107,48 @@ In case you are not able to install it with installer ^up there, follow these st
####Uncomplicated Firewall UFW ####Uncomplicated Firewall UFW
- Install UFW **7)**
`apt-get install ufw` `apt-get install ufw`
**it is most likely to have it already installed so if you see it is already installed, check with following command, and/or enable it** **it is most likely to have it already installed so if you see it is already installed, check with following command, and/or enable it**
**8)**
`ufw status` `ufw status`
**9)**
`ufw enable` `ufw enable`
**Type** `y` **hit Enter** **Type** `y` **hit Enter**
**10)**
`sudo ufw allow ssh` `sudo ufw allow ssh`
####Installing Unzip ####Installing Unzip
**11)**
`apt-get install unzip` `apt-get install unzip`
####Installing TMUX ####Installing TMUX
**12)**
`apt-get install tmux` `apt-get install tmux`
**Type** `y` **hit Enter** **Type** `y` **hit Enter**
####Importing certs ####Importing Discord certs
**13)**
`certmgr -ssl https://discordapp.com` `certmgr -ssl https://discordapp.com`
**14)**
`certmgr -ssl https://gateway.discord.gg` `certmgr -ssl https://gateway.discord.gg`
Type `yes` and hit Enter **(three times - as it will ask for three times)** Type `yes` and hit Enter **(three times - as it will ask for three times)**
####Creating Nadeko folder ####Creating Nadeko folder
- Create a new folder “nadeko” or anything you prefer **15)**
Create a new folder “nadeko” or anything you prefer
`mkdir nadeko` `mkdir nadeko`
- Move to “nadeko” folder (note `cd --` to go back the directory) **16)**
Move to “nadeko” folder (note `cd --` to go back the directory)
`cd nadeko` `cd nadeko`
@ -129,12 +157,14 @@ Type `yes` and hit Enter **(three times - as it will ask for three times)**
Go to this link: [Releases][Releases] and **copy the zip file address** of the lalest version available, Go to this link: [Releases][Releases] and **copy the zip file address** of the lalest version available,
it should look like `https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip` it should look like `https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
**17)**
Get the correct link, type `wget`, then *paste the link*, then hit **Enter**. Get the correct link, type `wget`, then *paste the link*, then hit **Enter**.
`wget https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip` `wget https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
**^Do not copy-paste it** **^Do not copy-paste it**
**18)**
Now we need to `unzip` the downloaded zip file and to do that, type the file name as it showed in your screen or just copy from the screen, should be like ` NadekoBot.vx.x.zip` Now we need to `unzip` the downloaded zip file and to do that, type the file name as it showed in your screen or just copy from the screen, should be like ` NadekoBot.vx.x.zip`
`unzip NadekoBot.vx.x.zip` `unzip NadekoBot.vx.x.zip`
@ -159,49 +189,68 @@ Now we need to `unzip` the downloaded zip file and to do that, type the file nam
- Copy the `credentials_example.json` to desktop - Copy the `credentials_example.json` to desktop
- EDIT it as it is guided here: [Setting up Credentials.json](Windows Guide.md#setting-up-credentialsjson-file) - EDIT it as it is guided here: [Setting up Credentials.json](Windows Guide.md#setting-up-credentialsjson-file)
- Read here how to [Create DiscordBot application](https://github.com/miraai/NadekoBot/blob/dev/docs/guides/Windows%20Guide.md#creating-discordbot-application) - Read here how to [Create DiscordBot application](https://github.com/miraai/NadekoBot/blob/dev/docs/guides/Windows%20Guide.md#creating-discordbot-application)
- Rename it to `credentials.json` and paste/put it back in the folder. - Rename it to `credentials.json` and paste/put it back in the folder. `(Yes, using CyberDuck)`
- You should see two files `credentials_example.json` and `credentials.json` - You should see two files `credentials_example.json` and `credentials.json`
- Also if you already have nadeko setup and have `credentials.json`, `config.json`, `nadekobot.sqlite`, and `"permissions" folder`, you can just copy and paste it to folder. - Also if you already have nadeko setup and have `credentials.json`, `config.json`, `nadekobot.sqlite`, and `"permissions" folder`, you can just copy and paste it to the Droplets folder using CyberDuck.
####Running NadekoBot ####Running NadekoBot
- Type/ Copy and hit **Enter**. Go back to **PuTTY**, `(hope its still running xD)`
**19)**
Type/ Copy and hit **Enter**.
`tmux new -s nadeko` `tmux new -s nadeko`
**^this will create a new session named “nadeko”** `(you can replace “nadeko” with anything you prefer and remember **^this will create a new session named “nadeko”** `(you can replace “nadeko” with anything you prefer and remember
its your session name) so you can run the bot in background.` its your session name) so you can run the bot in background without having to keep running PuTTY in the background.`
- Enter your Nadeko folder
`cd nadeko` `cd nadeko`
- Start NadekoBot with mono **20)**
`mono NadekoBot.exe` `mono NadekoBot.exe`
**CHECK THE BOT IN DISCORD, IF EVERYTHING IS WORKING** **CHECK THE BOT IN DISCORD, IF EVERYTHING IS WORKING**
####Setting up Nadeko Music
For how to set up Nadeko for music and Google API Keys, follow [Setting up NadekoBot for Music](Windows Guide.md#setting-up-nadekobot-for-music)
Now time to **move bot to background** and to do that, press **CTRL+B+D** (this will ditach the nadeko session using TMUX), and you can finally close PuTTY now. Now time to **move bot to background** and to do that, press **CTRL+B+D** (this will ditach the nadeko session using TMUX), and you can finally close PuTTY now.
Copy your CLIENT ID (that's in the same Developer page where you brought your token) and replace `12345678` in this link: `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with it. Go to that link and you will be able to add your bot to your server. Copy your CLIENT ID (that's in the same Developer page where you brought your token) and replace `12345678` in this link: `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with it. Go to that link and you will be able to add your bot to your server.
Or check this guide also [Inviting your bot to your server](Windows Guide.md#inviting-your-bot-to-your-server)
**NOW YOU HAVE YOUR OWN NADEKO BOT** `Thanks to Kwoth <3` **NOW YOU HAVE YOUR OWN NADEKO BOT** `Thanks to Kwoth <3`
####Some more Info (just in case): ####Some more Info (just in case)
-If you want to **see the sessions** after logging back again, type `tmux ls`, and that will give you the list of sessions running. -If you want to **see the sessions** after logging back again, type `tmux ls`, and that will give you the list of sessions running.
-If you want to **switch to/ see that session**, type `tmux a -t nadeko` (**nadeko** is the name of the session we created before so, replace **“nadeko”** with the session name you created.) -If you want to **switch to/ see that session**, type `tmux a -t nadeko` (**nadeko** is the name of the session we created before so, replace **“nadeko”** with the session name you created.)
-If you want to **kill** NadekoBot **session**, type `tmux kill-session -t nadeko` -If you want to **kill** NadekoBot **session**, type `tmux kill-session -t nadeko`
####Restarting Nadeko with the Server
Open **PuTTY** and login as you have before, type `reboot` and hit Enter.
####Updating Nadeko ####Updating Nadeko
**If you want to update your NadekoBot** just follow the steps from [Getting NadekoBot](https://github.com/miraai/NadekoBot/blob/dev/docs/guides/Linux%20Guide.md#creating-nadeko-folder) **FOLLOW THESE STEPS SERIALLY**
- **-21 OR 22**
- **-19**
- **-16**
- **-17**
- **-18**
- **-20**
HIT **CTRL+B+D** and close **PuTTY**
`IF YOU FACE ANY TROUBLE ANYWHERE IN THE GUIDE JUST FIND US IN NADEKO'S DISCORD SERVER` `IF YOU FACE ANY TROUBLE ANYWHERE IN THE GUIDE JUST FIND US IN NADEKO'S DISCORD SERVER`
[PuTTY]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
[CyberDuck]: https://cyberduck.io
[Linux Setup Video]: https://www.youtube.com/watch?v=icV4_WPqPQk&feature=youtu.be [Linux Setup Video]: https://www.youtube.com/watch?v=icV4_WPqPQk&feature=youtu.be
[Releases]: https://github.com/Kwoth/NadekoBot/releases [Releases]: https://github.com/Kwoth/NadekoBot/releases
[Readme]: https://github.com/Kwoth/NadekoBot/blob/master/README.md
[FFMPEG Help Guide]: http://www.faqforge.com/linux/how-to-install-ffmpeg-on-ubuntu-14-04/ [FFMPEG Help Guide]: http://www.faqforge.com/linux/how-to-install-ffmpeg-on-ubuntu-14-04/
[Mono Source]: http://www.mono-project.com/docs/getting-started/install/linux/ [Mono Source]: http://www.mono-project.com/docs/getting-started/install/linux/
[DigitalOcean]: http://m.do.co/c/46b4d3d44795/ [DigitalOcean]: http://m.do.co/c/46b4d3d44795/

15
docs/index.md
View File

@ -1,4 +1,5 @@
#NadekoBot Documentation #NadekoBot Documentation
To invite NadekoBot to your server, click on the image bellow: To invite NadekoBot to your server, click on the image bellow:
[![img][img]](https://discordapp.com/oauth2/authorize?client_id=170254782546575360&scope=bot&permissions=66186303) [![img][img]](https://discordapp.com/oauth2/authorize?client_id=170254782546575360&scope=bot&permissions=66186303)
@ -18,13 +19,12 @@ If you want to contribute, be sure to PR on the **[dev][dev]** branch.
- [OSX Guide](guides/OSX Guide.md) - [OSX Guide](guides/OSX Guide.md)
- [Building from Source](guides/Building from Source.md) - [Building from Source](guides/Building from Source.md)
- [Docker Guide](guides/Docker Guide.md) - [Docker Guide](guides/Docker Guide.md)
- [DigitalOcean Guide](guides/DigitalOcean Guide.md)
- Commands - Commands
- [Readme](Readme.md) - [Readme](Readme.md)
- [Commands List](Commands List.md) - [Commands List](Commands List.md)
- [Permissions System](Permissions System.md) - [Permissions System](Permissions System.md)
- [JSON Explanations](JSON Explanations.md) - [JSON Explanations](JSON Explanations.md)
- [Custiom Reactions](Custom Reactions.md) - [Custom Reactions](Custom Reactions.md)
- [Frequently Asked Questions](Frequently Asked Questions.md) - [Frequently Asked Questions](Frequently Asked Questions.md)
- [Contribution Guide](Contribution Guide.md) - [Contribution Guide](Contribution Guide.md)
- [Donate](Donate.md) - [Donate](Donate.md)
@ -34,3 +34,14 @@ If you want to contribute, be sure to PR on the **[dev][dev]** branch.
[GitHub]: https://github.com/Kwoth/NadekoBot [GitHub]: https://github.com/Kwoth/NadekoBot
[Issues]: https://github.com/Kwoth/NadekoBot/issues [Issues]: https://github.com/Kwoth/NadekoBot/issues
[dev]: https://github.com/Kwoth/NadekoBot/tree/dev [dev]: https://github.com/Kwoth/NadekoBot/tree/dev
[Italian]: http://i.imgur.com/SsaTwOF.png?1
[Russian]: http://i.imgur.com/wf9bc5G.png?1
[German]: http://i.imgur.com/EM5qPzf.png?1
[Chinese]: http://i.imgur.com/MVCNOjT.png?1
[English]: http://i.imgur.com/jHTyZFS.png?1
[Spanish]: http://i.imgur.com/9BsusB6.png?1
[French]: http://i.imgur.com/g2ARPF6.png?1
[Dutch]: http://i.imgur.com/SadddLj.png?1
[Norwegian]: http://i.imgur.com/TCVa0V8.png?1
[Serbian]: http://i.imgur.com/5evoUbU.png

3
mkdocs.yml
View File

@ -9,13 +9,12 @@ pages:
- OSX Guide: guides/OSX Guide.md - OSX Guide: guides/OSX Guide.md
- Building from Source: guides/Building from Source.md - Building from Source: guides/Building from Source.md
- Docker Guide: guides/Docker Guide.md - Docker Guide: guides/Docker Guide.md
- DigitalOcean Guide: guides/DigitalOcean Guide.md
- Commands: - Commands:
- Readme: Readme.md - Readme: Readme.md
- Commands List: Commands List.md - Commands List: Commands List.md
- Permissions System: Permissions System.md - Permissions System: Permissions System.md
- JSON Explanations: JSON Explanations.md - JSON Explanations: JSON Explanations.md
- Custom Commands: Custom Reactions.md - Custom Reactions: Custom Reactions.md
- Frequently Asked Questions: Frequently Asked Questions.md - Frequently Asked Questions: Frequently Asked Questions.md
- Contribution Guide: Contribution Guide.md - Contribution Guide: Contribution Guide.md
- ❤ Donate ❤: Donate.md - ❤ Donate ❤: Donate.md