Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dev-diaries41/termux-plugins
A collection of plugins for termux
https://github.com/dev-diaries41/termux-plugins
android termux
Last synced: 1 day ago
JSON representation
A collection of plugins for termux
- Host: GitHub
- URL: https://github.com/dev-diaries41/termux-plugins
- Owner: dev-diaries41
- Created: 2024-12-25T20:23:12.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-30T19:02:36.000Z (16 days ago)
- Last Synced: 2025-01-30T20:19:18.251Z (16 days ago)
- Topics: android, termux
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Termux-Plugins
This repository contains a collection of **Plugins** for Termux, which can be categorized into two types:
1. **Plugin-Services**: Custom background services that can be managed via Termux's service management system.
2. **Plugin-Scripts**: Executable scripts that can be run directly from the local directory.
Plugins can be managed using the `tplug` CLI tool. For instructions on how to install and use `tplug`, visit the [tplug repository](https://github.com/dev-diaries41/termux-plugin-cli.git).
> **Note:** To use Plugin-Services, ensure that **termux-services** is installed in your Termux environment. This dependency is not included in the `plugin.txt` files for Plugin-Services, as it is assumed to already be installed by users who need service-related functionality. For more information on **termux-services** and relevant usage, read the [Termux Wiki - Termux-services](https://wiki.termux.com/wiki/Termux-services).
---
## Table of Contents
- [Plugin Structure](#plugin-structure)
- [Explanation of Files](#explanation-of-files)
- [Example `plugin.txt`](#example-plugintxt)
- [Installing Plugins](#installing-plugins)
- [Scripts](#scripts)
- [Services](#services)
---
## Plugin Structure
Each plugin in this repository follows a standardized directory structure, regardless of whether it is a **Plugin-Service** or **Plugin-Script**.
```
my_plugin/
├── run # Executable bash script for starting the service or running the script
├── plugin/ # Optional additional files (Bash, Python, JS etc.) for the service.
├── plugin.txt # Txt file listing Termux dependencies on separate lines
```
### Explanation of Files
- **run**:
The main executable bash script required to start the service or run the script. For **Plugin-Services**, this is the script that starts the background process. For **Plugin-Scripts**, this is the script executed when the user runs the plugin.
- **plugin/**:
A directory that contains any additional scripts (Bash, Python, etc.) needed by the service or script. This is optional and only necessary if the plugin requires extra dependencies beyond the `run` script.
- **plugin.txt**:
A text file that lists the Termux dependencies required for the plugin. This is important to ensure that all necessary dependencies are installed before the plugin runs. Can be omitted if none are required.
### Example `plugin.txt`
Here is an example of a `plugin.txt` file for a plugin:
```
termux-api
nodejs-lts
```
---
## Installing Plugins
You can install plugins by cloning this repository or using the tplug CLI tool. While cloning is an option, using tplug is strongly recommended for easier management and installation of plugins.
Plugins can be installed using the `tplug` CLI tool. The following commands can be used for installing plugins:
1. **`install [ | -a] [-s | -r]`**
Install plugin-services or plugin-scripts from the repository.
- ``: Install a specific plugin-service or plugin-script.
- `-a`: Install all plugins (requires `-s` or `-r`).
- `-s`: Install plugin-services.
- `-r`: Install plugin-scripts.
2. For Plugin-Services, once installed, you must create a Termux service using:
**`add `**
Add a plugin-service from a local directory to the Termux service manager.
```bash
tplug add
```
---
## Services
This section lists all available **Plugin-Services** in the repository. Each service can be managed via Termux's service management system, which allows you to start, stop, and monitor background processes.
### **Telemux**
A lightweight Termux-based Telegram client that uses `termux-notifications`, `termux-dialog`, and a simple Express server to handle messages.
#### **Requirements**
- **Termux:API app** must be installed to enable essential functionalities like notifications and dialogs.
- **Telegram Bot Token** is required to get Telegram messages. You can get this from the `Bot Father` bot in Telegram. Once you have this, add it to `plugin/run.js`.
---
## Scripts
This section lists all available **Plugin-Scripts** in the repository.