MoonTVPlus Documentation

MoonTVPlus includes several advanced features for an enhanced media experience:

• External Player Support: Jump to players like PotPlayer, VLC, MPV, MX Player, nPlayer, and IINA.
• Video Super-Resolution (Anime4K): Real-time video quality enhancement using WebGPU (supports 1.5x, 2x, 3x, and 4x super-resolution).
• Bullet Chat (Danmaku) System: Search, match, and load bullet chats with persistence and blocking support.
• Douban Comment Scraping: Automatically fetches and displays Douban movie short reviews with pagination.
• Custom Video Source Scripts: (Experimental) Define custom logic for video sources, searching, details, and playback parsing.
• Custom Ad-Blocking: Ability to write custom code for enhanced ad-blocking.
• Watch Room: (Experimental) Supports multi-person synchronized viewing, real-time chat, and voice calls.
• M3U8 Downloads: Supports merging m3u8 fragments for browser-based downloading or local playback.
• Server-side Offline Download: Supports downloading video files to the server with breakpoint resume support.
• Private Library: Integration with OpenList, Emby, or Xiaoya to create a personal media library.
• Multi-source Aggregated Search: Returns results from all sources in a single search.
• PWA Support: Offline caching and installation as a desktop/home screen app for a native mobile experience.
• Smart Ad-Skipping: Automatically skips slice ads in videos.

To add a new video source, you must implement a script that returns an object containing specific lifecycle hooks. The script must follow a specific structure to handle source management, searching, recommendations, details, and URL resolution.

return {
  meta: {
    name: '示例脚本',
    author: 'admin'
  },

  async getSources(ctx) {
    return [{ id: 'default', name: '默认源' }];
  },

  async search(ctx, { keyword, page, sourceId }) {
    return {
      list: [],
      page,
      pageCount: 1,
      total: 0
    };
  },

  async recommend(ctx, { page }) {
    return {
      list: [],
      page: page || 1,
      pageCount: 1,
      total: 0
    };
  },

  async detail(ctx, { id, sourceId }) {
    return {
      id,
      title: '',
      poster: '',
      year: '',
      desc: '',
      playbacks: [
        {
          sourceId,
          sourceName: '默认源',
          episodes: [],
          episodes_titles: []
        }
      ]
    };
  },

  async resolvePlayUrl(ctx, { playUrl, sourceId, episodeIndex }) {
    return {
      url: playUrl,
      type: 'auto',
      headers: {}
    };
  }
};

Deploy MoonTVPlus to Tencent Cloud EdgeOne Pages using automated GitHub Actions. This requires an EdgeOne account and either a Turso or Upstash Redis instance.

1. Prerequisites

• Tencent Cloud EdgeOne account
• Forked repository on GitHub
• EdgeOne API Token
• Turso (recommended) or Upstash Redis instance

2. Configuration

Add the following secrets to your GitHub repository:

Required Secrets:

• EDGEONE_API_TOKEN: Your EdgeOne API Token.
• USERNAME: Admin username.
• PASSWORD: Admin password.
• NEXT_PUBLIC_STORAGE_TYPE: Set to turso or upstash.

If using Turso:

• TURSO_URL: Your Turso database URL (e.g., libsql://your-db.turso.io).
• TURSO_TOKEN: Your Turso access token.
• Note: Run pnpm init:turso to initialize the schema (requires TURSO_URL and TURSO_TOKEN env vars).

If using Upstash:

• UPSTASH_URL: Your Upstash Redis URL.
• UPSTASH_TOKEN: Your Upstash Redis token.

3. Deployment

• Go to the Actions tab and select the Deploy to EdgeOne workflow.
• Click Run workflow.
• project_name defaults to moontvplus.
• area defaults to overseas (global, excluding mainland China); use global for all regions.
• sync_environment is enabled by default to sync secrets to the EdgeOne project.

MoonTVPlus can be deployed using Docker with several storage backends. Choose the backend that fits your needs.

Option 1: Kvrocks (Recommended)

Uses Apache Kvrocks for storage. Ensure the mounted data directory has 777 permissions to avoid database creation failures.

services:
  moontv-core:
    image: ghcr.io/mtvpls/moontvplus:latest
    container_name: moontv-core
    restart: on-failure
    ports:
      - '3000:3000'
    environment:
      - USERNAME=admin
      - PASSWORD=admin_password
      - NEXT_PUBLIC_STORAGE_TYPE=kvrocks
      - KVROCKS_URL=redis://moontv-kvrocks:6666
    networks:
      - moontv-network
    depends_on:
      - moontv-kvrocks
  moontv-kvrocks:
    image: apache/kvrocks
    container_name: moontv-kvrocks
    restart: unless-stopped
    volumes:
      - kvrocks-data:/var/lib/kvrocks/db
    networks:
      - moontv-network
networks:
  moontv-network:
    driver: bridge
volumes:
  kvrocks-data:

Option 2: SQLite (D1 compatible)

Uses a local SQLite file. Requires a volume mount for persistence.

services:
  moontv-core:
    image: ghcr.io/mtvpls/moontvplus:latest
    container_name: moontv-core
    restart: on-failure
    ports:
      - '3000:3000'
    environment:
      - USERNAME=admin
      - PASSWORD=admin_password
      - NEXT_PUBLIC_STORAGE_TYPE=d1
      - SQLITE_DB_PATH=/app/.data/moontv.db
    volumes:
      - ./data:/app/.data

Option 3: Redis

Note: There is a risk of data loss if persistence is not configured.

services:
  moontv-core:
    image: ghcr.io/mtvpls/moontvplus:latest
    container_name: moontv-core
    restart: on-failure
    ports:
      - '3000:3000'
    environment:
      - USERNAME=admin
      - PASSWORD=admin_password
      - NEXT_PUBLIC_STORAGE_TYPE=redis
      - REDIS_URL=redis://moontv-redis:6379
    networks:
      - moontv-network
    depends_on:
      - moontv-redis
  moontv-redis:
    image: redis:alpine
    container_name: moontv-redis
    restart: unless-stopped
    networks:
      - moontv-network
    volumes:
      - ./data:/data
networks:
  moontv-network:
    driver: bridge

Option 4: Upstash

Requires an Upstash Redis instance.

services:
  moontv-core:
    image: ghcr.io/mtvpls/moontvplus:latest
    container_name: moontv-core
    restart: on-failure
    ports:
      - '3000:3000'
    environment:
      - USERNAME=admin
      - PASSWORD=admin_password
      - NEXT_PUBLIC_STORAGE_TYPE=upstash
      - UPSTASH_URL=YOUR_UPSTASH_HTTPS_ENDPOINT
      - UPSTASH_TOKEN=YOUR_UPSTASH_TOKEN

Lite Image

Use ghcr.io/mtvpls/moontvplus-lite:latest for a smaller footprint. Limitations:

• Does not support the built-in viewing room service.
• Does not support SQLite (NEXT_PUBLIC_STORAGE_TYPE=d1) automatic initialization.