55 <b >Ultroid - UserBot</b >
66</h1 >
77
8- <b >A stable pluggable Telegram userbot + Voice & Video Call music bot, based on Telethon.</b >
8+ <b >A stable pluggable Telegram userbot + Voice & Video Call music bot, based on Telethon.</b >
99
10+ [ ![ ] ( https://img.shields.io/badge/Ultroid-v0.3-blue )] ( # )
1011[ ![ Stars] ( https://img.shields.io/github/stars/TeamUltroid/Ultroid?style=flat-square&color=yellow )] ( https://github.com/TeamUltroid/Ultroid/stargazers )
1112[ ![ Forks] ( https://img.shields.io/github/forks/TeamUltroid/Ultroid?style=flat-square&color=orange )] ( https://github.com/TeamUltroid/Ultroid/fork )
1213[ ![ Size] ( https://img.shields.io/github/repo-size/TeamUltroid/Ultroid?style=flat-square&color=green )] ( https://github.com/TeamUltroid/Ultroid/ )
13- [ ![ Python] ( https://img.shields.io/badge/Python-v3.9.7 -blue )] ( https://www.python.org/ )
14+ [ ![ Python] ( https://img.shields.io/badge/Python-v3.9.9 -blue )] ( https://www.python.org/ )
1415[ ![ CodeFactor] ( https://www.codefactor.io/repository/github/teamultroid/ultroid/badge/main )] ( https://www.codefactor.io/repository/github/teamultroid/ultroid/overview/main )
1516[ ![ Maintenance] ( https://img.shields.io/badge/Maintained%3F-yes-green.svg )] ( https://github.com/TeamUltroid/Ultroid/graphs/commit-activity )
16- [ ![ Docker Pulls] ( https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square )] ( https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square )
17- [ ![ Open Source Love svg2] ( https://badges.frapsoft.com/os/v2/open-source.svg?v=103 )] ( https://github.com/TeamUltroid/Ultroid )
17+ [ ![ Docker Pulls] ( https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square )] ( https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square )
18+ [ ![ Open Source Love svg2] ( https://badges.frapsoft.com/os/v2/open-source.svg?v=103 )] ( https://github.com/TeamUltroid/Ultroid )
1819[ ![ Contributors] ( https://img.shields.io/github/contributors/TeamUltroid/Ultroid?style=flat-square&color=green )] ( https://github.com/TeamUltroid/Ultroid/graphs/contributors )
1920[ ![ PRs Welcome] ( https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square )] ( https://makeapullrequest.com )
20- [ ![ License] ( https://img.shields.io/badge/License-AGPL-blue )] ( https://github.com/TeamUltroid/Ultroid/blob/main/LICENSE )
21+ [ ![ License] ( https://img.shields.io/badge/License-AGPL-blue )] ( https://github.com/TeamUltroid/Ultroid/blob/main/LICENSE )
2122[ ![ Sparkline] ( https://stars.medv.io/Teamultroid/Ultroid.svg )] ( https://stars.medv.io/TeamUltroid/Ultroid )
2223----
2324
2930[ ![ Documentation] ( https://img.shields.io/badge/Documentation-Ultroid-blue )] ( http://ultroid.tech/ )
3031
3132# Tutorial
32- - Full Tutorial - [ ![ Full Tutorial] ( https://img.shields.io/badge/Watch%20Now-blue )] ( https://www.youtube.com/watch?v=9wF7k9qA0Q4 )
33+ - Full Tutorial - [ ![ Full Tutorial] ( https://img.shields.io/badge/Watch%20Now-blue )] ( https://www.youtube.com/watch?v=0wAV7pUzhDQ )
3334
3435- Tutorial to get Redis URL and password - [ here.] ( ./resources/extras/redistut.md )
3536---
@@ -42,16 +43,7 @@ Get the [Necessary Variables](#Necessary-Variables) and then click the button be
4243## Deploy Locally
4344- [ Traditional Method] ( #local-deploy---traditional-method )
4445- [ Easy Method] ( #local-deploy---easy-method )
45- - [ Latest UltroidCli] ( #local-deploy---latest-method )
46-
47-
48- ### Local Deploy - Latest Method
49- This is the latest and most fastest method currently.<br >
50- First, go to [ UltroidCli] ( https://github.com/BLUE-DEVIL1134/UltroidCli ) and install the latest release from the Github Releases.<br >
51- Then, do as it's given in the ` README.md ` to add the executable to your system path.
52-
53- Further, take a look at the [ ` docs ` ] ( https://blue-devil1134.github.io/UltroidCli/ ) to get more information.
54-
46+ - [ Ultroid CLI] ( #Ultroid-CLI )
5547
5648### Local Deploy - Easy Method
5749- Linux - ` bash -c "$(curl -fsSL https://git.io/JY9UM)" `
@@ -60,14 +52,14 @@ Further, take a look at the [`docs`](https://blue-devil1134.github.io/UltroidCli
6052
6153### Local Deploy - Traditional Method
6254- Get your [ Necessary Variables] ( #Necessary-Variables )
63- - Clone the repository: < br />
55+ - Clone the repository:
6456` git clone https://github.com/TeamUltroid/Ultroid.git `
65- - Go to the cloned folder: < br />
57+ - Go to the cloned folder:
6658` cd Ultroid `
67- - Create a virtual env: < br />
59+ - Create a virtual env:
6860` virtualenv -p /usr/bin/python3 venv `
6961` . ./venv/bin/activate `
70- - Install the requirements: < br />
62+ - Install the requirements:
7163` pip(3) install -U -r re*/st*/optional-requirements.txt `
7264` pip(3) install -U -r requirements.txt `
7365- Generate your ` SESSION ` :
@@ -83,10 +75,23 @@ Further, take a look at the [`docs`](https://blue-devil1134.github.io/UltroidCli
8375(You can either edit and rename the file or make a new file named ` .env ` .)
8476- Run the bot:
8577 - Linux Users:
86- ` bash resources/ startup/startup.sh `
78+ ` bash startup `
8779 - Windows Users:
8880 ` python(3) -m pyUltroid `
8981
82+ ### Ultroid CLI
83+ [ Ultroid CLI] ( https://github.com/BLUE-DEVIL1134/UltroidCli ) is a command-line interface for deploying Ultroid.
84+
85+ - ** Installing** -
86+ Run the following code on a terminal, with curl installed.
87+ ` ver=$(curl https://raw.githubusercontent.com/BLUE-DEVIL1134/UltroidCli/main/version.txt) && curl -L -o ultroid https://github.com/BLUE-DEVIL1134/UltroidCli/releases/download/$ver/ultroid.exe `
88+ OR
89+ Go to [ UltroidCli] ( https://github.com/BLUE-DEVIL1134/UltroidCli ) and install the version release from the Github Releases. Add the executable to your system path as specified in the [ Readme] ( https://github.com/BLUE-DEVIL1134/UltroidCli#how-to-use-ultroidcli- ) .
90+
91+ - ** Documentation** -
92+ Take a look at the [ ` docs ` ] ( https://blue-devil1134.github.io/UltroidCli/ ) for more detailed information.
93+
94+ ---
9095## Necessary Variables
9196- ` SESSION ` - SessionString for your accounts login session. Get it from [ here] ( #Session-String )
9297- ` REDIS_URI ` - Redis endpoint URL, from [ redislabs] ( http://redislabs.com/ ) , tutorial [ here.] ( ./resources/extras/redistut.md )
@@ -100,14 +105,17 @@ Different ways to get your `SESSION`:
100105* Termux : ` sh -c "$(curl -fsSL https://da.gd/termux-tel)" `
101106* TelegramBot : [ @SessionGeneratorBot ] ( https://t.me/SessionGeneratorBot )
102107
103- Made with 💕 by [ @ TeamUltroid ] ( https://t.me/TeamUltroid ) . < br />
108+ ---
104109
105110# License
111+ [ ![ License] ( https://www.gnu.org/graphics/agplv3-155x51.png )] ( LICENSE )
106112Ultroid is licensed under [ GNU Affero General Public License] ( https://www.gnu.org/licenses/agpl-3.0.en.html ) v3 or later.
107113
108- [ ![ License ] ( https://www.gnu.org/graphics/agplv3-155x51.png )] ( LICENSE )
114+ ---
109115
110116# Credits
111117* [ ![ TeamUltroid-Devs] ( https://img.shields.io/static/v1?label=Teamultroid&message=devs&color=critical )] ( https://t.me/UltroidDevs )
112118* [ Lonami] ( https://github.com/LonamiWebs/ ) for [ Telethon.] ( https://github.com/LonamiWebs/Telethon )
113119* [ MarshalX] ( https://github.com/MarshalX ) for [ PyTgCalls.] ( https://github.com/MarshalX/tgcalls )
120+
121+ > Made with 💕 by [ @TeamUltroid ] ( https://t.me/TeamUltroid ) .
0 commit comments