Skip to content

INSTRUCTIONS.md

Latest commit

 

History

History
85 lines (62 loc) · 3.29 KB

INSTRUCTIONS.md

File metadata and controls

85 lines (62 loc) · 3.29 KB
Raw

SUB SCRUB - USER INSTRUCTIONS Intelligent Subtitle & CC Management Utility

Depending on how you like to work, there are three ways to get SubScrub running on your machine.

*** IMPORTANT: USE AT YOUR OWN RISK ***

SubScrub moves files within your file system. While it is designed with multiple safety layers, the author is not responsible for any data loss or misplaced files.

BACKUP RECOMMENDATIONS:

  1. ALWAYS perform a "DRY RUN" (Step 4 in the script) before committing to a live run.

  2. If you are processing a massive library for the first time, consider cloning your subtitle directory to a separate drive first.

  3. Keep your media server's metadata backup current.

***** OPTION 1: THE STANDALONE EXE (Easiest) *****

This is a single file that has everything bundled together. No extra files or scripts are needed to run it.

  1. DOWNLOAD: Grab "SubScrub.exe" from the latest Release.
  2. RUN: Double-click the file.
  3. WINDOWS WARNING: Because I'm an independent developer, Windows might show a "SmartScreen" popup. a. Click "More Info" b. Click "Run Anyway"
  4. FOLLOW THE PROMPTS: The tool will guide you through picking your media folder and your backup spot.

***** OPTION 2: THE .BAT LAUNCHER (Best for Script Users) *****

If your antivirus is being grumpy about the EXE, or you just prefer using the script, use the Batch launcher.

  1. SETUP: Make sure "SubScrub.bat" and "SubScrub-v1.1.ps1" are in the SAME FOLDER.
  2. RUN: Double-click "SubScrub.bat".
  3. POWER USERS: You can now pass a language code directly to the batch file to skip interactive prompts (e.g., SubScrub.bat spa).
  4. WHY USE THIS?: This batch file automatically tells Windows to let the PowerShell script run without you having to change any system security settings manually.

***** OPTION 3: RAW POWERSHELL (.ps1) *****

For the power users who want to run the code directly in their terminal.

  1. Open PowerShell.
  2. Navigate to your folder: cd "C:\path\to\SubScrub"
  3. Run the script: .\SubScrub-v1.1.ps1
    • NEW: Use -Language parameter for automation: .\SubScrub-v1.1.ps1 -Language eng

Note: If you get an "execution policy" error, use Option 2 or run: Set-ExecutionPolicy RemoteSigned -Scope CurrentUser.

═════════════════════════════════════════════════════════════════════════════ COMMON QUESTIONS & TROUBLESHOOTING

"Windows says this file is dangerous!" That's just Windows being overprotective. Since this script moves files around, Windows flags it. You can audit the code in the .ps1 file yourself—it's all transparent! Just click "More Info" followed by "Run Anyway" to bypass the warning.

"Can I use network drives?" Yes! SubScrub v1.1 includes a stability delay specifically for NAS/SMB shares to help Windows release file handles. Just type your mapped drive letter like Z:\Media.

"It's missing some of my languages!" We now support 23+ languages by default. If yours isn't listed, you can type in any custom code (like 'tgl' for Tagalog) during the interactive setup.

Questions? Issues? Open a ticket on GitHub! Made by Chops Garbage Collection