59 lines
1.6 KiB
Markdown
59 lines
1.6 KiB
Markdown
# mtcute
|
|
|
|
**PROJECT IS NOT DEAD/ABANDONED**
|
|
|
|
I'm currently a bit struggling to devote enough time for it
|
|
due to IRL stuff. Also due to the stuff I'm working on in
|
|
the project right now, I'm not making any commits not to
|
|
break stuff.
|
|
|
|
Sorry about that! Will hopefully get my
|
|
hands back on it in late summer of 2022
|
|
|
|
|
|
|
|
Work-in-progress library for MTProto in TypeScript.
|
|
|
|
[🎯 Roadmap (notion.so)](https://teidesu.notion.site/MTCute-development-cfccff4fddad4b218f3bea27f784b8b5)
|
|
| [📦 TL Reference](https://mt.tei.su/tl)
|
|
|
|
> ⚠️ **Warning**: While this library is WIP, storage
|
|
> format *will* change without changing format version
|
|
> and without migration algorithm, and there *will* be breaking
|
|
> changes in the API.
|
|
>
|
|
> If you encounter errors related to storage, either
|
|
> reset your storage by removing the file, or fix it manually.
|
|
|
|
## Installation
|
|
|
|
mtcute is currently only published in my private NPM registry.
|
|
|
|
You can install it by running:
|
|
|
|
```bash
|
|
npm config set --location project @mtcute:registry https://npm.tei.su
|
|
|
|
npm install @mtcute/node # or any other package
|
|
```
|
|
|
|
## Setting up for development:
|
|
|
|
```bash
|
|
git clone https://github.com/mtcute/mtcute
|
|
cd mtcute
|
|
pnpm install
|
|
|
|
# generate code from tl schema
|
|
cd packages/tl
|
|
pnpm run gen-code
|
|
```
|
|
|
|
## Acknowledgements
|
|
|
|
Some parts were based on code from these projects:
|
|
|
|
- [TDLib](https://github.com/tdlib/td)
|
|
- [Pyrogram](https://github.com/pyrogram/pyrogram)
|
|
- [Telethon](https://github.com/LonamiWebs/Telethon)
|
|
- [TDesktop](https://github.com/telegramdesktop/tdesktop)
|