TDLib Android build guide

Before you start

The SDK, NDK, minimum API level and ABI are separate choices. The pinned instructions retain their original defaults; OpenSSL 1.1.1 is not a current production-security recommendation. Review supported dependencies for your application.

TDLib Android example

This is an example of building TDLib for Android. You need a Bash shell on Linux, macOS, or Windows with some common tools, a C++ compiler, JDK, PHP, perl, and gperf pre-installed.

Building TDLib for Android

• Run the script ./check-environment.sh to check that you have all required Unix tools and Java utilities. If the script exits with an error message, install the missing tool.
• Run the script ./fetch-sdk.sh to download Android SDK to a local directory.
• Run the script ./build-openssl.sh to download and build OpenSSL for Android.
• Run the script ./build-tdlib.sh to build TDLib for Android.
• The built libraries are now located in the tdlib/libs directory. If Java interface was built, then corresponding Java code is located in the tdlib/java directory, and standalone Java documentation can be found in the tdlib/javadoc directory. You can also use archives tdlib/tdlib.zip and tdlib/tdlib-debug.zip, which contain all aforementioned data.

If you already have installed Android SDK and NDK, you can skip the second step and specify existing Android SDK root path and Android NDK version as the first and the second parameters to the subsequent scripts. Make sure that the SDK includes android-34 platform and CMake 3.22.1.

If you already have prebuilt OpenSSL, you can skip the third step and specify path to the prebuild OpenSSL as the third parameter to the script ./build-tdlib.sh.

If you want to update TDLib to a newer version, you need to run only the script ./build-tdlib.sh.

You can specify different OpenSSL version as the fourth parameter to the script ./build-openssl.sh. By default OpenSSL 1.1.1 is used because of much smaller binary footprint and better performance than newer OpenSSL versions.

You can build shared OpenSSL libraries instead of static ones by passing any non-empty string as the fifth parameter to the script ./build-openssl.sh. This can reduce total application size if you have a lot of other code that uses OpenSSL and want it to use the same shared library.

You can build TDLib against shared standard C++ library by specifying "c++_shared" as the fourth parameter to the script ./build-tdlib.sh. This can reduce total application size if you have a lot of other C++ code and want it to use the same shared library.

You can also build TDLib with JSON interface instead of Java interface by passing "JSON" as the fifth parameter to the script ./build-tdlib.sh.

You can also build TDLib with JSON interface that can be called from Java by passing "JSONJava" as the fifth parameter to the script ./build-tdlib.sh.

You can build TDLib for a specific minimal Android API level by passing it as the sixth parameter to the script ./build-tdlib.sh. Passing a newer version can reduce total application size.

You can build TDLib for a specific ABIs by passing space-separated list of ABIs as the seventh parameter to the script ./build-tdlib.sh.

You can pass an empty string instead of any script parameter to use its default value. For example, you can use the command ./build-tdlib.sh '' '' '' '' 'JSON' to build TDLib with JSON interface using default values for other parameters.

Alternatively, you can use Docker to build TDLib for Android. Use docker build --output tdlib . to build the latest TDLib commit from Github, or docker build --build-arg COMMIT_HASH=<commit-hash> --output tdlib . to build specific commit. The output archives will be placed in the directory "tdlib" as specified. Additionally, you can specify build arguments "TDLIB_INTERFACE", "ANDROID_NDK_VERSION", "OPENSSL_VERSION", "BUILD_SHARED_OPENSSL_LIBS", and "ANDROID_STL" to the provided Dockerfile. For example, use docker build --build-arg TDLIB_INTERFACE=JSON --output tdlib . to build the latest TDLib with JSON interface.

Continue with the TDLib overview. For credentials, follow the API ID and Hash application process. For portal ERROR assistance, contact GetTGAPI support.

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.