Building on macOS

1. Toolchain

Before compiling make sure you have all the tools installed.

To install the dependencies, this guide will use homebrew which has installation instructions on their project page
This project uses CMake to generate the makefiles. Install it with brew install cmake

2. Install External Dependencies

brew install openssl

For voice support, additional dependencies are required

brew install libsodium opus

3. Build Source Code

Download the source code via Github or get the archive from the releases. Then navigate to the root directory of the project and run the commands below.

mkdir build
cd build
cmake ..
make -j8

Replace the number after -j with a number suitable for your setup, usually the same as the number of cores on your machine. cmake will fetch any dependencies that are required for you and ensure they are compiled alongside the library.

4. Optional: Run test cases

run ./test for unit test cases. You will need to create a config.json file in the directory above the executable file with a valid bot token in it. See the example file config.example.json for an example of the correct format.

5. Install globally

sudo make install

6. Installation to a different directory

If you want to install the library, its dependencies and header files to a different directory, specify this directory when running cmake:

cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install

Then once the build is complete, run make install to install to the location you specified.

7. Using the library

Once installed, you can make use of the library in standalone programs simply by including it and linking to it:

clang++ -std=c++17 -ldpp mydppbot.cpp -o dppbot

The important flags in this command-line are:

-std=c++17 - Required to compile the headers
-ldpp - Link to libdpp.dylib
mydppbot.cpp - Your source code
dppbot - The name of the executable to make

Of course, this is just a proof of concept - you should really use a more robust build system like GNU make or `cmake`.

Have fun!