mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-19 17:07:22 -05:00
removed manga and fixed image links
This commit is contained in:
@@ -2,11 +2,13 @@
|
|||||||
|
|
||||||
High-level architecture, module boundaries, communication protocols, and design principles of the Vyla Ecosystem.
|
High-level architecture, module boundaries, communication protocols, and design principles of the Vyla Ecosystem.
|
||||||
|
|
||||||
|
**Project Owner**: alwaysmesmerizingyou (Discord)
|
||||||
|
|
||||||
## System Topology
|
## System Topology
|
||||||
|
|
||||||
- **Client Interfaces**: Vyla Home (Tauri v2), Vyla Go (Mobile), Vyla TV (ExoPlayer), Web Players. Render UI, manage local state, initiate playback via SSE, and handle failover queues.
|
- **Client Interfaces**: Vyla Home (Tauri v2), Vyla Go (Mobile), Vyla TV (ExoPlayer), Web Players. Render UI, manage local state, initiate playback via SSE, and handle failover queues.
|
||||||
- **Stream API Gateway**: Node.js Cluster, SSE, HTTP Proxy. Multi-core IPC caching (1,500 entries, 5-min TTL), HLS/AES key rewriting, and 120-byte fake image mask stripping.
|
- **Stream API Gateway**: Node.js Cluster, SSE, HTTP Proxy. Multi-core IPC caching (1,500 entries, 5-min TTL), HLS/AES key rewriting, and 120-byte fake image mask stripping.
|
||||||
- **Vyla SDK Resolver**: `@vyla-entertainment/sdk` (ESM). 60+ provider scrapers, randomized jitter scheduling, two-phase stream validation, and manga scraping with Chrome 131 TLS fingerprinting.
|
- **Vyla SDK Resolver**: `@vyla-entertainment/sdk` (ESM). 60+ provider scrapers, randomized jitter scheduling, and two-phase stream validation.
|
||||||
- **Upstream Hosts**: Remote video segment delivery, HLS manifest endpoints, and subtitle hosts.
|
- **Upstream Hosts**: Remote video segment delivery, HLS manifest endpoints, and subtitle hosts.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -54,14 +54,13 @@
|
|||||||
"identifier": "urn:air:vyla.cc:library:sdk",
|
"identifier": "urn:air:vyla.cc:library:sdk",
|
||||||
"displayName": "Vyla SDK",
|
"displayName": "Vyla SDK",
|
||||||
"type": "application/ai-catalog+json",
|
"type": "application/ai-catalog+json",
|
||||||
"description": "Node.js resolver library aggregating 60+ upstream streaming providers, subtitle tracks, download packages, and manga reading archives.",
|
"description": "Node.js resolver library aggregating 60+ upstream streaming providers, subtitle tracks, download packages.",
|
||||||
"url": "https://vyla.cc/sdk",
|
"url": "https://vyla.cc/sdk",
|
||||||
"repository": "https://gitlab.com/vyla-entertainment/sdk",
|
"repository": "https://gitlab.com/vyla-entertainment/sdk",
|
||||||
"tags": [
|
"tags": [
|
||||||
"sdk",
|
"sdk",
|
||||||
"node.js",
|
"node.js",
|
||||||
"scraper",
|
"scraper",
|
||||||
"manga",
|
|
||||||
"video-resolver"
|
"video-resolver"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -479,7 +479,10 @@
|
|||||||
|
|
||||||
@media (max-width: 900px) {
|
@media (max-width: 900px) {
|
||||||
#header-container {
|
#header-container {
|
||||||
border-radius: 100px;
|
border-top-right-radius: 15px;
|
||||||
|
border-top-left-radius: 15px;
|
||||||
|
border-bottom-right-radius: 30px;
|
||||||
|
border-bottom-left-radius: 30px;
|
||||||
top: max(6px, env(safe-area-inset-top));
|
top: max(6px, env(safe-area-inset-top));
|
||||||
width: 90%;
|
width: 90%;
|
||||||
}
|
}
|
||||||
|
|||||||
158
llms-full.txt
158
llms-full.txt
@@ -25,6 +25,8 @@ FILE: start-here/introduction.md
|
|||||||
|
|
||||||
<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>
|
<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>
|
||||||
|
|
||||||
|
**Project Owner**: alwaysmesmerizingyou (Discord)
|
||||||
|
|
||||||
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla across 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?
|
## What is Vyla?
|
||||||
@@ -108,7 +110,7 @@ Vyla decouples presentation, streaming gateway mediation, and provider scraping
|
|||||||
|
|
||||||
### Vyla SDK (`@vyla-entertainment/sdk`)
|
### Vyla SDK (`@vyla-entertainment/sdk`)
|
||||||
- **Runtime**: Pure ES Module Node.js package.
|
- **Runtime**: Pure ES Module Node.js package.
|
||||||
- **Features**: Contains 60+ modular scrapers in `src/sources/`, random jitter scheduling, retry backoff, two-phase validation (`verifyStream` / `verifyPlayable`), and Manga scraping with TLS client fingerprint spoofing.
|
- **Features**: Contains 60+ modular scrapers in `src/sources/`, random jitter scheduling, retry backoff, two-phase validation (`verifyStream` / `verifyPlayable`).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -320,13 +322,13 @@ FILE: sdk/vyla-sdk/index.md
|
|||||||
|
|
||||||
# Vyla SDK (`@vyla-entertainment/sdk`)
|
# Vyla SDK (`@vyla-entertainment/sdk`)
|
||||||
|
|
||||||
<p class="page-description">The official Node.js scraping and resolver library for movies, television series, subtitles, downloads, and manga.</p>
|
<p class="page-description">The official Node.js scraping and resolver library for movies, television series, subtitles, and downloads.</p>
|
||||||
|
|
||||||
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla SDK developer tools" loading="lazy" decoding="async" fetchpriority="low" />
|
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla SDK developer tools" loading="lazy" decoding="async" fetchpriority="low" />
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
`@vyla-entertainment/sdk` is the core media resolver engine for Vyla. It runs in Node.js (ES Modules) to query 60+ streaming scrapers, extract subtitles, find media downloads, and browse manga archives.
|
`@vyla-entertainment/sdk` is the core media resolver engine for Vyla. It runs in Node.js (ES Modules) to query 60+ streaming scrapers, extract subtitles, and find media downloads.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -347,7 +349,6 @@ npm install @vyla-entertainment/sdk
|
|||||||
- **Streaming**: Resolve direct MP4 and adaptive HLS (`.m3u8`) links with `getStream()`, `getSources()`, and `probeSource()`.
|
- **Streaming**: Resolve direct MP4 and adaptive HLS (`.m3u8`) links with `getStream()`, `getSources()`, and `probeSource()`.
|
||||||
- **Subtitles**: Fetch `.vtt` and `.srt` subtitle tracks with `getSubtitles()`.
|
- **Subtitles**: Fetch `.vtt` and `.srt` subtitle tracks with `getSubtitles()`.
|
||||||
- **Downloads**: Find direct video files with file size metadata using `getDownloads()`.
|
- **Downloads**: Find direct video files with file size metadata using `getDownloads()`.
|
||||||
- **Manga**: Search titles, list chapters, and fetch page images with `searchManga()` and `getMangaChapter()`.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -380,7 +381,6 @@ console.log(`Subtitles found: ${subtitles.length}`);
|
|||||||
|
|
||||||
- **[Quickstart](/sdk/vyla-sdk/quickstart)** — Step-by-step tutorial for movies, TV episodes, and error handling.
|
- **[Quickstart](/sdk/vyla-sdk/quickstart)** — Step-by-step tutorial for movies, TV episodes, and error handling.
|
||||||
- **[API Reference](/sdk/vyla-sdk/reference)** — Complete methods, arguments, return shapes, and TypeScript types.
|
- **[API Reference](/sdk/vyla-sdk/reference)** — Complete methods, arguments, return shapes, and TypeScript types.
|
||||||
- **[Manga Module](/sdk/vyla-sdk/manga)** — Manga search, chapter indexes, and page loading.
|
|
||||||
- **[Contributing Scrapers](/sdk/vyla-sdk/contributing)** — How to write and test new source scrapers.
|
- **[Contributing Scrapers](/sdk/vyla-sdk/contributing)** — How to write and test new source scrapers.
|
||||||
|
|
||||||
================================================================================
|
================================================================================
|
||||||
@@ -547,7 +547,6 @@ for (const [key, status] of Object.entries(healthReport)) {
|
|||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- Consult the [Complete API Reference](/sdk/vyla-sdk/reference) for exhaustive class and method parameters.
|
- Consult the [Complete API Reference](/sdk/vyla-sdk/reference) for exhaustive class and method parameters.
|
||||||
- Learn how to integrate manga reading with the [Manga SDK Guide](/sdk/vyla-sdk/manga).
|
|
||||||
- Deploy an HTTP/SSE bridge with the [Stream API Guide](/stream-api/overview).
|
- Deploy an HTTP/SSE bridge with the [Stream API Guide](/stream-api/overview).
|
||||||
|
|
||||||
================================================================================
|
================================================================================
|
||||||
@@ -560,7 +559,7 @@ FILE: sdk/vyla-sdk/reference.md
|
|||||||
|
|
||||||
## Class: `VylaSDK`
|
## Class: `VylaSDK`
|
||||||
|
|
||||||
The primary entry point for media scraping, subtitle retrieval, downloads, and manga discovery.
|
The primary entry point for media scraping, subtitle retrieval, and downloads.
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import VylaSDK from '@vyla-entertainment/sdk';
|
import VylaSDK from '@vyla-entertainment/sdk';
|
||||||
@@ -698,28 +697,6 @@ Concurrently probes all active sources and returns a health map.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Manga Methods
|
|
||||||
|
|
||||||
#### `searchManga(query, page?, perPage?)`
|
|
||||||
```typescript
|
|
||||||
async searchManga(query: string, page?: number, perPage?: number): Promise<any>
|
|
||||||
```
|
|
||||||
Queries the manga catalog via `atsu.moe` using Chrome 131 TLS fingerprinting.
|
|
||||||
|
|
||||||
#### `getManga(id)`
|
|
||||||
```typescript
|
|
||||||
async getManga(id: string): Promise<any>
|
|
||||||
```
|
|
||||||
Retrieves full manga details, author, genres, and chapter list.
|
|
||||||
|
|
||||||
#### `getMangaChapter(mangaId, chapterId)`
|
|
||||||
```typescript
|
|
||||||
async getMangaChapter(mangaId: string, chapterId: string): Promise<any>
|
|
||||||
```
|
|
||||||
Resolves ordered image URLs and dimensions for all pages in a chapter.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## TypeScript Interfaces
|
## TypeScript Interfaces
|
||||||
|
|
||||||
### `Interface: SourceConfig`
|
### `Interface: SourceConfig`
|
||||||
@@ -802,127 +779,6 @@ export interface ProbeResult {
|
|||||||
export type ProbeAllResult = Record<string, ProbeResult>;
|
export type ProbeAllResult = Record<string, ProbeResult>;
|
||||||
```
|
```
|
||||||
|
|
||||||
================================================================================
|
|
||||||
FILE: sdk/vyla-sdk/manga.md
|
|
||||||
================================================================================
|
|
||||||
|
|
||||||
# Manga Resolution Module
|
|
||||||
|
|
||||||
<p class="page-description">How to integrate manga title discovery, chapter listings, and high-resolution page resolution using the Vyla SDK.</p>
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
In addition to video streaming, `@vyla-entertainment/sdk` includes a native Manga resolution module. Powered by `atsu.moe` and leveraging `node-tls-client`, the module bypasses anti-bot TLS fingerprinting by mimicking real Google Chrome 131 cryptographic handshakes.
|
|
||||||
|
|
||||||
This allows developers to build responsive, ad-free manga reading interfaces directly into their applications.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technical Architecture
|
|
||||||
|
|
||||||
Upstream manga archives frequently block standard Node.js `fetch` or `axios` requests using JA3/JA4 TLS fingerprinting. To ensure reliable connectivity:
|
|
||||||
|
|
||||||
1. **TLS Emulation**: Uses `node-tls-client` configured with `ClientIdentifier.chrome_131`.
|
|
||||||
2. **Session Persistence**: Reuses keep-alive TLS sessions across search and chapter page requests.
|
|
||||||
3. **Structured Geometry**: Returns explicit image dimensions (`width`, `height`) and pre-calculated aspect ratios so mobile and desktop readers can prevent layout shifts during image loading.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Manga Methods
|
|
||||||
|
|
||||||
### 1. Searching for Titles
|
|
||||||
|
|
||||||
Search the manga catalog by query string with pagination support:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import VylaSDK from '@vyla-entertainment/sdk';
|
|
||||||
|
|
||||||
const sdk = new VylaSDK();
|
|
||||||
|
|
||||||
const searchResult = await sdk.searchManga('Chainsaw Man', 1, 10);
|
|
||||||
|
|
||||||
console.log(`Total results: ${searchResult.total}`);
|
|
||||||
searchResult.items.forEach((manga) => {
|
|
||||||
console.log(`[ID: ${manga.id}] ${manga.title} - ${manga.latestChapter}`);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Search Response Structure
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"page": 1,
|
|
||||||
"perPage": 10,
|
|
||||||
"total": 42,
|
|
||||||
"items": [
|
|
||||||
{
|
|
||||||
"id": "chainsaw-man",
|
|
||||||
"title": "Chainsaw Man",
|
|
||||||
"cover": "https://cdn.atsu.moe/covers/chainsaw-man.webp",
|
|
||||||
"status": "Ongoing",
|
|
||||||
"latestChapter": "Chapter 180"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 2. Fetching Manga Details & Chapters
|
|
||||||
|
|
||||||
Retrieve full metadata, descriptions, genres, and the complete chapter index:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
const mangaDetails = await sdk.getManga('chainsaw-man');
|
|
||||||
|
|
||||||
console.log('Title:', mangaDetails.title);
|
|
||||||
console.log('Synopsis:', mangaDetails.description);
|
|
||||||
console.log('Genres:', mangaDetails.genres.join(', '));
|
|
||||||
console.log('Available Chapters:', mangaDetails.chapters.length);
|
|
||||||
|
|
||||||
const latest = mangaDetails.chapters[0];
|
|
||||||
console.log(`Latest Chapter: ${latest.chapterNumber} (ID: ${latest.id})`);
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 3. Resolving Chapter Pages
|
|
||||||
|
|
||||||
To render the reader view, fetch the ordered page image assets for a specific chapter:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
const mangaId = 'chainsaw-man';
|
|
||||||
const chapterId = 'chapter-1';
|
|
||||||
|
|
||||||
const pages = await sdk.getMangaChapter(mangaId, chapterId);
|
|
||||||
|
|
||||||
console.log(`Chapter contains ${pages.length} pages.`);
|
|
||||||
|
|
||||||
pages.forEach((page, index) => {
|
|
||||||
console.log(`Page ${index + 1}: ${page.url} [${page.width}x${page.height}]`);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Page Object Structure
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"index": 1,
|
|
||||||
"url": "https://cdn.atsu.moe/data/.../01.webp",
|
|
||||||
"width": 1080,
|
|
||||||
"height": 1600,
|
|
||||||
"aspectRatio": 0.675
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Reader Layout Best Practices
|
|
||||||
|
|
||||||
When rendering manga pages in a frontend reader:
|
|
||||||
|
|
||||||
1. **Prevent Cumulative Layout Shift (CLS)**: Use the provided `aspectRatio` or `width`/`height` in CSS (`aspect-ratio: attr(width) / attr(height);`) to reserve vertical scroll space before each image finishes downloading.
|
|
||||||
2. **Preload Neighboring Pages**: Implement a 2-page lookahead preloader so viewers turning pages experience instantaneous transitions.
|
|
||||||
3. **Session Cleanup**: In long-running background tasks, invoke `cleanup()` from the module when closing reader sessions to terminate idle TLS sockets.
|
|
||||||
|
|
||||||
================================================================================
|
================================================================================
|
||||||
FILE: sdk/vyla-sdk/contributing.md
|
FILE: sdk/vyla-sdk/contributing.md
|
||||||
================================================================================
|
================================================================================
|
||||||
@@ -2023,7 +1879,7 @@ High-level architecture, module boundaries, communication protocols, and design
|
|||||||
|
|
||||||
- **Client Interfaces**: Vyla Home (Tauri v2), Vyla Go (Mobile), Vyla TV (ExoPlayer), Web Players. Render UI, manage local state, initiate playback via SSE, and handle failover queues.
|
- **Client Interfaces**: Vyla Home (Tauri v2), Vyla Go (Mobile), Vyla TV (ExoPlayer), Web Players. Render UI, manage local state, initiate playback via SSE, and handle failover queues.
|
||||||
- **Stream API Gateway**: Node.js Cluster, SSE, HTTP Proxy. Multi-core IPC caching (1,500 entries, 5-min TTL), HLS/AES key rewriting, and 120-byte fake image mask stripping.
|
- **Stream API Gateway**: Node.js Cluster, SSE, HTTP Proxy. Multi-core IPC caching (1,500 entries, 5-min TTL), HLS/AES key rewriting, and 120-byte fake image mask stripping.
|
||||||
- **Vyla SDK Resolver**: `@vyla-entertainment/sdk` (ESM). 60+ provider scrapers, randomized jitter scheduling, two-phase stream validation, and manga scraping with Chrome 131 TLS fingerprinting.
|
- **Vyla SDK Resolver**: `@vyla-entertainment/sdk` (ESM). 60+ provider scrapers, randomized jitter scheduling, and two-phase stream validation.
|
||||||
- **Upstream Hosts**: Remote video segment delivery, HLS manifest endpoints, and subtitle hosts.
|
- **Upstream Hosts**: Remote video segment delivery, HLS manifest endpoints, and subtitle hosts.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
3
llms.txt
3
llms.txt
@@ -14,6 +14,8 @@
|
|||||||
|
|
||||||
> Vyla is a community-built, decentralized media ecosystem and developer platform focused on privacy, user sovereignty, and self-hosted streaming infrastructure. It provides native client applications (Home, Go, TV), a Node.js scraper SDK aggregating 60+ upstream providers, and a self-hosted HTTP/SSE Stream API proxy.
|
> Vyla is a community-built, decentralized media ecosystem and developer platform focused on privacy, user sovereignty, and self-hosted streaming infrastructure. It provides native client applications (Home, Go, TV), a Node.js scraper SDK aggregating 60+ upstream providers, and a self-hosted HTTP/SSE Stream API proxy.
|
||||||
|
|
||||||
|
**Project Owner**: alwaysmesmerizingyou (Discord)
|
||||||
|
|
||||||
## Architecture & Ecosystem Overview
|
## Architecture & Ecosystem Overview
|
||||||
|
|
||||||
- [Introduction](https://vyla.cc/start-here/introduction): Philosophy, system components, platform support, and getting started overview.
|
- [Introduction](https://vyla.cc/start-here/introduction): Philosophy, system components, platform support, and getting started overview.
|
||||||
@@ -30,7 +32,6 @@
|
|||||||
- [SDK Overview](https://vyla.cc/sdk): Installation, capabilities, module architecture, and initial configuration.
|
- [SDK Overview](https://vyla.cc/sdk): Installation, capabilities, module architecture, and initial configuration.
|
||||||
- [SDK Quickstart](https://vyla.cc/sdk/vyla-sdk/quickstart): 5-minute setup, resolving movie and TV streams, concurrent queries, and subtitle extraction.
|
- [SDK Quickstart](https://vyla.cc/sdk/vyla-sdk/quickstart): 5-minute setup, resolving movie and TV streams, concurrent queries, and subtitle extraction.
|
||||||
- [Complete API Reference](https://vyla.cc/sdk/vyla-sdk/reference): Comprehensive documentation of the VylaSDK class, methods, parameters, and TypeScript interfaces.
|
- [Complete API Reference](https://vyla.cc/sdk/vyla-sdk/reference): Comprehensive documentation of the VylaSDK class, methods, parameters, and TypeScript interfaces.
|
||||||
- [Manga Resolution Module](https://vyla.cc/sdk/vyla-sdk/manga): Title search, chapter listings, and page image extraction via atsu.moe with Chrome 131 TLS fingerprinting.
|
|
||||||
- [Contributing a Source Scraper](https://vyla.cc/sdk/vyla-sdk/contributing): How to author, test, and submit a new provider scraper module to the SDK.
|
- [Contributing a Source Scraper](https://vyla.cc/sdk/vyla-sdk/contributing): How to author, test, and submit a new provider scraper module to the SDK.
|
||||||
|
|
||||||
## Stream API Gateway
|
## Stream API Gateway
|
||||||
|
|||||||
@@ -2,6 +2,12 @@
|
|||||||
|
|
||||||
<p class="page-description">Credits and inspiration behind the Vyla API ecosystem.</p>
|
<p class="page-description">Credits and inspiration behind the Vyla API ecosystem.</p>
|
||||||
|
|
||||||
|
## Project Owner
|
||||||
|
|
||||||
|
**Vyla Entertainment** is owned and maintained by **alwaysmesmerizingyou** on Discord.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
This page highlights the open-source projects and developers that heavily inspired the Vyla API, player ecosystem, and overall UI direction.
|
This page highlights the open-source projects and developers that heavily inspired the Vyla API, player ecosystem, and overall UI direction.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
# Support Vyla
|
# Support Vyla
|
||||||
|
|
||||||
|
**Project Owner**: alwaysmesmerizingyou (Discord)
|
||||||
|
|
||||||
Vyla is a passion project, and keeping it running is hard. Every donation helps fund the infrastructure and development needed to keep improving Vyla and expanding what it can become. Your support will help a lot.
|
Vyla is a passion project, and keeping it running is hard. Every donation helps fund the infrastructure and development needed to keep improving Vyla and expanding what it can become. Your support will help a lot.
|
||||||
|
|
||||||
Your contributions help keep Vyla alive, growing, and improving.
|
Your contributions help keep Vyla alive, growing, and improving.
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
# Vyla SDK (`@vyla-entertainment/sdk`)
|
# Vyla SDK (`@vyla-entertainment/sdk`)
|
||||||
|
|
||||||
<p class="page-description">The official Node.js scraping and resolver library for movies, television series, embed configurations, subtitles, downloads, and manga.</p>
|
<p class="page-description">The official Node.js scraping and resolver library for movies, television series, embed configurations, subtitles, and downloads.</p>
|
||||||
|
|
||||||
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla SDK developer tools" loading="lazy" decoding="async" fetchpriority="low" />
|
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla SDK developer tools" loading="lazy" decoding="async" fetchpriority="low" />
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
`@vyla-entertainment/sdk` is the core media resolver engine for Vyla. It runs in Node.js (ES Modules) to query 65+ streaming scrapers, expose dedicated vs. aggregator source lists, provide pre-configured embed player URL templates, extract subtitles, find media downloads, and browse manga archives.
|
`@vyla-entertainment/sdk` is the core media resolver engine for Vyla. It runs in Node.js (ES Modules) to query 65+ streaming scrapers, expose dedicated vs. aggregator source lists, provide pre-configured embed player URL templates, extract subtitles, and find media downloads.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -29,7 +29,6 @@ npm install @vyla-entertainment/sdk
|
|||||||
- **Embed Configuration**: Pre-mapped movie and TV embed URL templates with `ads: false` tagging in `embed_config.js` (`EMBEDS` / `EMBED_MAP`).
|
- **Embed Configuration**: Pre-mapped movie and TV embed URL templates with `ads: false` tagging in `embed_config.js` (`EMBEDS` / `EMBED_MAP`).
|
||||||
- **Subtitles**: Fetch `.vtt` and `.srt` subtitle tracks with `getSubtitles()`.
|
- **Subtitles**: Fetch `.vtt` and `.srt` subtitle tracks with `getSubtitles()`.
|
||||||
- **Downloads**: Find direct `.mp4` download links using `getDownloads()`.
|
- **Downloads**: Find direct `.mp4` download links using `getDownloads()`.
|
||||||
- **Manga**: Search titles, list chapters, and fetch page images with `searchManga()`, `getManga()`, and `getMangaChapter()`.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -67,5 +66,4 @@ console.log(`Subtitles found: ${subtitles.length}`);
|
|||||||
|
|
||||||
- **[Quickstart](quickstart.md)** — Step-by-step tutorial for movies, TV episodes, embeds, and error handling.
|
- **[Quickstart](quickstart.md)** — Step-by-step tutorial for movies, TV episodes, embeds, and error handling.
|
||||||
- **[API Reference](reference.md)** — Complete methods, config exports, return shapes, and TypeScript types.
|
- **[API Reference](reference.md)** — Complete methods, config exports, return shapes, and TypeScript types.
|
||||||
- **[Manga Module](manga.md)** — Manga search, chapter indexes, and page loading.
|
|
||||||
- **[Contributing Scrapers](contributing.md)** — How to write and register new source and embed scrapers.
|
- **[Contributing Scrapers](contributing.md)** — How to write and register new source and embed scrapers.
|
||||||
@@ -1,131 +0,0 @@
|
|||||||
# Manga Resolution Module
|
|
||||||
|
|
||||||
<p class="page-description">How to integrate manga title discovery, chapter listings, and high-resolution page resolution using the Vyla SDK.</p>
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
In addition to video streaming, `@vyla-entertainment/sdk` includes a native Manga resolution module. Powered by `atsu.moe` and leveraging `node-tls-client`, the module bypasses anti-bot TLS fingerprinting by mimicking real Google Chrome 131 cryptographic handshakes.
|
|
||||||
|
|
||||||
This allows developers to build responsive, ad-free manga reading interfaces directly into their applications.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technical Architecture
|
|
||||||
|
|
||||||
Upstream manga archives frequently block standard Node.js `fetch` or `axios` requests using JA3/JA4 TLS fingerprinting. To ensure reliable connectivity:
|
|
||||||
|
|
||||||
1. **TLS Emulation**: Uses `node-tls-client` configured with `ClientIdentifier.chrome_131`.
|
|
||||||
2. **Session Persistence**: Reuses keep-alive TLS sessions across search and chapter page requests.
|
|
||||||
3. **Structured Geometry**: Returns explicit image dimensions (`width`, `height`) and pre-calculated aspect ratios so mobile and desktop readers can prevent layout shifts during image loading.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Manga Methods
|
|
||||||
|
|
||||||
### 1. Searching for Titles
|
|
||||||
|
|
||||||
Search the manga catalog by query string with pagination support:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import VylaSDK from '@vyla-entertainment/sdk';
|
|
||||||
|
|
||||||
const sdk = new VylaSDK();
|
|
||||||
|
|
||||||
const searchResult = await sdk.searchManga('Chainsaw Man', 1, 10);
|
|
||||||
|
|
||||||
console.log(`Total results: ${searchResult.total}`);
|
|
||||||
searchResult.results.forEach((manga) => {
|
|
||||||
console.log(`[ID: ${manga.id}] ${manga.title} (${manga.status})`);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Search Response Structure
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"page": 1,
|
|
||||||
"total": 42,
|
|
||||||
"results": [
|
|
||||||
{
|
|
||||||
"id": "chainsaw-man",
|
|
||||||
"title": "Chainsaw Man",
|
|
||||||
"englishTitle": "Chainsaw Man",
|
|
||||||
"authors": ["Tatsuki Fujimoto"],
|
|
||||||
"type": "Manga",
|
|
||||||
"medium": "MANGA",
|
|
||||||
"status": "Ongoing",
|
|
||||||
"year": 2018,
|
|
||||||
"rating": 8.7,
|
|
||||||
"popularity": 120000,
|
|
||||||
"poster": "https://cdn.atsu.moe/static/covers/chainsaw-man.webp",
|
|
||||||
"posterSmall": "https://cdn.atsu.moe/static/covers/chainsaw-man-sm.webp",
|
|
||||||
"posterMedium": "https://cdn.atsu.moe/static/covers/chainsaw-man-md.webp"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 2. Fetching Manga Details & Chapters
|
|
||||||
|
|
||||||
Retrieve full metadata, synopsis, genres, and the complete chapter index:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
const mangaDetails = await sdk.getManga('chainsaw-man');
|
|
||||||
|
|
||||||
console.log('Title:', mangaDetails.title);
|
|
||||||
console.log('Synopsis:', mangaDetails.synopsis);
|
|
||||||
console.log('Genres:', mangaDetails.genres.join(', '));
|
|
||||||
console.log('Available Chapters:', mangaDetails.chapters.length);
|
|
||||||
|
|
||||||
const latest = mangaDetails.chapters[0];
|
|
||||||
console.log(`Latest Chapter: ${latest.number} (ID: ${latest.id})`);
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 3. Resolving Chapter Pages
|
|
||||||
|
|
||||||
To render the reader view, fetch the ordered page image assets for a specific chapter:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
const mangaId = 'chainsaw-man';
|
|
||||||
const chapterId = 'chapter-1';
|
|
||||||
|
|
||||||
const chapter = await sdk.getMangaChapter(mangaId, chapterId);
|
|
||||||
|
|
||||||
console.log(`Chapter ${chapter.number} contains ${chapter.pages.length} pages.`);
|
|
||||||
|
|
||||||
chapter.pages.forEach((page) => {
|
|
||||||
console.log(`Page ${page.number}: ${page.url} [${page.width}x${page.height}]`);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Chapter Response Structure
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"id": "chapter-1",
|
|
||||||
"number": 1,
|
|
||||||
"title": "Dog & Chainsaw",
|
|
||||||
"scanlatorId": null,
|
|
||||||
"pages": [
|
|
||||||
{
|
|
||||||
"number": 1,
|
|
||||||
"url": "https://cdn.atsu.moe/static/data/.../01.webp",
|
|
||||||
"width": 1080,
|
|
||||||
"height": 1600,
|
|
||||||
"aspectRatio": 0.675
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Reader Layout Best Practices
|
|
||||||
|
|
||||||
When rendering manga pages in a frontend reader:
|
|
||||||
|
|
||||||
1. **Prevent Cumulative Layout Shift (CLS)**: Use the provided `aspectRatio` or `width`/`height` in CSS (`aspect-ratio: attr(width) / attr(height);`) to reserve vertical scroll space before each image finishes downloading.
|
|
||||||
2. **Preload Neighboring Pages**: Implement a 2-page lookahead preloader so viewers turning pages experience instantaneous transitions.
|
|
||||||
3. **Session Cleanup**: In long-running background tasks, invoke `cleanup()` from `src/manga/atsu.js` when closing reader sessions to terminate idle TLS sockets.
|
|
||||||
@@ -205,5 +205,4 @@ for (const [key, status] of Object.entries(healthReport)) {
|
|||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- Consult the [Complete API Reference](reference.md) for exhaustive class, config, and method parameters.
|
- Consult the [Complete API Reference](reference.md) for exhaustive class, config, and method parameters.
|
||||||
- Learn how to integrate manga reading with the [Manga SDK Guide](manga.md).
|
|
||||||
- Deploy an HTTP/SSE bridge with the [Stream API Guide](../../stream-api/overview)
|
- Deploy an HTTP/SSE bridge with the [Stream API Guide](../../stream-api/overview)
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## Class: `VylaSDK`
|
## Class: `VylaSDK`
|
||||||
|
|
||||||
The primary entry point for media scraping, subtitle retrieval, downloads, and manga discovery.
|
The primary entry point for media scraping, subtitle retrieval, and downloads.
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import VylaSDK from '@vyla-entertainment/sdk';
|
import VylaSDK from '@vyla-entertainment/sdk';
|
||||||
@@ -143,28 +143,6 @@ Concurrently probes all active (non-disabled) sources and returns a health map k
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Manga Methods
|
|
||||||
|
|
||||||
#### `searchManga(query, page?, perPage?)`
|
|
||||||
```typescript
|
|
||||||
async searchManga(query: string, page?: number, perPage?: number): Promise<MangaSearchResult>
|
|
||||||
```
|
|
||||||
Queries the manga catalog via `atsu.moe` using Chrome 131 TLS fingerprinting.
|
|
||||||
|
|
||||||
#### `getManga(id)`
|
|
||||||
```typescript
|
|
||||||
async getManga(id: string): Promise<MangaDetails>
|
|
||||||
```
|
|
||||||
Retrieves full manga details, authors, genres, tags, and chapter list.
|
|
||||||
|
|
||||||
#### `getMangaChapter(mangaId, chapterId)`
|
|
||||||
```typescript
|
|
||||||
async getMangaChapter(mangaId: string, chapterId: string): Promise<MangaChapterPages>
|
|
||||||
```
|
|
||||||
Resolves ordered image URLs and dimensions for all pages in a chapter.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Config & Embed Exports
|
## Config & Embed Exports
|
||||||
|
|
||||||
### `src/config.js`
|
### `src/config.js`
|
||||||
@@ -305,71 +283,3 @@ export interface ProbeResult {
|
|||||||
|
|
||||||
export type ProbeAllResult = Record<string, ProbeResult>;
|
export type ProbeAllResult = Record<string, ProbeResult>;
|
||||||
```
|
```
|
||||||
|
|
||||||
### `Interfaces: Manga`
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
export interface MangaSearchItem {
|
|
||||||
id: string;
|
|
||||||
title: string;
|
|
||||||
englishTitle: string | null;
|
|
||||||
authors: string[];
|
|
||||||
type: string;
|
|
||||||
medium: string;
|
|
||||||
status: string;
|
|
||||||
year: number | null;
|
|
||||||
rating: number | null;
|
|
||||||
popularity: number | null;
|
|
||||||
poster: string | null;
|
|
||||||
posterSmall: string | null;
|
|
||||||
posterMedium: string | null;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface MangaSearchResult {
|
|
||||||
page: number;
|
|
||||||
total: number;
|
|
||||||
results: MangaSearchItem[];
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface MangaChapterSummary {
|
|
||||||
id: string;
|
|
||||||
number: number;
|
|
||||||
title: string;
|
|
||||||
pageCount: number;
|
|
||||||
createdAt: string | null;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface MangaDetails {
|
|
||||||
id: string;
|
|
||||||
title: string;
|
|
||||||
englishTitle: string | null;
|
|
||||||
synopsis: string | null;
|
|
||||||
status: string;
|
|
||||||
type: string;
|
|
||||||
medium: string;
|
|
||||||
rating: number | null;
|
|
||||||
views: number | null;
|
|
||||||
authors: string[];
|
|
||||||
genres: string[];
|
|
||||||
tags: string[];
|
|
||||||
poster: string | null;
|
|
||||||
totalChapters: number;
|
|
||||||
chapters: MangaChapterSummary[];
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface MangaPage {
|
|
||||||
number: number;
|
|
||||||
url: string | null;
|
|
||||||
width: number;
|
|
||||||
height: number;
|
|
||||||
aspectRatio: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface MangaChapterPages {
|
|
||||||
id: string;
|
|
||||||
number: number;
|
|
||||||
title: string;
|
|
||||||
scanlatorId: string | null;
|
|
||||||
pages: MangaPage[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
@@ -54,12 +54,6 @@
|
|||||||
<changefreq>monthly</changefreq>
|
<changefreq>monthly</changefreq>
|
||||||
<priority>0.7</priority>
|
<priority>0.7</priority>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
|
||||||
<loc>https://vyla.cc/sdk/vyla-sdk/manga</loc>
|
|
||||||
<lastmod>2026-11-15</lastmod>
|
|
||||||
<changefreq>monthly</changefreq>
|
|
||||||
<priority>0.6</priority>
|
|
||||||
</url>
|
|
||||||
<url>
|
<url>
|
||||||
<loc>https://vyla.cc/sdk/vyla-sdk/contributing</loc>
|
<loc>https://vyla.cc/sdk/vyla-sdk/contributing</loc>
|
||||||
<lastmod>2026-11-15</lastmod>
|
<lastmod>2026-11-15</lastmod>
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 9.0 MiB After Width: | Height: | Size: 8.4 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 4.2 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.9 MiB |
@@ -1957,8 +1957,7 @@ main.prose blockquote p {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
body.is-home .theme-ambient,
|
body.is-home .theme-ambient {
|
||||||
body.is-404 .theme-ambient {
|
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
2
src/css/bundle.min.css
vendored
2
src/css/bundle.min.css
vendored
File diff suppressed because one or more lines are too long
@@ -265,8 +265,7 @@ main.prose blockquote p {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
body.is-home .theme-ambient,
|
body.is-home .theme-ambient {
|
||||||
body.is-404 .theme-ambient {
|
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ var THEME_MEDIA = {
|
|||||||
|
|
||||||
var THEME_MEDIA_MOBILE = {
|
var THEME_MEDIA_MOBILE = {
|
||||||
dark: "/src/assets/images/wallpaper-media/tree-mobile.webp",
|
dark: "/src/assets/images/wallpaper-media/tree-mobile.webp",
|
||||||
light: "/src/assets/images/wallpaper-media/ocean.webp"
|
light: "/src/assets/images/wallpaper-media/ocean-mobile.webp"
|
||||||
};
|
};
|
||||||
|
|
||||||
var SITE_TREE = [
|
var SITE_TREE = [
|
||||||
@@ -109,12 +109,7 @@ var SITE_TREE = [
|
|||||||
"file": "/sdk/vyla-sdk/reference.md",
|
"file": "/sdk/vyla-sdk/reference.md",
|
||||||
"path": "/sdk/vyla-sdk/reference"
|
"path": "/sdk/vyla-sdk/reference"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"title": "Manga Module",
|
|
||||||
"file": "/sdk/vyla-sdk/manga.md",
|
|
||||||
"path": "/sdk/vyla-sdk/manga",
|
|
||||||
"hasMedia": true
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -1671,6 +1666,7 @@ function loadPage() {
|
|||||||
if (prevBtn) prevBtn.classList.add("hidden");
|
if (prevBtn) prevBtn.classList.add("hidden");
|
||||||
if (nextBtn) nextBtn.classList.add("hidden");
|
if (nextBtn) nextBtn.classList.add("hidden");
|
||||||
window.scrollTo(0, 0);
|
window.scrollTo(0, 0);
|
||||||
|
revealThemeAmbient();
|
||||||
}
|
}
|
||||||
var sidebar = document.getElementById("sidebar");
|
var sidebar = document.getElementById("sidebar");
|
||||||
if (sidebar && sidebar.classList.contains("open")) {
|
if (sidebar && sidebar.classList.contains("open")) {
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ Vyla decouples presentation, streaming gateway mediation, and provider scraping
|
|||||||
|
|
||||||
### Vyla SDK (`@vyla-entertainment/sdk`)
|
### Vyla SDK (`@vyla-entertainment/sdk`)
|
||||||
- **Runtime**: Pure ES Module Node.js package.
|
- **Runtime**: Pure ES Module Node.js package.
|
||||||
- **Features**: Contains 60+ modular scrapers in `src/sources/`, random jitter scheduling, retry backoff, two-phase validation (`verifyStream` / `verifyPlayable`), and Manga scraping with TLS client fingerprint spoofing.
|
- **Features**: Contains 60+ modular scrapers in `src/sources/`, random jitter scheduling, retry backoff, and two-phase validation (`verifyStream` / `verifyPlayable`).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
<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>
|
<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>
|
||||||
|
|
||||||
|
**Project Owner**: alwaysmesmerizingyou (Discord)
|
||||||
|
|
||||||
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla across 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?
|
## What is Vyla?
|
||||||
|
|||||||
Reference in New Issue
Block a user