miraai
GitHub
commit
37f2ba8e2a
@ -34,7 +34,7 @@
|
||||
- **OsuAPIKey** - needed for osu top5 and beatmap commands.
|
||||
- **CarbonKey** - carbonitex.net key if your bot is listed there in order to send stats (probably nobody needs this)
|
||||
|
||||
Next to your exe you must also have a `data folder` in which there is `config.jso`n (among other things) which will contain some user specific config, like should the Bot join servers, should DMs to bot be forwarded to you and a list of IDs of blacklisted users, channels and servers. If you do not have `config.json`, you can should `config_example.json` to `config.json`.
|
||||
Next to your exe you must also have a `data folder` in which there is `config.jso`n (among other things) which will contain some user specific config, like should the Bot join servers, should DMs to bot be forwarded to you and a list of IDs of blacklisted users, channels and servers. If you do not have `config.json`, you should rename `config_example.json` to `config.json`.
|
||||
|
||||
[SoundcloudApp]: http://soundcloud.com/you/apps/new
|
||||
[Your SC Apps]: http://soundcloud.com/you/apps
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Overview
|
||||
Ever stuck handling your Nadeko permissions? Look no further than this guide!
|
||||
We'll handle a few example cases that we've seen frequently on the help channel, as well as explaining the order of permissions in general. Any command used here can be found in the [Commands list](https://github.com/Kwoth/NadekoBot/blob/master/commandlist.md#permissions)
|
||||
We'll handle a few example cases that we've seen frequently on the help channel, as well as explaining the order of permissions in general. Any command used here can be found in the [Commands list](Commands List.md#permissions)
|
||||
|
||||
# How does it work?
|
||||
Permissions are handy to set up to limit who in your server can use what. by default, every command is enabled for everyone, except for the administration commands, like `.kick` and `.prune`, which are set to correspond to discord's permissions, (kicking and managing messages respectively here), the permissions module, which we will show in the next paragraph, and some other commands throughout the other modules that are owner-only, meaning that only someone who has his or her id in the list of owners of the bot can use them.
|
||||
@ -70,7 +70,7 @@ Follow that with another space and, to enable it, type one of the following: [1,
|
||||
|
||||
Follow that with another space and the name of the user, role, channel. (depending on the first letter you picked)
|
||||
|
||||
###### Examples
|
||||
###### Examples #1
|
||||
- **;rm NSFW 0 [Role_Name]** Disables the NSFW module for the role, <Role_Name>.
|
||||
- **;cc "!!n" 0 [Channel_Name]** Disables skipping to the next song in the channel, <Channel_Name>.
|
||||
- **;uc "!!q" 1 [User_Name]** Enables queuing of songs for the user, <User_Name>.
|
||||
@ -78,7 +78,7 @@ Follow that with another space and the name of the user, role, channel. (dependi
|
||||
|
||||
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
|
||||
###### Examples #2
|
||||
- ;cp [Channel_Name]
|
||||
- ;rp [Role_Name]
|
||||
|
||||
|
||||
145
docs/guides/DigitalOcean Guide.md
Normal file
145
docs/guides/DigitalOcean Guide.md
Normal file
@ -0,0 +1,145 @@
|
||||
##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
|
||||
@ -1,6 +1,6 @@
|
||||
# Docker Guide with DigitalOcean
|
||||
|
||||
#####Prerequisites:
|
||||
#####Prerequisites
|
||||
- Digital ocean account (you can use my [reflink][reflink] to support the project and get 10$ after you register)
|
||||
- [PuTTY][PuTTY]
|
||||
- A bot account - follow this [guide][guide]
|
||||
|
||||
@ -3,73 +3,42 @@
|
||||
####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**)
|
||||
|
||||
######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.
|
||||
######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)
|
||||
|
||||
####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.
|
||||
|
||||
#### 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)
|
||||
Note: When you install mono, please run update once more to check for any missing repos and dependencies.
|
||||
|
||||
####Installing Mono
|
||||
######MONO (Source: [Mono Source][Mono Source])
|
||||
|
||||
**1) Installing Mono**
|
||||
|
||||
`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`
|
||||
`sudo apt-get update`
|
||||
|
||||
Note if the command is not being initiated, hit **Enter**
|
||||
|
||||
**2)**
|
||||
|
||||
`echo "deb http://download.mono-project.com/repo/debian wheezy-apache24-compat main" |
|
||||
sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list`
|
||||
|
||||
**2.5)**
|
||||
*ONLY DEBIAN 8 and later*
|
||||
####Mono on Debian 8 and later
|
||||
|
||||
`echo "deb http://download.mono-project.com/repo/debian wheezy-libjpeg62-compat main" |
|
||||
sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list`
|
||||
|
||||
**2.6)**
|
||||
*ONLY CentOS 7, Fedora 19 (and later)*
|
||||
####Mono on CentOS 7, Fedora 19 (and later) and later
|
||||
|
||||
`yum install yum-util`
|
||||
`rpm --import "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"`
|
||||
`yum-config-manager --add-repo http://download.mono-project.com/repo/centos/`
|
||||
|
||||
**3)**
|
||||
*Mono Devel*
|
||||
####Mono Devel
|
||||
|
||||
`apt-get install mono-devel`
|
||||
|
||||
**Type** `y` **hit Enter**
|
||||
|
||||
|
||||
**4)**
|
||||
Opus Voice Codec
|
||||
|
||||
`sudo apt-get install libopus0 opus-tools`
|
||||
|
||||
**Type** `y` **hit Enter**
|
||||
|
||||
**5)**
|
||||
`sudo apt-get install libopus-dev`
|
||||
|
||||
####Mono Fix
|
||||
**In case you are having issues with Mono where you get a random string and the bot won't run, do this:**
|
||||
|
||||
`sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF`
|
||||
@ -77,10 +46,18 @@ Opus Voice Codec
|
||||
`apt-get install ca-certificates-mono`
|
||||
`mozroots --import --sync`
|
||||
|
||||
####Installing Opus Voice Codec
|
||||
|
||||
- Opus Voice Codec
|
||||
|
||||
`sudo apt-get install libopus0 opus-tools`
|
||||
|
||||
**Type** `y` **hit Enter**
|
||||
|
||||
`sudo apt-get install libopus-dev`
|
||||
|
||||
####FFMPEG
|
||||
|
||||
**6)**
|
||||
`apt-get install ffmpeg`
|
||||
|
||||
**Type** `y` **hit Enter**
|
||||
@ -108,53 +85,42 @@ In case you are not able to install it with installer ^up there, follow these st
|
||||
|
||||
####Uncomplicated Firewall UFW
|
||||
|
||||
**7)**
|
||||
- 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**
|
||||
|
||||
**8)**
|
||||
`ufw status`
|
||||
|
||||
**9)**
|
||||
`ufw enable`
|
||||
|
||||
**Type** `y` **hit Enter**
|
||||
|
||||
**10)**
|
||||
`sudo ufw allow ssh`
|
||||
|
||||
|
||||
|
||||
**11)**
|
||||
Unzip
|
||||
####Installing Unzip
|
||||
|
||||
`apt-get install unzip`
|
||||
|
||||
**12)**
|
||||
TMUX
|
||||
####Installing TMUX
|
||||
|
||||
`apt-get install tmux`
|
||||
|
||||
**Type** `y` **hit Enter**
|
||||
|
||||
####Importing certs
|
||||
**13)**
|
||||
|
||||
`certmgr -ssl https://discordapp.com`
|
||||
|
||||
**14)**
|
||||
`certmgr -ssl https://gateway.discord.gg`
|
||||
|
||||
Type `yes` and hit Enter **(three times - as it will ask for three times)**
|
||||
|
||||
|
||||
**15)**
|
||||
Create a new folder “nadeko” or anything you prefer
|
||||
####Creating Nadeko folder
|
||||
- Create a new folder “nadeko” or anything you prefer
|
||||
|
||||
`mkdir nadeko`
|
||||
|
||||
**16)**
|
||||
Move to “nadeko” folder (note `cd --` to go back the directory)
|
||||
- Move to “nadeko” folder (note `cd --` to go back the directory)
|
||||
|
||||
`cd nadeko`
|
||||
|
||||
@ -163,15 +129,12 @@ Move to “nadeko” folder (note `cd --` to go back the directory)
|
||||
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`
|
||||
|
||||
**17)**
|
||||
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**
|
||||
|
||||
**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`
|
||||
|
||||
`unzip NadekoBot.vx.x.zip`
|
||||
@ -191,29 +154,29 @@ Now we need to `unzip` the downloaded zip file and to do that, type the file nam
|
||||
- It should show you the new folder you created.
|
||||
- Open it.
|
||||
|
||||
#####MAKE SURE YOU READ THE README BEFORE PROCEEDING
|
||||
####Renaming Credentials.json
|
||||
|
||||
- Copy the `credentials_example.json` to desktop
|
||||
- EDIT it as it is guided here: [Readme][Readme]
|
||||
- Rename it to `credentials.json` and paste/put it back in the folder. `(Yes, using CyberDuck)`
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
####Running NadekoBot
|
||||
|
||||
Go back to **PuTTY**, `(hope its still running xD)`
|
||||
|
||||
**19)**
|
||||
Type/ Copy and hit **Enter**.
|
||||
- Type/ Copy and hit **Enter**.
|
||||
|
||||
`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.`
|
||||
its your session name) so you can run the bot in background.`
|
||||
- Enter your Nadeko folder
|
||||
|
||||
`cd nadeko`
|
||||
|
||||
**20)**
|
||||
- Start NadekoBot with mono
|
||||
|
||||
`mono NadekoBot.exe`
|
||||
|
||||
**CHECK THE BOT IN DISCORD, IF EVERYTHING IS WORKING**
|
||||
@ -221,6 +184,7 @@ its your session name) so you can run the bot in background without having to ke
|
||||
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)
|
||||
|
||||
**NOW YOU HAVE YOUR OWN NADEKO BOT** `Thanks to Kwoth <3`
|
||||
|
||||
@ -228,34 +192,16 @@ Copy your CLIENT ID (that's in the same Developer page where you brought your to
|
||||
|
||||
-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.)
|
||||
|
||||
**21)**
|
||||
-If you want to **kill** NadekoBot **session**, type `tmux kill-session -t nadeko`
|
||||
|
||||
####How to restart Nadeko with the server (for science)
|
||||
**22)**
|
||||
Open **PuTTY** and login as you have before, type `reboot` and hit Enter.
|
||||
|
||||
####Updating Nadeko
|
||||
|
||||
**FOLLOW THESE STEPS SERIALLY**
|
||||
|
||||
- **-21 OR 22**
|
||||
- **-19**
|
||||
- **-16**
|
||||
- **-17**
|
||||
- **-18**
|
||||
- **-20**
|
||||
|
||||
HIT **CTRL+B+D** and close **PuTTY**
|
||||
**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)
|
||||
|
||||
`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
|
||||
[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/
|
||||
[Mono Source]: http://www.mono-project.com/docs/getting-started/install/linux/
|
||||
[DigitalOcean]: http://m.do.co/c/46b4d3d44795/
|
||||
|
||||
@ -1 +1,153 @@
|
||||
##MAC Guide
|
||||
### Setting Up NadekoBot on OSX
|
||||
#### Prerequisites
|
||||
- 1) [Homebrew][Homebrew]
|
||||
- 2) Mono
|
||||
- 3) Google Account
|
||||
- 4) Soundcloud Account (if you want soundcloud support)
|
||||
- 5) Text Editor (TextWrangler, or equivalent) or outside editor such as [Atom][Atom]
|
||||
|
||||
####Installing Homebrew
|
||||
|
||||
`/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
|
||||
|
||||
Run `brew update` to fetch the latest package data.
|
||||
####Installing dependencies
|
||||
```
|
||||
brew install git
|
||||
brew install ffmpeg
|
||||
brew update && brew upgrade ffmpeg
|
||||
brew install opus
|
||||
brew install opus-tools
|
||||
brew install opusfile
|
||||
brew install libffi
|
||||
brew install libsodium
|
||||
brew install tmux
|
||||
```
|
||||
|
||||
####Check your `FFMPEG`
|
||||
|
||||
**In case your `FFMPEG` wasnt installed properly**
|
||||
|
||||
- `brew options ffmpeg`
|
||||
- `brew install ffmpeg --with-x --with-y --with-z` etc.
|
||||
- `brew update && brew upgrade` (Update formulae and Homebrew itself && Install newer versions of outdated packages)
|
||||
- `brew prune` (Remove dead symlinks from Homebrew’s prefix)
|
||||
- `brew doctor` (Check your Homebrew installation for common issues)
|
||||
- Then try `brew install ffmpeg` again.
|
||||
|
||||
####Installing xcode-select
|
||||
Xcode command line tools. You will do this in Terminal.app by running the following command line:
|
||||
|
||||
`xcode-select --install`
|
||||
|
||||
A dialog box will open asking if you want to install `xcode-select`. Select install and finish the installation.
|
||||
|
||||
####Installing Mono
|
||||
- Building Mono dependencies:
|
||||
|
||||
`brew install autoconf automake libtool pkg-config`
|
||||
|
||||
- Building Mono from Source:
|
||||
|
||||
To build Mono from a Git Source Code checkout, you will want to have the official Mono installed on the system, as the build requires a working C# compiler to run. Once you do this, run the following commands, remember to replace PREFIX with your installation prefix that you selected:
|
||||
|
||||
```
|
||||
PATH=$PREFIX/bin:$PATH
|
||||
git clone https://github.com/mono/mono.git
|
||||
cd mono
|
||||
CC='cc -m32' ./autogen.sh --prefix=$PREFIX --disable-nls --build=i386-apple-darwin11.2.0
|
||||
make
|
||||
make install
|
||||
```
|
||||
To build Mono in 64 bit mode instead use this to configure the build:
|
||||
|
||||
`./autogen.sh --prefix=$PREFIX --disable-nls`
|
||||
|
||||
####Nadeko Setup
|
||||
- Create a new folder and name it `Nadeko`.
|
||||
- Move to our `Nadeko` folder
|
||||
|
||||
`cd Nadeko`
|
||||
- Go to [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`
|
||||
- Get the correct link, type `curl -O` and past the link, then hit `Enter`
|
||||
- It should be something like this:
|
||||
|
||||
`curl -O https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
|
||||
|
||||
^ do not copy-paste it
|
||||
|
||||
- Unzip the downloaded file in our `Nadeko` folder
|
||||
|
||||
####Creating DiscordBot application
|
||||
- Go to [DiscordApp][DiscordApp].
|
||||
- Log in with your Discord account.
|
||||
- On the left side, press `New Application`.
|
||||
- Fill out the `App Name` (your bot's name, in this case), put the image you want, and add an app description(optional).
|
||||
- Create the application.
|
||||
- Once the application is created, click on `Create a Bot User` and confirm it.
|
||||
- Keep this window open for now.
|
||||
|
||||
####Setting up Credentials.json file
|
||||
- In our `NadekoBot` folder you should have `.json` file named `credentials_example.json`. (Note: If you do not see a **.json** after `credentials_example.json `, do not add the `**.json**`. You most likely have `"Hide file extensions"` enabled.)
|
||||
- Rename `credentials_example.json` to `credentials.json`.
|
||||
- Open the file with your Text editor.
|
||||
- In there you will see fields like `Token`, `ClientId`, `BotId`, `OwnerIDs`.
|
||||
- In your [DiscordApp][DiscordApp], under `Bot User` part, you will see the `Token:click to reveal` part, click to reveal it.
|
||||
- Copy your bot's token, and put it between `" "` in your `credentials.json` file.
|
||||
- Copy `Client ID` and replace it with the example one in your `credentials.json`.
|
||||
- Copy `Bot ID` and replace it with the example one in your `credentials.json`.
|
||||
- Save your `credentials.json` but keep it open. We need to put your `User ID` and owner.
|
||||
|
||||
####Running NadekoBot
|
||||
- Copy/past and hit `Enter`
|
||||
|
||||
`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)`.
|
||||
|
||||
`cd nadeko`
|
||||
|
||||
- Start NadekoBot.exe using Mono:
|
||||
|
||||
`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)
|
||||
|
||||
####Inviting your bot to your server - [Invite Guide][Invite Guide]
|
||||
- Create a new server in Discord.
|
||||
- Copy your `Client ID` from your [DiscordApp][DiscordApp].
|
||||
- Replace `12345678` in this link `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with your `Client ID`.
|
||||
- Link should look like this: `https://discordapp.com/oauth2/authorize?client_id=**YOUR_CLENT_ID**&scope=bot&permissions=66186303`.
|
||||
- Go to newly created link and pick the server we created, and click `Authorize`.
|
||||
- Bot should be added to your server.
|
||||
|
||||
####Setting up OwnerIds
|
||||
- In the server where your bot is, in a text channel, type `.uid`
|
||||
- Your `User ID` should show, copy it.
|
||||
- Close `NadekoBot.exe`
|
||||
- Replace your `User ID` in the `credentials.json` between `[ ]` and save the changes.
|
||||
- Run `NadekoBot.exe` again.
|
||||
- Now you are the bot owner.
|
||||
- You can add `User IDs` from the other users by separating IDs with a comma if you want to have more owners.
|
||||
|
||||
####Setting NadekoBot Music
|
||||
|
||||
For Music Setup and API keys check [Setting up NadekoBot for Music](Windows Guide.md#setting-up-nadekobot-for-music) and [JSON Explanations](JSON Explanations.md).
|
||||
|
||||
####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 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`
|
||||
|
||||
[Homebrew]: http://brew.sh/
|
||||
[Mono]: http://www.mono-project.com/docs/compiling-mono/mac/
|
||||
[Releases]: //github.com/Kwoth/NadekoUpdater/releases/tag/v1.0
|
||||
[DiscordApp]: https://discordapp.com/developers/applications/me
|
||||
[Atom]: https://atom.io/
|
||||
[Invite Guide]: http://discord.kongslien.net/guide.html
|
||||
[Google Console]: https://console.developers.google.com
|
||||
[Soundcloud]: https://soundcloud.com/you/apps/new
|
||||
|
||||
@ -11,7 +11,7 @@ ________________________________________________________________________________
|
||||
- 5) [7zip][7zip] (or whatever you are using, WinRar)
|
||||
- 6) [Notepad++][Notepad++]
|
||||
|
||||
####Guide:
|
||||
####Guide
|
||||
|
||||
- Create a folder, name it `Nadeko`.
|
||||
- Head to [Releases][Releases]* and download `WINDOWS.-.nadeupdater.7z`.
|
||||
@ -44,7 +44,8 @@ ________________________________________________________________________________
|
||||
- Copy `Bot ID` and replace it with the example one in your `credentials.json`.
|
||||
- Save your `credentials.json` but keep it open. We need to put your `User ID` and owner.
|
||||
|
||||
####Inviting your bot to your server - [Invite Guide][Invite Guide]
|
||||
####Inviting your bot to your server
|
||||
- [Invite Guide][Invite Guide]
|
||||
- Create a new server in Discord.
|
||||
- Copy your `Client ID` from your [DiscordApp][DiscordApp].
|
||||
- Replace `12345678` in this link `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with your `Client ID`.
|
||||
@ -94,7 +95,7 @@ ________________________________________________________________________________
|
||||
- In `credentials.json`, fill in `"SoundcloudClientID"` with the copied ID.
|
||||
- Restart your computer.
|
||||
|
||||
####Prerequisites for manual `ffmpeg` setup:
|
||||
####Manual `ffmpeg` setup
|
||||
**Do this step in case you were not able to install `ffmpeg` with the installer.**
|
||||
|
||||
- Create a folder named `ffmpeg` in your main Windows directory. We will use **C:\ffmpeg** (for our guide)
|
||||
|
||||
@ -1 +1,2 @@
|
||||
Docs are in the air.
|
||||
Kwoth is magic.
|
||||
|
||||
@ -12,6 +12,7 @@ In case you need any help, hop on [NadekoBot Server][NadekoBot Server], where we
|
||||
- [OSX Guide](guides/OSX Guide.md)
|
||||
- [Building from Source](guides/Building from Source.md)
|
||||
- [Docker Guide](guides/Docker Guide.md)
|
||||
- [DigitalOcean Guide](guides/DigitalOcean Guide.md)
|
||||
- [Commands List](Commands List.md)
|
||||
- [Permissions System](Permissions System.md)
|
||||
- [JSON Explanations](JSON Explanations.md)
|
||||
|
||||
@ -9,6 +9,7 @@ pages:
|
||||
- OSX Guide: guides/OSX Guide.md
|
||||
- Building from Source: guides/Building from Source.md
|
||||
- Docker Guide: guides/Docker Guide.md
|
||||
- DigitalOcean Guide: guides/DigitalOcean Guide.md
|
||||
- Commands List: Commands List.md
|
||||
- Permissions System: Permissions System.md
|
||||
- JSON Explanations: JSON Explanations.md
|
||||
|
||||
Loading…
Reference in New Issue
Block a user