Syncplay installation guide

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

Compatible media players

You will need one of the supported media players:

• mpv >= 0.23.0. Available from: http://mpv.io/
• mpv.net >= 5.2.1. Available from: https://github.com/stax76/mpv.net
• MPC-BE >= 1.5.2.3123. Available from: https://sourceforge.net/projects/mpcbe/
• VLC >= 2.2.1 (but not VLC4). Available from: http://www.videolan.org/vlc/
• MPC-HC >= 1.6.4. Available from: http://mpc-hc.org/ (official) or https://github.com/clsid2/mpc-hc/releases (maintained fork)
• IINA >= 1.1.1. Available from: https://iina.io/

We recommend using mpv as that has the highest level of Syncplay compatibility, e.g. with respect to the in-player chat facility. To play certain online streams with mpv you will need youtube-dl. This is available from: https://rg3.github.io/youtube-dl/

Windows

1. If you are currently running Syncplay then please close it before running the installer.
2. Ensure that you have an acceptable version of a supported media player installed (see ‘Compatible media players’, above).
3. Download the Syncplay executable package and run the installer.
4. If you have any problems running Syncplay then try installing the  Microsoft Visual C++ 2015 Redistributable Package.
5. 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.
6. See the Syncplay Client Guide and the Syncplay Server Guide for details on how to use Syncplay on Linux.

Linux / *BSD

Software Requirements

• python >= 3.6 (Last version which supported Python 2 was Syncplay 1.5.5; Last version which supported Python 3.4 is Syncplay 1.6.5)
• twisted >= 16.4.0 (on Debian based distros python3-twisted)
• Additional requirements for GUI:
  • PySide2 (>=5.11.0 except for 5.15.0) (on Debian based distros use python3-pyside2.qtwidgets) – Syncplay supports PySide6 for those on Python >=3.12
• Additional requirements for TLS:
  • certifi >= 2018.11.29
  • pyopenssl >= 16.0.0
  • service_identity
  • idna >= 0.6 != 2.3
  • pem >= 21.2.0

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

1. Ensure you have mpv or VLC installed.
2. Download and install the .dmg file from https://syncplay.pl/download/ by selecting “Get Syncplay for OS X”.

Additional software required to run Python scripts on Windows

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 3.4 and the same scripts as Linux (above) plus:

• pywin32
• zope

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.

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.