README

Nutgram

The Telegram bot framework that doesn't drive you nuts

This framework takes advantage of the latest PHP 8 features, and tries to make the speed, scalability and flexibility of use its strength, it will allow you to quickly make simple bots, but at the same time, it provides more advanced features to handle even the most complicated flows. Some architectural concepts on which Nutgram is based are heavily influenced by other open source projects such as Botman and Zanzara, check them out too!

<?php

use SergiX44\Nutgram\Nutgram;

$bot = new Nutgram($_ENV['TOKEN']);

$bot->onCommand('start', function(Nutgram $bot) {
    $bot->sendMessage('Ciao!');
});

$bot->onText('My name is {name}', function(Nutgram $bot, string $name) {
    $bot->sendMessage("Hi $name");
});

$bot->run();

Installation

You can install the package via composer:

composer require nutgram/nutgram

Usage

• Official Documentation

Projects with this library

Is your project using Nutgram? Let us know, feel free to add yours!

• AnonyMeet (@AnonyMeetBot) - Anonymous chat bot
• File Converter (@newfileconverterbot) - Convert files to other formats
• Sticker Optimizer (@NewStickerOptimizerBot) - Optimize images for the @stickers bot
• Chat Merger (@ChatMergerBot) - Merge multiple messages into one
• Mermaid Generator (@newmermaidbot) - Generate mermaid diagrams from text
• Voice Transcriber (@voicetranscriberobot) - Transcribe audio messages to text
• Effin Birds (@effinbirdsbot) - Search and send in inline mode images made by https://twitter.com/EffinBirds

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Sergio Brighenti
• Luca Patera
• All Contributors

License

The MIT License (MIT). Please see License File for more information.