Plain-UB Extras

Repository "PlainUB-Extras" [Work in progress] is a collection of additional modules and features designed for use with plain-ub — A simple Telegram User-Bot. These scripts extend the functionality of the bot with custom commands and tools.

⚙️ How to Use

✅ Automatic Method (Recommended) (Need Docker)

1. In your docker config.env file, add or modify the following line to point to your fork or this repository directly:

   EXTRA_MODULES_REPO=https://github.com/R0Xofficial/PlainUB-Extras

2. Deploy or restart your bot. The modules will be automatically loaded from the external rerepository.

3. To update modules from the external repository, simply use the following command in the chat:

   eupdate -pull
   

   or

   eup -pull
   

---

⚙️ Manual Deployment (Alternative)

If you're deploying manually (without EXTRA_MODULES_REPO), you can also install the modules this way:

1. Go to the app folder in your Plain-UB directory:

   cd app

2. Create a new folder named modules if it doesn't already exist:

   mkdir modules

3. Clone this repository into the modules folder:

   git clone https://github.com/R0Xofficial/PlainUB-Extras modules

4. Restart your bot to load the modules.

5. To update modules from the external repository, simply use the following command in the chat:

   eupdate -pull
   

   or

   eup -pull
   

---

🔁 Check Updates

To check if you are using the latest PlainUB-Extras add-ons, simply use one of the commands below:

eupdate

or

eup

eup command is the same what eupdate command

📄 Note: (for people who forked this repository).

To check upstream repo use those command with -repo flag. If official repo data is showing up, it means you haven't changed the repository data in the 'settings.py' file.

Change REPO_OWNER and REPO_NAME to your own if you want the script to check for updates to your repo.

---

🛠️ Extra Configuration

Some modules may require additional configuration, such as API keys or tokens. To configure them:

1. Copy the example config file:

   cp example-extra_config.env extra_config.py

2. Open extra_config.py in a text editor and fill in your own API keys or tokens as needed.

3. Restart your bot after saving the changes.

---

📦 Install Requirements

Some modules may require additional Python packages. To install all necessary dependencies from the requirements.txt file, run:

pip install -r requirements.txt

Make sure you're in the correct directory where the requirements.txt file is located, or provide the full path.

📄 Note:
Some modules may require additional libraries that are not available via pip.
In such cases, you need to install them using pkg (for example, in Termux):

pkg install <package_name>

Example:

pkg install zbar -y

(yes, zbar is needed)

---

❗ Disclaimer

You are using these modules at your own risk.

I am not responsible for:

• incorrect or abusive usage of these modules,
• violations of Telegram's Terms of Service (ToS),
• account bans, restrictions, or any other consequences resulting from the usage of this code.

💬 Support

Need help, suggestions, or want to report a bug? Contact: @ItsR0Xx on Telegram.

---