Skip to content

QUICKSTART.md

Latest commit

 

History

History
124 lines (90 loc) · 2.68 KB

QUICKSTART.md

File metadata and controls

124 lines (90 loc) · 2.68 KB
Raw

Quick Start Guide - AVSync Desktop

Get up and running in 5 minutes!

Prerequisites

  • Node.js 18+ installed
  • Python 3.8+ installed
  • Git (optional)

Quick Setup

1. Install Dependencies

# Install Node.js packages
npm install

# Install Python packages
pip install -r requirements.txt

2. Build AVSync Executable

npm run build:pyinstaller

3. Download Binaries

Download and place these files in resources/bin/:

Windows:

macOS:

brew install ffmpeg mkvtoolnix
cp $(which ffmpeg) resources/bin/
cp $(which ffprobe) resources/bin/
cp $(which mkvmerge) resources/bin/

4. Copy AVSync Executable

# Windows
copy dist\avsync\avsync.exe resources\bin\

# macOS/Linux
cp dist/avsync/avsync resources/bin/
chmod +x resources/bin/*

5. Run Development Mode

npm run dev

The app will open automatically!

Build for Distribution

Windows

npm run package:win

Output: release/AVSync Desktop Setup x.x.x.exe

macOS

npm run package:mac

Output: release/AVSync Desktop-x.x.x.dmg

Using the Application

  1. Select Files: Click Browse to select your reference video, foreign video, and output path
  2. Preview Frames: Navigate through both videos to find matching points
  3. Add Sync Points (optional): Click "Add Sync Point" when both videos show the same moment
  4. Adjust Parameters: Expand sections in the right panel to customize settings
  5. Run: Click "Run AVSync" button and monitor the logs
  6. Wait: Processing may take several minutes depending on video length
  7. Done: Your synchronized video will be saved to the output path

Tips

  • Use the timeline sliders for quick navigation
  • Use frame buttons for precise positioning
  • The first and last sync points are most important for accuracy
  • Leave sync points empty for fully automatic synchronization
  • Enable "Verbose logging" for detailed output
  • Check the log file saved alongside your output for troubleshooting

Common Issues

"Module not found" error

rm -rf node_modules package-lock.json
npm install

PyInstaller fails

pip install --upgrade pyinstaller
pyinstaller --clean avsync.spec

Binaries not found

  • Verify all files are in resources/bin/
  • On Unix: chmod +x resources/bin/*

App won't open (macOS)

  • Right-click → Open (instead of double-click)

Need Help?

See the full documentation:

  • README.md - Complete feature documentation
  • BUILD_INSTRUCTIONS.md - Detailed build guide

Enjoy using AVSync Desktop!