Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Altruix/Altruix

Modern and Minimalistic Telegram UserBot based on Pyrogram
https://github.com/Altruix/Altruix

altruix bot hacktoberfest pyrogram python telegram telegram-bot telegram-userbot userbot

Last synced: about 2 months ago
JSON representation

Modern and Minimalistic Telegram UserBot based on Pyrogram

Awesome Lists containing this project

README

        

Altruix | UserBot



#### **Altruix** | A Modern yet simple UserBot which is based on Pyrogram. **Built By The Developers Of Friday Userbot.**

# Deploying To Different Platforms
> - For deploying [Locally](#Deploy-Locally)


# Official Support/Updates
> - Join the official **Updates** Channel
>
> - Join the official **Support** Chat
>


## Deploy Locally

If you want to Deploy your Altruix UserBot on your PC or in Termux these are the steps -

> ```
> git clone https://github.com/Altruix/Altruix
> cd Altruix
> nano .env
> bash start.sh
> ```

Example of [`.env`](#env)


## String Session

It's not necessary until you host the bot. You can get the String Session after you are done with hosting. Just run the Altruix Assistant bot and walk through the steps.

## Required Variables

> Following are the required variables for the proper working of userbot, note down these somewhere for easier access so that you may use them in future:

> These are used to communicate with the telegram servers. You can get you your `API_HASH` and `API_ID` from [Telegram](my.telegram.com) by following the given steps:
> - Go to [my.telegram.com](my.telegram.com).
> - Login via adding your mobile number in the international format i.e `+00 9876543210`.
> - You will receive an `11` character alphanumeric code via the Telegram App. Input this code into the input field and proceed.
> - Now click on [API development tools](https://my.telegram.org/apps).
> - Here you may add an `App title` and a `Short name` for it (they can be anything). Note down the `APP api_id` and `APP api_hash` for future use. Scroll down to the end of the page and click on `Save changes` button.

API_ID

> These are used to communicate with the telegram servers. You can get you your `API_HASH` and `API_ID` from [Telegram](my.telegram.com) by following the given steps:
> - Go to [my.telegram.com](my.telegram.com).
> - Login via adding your mobile number in the international format i.e `+00 9876543210`.
> - You will receive an `11` character alphanumeric code via the Telegram App. Input this code into the input field and proceed.
> - Now click on [API development tools](https://my.telegram.org/apps).
> - Here you may add an `App title` and a `Short name` for it (they can be anything). Note down the `APP api_id` and `APP api_hash` for future use. Scroll down to the end of the page and click on `Save changes` button.

API_HASH

> It's used to control your bot's actions etc. You can get your `BOT_TOKEN` for your bot by following the given steps:
> - Go to [@BotFather](t.me/BotFather).
> - Do `/start` -> `/newbot`
> - You'll be prompted to choose a name for your bot (it can be anything).
> - You'll be prompted to choose a username name for your bot (it can be anything but should end with suffix `bot`).
> - Your bot with the above details will be made! And a message containg your bots api token will also be sent.

BOT_TOKEN

> TO BE DONE

DB_URI

> It's used to tell your bot who is the owner of this bot and whom commands it should fulfil. Only the person with this ID can give the bot command to add more sessions to the database via `/add`.
> - Go to [@MissRose_Bot](t.me/MissRose_Bot).
> - Do `/start` -> `/info`
> - You'll receive a message containing your ID.

OWNER_ID


## .env



An example of how your `.env` file should look like:


## About the Repo

> Currently Running Stable version of Altruix.
> [![](https://img.shields.io/badge/Altruix-v0.0.1-color=red)](#)
> Is our project under active maintenance?
> [![Maintenance](https://img.shields.io/badge/Maintained%3F-Yes-color=green)](https://github.com/Altruix/Altruix/graphs/commit-activity)
> Developers aka Contributors for the Project.
> [![Contributors](https://img.shields.io/github/contributors/Altruix/Altruix?style=flat-square&color=orange)](https://github.com/Altruix/Altruix/graphs/contributors)

## Credits

> - EverythingSuckz
> - StarkGang
> - BilakshanP
> - Reeshuxd
> - Rohithaditya
> - StarkBotIndustries
> - sohag02
> - SHRE-YANSH
> - lostb053
> - Nksama
> - Crackexy
> - anonyindian
> - N0BLEWOLF
> - ramanveerji
> - swatv3nub