BiliSum Documentation

When using the onedir packaging, the application is distributed as a directory containing the executable and its dependencies.

Output Structure (dist/BiliSum/)

• BiliSum.exe: The main executable.
• _internal/: Internal PyInstaller dependencies.
• web/static/: Web assets.
• runtime/base/: The packaged seed runtime.
• bin/ffmpeg.exe: Bundled FFmpeg.

User Runtime and Data Directories

BiliSum uses specific directories in %LOCALAPPDATA% for persistent data and managed runtimes:

• User Data: %LOCALAPPDATA%/bilisum/data (stores tasks, products, cookies, etc.).
• Managed Runtime: %LOCALAPPDATA%/bilisum/runtime (stores installed components like CUDA torch or ASR models).
• GPU/CUDA Runtime: %LOCALAPPDATA%/bilisum/runtime/gpu-cu12x (default path for CUDA-enabled components).

BiliSum offers a 'VLM Understanding' mode for visual notes. Unlike standard notes that simply insert screenshots, this mode uses a Vision Language Model (VLM) to read the original notes and screenshots to reconstruct the article structure objectively.

Key features:

• Structure: Paragraphs and images alternate (3-6 selected images) instead of stacking images at the end.
• Content: Uses frame descriptions to create objective fact lists rather than narrative summaries.
• Configuration: You can enable this in Settings → Visual Note Format → VLM Understanding Type.
• Cost Control: Since VLM calls are more expensive, you can adjust 'Maximum number of screenshots' or 'Minimum screenshot interval' in the settings.
• Supported Models: OpenAI, Anthropic, compatible interfaces, or custom endpoints.

BiliSum automatically handles subtitle acquisition with a specific priority hierarchy. If a video has available subtitles, the system will skip audio downloading and ASR (Automatic Speech Recognition) transcription to speed up the process.

Subtitle Priority Order:

1. Subtitles uploaded by the UP loader
2. Bilibili AI Chinese subtitles
3. Other Chinese subtitles
4. The first available subtitle

If no subtitles are found or if subtitle acquisition fails, the system automatically falls back to local ASR transcription. It is recommended to ensure the "优先使用 B 站字幕" (Prefer Bilibili subtitles) option is enabled in the settings (this is enabled by default).

If you are upgrading from the older BriefVid version, BiliSum performs an automatic migration on the first launch.

• Source Directory: %LOCALAPPDATA%/briefvid
• Destination Directory: %LOCALAPPDATA%/bilisum
• Migration Strategy: The process uses a "fill missing only" approach. It copies missing data, task products, Cookies, and managed runtimes from the old directory to the new one without overwriting existing data in the new directory or deleting the old directory.
• Electron Data: Desktop preferences and login sessions are migrated from the old Electron BriefVid userData directory to the new BiliSum userData directory.

The base onedir package is configured for CPU execution by default. To enable GPU acceleration or local ASR, users must install these components via the application's settings page.

• CUDA Support: Installing via the settings page adds the CUDA version of torch to the user's managed runtime directory (%LOCALAPPDATA%/bilisum/runtime/gpu-cu12x).
• Local ASR: Local ASR is not distributed with the base package. It can be installed on demand via the settings page into the current runtime.
• Note: A restart of the application is required after installing these components for changes to take effect.

To package BiliSum for Windows using the onedir mode, run the provided build script. This script automates dependency installation, local package setup, generation of the sidecar managed runtime, collection of ffmpeg binaries, and the PyInstaller execution.

Prerequisites

• Python Version: Must use 3.12.
• Local Packages: The current environment must be able to install the three local packages from this repository.
• FFmpeg: If you intend to distribute ffmpeg with the package, ensure ffmpeg.exe and ffprobe.exe are in your system PATH, or set the VIDEO_SUM_FFMPEG_DIR environment variable.

Build Command

Run the following command in PowerShell:

python .\packaging\pyinstaller\build_onedir.py

You can start the local BiliSum browser service directly using npx.

Requirements:

• Python 3.12 must be installed on your system.

Behavior on first run: BiliSum will automatically create and manage a Python virtual environment located in your local app data directory.

# Start the BiliSum browser service
npx bilisum

# Start the service on a specific port
npx bilisum start --port 3839

# Run diagnostic checks
npx bilisum doctor