mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-20 09:37:28 -05:00
removed manga and fixed image links
This commit is contained in:
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>
|
||||
|
||||
**Project Owner**: alwaysmesmerizingyou (Discord)
|
||||
|
||||
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla across devices" loading="lazy" decoding="async" fetchpriority="low" />
|
||||
|
||||
## What is Vyla?
|
||||
@@ -108,7 +110,7 @@ Vyla decouples presentation, streaming gateway mediation, and provider scraping
|
||||
|
||||
### Vyla SDK (`@vyla-entertainment/sdk`)
|
||||
- **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`)
|
||||
|
||||
<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" />
|
||||
|
||||
## 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()`.
|
||||
- **Subtitles**: Fetch `.vtt` and `.srt` subtitle tracks with `getSubtitles()`.
|
||||
- **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.
|
||||
- **[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.
|
||||
|
||||
================================================================================
|
||||
@@ -547,7 +547,6 @@ for (const [key, status] of Object.entries(healthReport)) {
|
||||
## Next Steps
|
||||
|
||||
- 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).
|
||||
|
||||
================================================================================
|
||||
@@ -560,7 +559,7 @@ FILE: sdk/vyla-sdk/reference.md
|
||||
|
||||
## 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
|
||||
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
|
||||
|
||||
### `Interface: SourceConfig`
|
||||
@@ -802,127 +779,6 @@ export interface 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
|
||||
================================================================================
|
||||
@@ -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.
|
||||
- **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.
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user