Skip to content
BranchesTags

Repository files navigation

RimTUB - RimMirK's Telegram User Bot

Banner

Made in Ukraine #StandWithUkraine

UserBot for Telegram Works on Windows, Linux, macOS, MavisHost Python License Status GitHub Downloads (all assets, all releases) GitHub Release GitHub last commit rimtub.app Website Temporarily Unavailable Website StandWithUkraine

Версия на русском тут -> тык

RimTUB — is a powerful and convenient open-source Telegram userbot that's easy to adapt to your needs. Everything necessary is already built-in, and extending its capabilities only requires installing the modules you need. Simple to launch, flexible in configuration, and completely under your control — RimTUB is created to do more with less effort.

🤖 UserBots are scripts that work on behalf of your personal Telegram account. They can do everything a regular user can do.

😀 For example, you can create an auto-responder that will automatically react to specific messages.

✅ Usually, UserBots are used as Telegram extensions — a built-in calculator, quick translator, auto-adding people to chats, etc. You've probably already encountered such things. For instance, someone writes .calc 2+2, and the message transforms into 4.

🌟 Why RimTUB is the best choice

  • Modularity — extend functionality according to your wishes. Write your own modules or use ready-made ones.
  • Convenience — everything is intuitive: download, configure, run.
  • Flexibility — want to change Telegram's behavior? Modules allow you to implement anything!
  • Multi-account — connect multiple Telegram accounts and manage them without issues, everything works smoothly.
  • Cross-platform — works on Windows, Linux, macOS, and even Android (Termux).
  • Easy deployment on hosting — our partner MavisHost allows you to launch RimTUB in just a few clicks, without the need to configure servers.
  • Open source — with GPLv3 license.

🔗 Our website: RimTUB.app

Here you can:

  • Learn more about RimTUB
  • Download modules
  • Read articles

🧠 Useful "out of the box" commands

  • .me — info about the userbot (version, uptime, etc.).
  • .help — help on userbot.
  • .ping — ping test.
  • .restart — restart the userbot.
  • .calc <expression> — calculator.
  • .tr <language> <text/reply/quote> — translator.
  • .dml <link> — install module from link (from website, for example).
  • .dmf <reply to file> — install module from file.

⚙ Installation

Windows

🔹 Step 1. Download RimTUB

  1. Go to: GitHub Releases
  2. Click on the item with the Latest badge (this is the latest version).
  3. Below, click on assets (file list)
  4. In the file list, find an archive named like RimTUB-XXX.zip (XXX is the userbot version) — click on it to download.
  5. When it's downloaded — open the folder with the file, right-click on the archive and select "Extract All".
  6. Enter a path, for example: C:\RimTUB, and click "Extract".

🔹 Step 2. Create a Telegram bot

  1. Open Telegram and find user @BotFather.
  2. Click Start or type /start if the bot is silent.
  3. Type /newbot, set a name and link for the bot (for example, RimTUB_nickname_bot).
  4. BotFather will send you a long token — copy it (it looks like 123456:ABC-DEF...).
  5. ❗️ Type /setinline, select your bot, and type any text, for example asdfjwekjdsf ❗️

🔹 Step 3. Configure RimTUB

  1. Go to the C:\RimTUB folder that you just unpacked.
  2. Find the config.yaml file there.
  3. Open it with a double click. If nothing happens — right-click and select "Open with → Notepad".
  4. Insert your data there. Example: 
    PHONES:
  - +12345678990 # Your phone number linked to Telegram
  - +380XXXXXXXX # You can add multiple accounts
BOT_TOKEN: 123456:ABC-DEF...  # Token provided by BotFather
  5. Save the file: File → Save.

🔹 Step 4. Install Python

  1. Go to python.org.
  2. Hover over "Downloads" and select Windows.
  3. Click "Download Python 3.11.9".
  4. When the installer downloads — MAKE SURE to check "Add Python to PATH", then click "Install Now".
  5. Wait for the installation to complete and close the window.

🔹 Step 5. Launch RimTUB

  1. Press Win + R keys, a window will appear.

  2. Type cmd and press Enter — a black window will open (command prompt).

  3. Enter the following commands one by one (press Enter after each):

    cd C:\RimTUB
python -m venv .venv
.venv\Scripts\activate.bat
pip install -r requirements.txt
python main.py

    ⚠ If a window appears asking for permission to access the internet — click "Allow".

🔹 Step 6. Confirm login

  1. After launching, the bot will ask you to enter a code.
  2. Telegram will send you an SMS — enter this code in the console.
  3. If you have two-factor authentication enabled (password when logging into Telegram) — enter it as well. You'll only need to do this once

🎉 Done! RimTUB is running! Hooray!

Docker

🔹 Step 1. Clone the RimTUB repository

  1. In terminal, enter the command: 
    git clone https://github.com/RimTUB/RimTUB

🔹 Step 2. Create a Telegram bot

  1. Open Telegram and find user @BotFather.
  2. Click Start or type /start if the bot is silent.
  3. Type /newbot, set a name and link for the bot (for example, RimTUB_nickname_bot).
  4. BotFather will send you a long token — copy it (it looks like 123456:ABC-DEF...).
  5. ❗️ Type /setinline, select your bot, and type any text, for example asdfjwekjdsf. ❗️

🔹 Step 3. Configure RimTUB

  1. In terminal, navigate to the folder where you just cloned RimTUB: 
    cd RimTUB
  2. Open the configuration file config.yaml using a text editor, for example, nano: 
    nano config.yaml
  3. Insert your data there. Example: 
    PHONES:
  - +12345678990 # Your phone number linked to Telegram
  - +380XXXXXXXX # You can add multiple accounts

BOT_TOKEN: 123456:ABC-DEF...  # Token provided by BotFather
  4. To save the file in nano, press Ctrl + S to save. Then exit by pressing Ctrl + X.

🔹 Step 4. Run

  1. Enter the command to build RimTUB image: 
    docker build -t rimtub .
  1. Enter the command to start RimTUB interactively: 
    docker-compose up

🔹 Step 5. Confirm login

  1. After launching, the bot will ask you to enter a code.
  2. Telegram will send you an SMS — enter this code in the console.
  3. If you have two-factor authentication enabled (password when logging into Telegram) — enter it as well. You'll only need to do this once.
  4. Double CTRL + C to exit:

🔹 Step 6. Run

  1. Enter the command to start RimTUB in background: 
    docker-compose up -d

🎉 Done! RimTUB is working in Docker! Hooray!

Linux

🔹 Step 1. Install necessary dependencies

  1. Open terminal.
  2. Enter the following command to update packages and install dependencies: 
    sudo apt update
sudo apt install git python3.11 python3.11-venv -y

🔹 Step 2. Clone the RimTUB repository

  1. In terminal, enter the command: 
    git clone https://github.com/RimTUB/RimTUB

🔹 Step 3. Create a Telegram bot

  1. Open Telegram and find user @BotFather.
  2. Click Start or type /start if the bot is silent.
  3. Type /newbot, set a name and link for the bot (for example, RimTUB_nickname_bot).
  4. BotFather will send you a long token — copy it (it looks like 123456:ABC-DEF...).
  5. ❗️ Type /setinline, select your bot, and type any text, for example asdfjwekjdsf. ❗️

🔹 Step 4. Configure RimTUB

  1. In terminal, navigate to the folder where you just cloned RimTUB: 
    cd RimTUB
  2. Open the configuration file config.yaml using a text editor, for example, nano: 
    nano config.yaml
  3. Insert your data there. Example: 
    PHONES:
  - +12345678990 # Your phone number linked to Telegram
  - +380XXXXXXXX # You can add multiple accounts

BOT_TOKEN: 123456:ABC-DEF...  # Token provided by BotFather
  4. To save the file in nano, press Ctrl + S to save. Then exit by pressing Ctrl + X.

🔹 Step 5. Create and activate a virtual environment

  1. Enter the command to create a virtual environment: 
    python3.11 -m venv .venv
  2. Activate the virtual environment: 
    source .venv/bin/activate

🔹 Step 6. Install dependencies and launch RimTUB

  1. Install all necessary libraries: 
    pip install -r requirements.txt
  2. Launch RimTUB: 
    python main.py

🔹 Step 7. Confirm login

  1. After launching, the bot will ask you to enter a code.
  2. Telegram will send you an SMS — enter this code in the console.
  3. If you have two-factor authentication enabled (password when logging into Telegram) — enter it as well. You'll only need to do this once.

🎉 Done! RimTUB is working on your Linux! Hooray!

macOS

