Skip to content

Tandashi/YTSync-Plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation





Watch videos directly on YouTube with your friends 🍿. You no longer need sync-video, watch2gether for watching videos on YouTube. Simply create a room on YouTube and send the link to your friends.

Why should I use this and not sync-video / watch2gether / ... ?

Using this plugin you can watch videos directly on YouTube with your friends and don't need to visit an extra site. You also have the advantage that you can synchronise livestreams and Videos which have been blocked for embedded play. You also can use the features YouTube has to offer e.g. liking the current video, storing the current video in your private playlist and many more 🀩.

Features

  • Synchronising Videos and livestreams directly on YouTube
  • Basic permission system
  • Queue functionality
  • Autoplay functionality
  • Reactions
  • Dark and light mode (depending on your YouTube setting)

If you think there is anything missing then just create a feature request.

Installation

Native Plugin for Chrome and Firefox

Note: Will have slower releases compared to the Tampermonkey version since releasing in the app store need more time to verify new updates. The store version are still the prefered versions though.

There is a native version available for those who do not want to install Tampermonkey.

Tampermonkey

To install the plugin you first need to download and install Tampermonkey for your Browser:

After you installed Tampermonkey just head to the release section and click on the lib.user.js Asset on the latest release. A popup should appear. Just click on install and you're done πŸŽ‰.

Build from source

Required build dependencies:

  • yarn or npm
  • node.js (tested with v14+ but will probably work with v12 or less as well)

After you installed all the needed dependencies you can get the source code by cloning the git repository:

# SSH
git clone [email protected]:Tandashi/YTSync-Plugin.git

# HTTPS
git clone https://github.com/Tandashi/YTSync-Plugin.git

To install the dependencies run the following command:

# Using npm
npm install

# Using yarn
yarn install

To build the plugin you can run the following command:

# Using npm
npm run build -- --env=prod 		# Production build (Minified version)
npm run build -- --env=dev 		  # Development build (Includes Source map, ...)
npm run build -- --env=browser 	# Build the Browser Plugin

# Using yarn
yarn build --env=prod 		      # Production build (Minified version)
yarn build --env=dev 		        # Development build (Includes Source map, ...)
yarn build --env=browser 	      # Build the Browser Plugin

After you build the plugin you can find it in build/.

Usage

Creating a room

To create a room simply visit a video and click on the Create Sync button. After you joined the sync session simply copy the URL and share it with your friends.

Adding a video to the queue

Simply navigate to the video you want to add and click the Add to Queue button. It should automatically be added to the queue if you have the permissions to do so.

Removing a video from the queue

Simply use the trash icon next to the video. If you have the permissions to do so it should be gone after you clicked. There is only one case where this will not work no matter your permissions. There has to be one video in the queue at any time. So you will not be able to remove the last video.

Playing the next video / a video from the queue

To play the next video or any video that is currently in the queue simply click on it. If you have the permissions to do so the clicked video should begin to start for everyone. There is also an autoplay functionality that, when enabled, will play the next video in the queue, if there is any, after the current video has ended.

Queue

The queue information is displayed on the right side at the top.

Room Information

The room information is displayed on the right side below the video queue. It displays who is currently connected and if autoplay is enabled or not.

Colors and what they mean

From top to bottom:

  1. The room host. He has a green circle.
  2. A normal person. He has a yellow square outline as badge
  3. A moderator person. He has a yellow square with red outlines as badge.
  4. A sub-host person. He has a red square as badge.

Reactions

You find something funny but aren't in a voice call with your friends? Let them know by clicking on a reaction.

Permissions / Roles

Overview

Host Sub-Host Moderator Member
Watch videos synchonized 🍿 βœ… βœ… βœ… βœ…
Send Reactions βœ… βœ… βœ… βœ…
Edit (Add / Remove / Delete) Queue βœ… βœ… βœ…
Play video in Queue βœ… βœ… βœ…
Set autoplay βœ… βœ… βœ…
Resume / Pause βœ… βœ…
Seek to βœ… βœ…
Change roles βœ…

Host

You will automatically be assigned to the Host role when you create a sync room. You can also acquire this role if the current host left the session.

What you are able to do:

  • Change a users role
  • Everything the 'sub-host' Role is able to do

Sub-host

You can only get this role if the Host assigned it to you by clicking on badge with the yellow square and red outlines.

What you are able to do:

  • Resume / Pause the video
  • Change the time in the video
  • Everything the 'moderator' role is able to do

Moderator

You can only get this role if the Host assigned it to you by clicking on badge with the yellow square outlines.

  • Add videos to the queue
  • Remove videos from the queue
  • Play a video from the queue
  • Change the autoplay setting
  • Everything the 'member' role is able to do

Member

You will automatically be assigned to the Member role when you join a sync room.

What you are able to do:

  • Sit back, relax and enjoy the videos 🍿

Technical aspects

The Plugin communicates via socket.io with the YTSync Server to synchronise the rooms.

Contributing and Support

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change πŸ™.

Questions / Support

To get support head over to the discussions tab and create a new discussion as follows:

  1. Select the category Q&A
  2. Explain your problem

Feature request

To create a feature request head over to the discussions tab and create a new discussion as follows:

  1. Select the category Ideas
  2. Explain the feature

Bug Reports

To create a bug report head over to the issues tab and create a new issue as follows:

  1. Click on the Bug report template
  2. Fill out as many points as you can
  3. And your done :)

License

GNU General Public License v3.0