Spaces:
Running
Running
deepu2135 commited on
Commit ·
fd7b387
1
Parent(s): 1432503
docs: document HIDE_SPLIT_STREAMS and performance caching in README
Browse files
README.md
CHANGED
|
@@ -62,6 +62,8 @@ Deploy your own instance of the Telegram Stremio Addon instantly using any of th
|
|
| 62 |
## Key Features
|
| 63 |
|
| 64 |
- **Stream Matching**: Select any movie or series in Stremio; the addon automatically finds and matches corresponding video files in your Telegram channels/account and serves them instantly as stream sources.
|
|
|
|
|
|
|
| 65 |
- **Optional Stremio Catalog Search**: By default, Stremio's global search bar does not search Telegram to prevent rate limits (`FloodWait`). Users can optionally enable global catalog search by setting `ENABLE_TELEGRAM_SEARCH=true`.
|
| 66 |
- **Stitched Split Streaming**: Automatically groups, merges, and streams multi-part file archives (such as `.001`, `.part1` patterns) as one continuous virtual stream.
|
| 67 |
- **ZIP Archive Streaming**: Automatically scans, lists, and streams video files nested inside standard ZIP archives or split ZIP files (e.g., '.zip.001', '.zip.002', etc.) on the fly.
|
|
@@ -89,6 +91,14 @@ The addon parses standard split archive conventions including:
|
|
| 89 |
2. **Dynamic Range Mapping**: When you press play or seek in Stremio, the addon maps the player's byte-range requests to the respective split files on the fly.
|
| 90 |
3. **In-Memory Sequential Access**: It downloads only the necessary segments from Telegram DCs and transitions between split messages seamlessly in memory, resulting in uninterrupted playback.
|
| 91 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 92 |
---
|
| 93 |
|
| 94 |
## ZIP File Support
|
|
@@ -479,6 +489,7 @@ BOT_TOKEN=your_bot_token
|
|
| 479 |
API_KEY=your_addon_api_key
|
| 480 |
ADDON_URL=https://stremio-tg.yourdomain.com
|
| 481 |
ENABLE_TELEGRAM_SEARCH=false
|
|
|
|
| 482 |
```
|
| 483 |
*(Replace `yourdomain.com` with your actual domain)*
|
| 484 |
|
|
|
|
| 62 |
## Key Features
|
| 63 |
|
| 64 |
- **Stream Matching**: Select any movie or series in Stremio; the addon automatically finds and matches corresponding video files in your Telegram channels/account and serves them instantly as stream sources.
|
| 65 |
+
- **Ultra-Fast In-Memory Caching & RPC Optimization**: Intelligent 10x faster links and catalogue loading powered by in-memory TTL caching, batch message resolution, dynamic RPC query bounds, and HTTP Gzip response compression.
|
| 66 |
+
- **Hide Split Streams Setting**: Opt-in toggle (`HIDE_SPLIT_STREAMS=true`) to hide multi-part split video files (`.part001`, `.part002`, `.001`) only when loading stream links for movies and series, while keeping them fully visible and browsable in your channel catalogue and search!
|
| 67 |
- **Optional Stremio Catalog Search**: By default, Stremio's global search bar does not search Telegram to prevent rate limits (`FloodWait`). Users can optionally enable global catalog search by setting `ENABLE_TELEGRAM_SEARCH=true`.
|
| 68 |
- **Stitched Split Streaming**: Automatically groups, merges, and streams multi-part file archives (such as `.001`, `.part1` patterns) as one continuous virtual stream.
|
| 69 |
- **ZIP Archive Streaming**: Automatically scans, lists, and streams video files nested inside standard ZIP archives or split ZIP files (e.g., '.zip.001', '.zip.002', etc.) on the fly.
|
|
|
|
| 91 |
2. **Dynamic Range Mapping**: When you press play or seek in Stremio, the addon maps the player's byte-range requests to the respective split files on the fly.
|
| 92 |
3. **In-Memory Sequential Access**: It downloads only the necessary segments from Telegram DCs and transitions between split messages seamlessly in memory, resulting in uninterrupted playback.
|
| 93 |
|
| 94 |
+
### 💡 Hiding Split Files from Movie & Series Stream Links
|
| 95 |
+
|
| 96 |
+
If you prefer to see only complete single-file releases when browsing movies and series in Stremio (instead of seeing `.part001`, `.part002`, or `▶ Telegram Split` entries in the stream sources list), you can enable the `HIDE_SPLIT_STREAMS` setting:
|
| 97 |
+
|
| 98 |
+
* **How to enable**: Set `HIDE_SPLIT_STREAMS=true` under your deployment **Variables** or **Secrets** (or in your `.env` file).
|
| 99 |
+
* **Where split files are hidden**: Exclusively in movie and series stream links (`/stream/...`). When you select an IMDb title in Stremio, only non-split video releases will appear.
|
| 100 |
+
* **Where split files remain visible**: Split files remain **100% visible and browsable in your Channel Catalogue and in Telegram Search** (`/catalog/...`), and direct playback of any split file selected from the catalogue continues to work normally.
|
| 101 |
+
|
| 102 |
---
|
| 103 |
|
| 104 |
## ZIP File Support
|
|
|
|
| 489 |
API_KEY=your_addon_api_key
|
| 490 |
ADDON_URL=https://stremio-tg.yourdomain.com
|
| 491 |
ENABLE_TELEGRAM_SEARCH=false
|
| 492 |
+
HIDE_SPLIT_STREAMS=false
|
| 493 |
```
|
| 494 |
*(Replace `yourdomain.com` with your actual domain)*
|
| 495 |
|