A Java Wrapper for TDLib/TDLight
Go to file
Andrea Cavalli 0905a434a4 Typo 2021-09-27 19:29:30 +02:00
.github/workflows Add support for java 8, 9. Add support for ppc64, s390x, armhf 2021-09-15 14:53:23 +02:00
example TDLight Java 2 2021-09-27 19:27:13 +02:00
scripts Update deploy_release.sh 2020-12-29 23:47:23 +01:00
src/main TDLight Java 2 2021-09-27 19:27:13 +02:00
tdlib TDLight Java 2 2021-09-27 19:27:13 +02:00
tdlight Typo 2021-09-27 19:29:30 +02:00
.gitignore Fix example versioning 2020-12-30 00:28:15 +01:00
.gitmodules Move to github actions 2020-12-29 23:38:50 +01:00
JTDLIB_LICENSE Rewrite ReadMe 2020-08-20 12:18:04 +02:00
LICENSE Added missing license 2018-11-20 18:51:11 +01:00
README.md TDLight Java 2 2021-09-27 19:27:13 +02:00
jitpack.yml Move to github actions 2020-12-29 23:38:50 +01:00

README.md

TDLight Java

Build Status Release tag Java profiler

Complete Bot and Userbot Telegram library written in Java based on TDLib

Supported platforms

Java versions: from Java 8 to Java 17

Operating systems: Linux, Windows, MacOS

CPU architectures:

  • i386/x86 (Linux, Windows)
  • amd64/x86_64 (Linux, Windows, OSX)
  • armhf/armv7 (Linux)
  • aarch64/armv8/arm64 (Linux)
  • s390x (Linux)
  • ppc64el/ppc64le (Linux)

Required libraries for linux: OpenSSL and zlib

How to use the library

Installing with Maven

<project>
    <repositories>
        <repository>
            <id>mchv</id>
            <name>MCHV Apache Maven Packages</name>
            <url>https://mvn.mchv.eu/repository/mchv/</url>
        </repository>
    </repositories>

    <dependencies>
        <dependency>
            <groupId>it.tdlight</groupId>
            <artifactId>tdlight-java</artifactId>
            <version>VERSION</version>
        </dependency>
        <dependency>
            <groupId>it.tdlight</groupId>
            <artifactId>tdlight-natives-linux-amd64</artifactId>
            <version>NATIVES_VERSION</version>
        </dependency>
        <!-- Include other native versions that you want, for example for windows, osx, ... -->
    </dependencies>
</project>

Replace VERSION with the latest release version, you can find it here.

Replace NATIVES_VERSION with the latest native version. Make sure that you are using the correct natives version for the release that you are using.

Installing with Gradle

repositories {
    maven { url "https://mvn.mchv.eu/repository/mchv/" }
}
dependencies {
    implementation 'it.tdlight:tdlight-java:LATEST_VERSION'
    implementation 'it.tdlight:tdlight-natives-linux-amd64:NATIVES_VERSION'
    // Include other native versions that you want, for example for windows, osx, ...
}

Replace VERSION with the latest release version, you can find it here.

Replace NATIVES_VERSION with the latest native version. Make sure that you are using the correct natives version for the release that you are using.

Native dependencies

To use TDLight Java you need to include one or more native dependencies:

  • tdlight-natives-linux-amd64
  • tdlight-natives-linux-aarch64
  • tdlight-natives-linux-x86
  • tdlight-natives-linux-armv6
  • tdlight-natives-linux-armv7
  • tdlight-natives-linux-ppc64le
  • tdlight-natives-windows-amd64
  • tdlight-natives-osx-amd64

Usage

Simple initialization of a native TDLib client

An example on how to use TDLight Java can be found here: Example.java

TDLight methods documentation

TdApi JavaDoc

TDLight extended features

TDLight has some extended features compared to TDLib, that you can see on the TDLight official repository.

About

License

TDLight is licensed by Andrea Cavalli andrea@cavallium.it under the terms of the GNU Lesser General Public License 3

Libraries licenses

JTDlib is licensed by Ernesto Castellotti erny.castell@gmail.com under the terms of the GNU Lesser General Public License 3

TDLib is licensed by Aliaksei Levin levlam@telegram.org and Arseny Smirnov arseny30@gmail.com under the terms of the Boost Software License

OpenSSL is licensed under the terms of Apache License v2

Zlib is licensed under the terms of Zlib license