Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.32 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.32 KB
Raw

MTCute

contributions welcome

Work-in-progress library for MTProto in TypeScript.

🎯 Roadmap (notion.so) | 📦 TL Reference

⚠️ 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.

What currently works:

  • TCP Connection in NodeJS
  • Sending & receiving text messages
  • Uploading & downloading files
  • HTML & Markdown parse modes
  • Type-safe filter system

What is not done yet:

  • pretty much everything else

Setting up for development:

git clone https://github.com/mtcute/mtcute
cd mtcute
yarn install
npx lerna link

# generate code from tl schema
cd packages/tl
yarn generate-code

Acknowledgements

Some parts were based on code from these projects: