Concord is an asynchronous C99 Discord API library. It has minimal external dependencies, and a low-level translation of the Discord official documentation to C code.
#include <string.h>
#include <concord/discord.h>
void on_ready(struct discord *client) {
const struct discord_user *bot = discord_get_self(client);
log_info("Logged in as %s!", bot->username);
}
void on_message(struct discord *client, const struct discord_message *msg) {
if (strcmp(msg->content, "ping") != 0)
return; /* ignore messages that aren't 'ping' */
struct discord_create_message params = { .content = "pong" };
discord_create_message(client, msg->channel_id, ¶ms, NULL);
}
int main(void) {
struct discord *client = discord_init(BOT_TOKEN);
discord_set_on_ready(client, &on_ready);
discord_set_on_message_create(client, &on_message);
discord_run(client);
}This is a minimalistic example, refer to examples/ for a better overview.
- GNU/Linux 4.x
- FreeBSD 12
- NetBSD 8.1
- Windows 7 (Cygwin)
- GNU/Hurd 0.9
- Mac OS X 10.9
- Install Cygwin
- Make sure that you installed libcurl, gcc, make, and git when you ran the Cygwin installer!
- You will want to check the Windows tutorial here!
- Mingw64 and Msys2 are currently NOT supported. Please see this for more information.
- Once installed, compile it normally like you would on UNIX/Linux/OS X/BSD.
- Note: you will likely need to include
-L/usr/local/lib -I/usr/local/includeon yourgcccommand, or in yourCFLAGSvariable in your Makefile for your bot.
The only dependency is curl-7.56.1 or higher. If you are compiling libcurl from source, you will need to build it with SSL support.
$ sudo apt install -y build-essential libcurl4-openssl-dev$ sudo xbps-install -S libcurl-devel$ sudo apk add curl-dev$ pkg install curl- Note: you will need to install Xcode, or at a minimum, the command-line tools with
xcode-select --install.
$ brew install curl (Homebrew)
$ port install curl (MacPorts)$ git clone https://github.com/cogmasters/concord.git && cd concord$ makeYou might run into trouble with the compiler and linker not finding your Libcurl headers. You can do something like this:
$ CFLAGS=-I<some_path> LDFLAGS=-L<some_path> makeFor instance, on a FreeBSD system:
$ CFLAGS=-I/usr/local/include LDFLAGS=-L/usr/local/lib makeOn OS X using MacPorts:
$ CFLAGS=-I/opt/local/include LDFLAGS=-L/opt/local/lib makeOn OS X using a self-compiled libcurl:
$ CFLAGS=-I/usr/local/include LDFLAGS=-L/usr/local/include makeOn Windows with Cygwin, you might need to pass both arguments to use POSIX threading:
$ CFLAGS="-pthread -lpthread" makeThe following section outlines flags that can be attached to the Makefile if you wish to override the default compilation behavior with additional functionalities. Example:
$ CFLAGS="-DCCORD_SIGINTCATCH -DCCORD_VOICE" make-DCCORD_SIGINTCATCH- By default Concord will not shutdown gracefully when a SIGINT is received (i.e. Ctrl+c), enable this flag if you wish it to be handled for you.
-DCCORD_VOICE- Enable experimental Voice Connection handling.
-DCCORD_DEBUG_WEBSOCKETS- Enable verbose debugging for WebSockets communication.
-DCCORD_DEBUG_ADAPTER- Enable verbose debugging for REST communication.
The following outlines the default fields of config.json
{
"logging": { // logging directives
"level": "trace", // trace, debug, info, warn, error, fatal
"filename": "bot.log", // the log output file
"quiet": false, // change to true to disable logs in console
"overwrite": true, // overwrite file if already exists, append otherwise
"use_color": true, // display color for log entries
"http": {
"enable": true, // generate http specific logging
"filename": "http.log" // the HTTP log output file
},
"disable_modules": ["WEBSOCKETS", "USER_AGENT"] // disable logging for these modules
},
"discord": { // discord directives
"token": "YOUR-BOT-TOKEN", // replace with your bot token
"default_prefix": {
"enable": false, // enable default command prefix
"prefix": "YOUR-COMMANDS-PREFIX" // replace with your prefix
}
}
}- Get your bot token and add it to
config.json, by assigning it to discord's "token" field. There are well written instructions from discord-irc explaining how to get your bot token and adding it to a server. - Build example executables:
$ make examples - Run Copycat-Bot:
$ cd examples && ./copycat
Type a message in any channel the bot is part of and the bot should send an exact copy of it in return.
With Ctrl+c or with Ctrl+|
(note -- # means that you should be running as root)
# make installThis will install the headers and libary files into $PREFIX. You can override this as such:
# PREFIX=/opt/concord make installNote that included headers must be concord/ prefixed:
#include <concord/discord.h>$ gcc myBot.c -o myBot -pthread -ldiscord -lcurl$ clang myBot.c -o myBot -pthread -ldiscord -lcurl- IBM XL C/C++ (AIX, z/OS, possibly IBM i)
- Sun/Oracle Studio (Solaris)
- IRIX MIPSpro C++ (IRIX) -- NOTE: currently not supported
- Possibly others!
$ cc myBot.c -o myBot -ldiscord -lcurl -lpthreadNote: some systems such as Cygwin require you to do this:
$ gcc myBot.c -o myBot -pthread -lpthread -ldiscord -lcurl(this links against libpthread.a in /usr/lib)
First, make sure your executable is compiled with the -g flag to ensure human-readable debugger messages.
Using valgrind to check for memory leaks:
valgrind --leak-check=full ./myBotFor a more comprehensive guide check Valgrind's Quick Start.
Using GDB to check for runtime errors, such as segmentation faults:
$ gdb ./myBotAnd then execute your bot from the gdb environment:
(gdb) runIf the program has crashed, get a backtrace of the function calls leading to it:
(gdb) btFor a more comprehensive guide check Beej's Quick Guide to GDB
Problems? Check out our Discord Server.
All kinds of contributions are welcome, all we ask is to abide to our guidelines! If you want to help but is unsure where to get started then our Discord API Roadmap is a good starting point. Check our links for more helpful information.