Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TeamUltroid/Ultroid
Advanced Multi-Featured Telegram UserBot, Built in Python Using Telethon lib.
https://github.com/TeamUltroid/Ultroid
bot hacktoberfest multilanguage-support pytgcalls python python3 teamultroid telegram telegram-bot telegram-userbot telegrammusicbot telegramvc telethon ultroid userbot
Last synced: about 2 hours ago
JSON representation
Advanced Multi-Featured Telegram UserBot, Built in Python Using Telethon lib.
- Host: GitHub
- URL: https://github.com/TeamUltroid/Ultroid
- Owner: TeamUltroid
- License: agpl-3.0
- Created: 2021-02-22T00:45:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T12:23:32.000Z (12 days ago)
- Last Synced: 2024-10-29T15:07:53.238Z (9 days ago)
- Topics: bot, hacktoberfest, multilanguage-support, pytgcalls, python, python3, teamultroid, telegram, telegram-bot, telegram-userbot, telegrammusicbot, telegramvc, telethon, ultroid, userbot
- Language: Python
- Homepage: https://ultroid.tech
- Size: 11 MB
- Stars: 2,810
- Watchers: 50
- Forks: 7,931
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-telegram - Ultroid - Featured Telegram UserBot, Built in Python Using Telethon lib._ (OpenSource / OpenSource Bots)
- awesome-telegram - Ultroid - Featured Telegram UserBot, Built in Python Using Telethon lib._ (OpenSource / OpenSource Bots)
README
Ultroid - UserBot
A stable pluggable Telegram userbot + Voice & Video Call music bot, based on Telethon.
[](#)
[](https://github.com/TeamUltroid/Ultroid/stargazers)
[](https://github.com/TeamUltroid/Ultroid/fork)
[](https://github.com/TeamUltroid/Ultroid/)
[](https://www.python.org/)
[](https://www.codefactor.io/repository/github/teamultroid/ultroid/overview/main)
[](https://github.com/TeamUltroid/Ultroid/graphs/commit-activity)
[](https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square)
[](https://github.com/TeamUltroid/Ultroid)
[](https://github.com/TeamUltroid/Ultroid/graphs/contributors)
[](https://makeapullrequest.com)
[](https://github.com/TeamUltroid/Ultroid/blob/main/LICENSE)
[](https://stars.medv.io/TeamUltroid/Ultroid)
----
# Deploy
- [Heroku](#deploy-to-heroku)
- [Okteto](#deploy-to-okteto)
- [Local Machine](#deploy-locally)
# Documentation
[](http://ultroid.tech/)
# Tutorial
- Full Tutorial - [](https://www.youtube.com/watch?v=0wAV7pUzhDQ)
- Tutorial to get Redis URL and password - [here.](./resources/extras/redistut.md)
---
## Deploy to Heroku
Get the [Necessary Variables](#Necessary-Variables) and then click the button below!
[](https://deploy.ultroid.tech)
## Deploy to Okteto
Get the [Necessary Variables](#Necessary-Variables) and then click the button below!
[](https://cloud.okteto.com/deploy?repository=https://github.com/TeamUltroid/Ultroid)
## Deploy Locally
- [Traditional Method](#local-deploy---traditional-method)
- [Easy Method](#local-deploy---easy-method)
- [Ultroid CLI](#ultroid-cli)
### Local Deploy - Easy Method
- Linux - `wget -O locals.py https://git.io/JY9UM && python3 locals.py`
- Windows - `cd desktop ; wget https://git.io/JY9UM -o locals.py ; python locals.py`
- Termux - `wget -O install-termux https://tiny.ultroid.tech/termux && bash install-termux`
### Local Deploy - Traditional Method
- Get your [Necessary Variables](#Necessary-Variables)
- Clone the repository:
`git clone https://github.com/TeamUltroid/Ultroid.git`
- Go to the cloned folder:
`cd Ultroid`
- Create a virtual env:
`virtualenv -p /usr/bin/python3 venv`
`. ./venv/bin/activate`
- Install the requirements:
`pip(3) install -U -r re*/st*/optional-requirements.txt`
`pip(3) install -U -r requirements.txt`
- Generate your `SESSION`:
- For Linux users:
`bash sessiongen`
or
`wget -O session.py https://git.io/JY9JI && python3 session.py`
- For Termux users:
`wget -O session.py https://git.io/JY9JI && python session.py`
- For Windows Users:
`cd desktop ; wget https://git.io/JY9JI -o ultroid.py ; python ultroid.py`
- Fill your details in a `.env` file, as given in [`.env.sample`](https://github.com/TeamUltroid/Ultroid/blob/main/.env.sample).
(You can either edit and rename the file or make a new file named `.env`.)
- Run the bot:
- Linux Users:
`bash startup`
- Windows Users:
`python(3) -m pyUltroid`
---
## Necessary Variables
- `SESSION` - SessionString for your accounts login session. Get it from [here](#Session-String)
One of the following database:
- For **Redis** (tutorial [here](./resources/extras/redistut.md))
- `REDIS_URI` - Redis endpoint URL, from [redislabs](http://redislabs.com/).
- `REDIS_PASSWORD` - Redis endpoint Password, from [redislabs](http://redislabs.com/).
- For **MONGODB**
- `MONGO_URI` - Get it from [mongodb](https://mongodb.com/atlas).
- For **SQLDB**
- `DATABASE_URL`- Get it from [elephantsql](https://elephantsql.com).
## Session String
Different ways to get your `SESSION`:
* [](https://replit.com/@TeamUltroid/UltroidStringSession)
* Linux : `wget -O session.py https://git.io/JY9JI && python3 session.py`
* PowerShell : `cd desktop ; wget https://git.io/JY9JI ; python ultroid.py`
* Termux : `wget -O session.py https://git.io/JY9JI && python session.py`
* TelegramBot : [@SessionGeneratorBot](https://t.me/SessionGeneratorBot)
---
# License
[](LICENSE)
Ultroid is licensed under [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) v3 or later.
---
# Credits
* [](https://t.me/UltroidDevs)
* [Lonami](https://github.com/LonamiWebs/) for [Telethon.](https://github.com/LonamiWebs/Telethon)
* [MarshalX](https://github.com/MarshalX) for [PyTgCalls.](https://github.com/MarshalX/tgcalls)
> Made with 💕 by [@TeamUltroid](https://t.me/TeamUltroid).