Commit cb14d968 authored by Wizkiller96's avatar Wizkiller96

Fixed some markdown formatting issues.

parent 8f9dd2b1
Pipeline #139647591 passed with stage
in 2 minutes and 5 seconds
......@@ -8,4 +8,4 @@
| [![twitter](https://cdn.discordapp.com/attachments/155726317222887425/252192520094613504/twiter_banner.JPG)](https://twitter.com/WizBot_Dev) | [![Wiki](https://cdn.discordapp.com/attachments/266240393639755778/281920793330581506/datcord.png)](http://wizbot.readthedocs.io/en/latest/) |
| :--- | :--- |
| **Follow me on Twitter.** | **Read the Docs for self-hosting.** |
\ No newline at end of file
| **Follow me on Twitter.** | **Read the Docs for self-hosting.** |
......@@ -4,29 +4,29 @@
## Guides
* [Setting up WizBot on Docker](docs/guides/docker-guide-legacy.md)
* [Setting up WizBot on Docker](docs/guides/docker-guide.md)
* [Setting up WizBot From Source](docs/guides/from-source.md)
* [Setting up WizBot on Linux](docs/guides/linux-guide.md)
* [Setting Up WizBot on OSX \(macOS\)](docs/guides/osx-guide.md)
* [Setting Up WizBot on Windows With the Updater](docs/guides/windows-guide.md)
* [Setting up WizBot on Docker](docs/guides/docker-guide-legacy.md)
* [Setting up WizBot on Docker](docs/guides/docker-guide.md)
* [Setting up WizBot From Source](docs/guides/from-source.md)
* [Setting up WizBot on Linux](docs/guides/linux-guide.md)
* [Setting Up WizBot on OSX \(macOS\)](docs/guides/osx-guide.md)
* [Setting Up WizBot on Windows With the Updater](docs/guides/windows-guide.md)
## Commands
* [Readme](docs/readme.md)
* [Commands List](docs/commands-list.md)
* [Readme](docs/readme.md)
* [Commands List](docs/commands-list.md)
## Features Explained
* [JSON Explanations](docs/json-explanations.md)
* [Permissions Overview](docs/permissions-system.md)
* [Custom Reactions](docs/custom-reactions.md)
* [Placeholders](docs/placeholders.md)
* [Frequently Asked Questions](docs/frequently-asked-questions.md)
* [Bot Config](docs/bce-guide.md)
* [JSON Explanations](docs/json-explanations.md)
* [Permissions Overview](docs/permissions-system.md)
* [Custom Reactions](docs/custom-reactions.md)
* [Placeholders](docs/placeholders.md)
* [Frequently Asked Questions](docs/frequently-asked-questions.md)
* [Bot Config](docs/bce-guide.md)
## Other
* [Frequently Asked Questions](docs/frequently-asked-questions.md)
* [Contribution Guide](docs/contribution-guide.md)
* [❤ Donate ❤](docs/donate.md)
\ No newline at end of file
* [❤ Donate ❤](docs/donate.md)
......@@ -113,10 +113,8 @@ Whether the bot will see if there are updates available. The patch notes will be
* None: The bot will not check for updates
* Commit: This is useful for linux self-hosters - the bot will check for any new commit on the WizBot repository.
* Release: This is useful for windows self-hosters - the bot will check for any new releases published on the WizBot repository. This setting is also useful for linux self-hosters who only want to update when it's pretty safe to do so :\)
**Default is Release**
## PatreonCurrencyPerCent
You need this only if you have a patreon page, and you've specified the PatreonCampaignId and PatreonAccessToken in credentials.json. This value is the amount of currency the users will get with `.clparew` for each cent they've pledged. Also make sure your patreon is set to charge upfront, otherwise people will be able to pledge, claim reward and unpledge without getting charged. **Default is 1**
......@@ -5,4 +5,3 @@ Commands list has been moved to
[http://commands.wizbot.cc/](http://commands.wizbot.cc/)
\(if you can't see the page, try refreshing it and clearing the browser cache\)
......@@ -25,4 +25,3 @@
## Manage Permissions
**These permissions refer to the permissions you can set in Discord settings for individual users or roles.**
......@@ -5,4 +5,3 @@
3. Explain what you did in the MR message.
Thanks for all your help ^\_^
......@@ -18,7 +18,7 @@
| `.lcr` | Lists a page of global or server custom reactions \(15 reactions per page\). Running this command in a DM will list the global custom reactions, while running it in a server will list that server's custom reactions. | `.lcr 1` |
| `.dcr` | Deletes a custom reaction based on the provided index. Running this command in a server requires the Administrator permission. Running this command in DM is Bot Owner only, and will delete a global custom reaction. | `.dcr 5` |
### Now that we know the commands let's take a look at an example of adding a command with `.acr`,
### Now that we know the commands let's take a look at an example of adding a command with `.acr`
`.acr "Nice Weather" It sure is, %user%!`
......@@ -41,7 +41,6 @@ For example: `.acr /o/ -`
Now if you try to trigger `/o/`, it won't print anything.
## Placeholders!
## Placeholders
To learn about placeholders, go [here](placeholders.md)
# Donate to WizBot
If you want to help WizBot and WizBot's team by donating, you can do that in the two of the following ways:
If you want to help WizBot and WizNet's team by donating, you can do that in the two of the following ways:
## PayPal
If you wish to donate over PayPal, you can send your donations to: `[email protected]`
If you wish to donate over PayPal, you can send your donations to: [WizNet's PayPal](https://www.paypal.me/Wizkiller96Network)
## Patreon
If you wish to donate monthly over Patreon, you can do so by going to: [WizNet's Patreon](https://patreon.com/wiznet)
# Frequently Asked Questions
## Question 1: How do I get WizBot to join my server?
## Question 1: How do I get WizBot to join my server
**Answer:** Simply send WizBot a Direct Message with `.h` and follow the link. **Only People with the Manage Server permission can add the bot to the server**
## Question 2: I want to change permissions, but it isn't working!
## Question 2: I want to change permissions, but it isn't working
**Answer:** You must have the `.permrole` \(by default this is the `WizBot` role, for more details on permissions check [here](http://wizbot.readthedocs.io/en/latest/Permissions%20System/). If you have a role called `WizBot` but can't assign it it's probably the Bot Role so, just create a **New Role** called `WizBot` and assign that to yourself instead.\)
## Question 3: I want to enable NSFW on a channel.
## Question 3: I want to enable NSFW on a channel
**Answer:** To enable the NSFW Module on one channel, type `.cm NSFW enable #channel-name`. If this does not work refer to Question 2. To enable NSFW for your **entire server**, type `.sm NSFW enable`.
## Question 4: How do I get Cherry Blossom/Currency?
## Question 4: How do I get Cherry Blossom/Currency
**Answer:** You can get Cherry Blossom by picking them up after they have been generated with `.gc`, which you can then either plant \(give away to a channel so that someone can pick it\), or gamble with for potentinal profit with `.betflip`, `.betroll` and `.jr`. You can get flowers on the public bot by reacting on reaction events or by donating on [Patreon](https://patreon.com/wiznet) or [PayPal](https://paypal.me/wizkiller96network).
## Question 5: I have an issue/bug/suggestion, where do I put it so it gets noticed?
## Question 5: I have an issue/bug/suggestion, where do I put it so it gets noticed
**Answer:** First, check [issues](https://github.com/Wizkiller96/WizBot/issues).
If your problem or suggestion is not there, feel free to request/notify us about it in the Issues section of GitHub for issues.
## Question 6: How do I use this command?
## Question 6: How do I use this command
**Answer:** You can see the description and usage of certain commands by using `.h command` **i.e** `.h .sm`.
The whole list of commands can be found [here](http://wizbot.readthedocs.io/en/latest/Commands%20List/)
## Question 7: Music isn't working?
## Question 7: Music isn't working
**Answer:** Music is disabled on public WizBot due to large hosting costs, it will be re-enabled later in the future for donators.
**If you would like music in the meantime, you must host WizBot yourself**. Be sure you have FFMPEG installed correctly, and have followed the [guide](http://wizbot.readthedocs.io/en/latest/guides/Windows%20Guide/#setting-up-wizbot-for-music) carefully.
## Question 8: My music is still not working/very laggy?
## Question 8: My music is still not working/very laggy
**Answer:** Try changing your discord [location](https://support.discordapp.com/hc/en-us/articles/216661717.how-do-I-change-my-Voice-Server-Region-), if this doesn't work be sure you have enabled the correct permissions for WizBot and rebooted since installing FFMPEG.
## Question 9: I want to change data in the database like Cherry Blossom or something else but how?
## Question 9: I want to change data in the database like Cherry Blossom or something else but how
**Answer:** Follow the [DB Guide](http://wizbot.readthedocs.io/en/latest/JSON%20Explanations/#db-files), Open `/data/WizBot.db` using **sqlitebrowser** \(or some alternative\), Browse Data, select relevant table, change data, Write changes and done.
## Question 10: The .greet and .bye commands doesn't work, but everything else is!
## Question 10: The .greet and .bye commands doesn't work, but everything else is
**Answer:** Set a greeting message by using `.greetmsg YourMessageHere` and a bye-message by using `.byemsg YourMessageHere`. Don't forget that `.greet` and `.bye` only apply to users joining a server, not coming online/offline.
## Question 11: I made an application, but I can't add that new bot to my server, how do I invite it to my server?
## Question 11: I made an application, but I can't add that new bot to my server, how do I invite it to my server
**Answer:** You need to use oauth link to add it to you server, just copy your **CLIENT ID** \(that's in the same [Developer page](https://discordapp.com/developers/applications/me) where you brought your token\) and replace `12345678` in the link below: [https://discordapp.com/oauth2/authorize?client\_id=\`12345678\`&scope=bot&permissions=66186303](https://discordapp.com/oauth2/authorize?client_id=`12345678`&scope=bot&permissions=66186303)
Follow this Detailed [Guide](http://wizbot.cc/invite-guide.html).
## Question 12: I'm building WizBot from source, but I get hundreds of \(namespace\) errors without changing anything!?
## Question 12: I'm building WizBot from source, but I get hundreds of \(namespace\) errors without changing anything
**Answer:** Using Visual Studio, you can solve these errors by going to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution`. Go to the Installed tab, select the Packages that were missing \(usually `Newtonsoft.json` and `RestSharp`\) and install them for all projects.
## Question 13: My bot has all permissions but it's still saying, "Failed to add roles. Bot has insufficient permissions". How do I fix this?
## Question 13: My bot has all permissions but it's still saying, "Failed to add roles. Bot has insufficient permissions". How do I fix this
**Answer:** Discord has added a few new features and the roles now follow the role hierarchy, which means you need to place your bot's role above every other role on your server to fix the issue. [Here's](https://support.discordapp.com/hc/en-us/articles/214836687-Role-Management-101) a link to Discord's role management 101.
**Please Note:** _The bot can only set/add all roles below its own highest role. It cannot assign its "highest role" to anyone else._
## Question 14: I've broken permissions and am stuck, can I reset permissions?
## Question 14: I've broken permissions and am stuck, can I reset permissions
**Answer:** Yes, there is a way, in one easy command! Just run `.resetperms` and all the permissions you've set through **Permissions Module** will reset.
## Setting up WizBot with docker
# Setting up WizBot with docker
#### Hosting WizBot with docker is not officially supported until the next major version (3.0)
##### If you've been previously hosting with docker, please move to one of the other hosting options
## Hosting WizBot with docker is not officially supported until the next major version (3.0)
### If you've been previously hosting with docker, please move to one of the other hosting options
......@@ -21,7 +21,7 @@ This is the recommended way of installing WizBot from source. If you don't want
- [Git](https://git-scm.com/downloads) \(select [this option](https://i.imgur.com/zlWVTsi.png) during the installation process\)
- Redis
- Windows 64 bit: Download and install the [latest msi](https://github.com/MicrosoftArchive/redis/releases/tag/win-3.0.504). Don't forget to [add it to the path environment variable](https://i.imgur.com/uUby6Xw.png) during the installation process.
- Windows 32 bit: Skip this step
- Windows 32 bit: Skip this step
- [Create a Discord Bot application](../../jsons-explained/#creating-discord-bot-application) and [invite the bot to your server](../../jsons-explained/#inviting-your-bot-to-your-server).
**Optional** If you want WizBot to play music, do the following:
......@@ -36,7 +36,7 @@ This is the recommended way of installing WizBot from source. If you don't want
- Right click the `WizBotInstaller.bat` file and open it as Administrator
- After the admin check, you should see main menu with the options below:
```
```bash
1. Download Latest Build
2. Run WizBot (normally)
3. Run WizBot with Auto Restart (check "if" WizBot is working properly, before using this)
......@@ -106,7 +106,7 @@ If you want WizBot to play music, do the following:
"ShardRunArguments": "run -c Release --no-build -- {0} {1}",
```
- Move `youtube-dl.exe` and `ffmpeg.exe` into `wizBot/src/wizBot` \(or add them to your PATH environment variable, if you know how\)
- Move `youtube-dl.exe` and `ffmpeg.exe` into `wizBot/src/wizBot` \(or add them to your PATH environment variable, if you know how\)
- **For 32-bit Windows**, replace `libsodium.dll` and `opus.dll` in `wizBot/src/wizBot` with the ones you've downloaded.
### Launching WizBot
......@@ -127,7 +127,7 @@ If you want WizBot to play music, do the following:
- Move to WizBot's root folder:
- `cd WizBot`
- Update WizBot:
- `git pull`
- `git pull`
**If you have made custom edits to the source code.**
......@@ -147,4 +147,3 @@ Other useful commands:
- `git stash list` to see the list of saved stashes and their corresponding ID
- `git stash drop [email protected]{n}` to delete a specific stash
- `git stash pop [email protected]{n}` to apply and delete a specific stash
## Setting up WizBot on Linux
# Setting up WizBot on Linux
| Table of Contents |
| :--- |
......@@ -11,11 +11,11 @@
| [Setting up WizBot on a VPS \(Digital Ocean\)](#setting-up-wizbot-on-a-linux-vps-digital-ocean-droplet) |
| [Setting up WinSCP](#setting-up-winscp) |
#### Operating System Compatibility
## Operating System Compatibility
It is recommended that you use **Ubuntu 16.04**, as there have been nearly no problems with it. Music features are currently not working on CentOS. Also, **32-bit systems are incompatible**.
##### Compatible operating systems
### Compatible operating systems
- Ubuntu: 14.04, 16.04, 16.10, 17.04, 17.10, 18.04
- Mint: 17, 18
......@@ -104,7 +104,7 @@ You may be presented with the installer main menu once you shut your bot down. I
`sudo pm2 status` to see all pm2 processes
`sudo pm2 info WizBot` information about WizBot
`sudo pm2 info WizBot` information about WizBot
`sudo pm2 logs WizBot` to view real-time logs of WizBot, or
......@@ -123,7 +123,7 @@ You may be presented with the installer main menu once you shut your bot down. I
#### Running WizBot on tmux [if you don't want to use pm2]
**Before proceeding, make sure your bot is not running by either running `.die` in your Discord server or exiting the process with `Ctrl+C`.**
**Before proceeding, make sure your bot is not running by either running `.die` in your Discord server or exiting the process with `Ctrl+C`.**
If you are presented with the installer main menu, exit it by choosing Option `8`.
- Create a new session: `tmux new -s WizBot`
......@@ -148,9 +148,7 @@ You will be shown the following options:
- With option `1. Run Auto Restart normally without Updating`, the bot will restart on `.die` command and will not download the latest build available.
- With option `2. Run Auto Restart and update WizBot`, the bot will restart and download the latest build available everytime the `.die` command is used.
**Now check your Discord server, the bot should be online**
- To move the bot to the background, press **Ctrl+B**, release the keys then hit **D**. That will detach the session, allowing you to finally close the terminal window and not worry about having your bot shut down in the process.
#### Updating WizBot
......@@ -234,7 +232,7 @@ Here is a list of useful commands if you intend on managing WizBot with *systemd
- `sudo systemctl restart WizBot` - restarts WizBot. Can be used while the bot is being run.
- `sudo systemctl stop WizBot` - completely shuts WizBot down.
- `sudo systemctl enable WizBot` - makes WizBot start automatically upon system reboots.
- `sudo systemctl disable WizBot` - stops WizBot from starting automatically upon system reboots.
- `sudo systemctl disable WizBot` - stops WizBot from starting automatically upon system reboots.
- `sudo systemctl status WizBot` - shows some information about your bot (press `Ctrl+C` to exit).
---
......
## Setting Up WizBot on OSX (macOS)
# Setting Up WizBot on OSX (macOS)
| Table of Contents |
| :------------------------------------------------------ |
......@@ -10,30 +10,29 @@
| [Using WizBot with tmux (if you don't want to use pm2)] |
| [Doing a clean reinstall] |
#### Prerequisites
## Prerequisites
- OSX 10.12 (Sierra) or higher (needed for .NET Core 2.x).
- [Homebrew](http://brew.sh/).
- [Homebrew](http://brew.sh/).
- [Create a Discord Bot application](../../jsons-explained/#creating-discord-bot-application) and [invite the bot to your server](../../jsons-explained/#inviting-your-bot-to-your-server).
#### Installing Homebrew
### Installing Homebrew
- Open Terminal (if you don't know how to, click on the magnifying glass on the top right corner of your screen and type **Terminal** on the window that pops up).
- Copy and paste this command, then press Enter:
`/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
#### Installing the prerequisites
Run this command in Terminal (copy-paste the entire block):
Run this command in Terminal (copy-paste the entire block):
``` bash
brew install wget git ffmpeg openssl opus opus-tools opusfile libffi libsodium tmux python youtube-dl redis npm \
brew services start redis \
npm install [email protected] -g
npm install [email protected] -g
```
**Installing dotNET Core SDK**
##### **Installing dotNET Core SDK**
- Download [dotNET Core SDK 2.1](https://dotnet.microsoft.com/download/thank-you/dotnet-sdk-2.1.801-macos-x64-installer)
- Open the `.pkg` file you've downloaded and install it.
......@@ -45,7 +44,6 @@ ln -s /usr/local/opt/openssl/lib/libcrypto.1.0.0.dylib /usr/local/lib/ \
ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
```
#### Downloading and Running WizBot
- Use the following command to download and run the installer. (PS: **Do not** rename the **`linuxAIO.sh`** file)
......@@ -55,12 +53,10 @@ ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
- Choose Option `2` to **Run WizBot (Normally)**.
- Check in your Discord server if your new bot is working properly. Once you're done testing, type `.die` on Discord to shut it down. The Terminal should automatically return to the main menu.
#### Running WizBot with the terminal closed
If you run WizBot through option 2 or 3 and close the terminal, WizBot will also close. To avoid this, you'll need to use a process manager that will keep it open and running in the background. This section of the guide instructs on how to achieve this with pm2 and tmux. Whether you pick one or the other, please **do not** simultaneously, or you're going to get double responses to every command.
#### Using WizBot with pm2 (easiest method)
- pm2 will not only allow WizBot to run in the background, but will also automatically launch WizBot upon system reboots.
......@@ -70,17 +66,13 @@ If you run WizBot through option 2 or 3 and close the terminal, WizBot will also
- Pick whether you want to run it with or without auto-restart and auto-update.
- Once it's done, run Option `8` to exit.
- That's it. Your bot should be running in the background. Feel free to close the Terminal window.
**Managing WizBot with pm2**
- Use the following commands on Terminal to check your WizBot setup:
- `pm2 status` to see all pm2 processes
- `pm2 info WizBot` to see information about WizBot
- `pm2 logs WizBot` to view real-time logs of WizBot, or
- `pm2 logs WizBot --lines number` (**number** = how many lines you want to output) to see a specific amount of lines of the log. The logfile is also stored and presented at the top of these commands
**Updating WizBot with pm2**
- If you have set up WizBot with auto-update, simply run `.die` on your Discord server. That's it.
- If you have set up WizBot with no auto-update:
- Shut your bot down with `pm2 stop WizBot`
......@@ -88,7 +80,6 @@ If you run WizBot through option 2 or 3 and close the terminal, WizBot will also
- Once it's done, exit the installer with Option `8` and run `pm2 restart WizBot`
- You can watch your bot going online with `pm2 logs WizBot`
#### Using WizBot with tmux (if you don't want to use pm2)
- On the Terminal, create a new session:
......@@ -98,13 +89,13 @@ The above command will create a new session named **wizbot** *(you can replace
- Run the installer: `bash linuxAIO.sh`
- Choose `2` to **Run WizBot normally**.
- **NOTE**: With this option, if you use `.die` on Discord, the bot will shut down and stay offline until you manually run it again.
- **NOTE**: With this option, if you use `.die` on Discord, the bot will shut down and stay offline until you manually run it again.
- Choose `3` to **Run WizBot with Auto Restart**.
- **NOTE**: With this option, the bot will auto run if you use `.die`, making it function as a restart.
- **NOTE**: With this option, the bot will auto run if you use `.die`, making it function as a restart.
If you pick Option `3`, you will be shown the following options:
```
```bash
1. Run Auto Restart normally without Updating.
2. Run Auto Restart and update WizBot.
3. Exit
......@@ -116,28 +107,23 @@ If you pick Option `3`, you will be shown the following options:
Now check your Discord server, the bot should be online.
- To move the bot to the background, press **Control+B**, release the keys then hit **D**. That will detach the session, allowing you to finally close the terminal window and not worry about having your bot shut down in the process.
**Updating WizBot with tmux**
- If you're running WizBot with auto-update, just type `.die` in your Discord server. That's it!
- If you're running WizBot with **no** auto-update:
- Kill your previous session.
- Kill your previous session.
- Check the session name with `tmux ls`
- Kill with `tmux kill-session -t wizbot` (don't forget to replace "wizbot" with whatever you named your bot's session).
- Create a new session: `tmux new -s wizbot`
- Run this command: `cd ~ && wget -N https://github.com/Wizkiller96/WizBot-BashScript/raw/1.9/linuxAIO.sh && bash linuxAIO.sh`
- Choose Option `1` to download the most up to date version of WizBot.
- Once it's done, choose Option `2` or `3` and detach the session by pressing **Control+B**, release then **D**.
**Additional Information**
- If you want to **see the active sessions**, run `tmux ls`. That will give you the list of the currently running sessions.
- If you want to **switch to/see a specific session**, type `tmux a -t wizbot` (*wizbot* is the name of the session we created before so, replace it with the session name you have created).
- If you want to go through the log, press **Control+B**, release the keys then hit **Page Up** or **Page Down** to navigate.
- If you want to go through the log, press **Control+B**, release the keys then hit **Page Up** or **Page Down** to navigate.
- Don't forget to always detach from the session by pressing **Control+B** then **D** once you're done.
- If you want **create** a new session, run `tmux new -s wizbot`. If you want to **kill it**, run `tmux kill-session -t wizbot`
#### Doing a clean reinstall
- Make a backup of your credentials (`~/WizBot/src/WizBot/credentials.json`)
......@@ -146,7 +132,7 @@ Now check your Discord server, the bot should be online.
- Delete the WizBot folder
- Install the bot from scratch, replace the files you backed up and run.
#### Help! My music isn't working!
#### Help! My music isn't working
Make sure you have the [Google API Key](../../jsons-explained/#setting-up-your-api-keys) in your `credentials.json`
If music still isn't working, try reinstalling ffmpeg:
......@@ -155,7 +141,6 @@ If music still isn't working, try reinstalling ffmpeg:
- `brew prune` (Remove dead symlinks from Homebrew’s prefix)
- `brew doctor` (Check your Homebrew installation for common issues)
- Then try `brew install ffmpeg` again.
[Prerequisites]: #prerequisites
[Installing Homebrew]: #installing-homebrew
......
......@@ -19,7 +19,7 @@
* [Redis](https://github.com/MicrosoftArchive/redis/releases/download/win-3.0.504/Redis-x64-3.0.504.msi) \(supplied with the updater\)
* [Create a Discord Bot application](../../jsons-explained/#creating-discord-bot-application) and [invite the bot to your server](../../jsons-explained/#inviting-your-bot-to-your-server).
**Optional**
### **Optional**
* [Notepad++](https://notepad-plus-plus.org/) \(makes it easier to edit your credentials\)
* [Visual C++ 2010 \(x86\)](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe) and [Visual C++ 2017 \(x64\)](https://aka.ms/vs/15/release/vc_redist.x64.exe) \(both are required if you want WizBot to play music - restart Windows after installation\)
......@@ -44,7 +44,7 @@ _If you happen to close the wizard with that option unchecked, you can easily fi
## Updating WizBot
* Make sure WizBot is closed and not running
* Make sure WizBot is closed and not running
\(Run `.die` in a connected server to ensure it's not running\).
......@@ -61,4 +61,3 @@ You can still install them manually:
* [ffmpeg](https://ffmpeg.zeranoe.com/builds/) - Download the Release build and move the file to `C:\ffmpeg`, extract its contents and rename the folder to `nightly`.
* If that still fails, move the `ffmpeg.exe` file to `C:\Program Files\WizBot\system`.
* [youtube-dl](https://rg3.github.io/youtube-dl/download.html) - Click on `Windows.exe` \(on the top left corner\) and download the file. Then move it to `C:\Program Files\WizBot\system`.
......@@ -2,10 +2,10 @@
To invite public WizBot to your server, click on the image bellow:
[![](https://cdn.discordapp.com/attachments/202743183774318593/210580315381563392/discord.png)](https://discordapp.com/oauth2/authorize?client_id=170849867508350977&scope=bot&permissions=66186303)
[![WizNet Discord](https://cdn.discordapp.com/attachments/202743183774318593/210580315381563392/discord.png)](https://discordapp.com/oauth2/authorize?client_id=170849867508350977&scope=bot&permissions=66186303)
In case you need any help, hop on the [WizNet Server](https://discord.gg/0ehQwTK2RBjAxzEY), where we can provide support.
WizBot is an open source project, and it can be found on our [GitHub](https://github.com/Wizkiller96/WizBot) or [GitLab](https://gitlab.com/WizNet/WizBot) page.
Here you can read current [Issues](https://github.com/Wizkiller96/WizBot/issues).
\ No newline at end of file
Here you can read current [Issues](https://github.com/Wizkiller96/WizBot/issues).
......@@ -57,11 +57,11 @@ If you don't see a `credentials.json` file, you will need to rename `credentials
![img4](https://i.imgur.com/6beUSa5.gif)
- On the **General Information** tab, copy your `Client ID` from your [applications page](https://discordapp.com/developers/applications/me).
- Replace the `12345678` in this link:
- Replace the `12345678` in this link:
`https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with your `Client ID`.
- The link should now look like this:
- The link should now look like this:
`https://discordapp.com/oauth2/authorize?client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=66186303`
......@@ -71,10 +71,10 @@ If you don't see a `credentials.json` file, you will need to rename `credentials
### Setting up credentials.json file
- **For Windows \(Updater\)**: the `credentials.json` file is located in the `C:\Program Files\WizBot\system` folder.
- Note: there is a shortcut as well in `C:\Program Files\WizBot`, for easier access.
- Note: there is a shortcut as well in `C:\Program Files\WizBot`, for easier access.
- **For Windows \(Source\), Linux and OSX**: the `credentials.json` file is located in the `WizBot/src/WizBot` folder.
#### Getting Client ID:
#### Getting Client ID
- On the **General Information** tab of your [applications page](https://discordapp.com/developers/applications/me), copy your `Client ID`.
- Open your `credentials.json` file and replace the `12312123` part of the `"ClientId"` line with it.
......@@ -86,9 +86,9 @@ It should look like this:
"ClientId": 179372110000358912,
```
#### Getting the Bot's Token:
#### Getting the Bot's Token
* On the **Bot** tab of your [applications page](https://discordapp.com/developers/applications/me), copy your `Token`.
- On the **Bot** tab of your [applications page](https://discordapp.com/developers/applications/me), copy your `Token`.
- _Note: Your bot Token **is not** the Client Secret! We won't need the Client Secret for anything._
- Paste your bot token **between** the quotation marks on the `"Token"` line of your `credentials.json`.
......@@ -98,11 +98,11 @@ It should look like this:
"Token": "MTc5MzcyXXX2MDI1ODY3MjY0.ChKs4g.I8J_R9XX0t-QY-0PzXXXiN0-7vo",
```
#### Getting Owner ID_\(s\)_ & Admin ID_\(s\)_:
#### Getting Owner ID_\(s\)_ & Admin ID_\(s\)_
- Go to your Discord server and attempt to mention yourself, but put a backslash at the start:
- Go to your Discord server and attempt to mention yourself, but put a backslash at the start:
*\(to make it slightly easier, add the backslash after you type the mention out\)*
- For example, the message `\@fearnlj01#3535` will appear as `<@145521851676884992>` after you send the message.
- For example, the message `\@fearnlj01#3535` will appear as `<@145521851676884992>` after you send the message.
- The message will appear as a mention if done correctly. Copy the numbers from it `145521851676884992` and replace the 0 on the `OwnerIds` section with your user ID.
- Save the `credentials.json` file.
- If done correctly, you should now be the bot owner. You can add multiple owners or admins by seperating each owner ID or admin ID with a comma within the square brackets.
......@@ -141,34 +141,34 @@ This part is completely optional, **however it's necessary for music and a few o
- Required for Youtube Song Search, Playlist queuing, and a few more things.
- Follow these steps on how to setup Google API keys:
- Go to [Google Console](https://console.developers.google.com) and log in.
- Create a new project \(name does not matter\).
- Create a new project \(name does not matter\).
- Once the project is created, go into `Library`
- Under the `Other Popular APIs` section, enable `URL Shortener API` and `Custom Search API`
- Under the `Other Popular APIs` section, enable `URL Shortener API` and `Custom Search API`
- Under the `YouTube APIs` section, enable `YouTube Data API`
- Under the `Google Maps APIs` section, enable `Google Maps Geocoding API` and `Google Maps Time Zone API`
- On the left tab, access `Credentials`,
- Click `Create Credentials` button,
- Click on `API Key`
- A new window will appear with your `Google API key`
- Click `Create Credentials` button,
- Click on `API Key`
- A new window will appear with your `Google API key`
*NOTE: You don't really need to click on_ `RESTRICT KEY`_, just click on_ `CLOSE` _when you are done.*
- Copy the key.
- Copy the key.
- Open up `credentials.json` and look for `"GoogleAPIKey"`, paste your API key inbetween the quotation marks.
- It should look like this:
```json
"GoogleApiKey": "AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM",
```
- **MashapeKey**
- **MashapeKey**
- Required for Urban Dictionary, and Hearthstone cards.
- Api key obtained on https://rapidapi.com (register -> go to MyApps -> Add New App -> Enter Name -> Application key)
- Api key obtained on <https://rapidapi.com> (register -> go to MyApps -> Add New App -> Enter Name -> Application key)
- Copy the key and paste it into `credentials.json`
- **LoLApiKey**
- Required for all League of Legends commands.
- **LoLApiKey**
- Required for all League of Legends commands.
- You can get this key [here](http://api.champion.gg/).
- **OsuApiKey**
- **OsuApiKey**
- Required for Osu commands
- You can get this key [here](https://osu.ppy.sh/p/api).
- You can get this key [here](https://osu.ppy.sh/p/api).
- **CleverbotApiKey**
- Required if you want to use Cleverobot. It's currently a paid service.
- You can get this key [here](http://www.cleverbot.com/api/).
......@@ -185,19 +185,20 @@ This part is completely optional, **however it's necessary for music and a few o
- Once created, clicking on your application will show a new Client ID field
- Copy it to your credentials.json as shown below
- *(if you're adding it as the last key inside your credentials.json, remove the trailling comma from the example below)*
```json
"TwitchClientId": "516tr61tr1qweqwe86trg3g",
```
- **LocationIqApiKey**
- Optional. Used only for the `.time` command. https://locationiq.com api key (register and you will receive the token in the email).
- Optional. Used only for the `.time` command. <https://locationiq.com> api key (register and you will receive the token in the email).
- **TimezoneDbApiKey**
- Optional. Used only for the `.time` command. https://timezonedb.com api key (register and you will receive the token in the email **YOU HAVE TO ACTIVEATE IT AFTER YOU GET IT**).
- Optional. Used only for the `.time` command. <https://timezonedb.com> api key (register and you will receive the token in the email **YOU HAVE TO ACTIVEATE IT AFTER YOU GET IT**).
### Additional Settings
#### Additional Settings
- **TotalShards**
- Required if the bot will be connected to more than 2500 servers.
- **TotalShards**
- Required if the bot will be connected to more than 2500 servers.
- Most likely unnecessary to change until your bot is added to more than 2500 servers.
- **RedisOptions**
- Required if the Redis instance is not on localhost or on non-default port.
......@@ -236,7 +237,7 @@ In order to open it you will need [SQLite Browser](http://sqlitebrowser.org/).
**To make changes:**
- Shut your bot down.
- Shut your bot down.
- Copy the `WizBot.db` file to someplace safe. \(Back up\)
- Open it with SQLite Browser.
- Go to the **Browse Data** tab.
......@@ -258,7 +259,7 @@ In order to open it you will need [SQLite Browser](http://sqlitebrowser.org/).
- For example, if you want to shard your WizBot which you installed using windows installer, you would want to set it to something like this: `C:\Program Files\WizBot\system\WizBot.exe`
- **ShardRunArguments**
- Arguments to the shard run command
- Required if you're sharding your bot on windows using .exe, or in a custom way.
- Required if you're sharding your bot on windows using .exe, or in a custom way.
- This internally defaults to `run -c Release --no-build -- {0} {1} {2}` which will be enough to run linux and other 'from source' setups