Skip to content

Subtitle

Jump to bottom
Zalunda edited this page Sep 17, 2025 · 7 revisions

Subtitle Creation Engine

Welcome to the FunscriptToolbox subtitle engine! This tool provides a powerful, semi-automated pipeline for creating high-quality subtitles. It combines local automated tools with the advanced contextual understanding of AI models, while providing crucial checkpoints for manual review and correction.

The engine is built on a highly flexible, folder-based configuration system. The workflow you use is determined simply by which sub-folder (e.g., Staging, ManualHQWorkflow, AutomaticHQWorkflow) you place your video project in. This allows you to easily switch between a quick-and-simple process and a more advanced, high-quality pipeline.

This guide will walk you through the one-time setup and introduce the workflow concepts.

Initial Setup

Follow these steps to configure the tool and its dependencies.

Step 1: Install FunscriptToolbox and Dependencies

  1. Download FunscriptToolbox: Get the latest version from the Releases page.
  2. Run the Installer: Run the --FSTB-Installation.bat script. This will create a FSTB-CreateSubtitles folder containing the necessary configuration files and batch scripts.
  3. Install Subtitle Edit: This tool relies on Subtitle Edit and its integration with the Purfview-Whisper transcription engine. Please install it if you haven't already.

Step 2: Configure Purfview-Whisper

To ensure FunscriptToolbox can perform local transcriptions, you need to tell it where to find the Purfview-Whisper engine, which is managed through Subtitle Edit.

  1. Open Subtitle Edit and navigate to Video -> Audio to text (Whisper)...

  2. Configure the Engine:

    • (1) Set the Engine to Purfview's Faster-Whisper. If it's not installed, Subtitle Edit will prompt you to download it.
    • (2) Click the ... button to open the model downloader.
    • (3) From the dropdown, select the * large-v2 model.
    • (4) Click Download. This ensures the model is available for both Subtitle Edit and FunscriptToolbox.
    image

  3. Find the Whisper Path: The Purfview-Whisper application is now installed in one of these locations:

    • If you used the portable version of Subtitle Edit: [Path_To_Subtitle_Edit]\Whisper\Purfview-Whisper-Faster
    • If you used the installer: %APPDATA%\Subtitle Edit\Whisper\Purfview-Whisper-Faster

  4. Update the Config File:

    • Open the --FSTB-SubtitleGenerator.config file located in the FSTB-CreateSubtitles folder.
    • Find the ApplicationFullPath property.
    • Replace [TOREPLACE-WITH-PathToPurfview] with the full path to the Purfview-Whisper-Faster directory you located above. Remember to use double backslashes (\\) in the path.

    Example: "ApplicationFullPath": "C:\\Users\\YourName\\AppData\\Roaming\\Subtitle Edit\\Whisper\\Purfview-Whisper-Faster\\faster-whisper-xxl.exe",

Step 3: Add Your API Keys in the Private Config File

  1. Get Your API Keys: The default configuration relies on keys from the following services. Both offer free tiers that are sufficient for getting started.

  2. Edit the Private Config File: Open the --FSTB-SubtitleGenerator.private.config file in a text editor. The installation script should have created this file for you.

  3. Paste Your Keys: Paste your API keys into the corresponding empty "" fields.

    Before:

    {
  "APIKeyGemini": "",
  "APIKeyPoe": ""
}

    After:

    {
  "APIKeyGemini": "AIzaSy...your...gemini...key...",
  "APIKeyPoe": "your-poe-key-goes-here-12345"
}

  4. Save the file. Your setup is now complete!

Understanding the Workflow Philosophy

Before you dive in, it's essential to understand the folder-based system. The main configuration file (--FSTB-SubtitleGenerator.config) acts as a master template with most advanced features disabled by default. You control the process by placing your project in specific sub-folders, each containing an override file that enables and configures the workers needed for that particular workflow.

The recommended path is:

  1. Staging: Every new project starts here for a fast, low-cost initial transcription and translation. This lets you quickly decide if a video is worth processing further.
  2. Promotion: If you want to create a final, professional-grade subtitle, you then move the project folder from Staging to a more advanced workflow folder, like ManualHQWorkflow.
  3. Advanced Processing: The tool automatically detects the new location, applies the new override settings, and continues the process using more powerful AI tools.

Next Steps

Now that you're set up, you are ready to start creating subtitles using the Subtitle Creation Workflow.

Configuration & Advanced Topics

The default configuration is a great starting point, but you can customize every aspect of the pipeline.

  • Configuration File Overview: Learn how the new hierarchical override system works and how to customize the workflow.
  • Core Concepts: Understand the fundamental building blocks of the engine, like Timed Items and Metadata.
  • Advanced Usage: Go beyond the basics with command-line options.

Clone this wiki locally