Viren070/AIOStreams
1
0
Fork 0
mirror of https://github.com/Viren070/AIOStreams.git synced 2025-12-01 23:14:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Viren070
2025-11-08 23:37:36 +00:00
committed by GitHub
parent 078ef3c49d
commit 50c1c8510a
1 changed files with 29 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+29 -21
View File
@@ -5,7 +5,6 @@
</picture>
</p>
<h1 align="center">AIOStreams</h1>
<p align="center">
@@ -36,22 +35,24 @@
## ✨ What is AIOStreams?
AIOStreams was created to give users ultimate control over their Stremio experience. Instead of juggling multiple addons with different configurations and limitations, AIOStreams acts as a central hub. It fetches results from all your favorite sources, then filters, sorts, and formats them according to *your* rules before presenting them in a single, clean list.
AIOStreams was created to give users ultimate control over their Stremio experience. Instead of juggling multiple addons with different configurations and limitations, AIOStreams acts as a central hub. It fetches results from all your favorite sources, then filters, sorts, and formats them according to _your_ rules before presenting them in a single, clean list.
Whether you're a casual user who wants a simple, unified stream list or a power user who wants to fine-tune every aspect of your results, AIOStreams has you covered.
AIOStreams also includes a powerful suite of [built-in addons](#-built-in-addons) that can search various torrents and usenet indexers. With support for [nzbDAV](https://github.com/nzbdav-dev/nzbdav) and [AltMount](https://github.com/javi11/altmount), you can stream usenet results directly from your Usenet provider via NNTP - no debrid service required.
<p align="center">
<img src="https://github.com/user-attachments/assets/6179efdb-abc9-4e0c-ae11-fb0e3ca9606a" alt="AIOStreams in action" width="750" />
<img src="https://github.com/user-attachments/assets/17bab03a-8997-4385-8f7e-cebe607a8328" alt="AIOStreams in action" width="850" />
</p>
## 🚀 Key Features
### 🔌 All Your Addons, One Interface
- **Unified Results**: Aggregate streams from multiple addons into one consistently sorted and formatted list.
- **Simplified Addon Management**: AIOStreams features a built-in addon marketplace. Many addons require you to install them multiple times to support different debrid services. AIOStreams handles this automatically. Just enable an addon from the marketplace, and AIOStreams dynamically applies your debrid keys, so you only have to configure it once.
- **Automatic Updates**: Because addon manifests are generated dynamically, you get the latest updates and fixes without ever needing to reconfigure or reinstall.
- **Custom Addon Support**: Add *any* Stremio addon by providing its configured URL. If it works in Stremio, it works here.
- **Custom Addon Support**: Add _any_ Stremio addon by providing its configured URL. If it works in Stremio, it works here.
- **Full Stremio Support**: AIOStreams doesn't just manage streams; it supports all Stremio resources, including catalogs, metadata, and even addon catalogs.
<p align="center">
@@ -59,14 +60,16 @@ Whether you're a casual user who wants a simple, unified stream list or a power
</p>
### 🧩 Built-in Addons
Think of "built-in addons" as independent addons bundled exclusively with AIOStreams. When you host AIOStreams, you're also hosting these addons, ready to be added to your configuration just like any other community addon (e.g., Comet, Torrentio).
AIOStreams includes over 10 built-in addons that search various sources and deliver results that can usually be streamed through your debrid service.
AIOStreams includes over 10 built-in addons that search various sources and deliver results to be streamed by you.
> [!NOTE]
> At this time, these addons require a debrid service and do not yet support P2P streaming. All built-in addons come with anime support and support Kitsu/MAL catalogs.
> Built-in addons that search for torrents require a debrid service and do not yet support P2P streaming. Usenet results can be streamed directly from your Usenet provider via [NZBDav](https://github.com/nzbdav-dev/nzbdav) or [AltMount](https://github.com/javi11/altmount), or through TorBox (Pro plan required). All built-in addons come with anime support and support Kitsu/MAL catalogs.
The suite of built-in addons includes:
- **Stremio GDrive**: Connect your Google Drive to Stremio.
- **TorBox Search**: An alternative to the official TorBox addon with more customisability and support for more debrid services.
- **Knaben**: Scrapes Knaben, an indexer proxy for several popular torrent sites including The Pirate Bay, 1337x, and Nyaa.si.
@@ -76,30 +79,33 @@ The suite of built-in addons includes:
- **Bitmagnet**: Scrape your self-hosted Bitmagnet instance - a BitTorrent indexer and DHT crawler. Set `BUILTIN_BITMAGNET_URL` for the addon to appear.
- **Jackett**: Connect and scrape your Jackett instance by providing its URL and API key.
- **Prowlarr**: Connect and scrape your Prowlarr instance by providing its URL and API key.
- **NZBHydra**: Stream results from your Usenet indexers with TorBox by connecting your NZBHydra instance.
- **Newznab**: Directly configure and scrape your Usenet indexers for results with TorBox using a Newznab API.
- **NZBHydra**: Stream results from your Usenet indexers by connecting your NZBHydra instance.
- **Newznab**: Directly configure and scrape your Usenet indexers for results using a Newznab API.
- **Torznab**: Configure any Torznab API to scrape torrent results, allowing individual indexers from Jackett to be added separately.
### 🔬 Advanced Filtering & Sorting Engine
Because all addons are routed through AIOStreams, you only have to **configure your filters and sorting rules once**. This powerful, centralized engine offers far more options and flexibility than any individual addon.
- **Granular Filtering**: Define `include` (prevents filtering), `required`, or `excluded` rules for a huge range of properties:
- **Video/Audio**: Resolution, quality, encodes, visual tags (`HDR`, `DV`), audio tags (`Atmos`), and channels.
- **Source**: Stream type (`Debrid`, `Usenet`, `P2P`), language, seeder ranges, and cached/uncached status (can be applied to specific addons/services).
- **Video/Audio**: Resolution, quality, encodes, visual tags (`HDR`, `DV`), audio tags (`Atmos`), and channels.
- **Source**: Stream type (`Debrid`, `Usenet`, `P2P`), language, seeder ranges, and cached/uncached status (can be applied to specific addons/services).
- **Preferred Lists**: Manually define and order a list of preferred properties to prioritize certain results, for example, always showing `HDR` streams first.
- **Keyword & Regex Filtering**: Filter by simple keywords or complex regex patterns matched against filenames, indexers and release groups for ultimate precision.
- **Accurate Title Matching**: Leverages the TMDB API to precisely match titles, years, and season/episode numbers, ensuring you always get the right content. This can be granularly applied to specific addons or content types.
- **Powerful Conditional Engine**: Create dynamic rules with a simple yet powerful expression language.
- *Example*: Only exclude 720p streams if more than five 1080p streams are available: `count(resolution(streams, '1080p')) > 5 ? resolution(streams, '720p') : false`.
- Check the wiki for a [full function reference](https://github.com/Viren070/AIOStreams/wiki/Stream-Expression-Language).
- _Example_: Only exclude 720p streams if more than five 1080p streams are available: `count(resolution(streams, '1080p')) > 5 ? resolution(streams, '720p') : false`.
- Check the wiki for a [full function reference](https://github.com/Viren070/AIOStreams/wiki/Stream-Expression-Language).
- **Customisable Deduplication**: Choose how duplicate streams are detected: by filename, infohash, and a unique "smart detect" hash generated from certain file attributes.
- **Sophisticated Sorting**:
- Build your perfect sort order using any combination of criteria.
- Define separate sorting logic for movies, series, anime, and even for cached vs. uncached results.
- The sorting system automatically uses the rankings from your "Preferred Lists".
- Build your perfect sort order using any combination of criteria.
- Define separate sorting logic for movies, series, anime, and even for cached vs. uncached results.
- The sorting system automatically uses the rankings from your "Preferred Lists".
### 🗂️ Unified Catalog Management
Take control of your Stremio home page. AIOStreams lets you manage catalogs from all your addons in one place.
- **Rename**: Rename both the name and the type of the catalog to whatever you want. (e.g. Changing Cinemeta's `Popular - Movies` to `Popular - 📺`)
- **Reorder & Disable**: Arrange catalogs in your preferred order or hide the ones you don't use.
- **Shuffle Catalogs**: Discover new content by shuffling the results of any catalog. You can even persist the shuffle for a set period.
@@ -111,12 +117,12 @@ Take control of your Stremio home page. AIOStreams lets you manage catalogs from
</p>
### 🎨 Total Customization
- **Custom Stream Formatting**: Design exactly how stream information is displayed using a powerful templating system.
- **Live Preview**: See your custom format changes in real-time as you build them.
- **Predefined Formats**: Get started quickly with built-in formats, some created by me and others inspired by other popular addons like Torrentio and the TorBox Stremio Addon.
- **[Custom Formatter Wiki](https://github.com/Viren070/AIOStreams/wiki/Custom-Formatter)**: Dive deep into the documentation to create your perfect stream title.
<p align="center">
<img src="https://github.com/user-attachments/assets/906cc3fc-16d1-4702-99c7-425b2445387b" alt="Custom Formatter UI" width="750"/>
</p>
@@ -128,8 +134,8 @@ Take control of your Stremio home page. AIOStreams lets you manage catalogs from
</sub>
</p>
### 🛡️ Proxy
- **Proxy Integration**: Seamlessly proxy streams through AIOStreams' proxy or an external proxy like **[MediaFlow Proxy](https://github.com/mhdzumair/mediaflow-proxy)** or **[StremThru](https://github.com/MunifTanjim/stremthru)**.
- **Bypass IP Restrictions**: Essential for services that limit simultaneous connections from different IP addresses.
@@ -151,6 +157,7 @@ Setting up AIOStreams is simple.
- Click the "Install" button. This will open your Stremio addon compatible app and add your newly configured AIOStreams addon.
For detailed instructions, check out the Wiki:
- **[Deployment Guide](https://github.com/Viren070/AIOStreams/wiki/Deployment)**
- **[Configuration Guide](https://github.com/Viren070/AIOStreams/wiki/Configuration)**
@@ -183,7 +190,8 @@ AIOStreams is a tool for aggregating and managing data from other Stremio addons
This project wouldn't be possible without the foundational work of many others in the community, especially those who develop the addons that AIOStreams integrates. Special thanks to the developers of all the integrated addons, the creators of [mhdzumair/mediaflow-proxy](https://github.com/mhdzumair/mediaflow-proxy) and [MunifTanjim/stremthru](https://github.com/MunifTanjim/stremthru), and the open-source projects that inspired parts of AIOStreams' design:
* UI Components and issue templates adapted with permission from [5rahim/seanime](https://github.com/5rahim/seanime) (which any anime enthusiast should definitely check out!)
* [sleeyax/stremio-easynews-addon](https://github.com/sleeyax/stremio-easynews-addon) for the projects initial structure
* Custom formatter system inspired by and adapted from [diced/zipline](https://github.com/diced/zipline).
* Condition engine powered by [expr-eval](https://github.com/silentmatt/expr-eval)
- UI Components and issue templates adapted with permission from [5rahim/seanime](https://github.com/5rahim/seanime) (which any anime enthusiast should definitely check out!)
- [NzbDAV](https://github.com/nzbdav-dev/nzbdav) & [AltMount](https://github.com/javi11/altmount) integration inspired by [Sanket9225/UsenetStreamer](https://github.com/Sanket9225/UsenetStreamer/)
- [sleeyax/stremio-easynews-addon](https://github.com/sleeyax/stremio-easynews-addon) for the projects initial structure
- Custom formatter system inspired by and adapted from [diced/zipline](https://github.com/diced/zipline).
- Condition engine powered by [silentmatt/expr-eval](https://github.com/silentmatt/expr-eval)