This document compiles the official Vega documentation guides for reference in this project. It includes setup instructions, provider extensions, troubleshooting, and advanced integration.
- Download and Install Vega
- Add Provider Sources
- Build Your Own Provider (Developer Guide)
- Bypass ISP Blocking
- External Downloader and Player
Download Vega only from official release channels to ensure security and stability.
- Universal Build: Works across all supported Android CPU architectures. Recommended if APK size is not a constraint.
- arm64-v8a: Optimized for modern 64-bit ARM devices (most modern phones and tablets).
- armeabi-v7a: Optimized for older 32-bit ARM devices.
On your Android device, install a system info tool (such as CPU-Z, Droid Hardware Info, or AIDA64) and check the CPU ABI or Architecture property.
Vega allows extending its content libraries using official or custom provider sources.
- Open the Vega app and navigate to Settings > Provider Manager > Available Providers.
- Tap the + (plus) floating action button.
- Enter the provider repository identifier (e.g.,
vega-orgfor the official repository) or a custom provider URL. - Press Confirm to load and register the source.
Vega supports custom provider extensions written in JavaScript/TypeScript. Developers can write custom scraper modules and test them locally.
Each provider lives in its own dedicated directory under the providers/ folder:
providers/
myProvider/
catalog.ts
meta.ts
posts.ts
stream.ts
episodes.ts (optional)
Defines the main categories, filters, or genres displayed on the homepage.
- Exports:
catalog: An array of objects containingtitle(category name) andfilter(identifier passed togetPosts).genres(optional): An array of objects for genre-based navigation.
- Example:
export const catalog = [ { title: "Popular Movies", filter: "/category/popular-movies" }, { title: "Latest TV Shows", filter: "/category/latest-tv-shows" } ]; export const genres = [ { title: "Action", filter: "/genre/action" }, { title: "Drama", filter: "/genre/drama" } ];
Handles listing cataloged items and processing search queries.
- Exports:
getPosts({ filter, page, providerValue, signal, providerContext }): Fetches and returns an array ofPostobjects.getSearchPosts({ searchQuery, page, providerValue, signal, providerContext })(optional): Fetches search results for a query.
- Example:
import { Post, ProviderContext } from "../types"; export const getPosts = async function ({ filter, page, providerValue, signal, providerContext }: { filter: string; page: number; providerValue: string; signal: AbortSignal; providerContext: ProviderContext; }): Promise<Post[]> { // Custom scraping or API fetching logic here return []; };
Retrieves detailed metadata (synopsis, runtime, title, banner, seasons/episodes) for a selected item.
- Exports:
getMeta({ link, providerContext }): Returns anInfometadata object.
- Example:
import { Info, ProviderContext } from "../types"; export const getMeta = async function ({ link, providerContext }: { link: string; providerContext: ProviderContext; }): Promise<Info> { return { title: "Example Title", synopsis: "A sample synopsis text.", image: "https://example.com/image.jpg", imdbId: "tt1234567", type: "movie", linkList: [] }; };
Extracts streaming video playbacks/sources from a selected post.
- Exports:
getStream({ link, type, signal, providerContext }): Returns an array ofStreamresource objects.
- Example:
import { Stream, ProviderContext } from "../types"; export const getStream = async function ({ link, type, signal, providerContext }: { link: string; type: string; signal: AbortSignal; providerContext: ProviderContext; }): Promise<Stream[]> { return [ { server: "Direct Stream", link: "https://example.com/movie.m3u8", type: "m3u8", quality: "1080" } ]; };
Handles lazy-loading episode lists for long-running series if they cannot be fully returned in getMeta.
- Exports:
getEpisodes({ url, providerContext }): Returns an array ofEpisodeLinkobjects.
The linkList array handles season grouping or direct file attachments:
episodesLink: If season episodes require a secondary fetch, provideepisodesLink. When the user clicks the season,getEpisodesis invoked with this value.directLinks: If all episode resources are known upfront, bypassgetEpisodesby listing them directly underdirectLinkswith fieldstitle,link, andtype.
- End-to-End Testing:
npm run test -- <provider_name>
- Single Function Testing:
npm run test:provider <provider_name> <function_name>
- Start the local dev server using
npm run auto. Note the local IP and port provided. - In the Vega app project, open
src/lib/services/ExtensionManager.ts. - Set the test parameters:
private testMode = true; private baseUrlTestMode = "http://<your-local-ip>:3001";
- Connect both your dev computer and your test device to the same Wi-Fi network. The app will now query your local code structure.
If a provider endpoint fails to load on your local Wi-Fi, your ISP may be resolving DNS blocks. Try these configurations:
- Navigate to Settings > Network & Internet.
- Select Advanced > Private DNS.
- Choose Private DNS provider hostname.
- Enter
one.one.one.one(Cloudflare) and press Save.
Install Cloudflare's 1.1.1.1 (WARP) VPN layer to encapsulate request streams from ISP inspectors.
Use a verified VPN service. Note that some websites detect and reject commercial VPN IP blocks.
If internal player elements fail, customize third-party apps:
- Navigate to Settings > Preferences.
- Enable external app selection hooks.
- Recommended apps:
- VLC Media Player: For HLS/M3U8 streams.
- Free Download Manager (FDM): For file downloads.
- Tip: Long-press play or download components to open with external handler targets directly.