mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-16 15:37:23 -05:00
fixed syntax issues
This commit is contained in:
@@ -1,82 +1,47 @@
|
||||
# Vyla Entertainment
|
||||
# Vyla
|
||||
|
||||
<p class="page-description">A community-built, decentralized media ecosystem and developer platform focused on privacy, user sovereignty, and self-hosted streaming infrastructure.</p>
|
||||
<p class="page-description">An open-source, modular media ecosystem. Native apps for desktop, mobile, and TV backed by a scraper SDK and self-hosted streaming gateway.</p>
|
||||
|
||||
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="The Vyla Ecosystem across Desktop, Android, and Android TV devices" loading="lazy" decoding="async" fetchpriority="low" />
|
||||
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla across devices" loading="lazy" decoding="async" fetchpriority="low" />
|
||||
|
||||
## What is Vyla?
|
||||
|
||||
**Vyla** is an open-source, modular media ecosystem built on a simple foundation: **users and developers should have absolute sovereignty over their media experience.**
|
||||
Vyla is an open-source media stack built for privacy and user control:
|
||||
|
||||
Unlike centralized streaming platforms that lock users into closed walled gardens, proprietary codecs, and telemetry tracking, Vyla separates the entire media stack into distinct, reusable layers:
|
||||
|
||||
1. **Client Frontends**: Native applications for Desktop (Windows, macOS, Linux), Mobile (Android), and Television (Android TV / Google TV).
|
||||
2. **Scraper & Resolver SDK**: A high-performance Node.js scraping engine (`@vyla-entertainment/sdk`) aggregating over 60 distributed upstream providers with automatic jitter buffering and HLS playback verification.
|
||||
3. **Stream API Gateway**: A self-hostable HTTP and Server-Sent Events (SSE) microservice proxy delivering low-latency progressive playback manifests, subtitle tracks, and media downloads.
|
||||
- **Client Apps**: Native frontends for Desktop (Windows, macOS, Linux), Android Mobile, and Android TV.
|
||||
- **Vyla SDK (`@vyla-entertainment/sdk`)**: A Node.js scraping engine querying 60+ upstream sources with jitter buffering and stream validation.
|
||||
- **Stream API**: A self-hostable HTTP and Server-Sent Events (SSE) gateway delivering live stream manifests, subtitles, and downloads.
|
||||
|
||||
:::callout-note
|
||||
**Core Policy**: Vyla does not host, upload, store, or distribute video files or copyrighted media. The ecosystem provides client applications and self-hosted scraping tools that resolve publicly accessible links on demand.
|
||||
Vyla does not host, upload, or store video files. It resolves publicly accessible web links on demand.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Ecosystem Architecture at a Glance
|
||||
## Ecosystem Components
|
||||
|
||||
The Vyla Ecosystem is designed around modularity. Each component functions autonomously or seamlessly interconnects with other components:
|
||||
|
||||
| Layer | Components | Core Capabilities |
|
||||
| :--- | :--- | :--- |
|
||||
| **User Interfaces** | **Vyla Home**, **Vyla Go**, **Vyla TV** | Desktop Tauri v2 with embedded sidecar, Android mobile client with WebGL shaders, and native Android TV (Jetpack Compose + ExoPlayer). |
|
||||
| **Distribution Gateway** | **Stream API** | Node.js cluster gateway, SSE progressive source emitter, M3U8 playlist & key rewriting proxy, and 120-byte fake-image obfuscation stripper. |
|
||||
| **Resolver Engine** | **Vyla SDK** (`@vyla-entertainment/sdk`) | 60+ modular source scrapers, two-phase stream verification (`verifyStream` / `verifyPlayable`), manga TLS-fingerprinted extraction, and subtitle normalization. |
|
||||
- **[Vyla Home](/products/home)** — Desktop app built with Tauri v2 and Rust. Includes auto-updates, Discord RPC, and offline fallbacks.
|
||||
- **[Vyla Go](/products/go)** — Android mobile client with shader animations and background playback.
|
||||
- **[Vyla TV](/products/tv)** — Android TV and Fire TV app with D-pad navigation and ExoPlayer playback.
|
||||
- **[Stream API](/stream-api/overview)** — High-concurrency Node.js streaming gateway with cluster caching and M3U8 reverse proxying.
|
||||
- **[Vyla SDK](/sdk)** — Core resolver module for Node.js backends and scrapers.
|
||||
- **[Web Player](/products/player)** — Lightweight HLS integration for custom web players.
|
||||
|
||||
---
|
||||
|
||||
## The Vyla Component Matrix
|
||||
## Design Principles
|
||||
|
||||
| Component | Platform / Tech Stack | Primary Responsibility | Documentation |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **Vyla Home** | Tauri v2, Node.js Sidecar, Rust | Full desktop control center, automatic updates, Discord RPC | [Vyla Home Guide](/products/home) |
|
||||
| **Vyla Go** | Tauri v2 Mobile, WebGL Shaders | Android mobile runtime, automated payload download, background playback | [Vyla Go Guide](/products/go) |
|
||||
| **Vyla TV** | Kotlin, Jetpack Compose, ExoPlayer | 10-foot Leanback television UI, D-pad navigation, 4K/HDR streaming | [Vyla TV Guide](/products/tv) |
|
||||
| **Stream API** | Node.js, Cluster Workers, SSE | Self-hosted HTTP streaming gateway, M3U8 proxy, segment stripper | [Stream API Overview](/stream-api/overview) |
|
||||
| **Vyla SDK** | Node.js (ESM), TLS Client, Cheerio | Multi-provider video resolver, subtitle extractor, manga engine | [SDK Overview](/sdk) |
|
||||
| **Custom Player** | HLS.js, Video.js, HTML5 | Custom web and native playback integration layer | [Build a Player](/products/player) |
|
||||
- **No Telemetry**: No mandatory accounts, analytics, or tracking.
|
||||
- **Automatic Failover**: Queries multiple providers with randomized jitter. If a provider fails, the player moves to the next candidate instantly.
|
||||
- **Progressive Delivery**: Stream API emits metadata and video candidates over Server-Sent Events (SSE) so playback starts in 3 to 8 seconds.
|
||||
- **Self-Hostable**: Run every service locally or deploy to your own VPS.
|
||||
|
||||
---
|
||||
|
||||
## Core Principles
|
||||
## Quick Navigation
|
||||
|
||||
- **Zero Centralized Telemetry**: Vyla frontends never require mandatory tracking, user account creation, or proprietary telemetry services.
|
||||
- **Failover by Design**: Video resolution queries multiple providers concurrently with randomized jitter. If one upstream host goes down or throttles, the client seamlessly shifts to the next viable candidate.
|
||||
- **Progressive Delivery**: Stream API delivers media metadata instantly, followed by source candidates streamed over Server-Sent Events (SSE) as each scraper resolves. Players start playback within 3 to 8 seconds without waiting for the slowest source.
|
||||
- **Local Sovereignty**: Every part of Vyla can be self-hosted locally on your laptop, home server, NAS, or virtual private server (VPS).
|
||||
|
||||
---
|
||||
|
||||
## Where to Begin
|
||||
|
||||
Select your path based on your role:
|
||||
|
||||
:::code-group
|
||||
<!-- tab: End Users -->
|
||||
- **On Desktop (Windows, macOS, Linux)?** Download and run [Vyla Home](/products/home).
|
||||
- **On Android Phone or Tablet?** Install the native [Vyla Go APK](/products/go).
|
||||
- **On Android TV, Google TV, or Fire TV?** Install the [Vyla TV APK](/products/tv).
|
||||
- **Need help with setup?** Read the [Troubleshooting Guide](/resources/troubleshooting).
|
||||
|
||||
<!-- tab: Backend Developers -->
|
||||
- **Embedding scrapers in a Node.js project?** Check out the [SDK Quickstart](/sdk/vyla-sdk/quickstart) and [Complete API Reference](/sdk/vyla-sdk/reference).
|
||||
- **Want to author a new provider?** Follow the [Contributing a Source Guide](/sdk/vyla-sdk/contributing).
|
||||
- **Integrating Manga discovery?** Read the [Manga SDK Documentation](/sdk/vyla-sdk/manga).
|
||||
|
||||
<!-- tab: Frontend & App Developers -->
|
||||
- **Connecting a web or mobile player?** Read [Paths & Playback Events](/stream-api/reference/paths) and the [Client Integration Guide](/guides/integrations).
|
||||
- **Building fallback strategies?** Study the [Error Handling Guide](/guides/error-handling).
|
||||
- **Self-hosting the streaming gateway?** Read the [Self-Hosting Guide](/stream-api/deployment/self-hosting).
|
||||
|
||||
---
|
||||
|
||||
## Legal Notice & DMCA Compliance
|
||||
|
||||
Vyla is self-hosted software intended for personal educational and development use. All stream resolution and scraper logic interacts with publicly available web sources. Rights holders can review our takedown policies in the [DMCA Policy](/misc/project/dmca).
|
||||
- **Desktop Users**: Get started with [Vyla Home](/products/home).
|
||||
- **Mobile & TV**: Check out [Vyla Go](/products/go) and [Vyla TV](/products/tv).
|
||||
- **Node.js Developers**: See the [SDK Quickstart](/sdk/vyla-sdk/quickstart) and [API Reference](/sdk/vyla-sdk/reference).
|
||||
- **Self-Hosters**: Read the [Self-Hosting Guide](/stream-api/deployment/self-hosting).
|
||||
- **Need Help?**: Visit the [FAQ](/resources/faq) or [Troubleshooting](/resources/troubleshooting).
|
||||
|
||||
Reference in New Issue
Block a user