/ub

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

TeamUltroid Logo

Ultroid - UserBot

A stable pluggable Telegram userbot + vc music bot, based on Telethon.

Stars Forks Size
Python Maintenance Open Source Love svg2
Contributors PRs Welcome License Sparkline

Deploy

Documentation

Document

Tutorial

  • Full Tutorial - Full Tutorial

  • Tutorial to get Redis URL and password - here.

Deploy to Heroku

Get the Necessary Variables and then click the button below!

Deploy

Deploy Locally

Local Deploy - Easy Method

  • Linux - bash -c "$(curl -fsSL https://git.io/JY9UM)"
  • Windows - cd desktop ; wget https://del.dog/raw/ultroid-termux -o locals.py ; python locals.py
  • Termux - sh -c "$(curl -fsSL https://del.dog/raw/ultroid-termux-deploy)"

Local Deploy - Traditional Method

  • Get your 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 requirements.txt
  • Generate your SESSION:
    • For Linux users: bash sessiongen or bash -c "$(curl -fsSL https://del.dog/ultroid)"
    • For Termux users: sh -c "$(curl -fsSL https://da.gd/termux-tel)"
    • For Windows Users: cd desktop ; wget https://del.dog/ultroid -o ultroid.py ; python ultroid.py
  • Fill your details in a .env file, as given in .env.sample. (You can either edit and rename the file or make a new file named .env.)
  • Run the bot:
    • Linux Users: bash resources/startup/startup.sh
    • Windows Users: python(3) -m pyUltroid

Necessary Variables

  • API_ID - Your API_ID from my.telegram.org
  • API_HASH - Your API_HASH from my.telegram.org
  • SESSION - SessionString for your accounts login session. Get it from here
  • BOT_TOKEN - The token of your bot from @BotFather
  • BOT_USERNAME - The username of your bot from @BotFather
  • LOG_CHANNEL - A private group/channel id.
  • REDIS_URI - Redis endpoint URL, from redislabs, tutorial here.
  • REDIS_PASSWORD - Redis endpoint Password, from redislabs, tutorial here.

Session String

Different ways to get your SESSION:

  • Run on Repl.it
  • Linux : bash -c "$(curl -fsSL https://del.dog/ultroid)"
  • PowerShell : cd desktop ; wget https://git.io/JY9JI ; python ultroid.py
  • Termux : sh -c "$(curl -fsSL https://da.gd/termux-tel)"

Made with 💕 by @TeamUltroid.

License

Ultroid is licensed under GNU Affero General Public License v3 or later.

License

Credits