{"id":13826336,"url":"https://github.com/Altruix/Altruix","last_synced_at":"2025-07-09T00:33:07.621Z","repository":{"id":45831114,"uuid":"509909294","full_name":"Altruix/Altruix","owner":"Altruix","description":"Modern and Minimalistic Telegram UserBot based on Pyrogram","archived":true,"fork":false,"pushed_at":"2022-11-12T02:10:57.000Z","size":672,"stargazers_count":23,"open_issues_count":0,"forks_count":20,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-05T09:15:12.454Z","etag":null,"topics":["altruix","bot","hacktoberfest","pyrogram","python","telegram","telegram-bot","telegram-userbot","userbot"],"latest_commit_sha":null,"homepage":"https://t.me/AltruiXUB","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Altruix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-03T03:03:13.000Z","updated_at":"2024-02-08T21:07:57.000Z","dependencies_parsed_at":"2023-01-22T00:18:49.633Z","dependency_job_id":null,"html_url":"https://github.com/Altruix/Altruix","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altruix%2FAltruix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altruix%2FAltruix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altruix%2FAltruix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altruix%2FAltruix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Altruix","download_url":"https://codeload.github.com/Altruix/Altruix/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225476384,"owners_count":17480215,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["altruix","bot","hacktoberfest","pyrogram","python","telegram","telegram-bot","telegram-userbot","userbot"],"created_at":"2024-08-04T09:01:35.829Z","updated_at":"2024-11-20T05:30:39.003Z","avatar_url":"https://github.com/Altruix.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\u003cb\u003eAltruix | UserBot\u003c/b\u003e\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://telegra.ph/file/f51efe570b5f0a9165f8e.png\"; width=\"1155px\"\u003e\u003cbr\u003e\u003c/p\u003e  \n\n#### **Altruix** | A Modern yet simple UserBot which is based on Pyrogram. **Built By The Developers Of Friday Userbot.** \n\u003cbr\u003e\n\n# Deploying To Different Platforms\n\u003e - For deploying [Locally](#Deploy-Locally)\n\n\u003cbr\u003e\n\n# Official Support/Updates\n\u003e - Join the official **Updates** Channel  \n\u003e    \u003ca href=\"https://t.me/AltruiXUB\"\u003e\u003cimg src=\"https://img.shields.io/badge/Join-Altruix%20Channel-red.svg?logo=Telegram\"\u003e\u003c/a\u003e  \n\u003e - Join the official **Support** Chat  \n\u003e    \u003ca href=\"https://t.me/AltruixChat\"\u003e\u003cimg src=\"https://img.shields.io/badge/Join-Altruix%20Group-blue.svg?logo=telegram\"\u003e\u003c/a\u003e\n\n\u003cbr\u003e\n\n## Deploy Locally\n\nIf you want to Deploy your Altruix UserBot on your PC or in Termux these are the steps -\n\n\u003e ```\n\u003e git clone https://github.com/Altruix/Altruix\n\u003e cd Altruix\n\u003e nano .env\n\u003e bash start.sh\n\u003e ```\n\nExample of [`.env`](#env)\n\n\u003cbr\u003e\n\n## String Session\n\nIt'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. \n\n## Required Variables\n\n\u003e 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:\n\n\u003cdetails close\u003e\n\n  \u003e 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:\n  \u003e - Go to [my.telegram.com](my.telegram.com).\n  \u003e - Login via adding your mobile number in the international format i.e `+00 9876543210`.\n  \u003e - You will receive an `11` character alphanumeric code via the Telegram App. Input this code into the input field and proceed.\n  \u003e - Now click on [API development tools](https://my.telegram.org/apps).\n  \u003e - 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.\n\n\u003csummary\u003e API_ID \u003c/summary\u003e\n\u003c/details\u003e\n\n\u003cdetails close\u003e\n\n  \u003e 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:\n  \u003e - Go to [my.telegram.com](my.telegram.com).\n  \u003e - Login via adding your mobile number in the international format i.e `+00 9876543210`.\n  \u003e - You will receive an `11` character alphanumeric code via the Telegram App. Input this code into the input field and proceed.\n  \u003e - Now click on [API development tools](https://my.telegram.org/apps).\n  \u003e - 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.\n\n\u003csummary\u003e API_HASH \u003c/summary\u003e\n\u003c/details\u003e\n\n\u003cdetails close\u003e\n\n  \u003e It's used to control your bot's actions etc. You can get your `BOT_TOKEN` for your bot by following the given steps:\n  \u003e - Go to [@BotFather](t.me/BotFather).\n  \u003e - Do `/start` -\u003e `/newbot`\n  \u003e - You'll be prompted to choose a name for your bot (it can be anything).\n  \u003e - You'll be prompted to choose a username name for your bot (it can be anything but should end with suffix `bot`).\n  \u003e - Your bot with the above details will be made! And a message containg your bots api token will also be sent.\n\n\u003csummary\u003e BOT_TOKEN \u003c/summary\u003e\n\u003c/details\u003e\n\n\u003cdetails close\u003e\n\n  \u003e TO BE DONE\n\n\u003csummary\u003e DB_URI \u003c/summary\u003e\n\u003c/details\u003e\n\n\u003cdetails close\u003e\n\n  \u003e 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`.\n  \u003e - Go to [@MissRose_Bot](t.me/MissRose_Bot).\n  \u003e - Do `/start` -\u003e `/info`\n  \u003e - You'll receive a message containing your ID.\n\n\u003csummary\u003e OWNER_ID \u003c/summary\u003e\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## .env\n\n\u003cdetails close\u003e\n\u003cp align=\"center\"\u003e\u003cimg src=\"Main/assets/images/dot_env_template.png\"; width=\"1155px\"\u003e\u003cbr\u003e\u003c/p\u003e\n\u003csummary\u003e An example of how your `.env` file should look like: \u003c/summary\u003e\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## About the Repo\n\n\u003e Currently Running Stable version of Altruix.  \n\u003e [![](https://img.shields.io/badge/Altruix-v0.0.1-color=red)](#)  \n\u003e Is our project under active maintenance?  \n\u003e [![Maintenance](https://img.shields.io/badge/Maintained%3F-Yes-color=green)](https://github.com/Altruix/Altruix/graphs/commit-activity)   \n\u003e Developers aka Contributors for the Project.  \n\u003e [![Contributors](https://img.shields.io/github/contributors/Altruix/Altruix?style=flat-square\u0026color=orange)](https://github.com/Altruix/Altruix/graphs/contributors)\n\n## Credits\n\n\u003e - \u003ca href=\"https://www.github.com/EverythingSuckz\"\u003e    EverythingSuckz    \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/StarkGang\"\u003e          StarkGang          \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/BilakshanP\"\u003e         BilakshanP         \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/Reeshuxd\"\u003e           Reeshuxd           \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/Rohith-Sreedharan\"\u003e       Rohithaditya       \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/StarkBotIndustries\"\u003e StarkBotIndustries \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/sohag02\"\u003e            sohag02            \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/SHRE-YANSH\"\u003e         SHRE-YANSH         \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/lostb053\"\u003e           lostb053           \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/Nksama\"\u003e             Nksama             \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/Crackexy\"\u003e           Crackexy           \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/anonyindian\"\u003e        anonyindian        \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/N0BLEWOLF\"\u003e          N0BLEWOLF          \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/ramanveerji\"\u003e        ramanveerji        \u003c/a\u003e\n\u003e - \u003ca href=\"https://www.github.com/swatv3nub \"\u003e         swatv3nub          \u003c/a\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"500\" src=\"https://telegra.ph/file/5ee1e2ff5437b97aabf2e.png\"\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAltruix%2FAltruix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAltruix%2FAltruix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAltruix%2FAltruix/lists"}