https://github.com/tgsnake/tgsnake

Telegram MTProto framework for javascript or typescript
https://github.com/tgsnake/tgsnake

mtproto telegram telegram-bot telegram-client

Last synced: 24 days ago
JSON representation

Telegram MTProto framework for javascript or typescript

• Host: GitHub
• URL: https://github.com/tgsnake/tgsnake
• Owner: tgsnake
• License: mit
• Created: 2021-06-14T03:23:45.000Z (over 3 years ago)
• Default Branch: wayang-kulit
• Last Pushed: 2024-05-01T07:08:12.000Z (8 months ago)
• Last Synced: 2024-05-19T02:07:20.649Z (7 months ago)
• Topics: mtproto, telegram, telegram-bot, telegram-client
• Language: TypeScript
• Homepage: https://tgsnake.js.org
• Size: 135 MB
• Stars: 71
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-bot-telegram-indonesia - TGSnake - - Telegram mtproto client berbasis [gramjs] (Library & Framework / Tutorial Made)

README

        
![tgsnakeicon](https://tgsnake.js.org/images/tgsnake.jpg)  

tgsnake is a modern MTProto framework for javascript or typescript.  

[![github-repo](https://img.shields.io/badge/Github-tgsnake-blue.svg?style=for-the-badge&logo=github)](https://github.com/tgsnake/tgsnake) [![telegram-chat](https://img.shields.io/badge/Telegram-Chat-blue.svg?style=for-the-badge&logo=telegram)](https://t.me/tgsnakechat)  

[![telegram-channel](https://img.shields.io/badge/Telegram-Channel-blue.svg?style=for-the-badge&logo=telegram)](https://t.me/tgsnake)

Don't forget to read our FAQ in our site!!

### Example :

- Installation :

```bash

npx create-tgsnake-app myapp

```

- Simple Hello World :

```javascript

const { Snake } = require('tgsnake');

// import {Snake} from "tgsnake"

const bot = new Snake({

  apiHash: 'abcde', //your api hash

  apiId: 123456, // your api id

  logLevel: 'none', // logger level

});

bot.run(); //snake running

bot.on('msg.text', (ctx) => {

  //handle new message event.

  ctx.msg.reply('Hello World'); // reply with "Hello World"

  //console.log(ctx) // see json of message.

});

```

More example you can found in our website.

### Contribution

Welcome, You can contribute to this project.

### Reference

- [Pyrogram](https://github.com/pyrogram/pyrogram)

- [Telethon](https://github.com/LonamiWebs/Telethon)

- [GramJs](https://github.com/gram-js/gramjs)

- [Telegram Api](https://core.telegram.org/schema)

- [Grammy](https://github.com/grammyjs/grammyjs)

- [Telegraf](https://github.com/telegraf/telegraf)

Thanks to all the frameworks and references that I use, several people who helped in developing this framework that I cannot mention one by one.

Build with ♥️ by [tgsnake dev](https://t.me/tgsnakechat).