🔹 Step 1. Install necessary dependencies

  1. Open Terminal.

  2. Enter the command to install Homebrew (if it's not installed):

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

    Follow the instructions in the terminal to complete the installation.

  3. Install Python 3.11 and Git through Homebrew:

    brew install git python@3.11

🔹 Step 2. Clone the RimTUB repository

  1. Enter the command to clone the repository: 
    git clone https://github.com/RimTUB/RimTUB

🔹 Step 3. Create a Telegram bot

  1. Open Telegram and find user @BotFather.
  2. Click Start or type /start if the bot is silent.
  3. Type /newbot, set a name and link for the bot (for example, RimTUB_nickname_bot).
  4. BotFather will send you a long token — copy it (it looks like 123456:ABC-DEF...).
  5. ❗️ Type /setinline, select your bot, and type any text, for example asdfjwekjdsf. ❗️

🔹 Step 4. Configure RimTUB

  1. In terminal, navigate to the project folder: 
    cd RimTUB
  2. Open the configuration file config.yaml using a text editor, for example, nano: 
    nano config.yaml
  3. Insert your data. Example: 
    PHONES:
  - +12345678990 # Your phone number linked to Telegram
  - +380XXXXXXXX # You can add multiple accounts
BOT_TOKEN: 123456:ABC-DEF...  # Token provided by BotFather
  4. To save the file in nano, press Ctrl + O, then Enter to confirm. After that, exit by pressing Ctrl + X.

🔹 Step 5. Create and activate a virtual environment

  1. Enter the command to create a virtual environment: 
    python3.11 -m venv .venv
  2. Activate the virtual environment: 
    source .venv/bin/activate

🔹 Step 6. Install dependencies and launch RimTUB

  1. Install all necessary libraries: 
    pip install -r requirements.txt
  2. Launch RimTUB: 
    python main.py

🔹 Step 7. Confirm login

  1. After launching, the bot will ask you to enter a code.
  2. Telegram will send you an SMS — enter this code in the console.
  3. If you have two-factor authentication enabled (password when logging into Telegram) — enter it as well. You'll only need to do this once.

🎉 Done! RimTUB is working on your Mac! Hooray!

UserLAnd (Android)

🔹 Step 1. Install UserLAnd

  1. Go to Play Marker and download UserLAnd.
  2. Install it on your device.

🔹 Step 2. Download Python and RimTUB

  1. Open UserLAnd.
  2. Chose Debian Termial only
  3. In Terminal run following commands: (It will take up to 40 minutes)
sudo apt update && sudo apt upgrade -y

sudo apt install -y wget build-essential libssl-dev zlib1g-dev \
libncurses5-dev libncursesw5-dev libreadline-dev libsqlite3-dev \
libgdbm-dev libdb5.3-dev libbz2-dev libexpat1-dev liblzma-dev \
tk-dev uuid-dev libffi-dev

cd /tmp
wget https://www.python.org/ftp/python/3.11.9/Python-3.11.9.tgz
tar -xvf Python-3.11.9.tgz
cd Python-3.11.9

./configure --enable-optimizations
make -j$(nproc)
sudo make altinstall

sudo ln -sf /usr/local/bin/python3.11 /usr/bin/python
sudo ln -sf /usr/local/bin/python3.11 /usr/bin/python3
sudo ln -sf /usr/local/bin/python3.11 /usr/bin/py
sudo ln -sf /usr/local/bin/python3.11 /usr/bin/py3

py -m ensurepip

sudo ln -sf /usr/local/bin/pip3.11 /usr/bin/pip
sudo ln -sf /usr/local/bin/pip3.11 /usr/bin/pip3

cd ..
cd ..

sudo apt install -y git
sudo apt install -y nano

git clone https://github.com/RimTUB/RimTUB

cd RimTUB

py -m venv .venv

source .venv/bin/activate

sudo pip install -r requirements.txt

🔹 Step 3. Create a Telegram bot

  1. Open Telegram and find user @BotFather.
  2. Click Start or type /start if the bot is silent.
  3. Type /newbot, set a name and link for the bot (for example, RimTUB_nickname_bot).
  4. BotFather will send you a long token — copy it (it looks like 123456:ABC-DEF...).
  5. ❗️ Type /setinline, select your bot, and type any text, for example asdfjwekjdsf. ❗️

🔹 Step 4. Configure RimTUB

  1. Open the configuration file config.yaml using a text editor, for example, nano: 
    nano config.yaml
  2. Insert your data. Example: 
    PHONES:
  - +12345678990 # Your phone number linked to Telegram
  - +380XXXXXXXX # You can add multiple accounts
BOT_TOKEN: 123456:ABC-DEF...  # Token provided by BotFather
  3. To save the file in nano, press Ctrl + S. After that, exit by pressing Ctrl + X.

🔹 Step 5. Launch RimTUB

  1. After all dependencies are installed, launch RimTUB: 
    python main.py

🔹 Step 6. Confirm login

  1. After launching, the bot will ask you to enter a code.
  2. Telegram will send you an SMS — enter this code in the console.
  3. If you have two-factor authentication enabled (password when logging into Telegram) — enter it as well. You'll only need to do this once.

🎉 Done! RimTUB is working on your phone! Hooray!

Termux (Android)

🔹 Step 1. Install Termux

  1. Go to F-Droid and download Termux.
  2. Install it on your device.

🔹 Step 2. Clone the RimTUB repository

  1. Open Termux.
  2. Clone the RimTUB repository: 
    apt update && apt upgrade -y && apt install git -y
git clone https://github.com/RimTUB/RimTUB

🔹 Step 3. Create a Telegram bot

  1. Open Telegram and find user @BotFather.
  2. Click Start or type /start if the bot is silent.
  3. Type /newbot, set a name and link for the bot (for example, RimTUB_nickname_bot).
  4. BotFather will send you a long token — copy it (it looks like 123456:ABC-DEF...).
  5. ❗️ Type /setinline, select your bot, and type any text, for example asdfjwekjdsf. ❗️

🔹 Step 4. Configure RimTUB

  1. In Termux, navigate to the project folder: 
    cd RimTUB
  2. Open the configuration file config.yaml using a text editor, for example, nano: 
    nano config.yaml
  3. Insert your data. Example: 
    PHONES:
  - +12345678990 # Your phone number linked to Telegram
  - +380XXXXXXXX # You can add multiple accounts
BOT_TOKEN: 123456:ABC-DEF...  # Token provided by BotFather
  4. To save the file in nano, press Ctrl + O, then Enter to confirm. After that, exit by pressing Ctrl + X.

🔹 Step 5. Run Termux.sh to install dependencies

  1. In Termux, enter the command to execute the termux.sh script, which will install all necessary dependencies: 
    bash termux.sh
  2. Wait for the dependencies installation to complete.

🔹 Step 6. Launch RimTUB

  1. After all dependencies are installed, launch RimTUB: 
    python main.py

🔹 Step 7. Confirm login

  1. After launching, the bot will ask you to enter a code.
  2. Telegram will send you an SMS — enter this code in the console.
  3. If you have two-factor authentication enabled (password when logging into Telegram) — enter it as well. You'll only need to do this once.

🎉 Done! RimTUB is working on your phone! Hooray!

📚 Module documentation: docs.rimtub.dev

Here you'll find everything you need to write your own module for RimTUB:

  • Step-by-step instructions on writing and module structure.
  • Complete description of available functions and methods for working with RimTUB.
  • Code examples that will help you quickly start development.

If you want to create your own cool modules, be sure to study the documentation. It has everything! And if you don't understand something, you can ask the developer for help (contacts below)

❓ FAQ

  • Can I run it on my phone?

    Yes! Just install it through Termux.

  • What if I can't run it on my device?

    Contact @RimMirK, he can help with hosting.

  • Can I order a custom module?

    Yes, also contact @RimMirK

  • I want to add a module to the website

    No problem, write to @RimMirK

💬 Contacts and Links

About

RimMirK's Telegram User Bot [RimTUB] - is a powerful and convenient open-source Telegram userbot that's easy to adapt to your needs. Everything necessary is already built-in, and extending its capabilities only requires installing the modules you need. Simple to launch, flexible in configuration, and completely under your control — RimTUB is cre...

RimTUB.pp.ua

Topics

kurigrammodulerimmirkrimtubtelegramubuserbotuserbot-for-telegram

Resources

Readme
GPL-3.0 license
Activity
Custom properties

Stars

7 stars

Watchers

2 watching

Forks

3 forks
Report repository

Releases

Packages

Used by

Contributors

Languages