2021-04-08 12:19:38 +03:00
|
|
|
# MTCute
|
|
|
|
|
|
2021-04-08 22:58:49 +03:00
|
|
|
|
2021-04-08 12:19:38 +03:00
|
|
|
|
|
|
|
|
Work-in-progress library for MTProto in TypeScript.
|
|
|
|
|
|
|
|
|
|
[🎯 Roadmap (notion.so)](https://www.notion.so/teidesu/MTCute-development-cfccff4fddad4b218f3bea27f784b8b5)
|
2021-04-14 18:12:50 +03:00
|
|
|
| [📦 TL Reference](https://mt.tei.su/tl)
|
2021-04-08 12:19:38 +03:00
|
|
|
|
2021-04-08 13:12:31 +03:00
|
|
|
> ⚠️ **Warning**: While this library is WIP, storage
|
|
|
|
|
> format *will* change without changing format version
|
2021-04-11 14:55:49 +03:00
|
|
|
> and without migration algorithm, and there *will* be breaking
|
|
|
|
|
> changes in the API.
|
2021-04-08 13:12:31 +03:00
|
|
|
>
|
2021-04-11 14:55:49 +03:00
|
|
|
> If you encounter errors related to storage, either
|
2021-04-08 13:12:31 +03:00
|
|
|
> reset your storage by removing the file, or fix it manually.
|
|
|
|
|
|
2021-04-08 12:19:38 +03:00
|
|
|
What currently works:
|
|
|
|
|
|
|
|
|
|
- [x] TCP Connection in NodeJS
|
|
|
|
|
- [x] Sending & receiving text messages
|
|
|
|
|
- [x] Uploading & downloading files
|
|
|
|
|
- [x] HTML & Markdown parse modes
|
|
|
|
|
- [x] Type-safe filter system
|
|
|
|
|
|
|
|
|
|
What is not done yet:
|
|
|
|
|
|
|
|
|
|
- pretty much everything else
|
|
|
|
|
|
|
|
|
|
## Setting up for development:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/teidesu/mtcute
|
|
|
|
|
cd mtcute
|
|
|
|
|
yarn install
|
|
|
|
|
npx lerna link
|
2021-04-14 23:06:10 +03:00
|
|
|
|
|
|
|
|
# generate code from tl schema
|
|
|
|
|
cd packages/tl
|
|
|
|
|
yarn generate-code
|
2021-04-08 12:19:38 +03:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Acknowledgements
|
|
|
|
|
|
|
|
|
|
Some parts were based on code from these projects:
|
|
|
|
|
|
|
|
|
|
- [Pyrogram](https://pyrogram.org)
|
|
|
|
|
- [Telethon](https://github.com/LonamiWebs/Telethon)
|
|
|
|
|
- [TDesktop](https://github.com/telegramdesktop/tdesktop)
|
