Syncplay installation guide

Compatible media players

You will need one of the supported media players:

Windows

  1. Ensure that you have an acceptable version of a supported media player installed (see ‘Compatible media players’, above).
  2. Download the Syncplay executable package and run the installer. If you want to use Syncplay with VLC then you should ensure “Install Syncplay interface for VLC” is ticked.
  3. If you have any problems running Syncplay then try installing the  Microsoft Visual C++ 2008 Redistributable Package. Most people already have it, but Windows systems without MSVCP90.dll need to install this.
  4. If you are using Syncplay with MPC-HC then you may wish to disable ‘Slow down on desync’ under ‘Show more settings’ in the Syncplay configuration window.
  5. See the Syncplay Client Guide and the Syncplay Server Guide for details on how to use Syncplay on Linux.

Linux / *BSD

Software Requirements

  • mpv, mplayer2 or vlc (MPlayer 1.x is not compatible with Syncplay and will not work)
  • python = 2.7.* (Python 3.0 not supported)
  • twisted >= 12.1.0 (on Debian based distros python-twisted)
  • PySide >= 1.1.0 (on Debian based distros python-pyside) (needed for GUI)

Installation

  1. Ensure you have meet the software requirements (see above)
  2. Download the Syncplay tarball, e.g. get the most recent .tar.gz from https://github.com/Syncplay/syncplay/releases
  3. Run sudo make install to install everything (or sudo make install-client VLC_SUPPORT=false if you do not want the server or VLC support installed)
  4. See the Syncplay Client Guide and the Syncplay Server Guide for details on how to use Syncplay on Linux.

Mac OS X

Instructions  by patricksnape update and replace the previous guide adapted from ‘Installing and using Syncplay on Mac OS X’ by Chris Trotman (solarnz). This guide will assume that you are comfortable with the command line, and know how to launch a terminal. See the troubleshooting guide for known OS X issues and workarounds.

If you get permission denied errors, make sure you have opened the installed applications at least once!

Green/grey highighted text denote commands to be entered into the Terminal

Note: Support for Mac is experimental as none of the core Syncplay developers have a Mac. If you know any good OS X Python developers then please ask them to help us improve our support for OS X. Syncplay does not currently support macOS 10.12 Sierra – join the discussion thread to see if you can help.

Installing Conda on OSX

  1. Download miniconda
  2. Install it by running the shell script in the terminal and following the instructions. (If you get a permission error then run CHMOD 755 on the file)
  3. Make sure that miniconda is on your path
    1. Test this using conda info
    2. If not on your path, you probably need to enter something along the lines of export PATH="/path/to/miniconda/bin:$PATH"

Installing Syncplay on OSX

  1. After you’ve installed Conda (see above) enter the following into the terminal:
    conda create -n syncplay python pyside pip
    source activate syncplay
    conda install qt
  2. Make sure it installs qt 4.8.5 and not the version that pyside installs by default (4.7.4) otherwise it will crash with an exception.
  3. Now for the rest, enter the following into the terminal:
    pip install twisted
    git clone https://github.com/Syncplay/syncplay

Note: You may also be given a prompt or message in relation to Xcode. If this happens, follow the on-screen instructions (e.g. for install tool, or to agree to license)

VLC Media Player Installation Instructions

SOME PEOPLE HAVE PROBLEMS RUNNING VLC WITH SYNCPLAY ON OS X – IF YOU HAVE TROUBLE PLEASE USE mpv!

  1. Download and install VLC from the VLC website
  2. Open VLC.app from Applications
  3. Close VLC
  4. Type the following into the console:
    cd syncplay
    cp resources/lua/intf/syncplay.lua /Applications/VLC.app/Contents/MacOS/share/lua/intf/

mpv Media Player Installation Instructions

SOME PEOPLE HAVE PROBLEMS RUNNING mpv WITH SYNCPLAY ON OS X – IF YOU HAVE TROUBLE PLEASE USE VLC!

  1. Enter the following into the terminal:
    brew tap mpv-player/mpv
    brew install ffmpeg
    brew install mpv --HEAD
    brew linkapps
  2. Open mpv.app from Applications
  3. Close mpv

Running Syncplay on OSX

  1. After you’ve installed Conda, Syncplay and an appropriate media player (see above) enter the following into the terminal:
    source activate syncplay
    cd syncplay
    ./syncplayClient.py
  2. Choose your player and a video and enjoy!

Note: The source activate syncplay command is required before running Syncplay because the Python dependencies are installed inside a conda environment (which keeps them isolated).

For more general information on using Syncplay see the guide to Using the Syncplay Client and Running a Syncplay Server.

Software required to run Python scripts

If you are not using the frozen executable package (e.g. because you are running Syncplay from the latest source code) then you will need Python 2,7 and the 32-bit versions of the following to run Python scripts:

If you are using the frozen executable package available from the Download page then you will not need to be able to run Python scripts.

Windows users without MSVCP90.dll also need the Microsoft Visual C++ 2008 Redistributable Package.

Note: If you want to build your own Windows installers you will need NSIS and py2exe to run buildpy2exe.py. NSIS is assumed to be installed to ‘C:\Program Files (x86)\NSIS\makensis.exe’, so if it is not you will need to modify the .py accordingly.