2018-12-26 08:07:24 +00:00
# TelegramBotAPI
2020-11-16 15:59:25 +00:00
< details >
< summary > < b > I do not wanna read a lot, just give me my bot< / b > < / summary >
2021-01-03 09:19:35 +00:00
You can simply use < a href = "https://github.com/InsanusMokrassar/TelegramBotAPI-bot_template" > this template< / a > (and button
< a href = "https://github.com/InsanusMokrassar/TelegramBotAPI-bot_template/generate" > Use template< / a > ) to get your copy of bot and start to code.
2021-01-03 09:22:19 +00:00
< p > < / p >
2021-01-03 09:17:58 +00:00
< b > P.S. Do not forget to look into our < a href = "https://bookstack.inmo.dev/books/telegrambotapi/" > minidocs< / a > and
< a href = "https://tgbotapi.inmo.dev/docs/index.html" > kdocs< / a > < / b >
2020-11-16 15:59:25 +00:00
< / details >
2020-10-02 08:27:07 +00:00
| Common info | [](https://github.com/KotlinBy/awesome-kotlin) [](https://travis-ci.com/InsanusMokrassar/TelegramBotAPI) [Small survey ](https://forms.gle/2Hex2ynbHWHhi1KY7 )|
2020-04-08 08:34:55 +00:00
| -------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2020-11-08 12:58:52 +00:00
| Useful links | [](https://t.me/InMoTelegramBotAPI) [](https://github.com/InsanusMokrassar/TelegramBotAPI-bot_template/generate) [](https://tgbotapi.inmo.dev/docs/index.html) [Examples ](https://github.com/InsanusMokrassar/TelegramBotAPI-examples/ ), [Mini tutorial ](https://bookstack.inmo.dev/books/telegrambotapi/chapter/introduction-tutorial ) |
2020-10-04 12:50:05 +00:00
| TelegramBotAPI Core status | [](https://bintray.com/insanusmokrassar/TelegramBotAPI/tgbotapi.core/_latestVersion) [](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.core) |
2020-10-04 12:34:03 +00:00
| TelegramBotAPI Extensions status | [](https://bintray.com/insanusmokrassar/TelegramBotAPI/tgbotapi.extensions.api/_latestVersion) [](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.api) |
| TelegramBotAPI Util Extensions status | [](https://bintray.com/insanusmokrassar/TelegramBotAPI/tgbotapi.extensions.utils/_latestVersion) [](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.utils) |
2020-10-04 12:46:28 +00:00
| TelegramBotAPI All status | [](https://bintray.com/insanusmokrassar/TelegramBotAPI/tgbotapi/_latestVersion) [](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi) |
2018-12-26 08:07:24 +00:00
2020-08-29 12:37:02 +00:00
**At the time of publication of version `0.28.0` there are errors in serialization plugins like
[kotlinx.serialization#1004 ](https://github.com/Kotlin/kotlinx.serialization/issues/1004 ). It is possible, that both JVM
and JS version may work improperly in some cases with `kotlinx.serialization` version `1.0.0-RC` **
2020-11-16 15:56:31 +00:00
## What is it?
2020-02-17 09:25:08 +00:00
It is a complex of libraries for working with `TelegramBotAPI` in type-safe and strict way as much as it possible. In
the list of this complex currently next projects:
2018-12-26 08:07:24 +00:00
2020-10-04 12:50:05 +00:00
* [TelegramBotAPI Core ](tgbotapi.core/README.md ) - core of library. In fact it is independent library and can be used alone
2020-04-08 08:34:55 +00:00
without any additional library
2020-10-04 12:50:05 +00:00
* [TelegramBotAPI API Extensions ](tgbotapi.extensions.api/README.md ) - contains extensions (mostly for
2020-04-08 08:34:55 +00:00
`RequestsExecutor` ), which allows to use the core library in more pleasant way
2020-10-04 12:34:03 +00:00
* [TelegramBotAPI Util Extensions ](tgbotapi.extensions.utils/README.md ) - contains extensions for more comfortable
2020-04-08 09:28:03 +00:00
work with commands, updates and other different things
2020-10-04 12:50:05 +00:00
* [TelegramBotAPI ](tgbotapi/README.md ) - concentration of all previously mentioned libraries
2018-12-26 08:07:24 +00:00
2020-02-17 09:25:08 +00:00
Most part of some specific solves or unuseful
moments are describing by official [Telegram Bot API ](https://core.telegram.org/bots/api ).
2019-05-05 01:04:48 +00:00
2020-04-17 09:43:43 +00:00
## JavaScript notes
2020-08-29 12:37:02 +00:00
### Versions before `0.28.0`
2020-04-17 09:52:47 +00:00
In case if you are want to use this library inside of browser, you will need additional settings (thanks for help to [Alexander Nozik ](https://research.jetbrains.org/researchers/altavir )):
2020-04-17 09:43:43 +00:00
< details >
2020-08-20 05:58:37 +00:00
< summary > Gradle build script help (for versions before 0.28.0)< / summary >
2020-04-17 09:43:43 +00:00
```groovy
dependencies {
/* ... */
implementation "com.github.insanusmokrassar:TelegramBotAPI:$tgbot_api_version"
implementation "com.github.insanusmokrassar:TelegramBotAPI-extensions-api:$tgbot_api_version" // optional
implementation "com.github.insanusmokrassar:TelegramBotAPI-extensions-utils:$tgbot_api_version" // optional
/* Block of dependencies for correct building in browser */
implementation(npm("fs"))
implementation(npm("bufferutil"))
implementation(npm("utf-8-validate"))
implementation(npm("abort-controller"))
implementation(npm("text-encoding"))
}
/* ... */
kotlin {
target {
browser {
/* Block for fix of exception in absence of some functionality, https://github.com/ktorio/ktor/issues/1339 */
dceTask {
dceOptions {
keep("ktor-ktor-io.\$\$importsForInline\$\$.ktor-ktor-io.io.ktor.utils.io")
}
}
}
}
}
```
< / details >
2020-02-17 09:25:08 +00:00
## Ok, where should I start?
2019-05-05 01:04:48 +00:00
2020-06-26 13:11:59 +00:00
2020-10-11 19:08:56 +00:00
In most cases, the most simple way will be to implement [TelegramBotAPI ](tgbotapi/README.md ) - it contains
2020-05-14 08:07:23 +00:00
all necessary tools for comfort usage of this library. If you want to exclude some libraries, you can implement just
2020-10-04 12:34:03 +00:00
[TelegramBotAPI API Extensions ](tgbotapi.extensions.api/README.md ),
[TelegramBotAPI Util Extensions ](tgbotapi.extensions.utils/README.md ) or even
2020-10-04 12:50:05 +00:00
[TelegramBotAPI Core ](tgbotapi.core/README.md ).
2019-05-05 01:04:48 +00:00
2020-05-14 08:07:23 +00:00
If you want to dive deeper in the core of library or develop something for it - welcome to learn more from
2020-10-04 12:50:05 +00:00
[TelegramBotAPI Core ](tgbotapi.core/README.md ) and our [Telegram Chat ](https://teleg.one/InMoTelegramBotAPIChat ).
2020-05-14 08:07:23 +00:00
2020-04-08 09:28:03 +00:00
Anyway, all libraries are very typical inside of them. Examples:
* In `TelegramBotAPI` common request look like `requestsExecutor.execute(SomeRequest())`
2020-10-04 12:34:03 +00:00
* `tgbotapi.extensions.api` typical syntax look like `requestsExecutor.someRequest()` (in most cases it would be
2020-04-08 19:24:55 +00:00
better to use `bot` name instead of `requestsExecutor` )
2020-10-04 12:34:03 +00:00
* `tgbotapi.extensions.utils` will look like `filter.filterBaseMessageUpdates(chatId).filterExactCommands(Regex("^.*$"))...`
2020-05-14 07:44:18 +00:00
## Build instruction
If you want to build this project or to contribute, there are several recommendations:
### Build
In case if you want to just build project, run next command:
```bash
./gradlew clean build
```
On windows:
```
gradlew.bat clean build
```
### Publishing for work with your version locally
In case, if you want to work in your other projects using your modification (or some state) of this library,
you can use next code:
```bash
./gradlew clean build publishToMavenLocal
```
On windows:
```
gradlew.bat clean build publishToMavenLocal
```
But you must remember, that in this case your local maven repo must be the first one from
your project retrieving libraries:
```groovy
repositories {
mavenLocal() // that must be the first one
jcenter()
mavenCentral()
}
```
Besides, for your own version you can change variable `library_version` in the file [gradle.properties ](./gradle.properties ).
