Skip to content

(WIP) Kotlin coroutines based Telegram bot API/SDK Kotlin multiplatform library, is also a Simple Robot Component library. πŸ”₯πŸ”₯❀️‍πŸ”₯

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
COPYING

simple-robot/simbot-component-telegram

Repository files navigation

simbot logo

~ Simple Robot ~
Telegram Component

release release
stars forks watchers repo size issues last commit copying

δΈ­ζ–‡ | English

Caution

WIP.

Some thoughts? Feel free to share or join the communities.

Warning

This content is machine-translated.

This is a Telegram Bot API/SDK Kotlin multi-platform library based on Kotlin coroutines, efficient and asynchronous, Java-friendly.

It is also a component library of Simple Robot v4 (simbot), which is a subproject of simbot. With the capabilities provided by the simbot core library, it can support more advanced encapsulation, as well as component collaboration, Spring support, and more.

It can be used as aid as a low-level API/SDK dependency or as a lightweight framework that can be developed quickly with the help of the simbot core library!

Serialization and network requests are based on Kotlin serialization and Ktor.

Documentation

Modules

⭐ Type module

Provides definitions for most types in Telegram and supports serialization based on Kotlin Serialization.

πŸ‘‰ Go to the module to learn more.

⭐ API module

Based on Type module and Ktor's KMP implementation for Telegram Bot API, is a simple, efficient and lightweight API implementation module.

This module provides very little extra implementation. The goal is to preserve the feel of the original API as much as possible without overwrapping it.

πŸ‘‰ Go to the module to learn more.

⭐ Stdlib module

Based on API module, for the implementation of authentication, subscription events and other related functions in bot.

The stdlib module can be thought of as a lightweight SDK implementation library.

This module provides an implementation of event-related functionality based on the API module, including the ability to subscribe to events.

Again, the goal is to provide as much of the feel of the original API as possible without overwrapping it.

πŸ‘‰ Go to the module to learn more.

⭐ Core Component module

A component implementation of the simbot4 core library based on standard library module.

Is a relatively highly encapsulated module that provides most of the capabilities of simbot4, including event listeners, multi-component coordination, Spring Boot starter, and more.

πŸ‘‰ Go to Modules to learn more.

CONTRIBUTING

See CONTRIBUTING.md for more information!

We welcome you and look forward to it feed back or pull request, Thank you for your contribution and support!

License

simbot-component-telegram is open source under the LGPLv3 licence。

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General 
Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) 
any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied 
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 
details.

You should have received a copy of the GNU Lesser General Public License along with this program. 
If not, see <https://www.gnu.org/licenses/>.

About

(WIP) Kotlin coroutines based Telegram bot API/SDK Kotlin multiplatform library, is also a Simple Robot Component library. πŸ”₯πŸ”₯❀️‍πŸ”₯

Topics

Resources

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
COPYING

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Languages