syncplay/README.md

<!---
# Copyright (C) 2019 Syncplay
# This file is licensed under the MIT license - http://opensource.org/licenses/MIT

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-->

# Syncplay
![GitHub Actions build status](https://github.com/Syncplay/syncplay/workflows/Build/badge.svg)

Solution to synchronize video playback across multiple instances of mpv, VLC, MPC-HC, MPC-BE and mplayer2 over the Internet.

## Official website
https://syncplay.pl

## Download
https://syncplay.pl/download/

## What does it do

Syncplay synchronises the position and play state of multiple media players so that the viewers can watch the same thing at the same time.
This means that when one person pauses/unpauses playback or seeks (jumps position) within their media player then this will be replicated across all media players connected to the same server and in the same 'room' (viewing session).
When a new person joins they will also be synchronised. Syncplay also includes text-based chat so you can discuss a video as you watch it (or you could use third-party Voice over IP software to talk over a video).

## What it doesn't do

Syncplay is not a file sharing service.

## License

This project, the Syncplay released binaries, and all the files included in this repository unless stated otherwise in the header of the file, are licensed under the [Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html). A copy of this license is included in the LICENSE file of this repository. Licenses and attribution notices for third-party media are set out in [third-party-notices.txt](syncplay/resources/third-party-notices.txt).

## Authors
* *Initial concept and core internals developer* - Uriziel.
* *GUI design and current lead developer* - Et0h.
* *Original SyncPlay code* - Tomasz Kowalczyk (Fluxid), who developed SyncPlay at https://github.com/fluxid/syncplay
* *Other contributors* - See http://syncplay.pl/about/development/
Release some files under the MIT license. The freedesktop project requires that the AppStream metadata are released under a subset of licenses that does not include Apache 2.0. For this reason, we decided to change the license of the README file and release it under the MIT license (after obtaining explicit permission from all the contributors to that file). With the same goal, the script that generates the AppImage and the AppStreams metadata is also released under the MIT license. The README file now clearly states the project license and that some files are released under a different license, as declared in their header or in our third-party notices file. 2019-05-26 22:31:40 +00:00			`<!---`
			`# Copyright (C) 2019 Syncplay`
			`# This file is licensed under the MIT license - http://opensource.org/licenses/MIT`

			`# Permission is hereby granted, free of charge, to any person obtaining a copy`
			`# of this software and associated documentation files (the "Software"), to deal`
			`# in the Software without restriction, including without limitation the rights`
			`# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell`
			`# copies of the Software, and to permit persons to whom the Software is`
			`# furnished to do so, subject to the following conditions:`

			`# The above copyright notice and this permission notice shall be included in all`
			`# copies or substantial portions of the Software.`

			`# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR`
			`# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,`
			`# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE`
			`# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER`
			`# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,`
			`# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE`
			`# SOFTWARE.`
			`-->`

Add build status badges 2020-03-14 13:53:07 +00:00			`# Syncplay`
Migrate from Travis CI to GitHub Actions (#374) * Migrate from Travis CI to GitHub Actions * Remove snapcraft build 2021-01-11 18:55:59 +00:00			`![GitHub Actions build status](https://github.com/Syncplay/syncplay/workflows/Build/badge.svg)`
tequila init 2012-10-12 16:37:12 +00:00
Reflect current Syncplay situation in readme 2018-01-14 18:22:32 +00:00			`Solution to synchronize video playback across multiple instances of mpv, VLC, MPC-HC, MPC-BE and mplayer2 over the Internet.`
tequila init 2012-10-12 16:37:12 +00:00
Update README.md 2013-01-08 19:46:17 +00:00			`## Official website`
Move Syncplay.pl web links to HTTPS 2018-03-22 18:05:32 +00:00			`https://syncplay.pl`
Update README.md 2013-01-08 19:46:17 +00:00
Updating README 2014-02-22 14:36:13 +00:00			`## Download`
Move Syncplay.pl web links to HTTPS 2018-03-22 18:05:32 +00:00			`https://syncplay.pl/download/`
tequila init 2012-10-12 16:37:12 +00:00
			`## What does it do`

			`Syncplay synchronises the position and play state of multiple media players so that the viewers can watch the same thing at the same time.`
			`This means that when one person pauses/unpauses playback or seeks (jumps position) within their media player then this will be replicated across all media players connected to the same server and in the same 'room' (viewing session).`
Typofix 2018-01-14 20:11:20 +00:00			`When a new person joins they will also be synchronised. Syncplay also includes text-based chat so you can discuss a video as you watch it (or you could use third-party Voice over IP software to talk over a video).`
tequila init 2012-10-12 16:37:12 +00:00
			`## What it doesn't do`

Reflect current Syncplay situation in readme 2018-01-14 18:22:32 +00:00			`Syncplay is not a file sharing service.`
tequila init 2012-10-12 16:37:12 +00:00
Release some files under the MIT license. The freedesktop project requires that the AppStream metadata are released under a subset of licenses that does not include Apache 2.0. For this reason, we decided to change the license of the README file and release it under the MIT license (after obtaining explicit permission from all the contributors to that file). With the same goal, the script that generates the AppImage and the AppStreams metadata is also released under the MIT license. The README file now clearly states the project license and that some files are released under a different license, as declared in their header or in our third-party notices file. 2019-05-26 22:31:40 +00:00			`## License`

Add notice for Python in third party collection file (#404) * Add notice for Python in third party collection file * Convert third party notices file to plain text * Adapt codebase to third party notices format change 2021-03-28 20:08:51 +00:00			`This project, the Syncplay released binaries, and all the files included in this repository unless stated otherwise in the header of the file, are licensed under the [Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html). A copy of this license is included in the LICENSE file of this repository. Licenses and attribution notices for third-party media are set out in [third-party-notices.txt](syncplay/resources/third-party-notices.txt).`
Release some files under the MIT license. The freedesktop project requires that the AppStream metadata are released under a subset of licenses that does not include Apache 2.0. For this reason, we decided to change the license of the README file and release it under the MIT license (after obtaining explicit permission from all the contributors to that file). With the same goal, the script that generates the AppImage and the AppStreams metadata is also released under the MIT license. The README file now clearly states the project license and that some files are released under a different license, as declared in their header or in our third-party notices file. 2019-05-26 22:31:40 +00:00
Update README.md - Add authors 2012-12-26 21:42:18 +00:00			`## Authors`
Reflect current Syncplay situation in readme 2018-01-14 18:22:32 +00:00			`* Initial concept and core internals developer - Uriziel.`
			`* GUI design and current lead developer - Et0h.`
Updating README 2014-02-22 14:36:13 +00:00			`* Original SyncPlay code - Tomasz Kowalczyk (Fluxid), who developed SyncPlay at https://github.com/fluxid/syncplay`
Reflect current Syncplay situation in readme 2018-01-14 18:22:32 +00:00			`* Other contributors - See http://syncplay.pl/about/development/`