Discord++ example bot, Echo^EchoEcho

Community & Support ^{Some incredibly nice people here!}

Discord++ Discord Server

How to Get Started ^{Let's get it sta-arted! Let's get it started in here!}

Install Prerequisites

Install Git

• If you want to use Git in the command line, run sudo apt install git on Ubuntu, on Windows you can download Git for Windows or use choco install git if you have Chocolatey installed.
• If you're less terminal-inclined, you can install a Git GUI wrapper. There's a nice list here.
  • I would personally recommend GitKraken. The free version has everyhting you need, (although their conflict resolver for Pro is nice,) and you can also get Pro free with GitHub Education!

^ANDInstall CMake

• Debian-based (Ubuntu) run sudo apt install cmake
• Fedora/RHEL-based sudo dnf install cmake
• Windows Download CMake or run choco install cmake if you have Chocolatey installed.

^AND Install C++

1. Install a C++ compiler
   • the typical standard on Linux is gcc, you can install it on Ubuntu with sudo apt install gcc
   • clang is an alternative that I feel has better error statements, you can install it on Ubuntu with sudo apt install clang
   • The typical compiler on Windows is Microsoft Visual C++
   • MinGW or Cygwin are valid alternatives if you like GCC running on Windows, there's also WSL which allows you to run a Linux based distribution under Windows.

^{AND OPTIONALLY}Install vcpkg

• Vcpkg is a cross platform library manager, you can install it by reading the instructions on this page
• This program is required for building Echo under Windows.

^AND Install Libraries

• Debian-based (Ubuntu) sudo apt install build-essential libboost-all-dev libssl-dev
• Fedora/RHEL-based sudo dnf install openssl-devel boost-devel
• Vcpkg vcpkg install boost-system boost-beast openssl

^OR Install Everything at Once

• Debian-based (Ubuntu) sudo apt install git clang cmake build-essential libboost-all-dev libssl-dev

Set Up Repository

Fork Echo ^{Optional, I guess}

• Click the 'Fork' button in the upper-right of the repo's page
• If you're in an organization, elect the where you want the fork to go
• Click on your new 'Settings' tab, and rename your new repo

Clone the Code

Run git clone --recursive https://github.com/discordpp/echo-bot.git in your desired directory. If you made a fork, replace echo-bot as applicable.

Register a Bot

1. Go to Discord's Developer Portal 'Application' page, it will prompt you to sign in ^{By the way, do you have 2FA enabled? It's a really good idea, especially with bots on your account}
2. Click 'New Application', and enter a name for your bot
3. Click on 'Bot' under 'Settings' on the right, click 'Add Bot', and then 'Yes, do it!'
   • Make note of the 'Copy' button under 'Token', we'll get back to this later
   • Also, come back and click the 'regenerate' button if anyone ever gets a hold of your bot's token
   • If you want to give your bot an avatar, I'd recommend doing it both on the 'General Information' landing page and here on the 'Bot' page, it makes things less confusing if you ever need to come back.

Add your Bot to a Server

1. Copy https://discordapp.com/api/oauth2/authorize?client_id=[ID]&scope=bot&permissions=[permissions] to somewhere, such as notepad
2. Go back to the 'General Information' page of your application
3. Click 'Copy' under 'Client ID', and paste it into your URL, taking care to replace the word and brackets
4. Go to the 'Bot' page
5. Select the permissions you want your bot to have from under 'Bot Permissions'
   • You probably want at least 'Send Messages', 2048
6. Click the 'Copy' button under 'Permissions Integer', and paste it in your URL, make sure you get the brackets like before
7. Paste the URL into a web btowser, select a server to add it to, and click 'Authorize'

Build your Bot

1. Create a build directory (folder) with mkdir build
2. Enter the folder with cd build
3. Go back to your Application's 'bot' page from before, and copy the token. Run echo Bot [token] > token.dat, replacing [token] with your bot's token. Alternatively, you can set the ECHO_BOT_TOKEN environment variable to Bot [token].
4. Build the makefiles with cmake ../
   • If you are using vcpkg then run cmake -DCMAKE_TOOLCHAIN_FILE="your vcpkg.cmake folder" ../
5. Build the bot with make (if you are using Visual Studio open echo_bot.sln and build from there)
6. Run the bot with ./echo_bot
   • You can change the executable name by modifying the project command in CMakeLists.txt
7. ???
8. Profit! Mention your bot in a scope it can read & write in, it should echo back your message.

Contributing

• Echo is pretty simple and probably doesn't need much, but if you have a suggestion or spot an issue, make a pull request on Github!
• Also, this repo needs better jokes.