/friendly-telegram

A telegram userbot

Primary LanguagePythonOtherNOASSERTION

friendly-telegram userbot

Hey, welcome to our userbot!

But how do I set it up?

All of the setup instructions are in this README, read carefully!

First of all, this bot requires Python 3 (minimum 3.5) and a modern-ish OS (preferably Linux-based)

Step by step explanation:

Installing Python 3 and required packages

  1. Update package list sudo apt update

  2. Install required packages sudo apt install python3 python3-pip git

  3. Install optional modular dependencies (required for some modules)

# Pillow for stickers/kang
sudo apt install python3-dev libwebp-dev libz-dev libjpeg-dev
# Utilities
sudo apt install neofetch
# UI
sudo apt install dialog

Configuring the userbot

  1. Clone the source code
cd
git clone https://github.com/penn5/friendly-telegram
cd friendly-telegram
  1. Install requirements
python3 -m pip install cryptg
python3 -m pip install -r friendly-telegram/requirements.txt
  1. Follow the instructions written here to get your API key/hash and ID

  2. Run the configuration script python3 -m friendly-telegram --setup

  3. On the newly opened menu, select "API Key/hash and ID" When prompted, enter your API key/hash and ID

Launching the bot

cd ~/friendly-telegram
python3 -m friendly-telegram

Usage

Try typing .help in any Telegram chat while the bot is running

OS Quirks

Android

Use Termux

pkg install git python-dev libjpeg-turbo-dev zlib-dev libwebp-dev libffi-dev build-essential dialog neofetch
git clone https://github.com/penn5/friendly-telegram
cd friendly-telegram
pip install cryptg
pip install -r requirements.txt
# For setup
python -m friendly-telegram --setup
# And again for actual execution
python -m friendly-telegram

Make sure to enable the wakelock from Termux notification, especially on MIUI

Windows

  • All terminal related features don't work. I'll fix it later.

Mac OS X

Untested. No reason it shouldn't work.

Web hosting services

These are basically just Linux. They will work with some effort to get the API token and session file over.