SubtitleGuideAdvancedUsage

Advanced Usage

This guide is for users who want to take their usage to the next level. Here, we'll cover how to run the tool directly from the command line for more control and the purpose of the private configuration file.

Using the Command Line

While the --FSTB-CreateSubtitles.bat script is convenient, you can run the tool directly from a command prompt or terminal (like PowerShell or Windows Terminal) for more flexibility. This allows you to process files in any location and use additional options not exposed by the batch file.

The basic command structure is:

FunscriptToolbox.exe subtitles.create [files...] [options...]

Key Arguments and Options

• [files...] (required)

  • This is a space-separated list of the video files you want to process. You can use wildcards (*) to process multiple files at once.
  • Example: FunscriptToolbox.exe subtitles.create "my-video.mp4" "another-video.mp4"
  • Example with wildcard: FunscriptToolbox.exe subtitles.create "*.mp4"

• --config (required)

  • Specifies the path to your main configuration file.
  • Example: --config "--FSTB-SubtitleGenerator.config"

• --recursive (-r)

  • When used with a wildcard in the file path, this option will search for matching files in all subdirectories.
  • Example: FunscriptToolbox.exe subtitles.create "C:\Projects\**\*.mp4" --recursive will find all mp4 files in C:\Projects and any folder inside it.

• --verbose (-v)

  • Enables verbose logging in the console. This is extremely useful for debugging, as it prints more detailed information about what each worker is doing. It also ensures all temporary files (like audio chunks and screenshots sent to AIs) are saved to the backup folder.

---

Managing Secrets: The Private Config File

You will notice two main configuration files: the main .config and the .private.config. This separation is intentional and follows a security best practice.

• --FSTB-SubtitleGenerator.config: This file defines the workflow. It contains the logic, the list of workers, and the AI prompts. It contains no sensitive information.
• --FSTB-SubtitleGenerator.private.config: This file stores your secrets. Its only purpose is to hold your private API keys.

The benefits of this separation are:

• Security: You can never accidentally share your API keys by sharing your main configuration file.
• Shareability: You can safely share your .config file with other users or post it online to ask for help, without having to scrub it for personal information.
• Version Control: You can commit your main .config file to a version control system like Git without exposing your secrets.

The tool automatically loads the .private.config file that corresponds to the main .config file you specify.