trilene / mtxclient Goto Github PK

Client API library for the Matrix protocol, built on top of Boost.Asio.

• Boost 1.70 (includes Boost.Beast and makes the strand interface usable)
• OpenSSL
• C++ 17 compiler
• CMake 3.15 or greater (lower versions can work, but they tend to mess up linking the right boost libraries)
• Google Test (for testing)

If you are missing some or all of those above dependencies, you can add -DHUNTER_ENABLED=ON to the cmake configure command to use bundled dependencies. You can finetune them with the following variables. They default to ON, if Hunter is enabled and to OFF otherwise.

Below is an example which will build the library along with the tests & examples.

cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Debug
cmake --build build

You will need to pass as argument (-DOPENSSL_ROOT_DIR) the installation root of openssl.

cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl
cmake --build build

You can toggle off the tests & examples by passing -DBUILD_LIB_TESTS=OFF & -DBUILD_LIB_EXAMPLES=OFF respectively.

In order to run the integration tests you'll need a local synapse instance. You can start an instance with docker by running the following

make synapse

then run the test suite

make test