/livebio-tg

Make your telegram about me live.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

livebio-tg

Make your telegram about me live.

Installing

General Install

If you are using Linux, you can use this easy setup script (does not install python):

sh -c "$(curl -sS https://raw.githubusercontent.com/LaptopCat/livebio-tg/files/i.sh)"

1. Clone this repository

You can do this using the git CLI (if you have it installed) or just download the zip file on the Code page.

2. Install Python and the required dependencies

Download Python from here (Latest version is recommended, but anything higher than Python 3.7 should work)

Make sure to choose "Add Python to PATH" when installing to make this tutorial easy to follow!

Now, open your command prompt and use those commands to install the required modules:

python -m pip install telethon
python -m pip install rich

(replace python with python3 on linux)

3. Create a Telegram Application

To work, livebio-tg requires a Telegram app to change your bio.

To create a Telegram application, go to this page and log into your Telegram account.

After you login, you will need to fill out a form, you can fill it in with anything you want, but make sure that all fields are filled.

If there is no error while creating an app, you will see a screen with your app info.

You need to copy the "api_id" and the "api_hash" and write them down somewhere (you shouldn't share those values with anyone)

4. Configuring livebio

After you cloned the repository, head to the config.py file.

It is a Python dictionary (has JSON-like syntax)

Config Structure

telegram
app
id Your api_id (Integer)
hash Your api_hash (String)
auth
mode Authentication mode (String). Can be string or file. Defaults to file.
string Session string. Only needed with the string authentication mode. For more info on authentication modes, look below.
script
splitter Optional
The string used for splitting plugin output (String). Defaults to |
delay Optional
Delay between each bio change in seconds (Integer). Defaults to 20
template Template which gets used during bio generation (String). For more info on templates, look below.
logstrings Optional
Dictionary of strings that are logged to the console or used somewhere to generate the bio. Default logstrings are on line 26 of main.py
plugins
Plugin settings go here.
Each plugin will have a reference on how you need to configure it.

What authentication mode should I choose, and why?

How do I make a template?

Example Config (has some plugin configs)

Plugins

Plugins are the things that actually make your livebio awesome.