merge with upstream https://github.com/RblSb/SyncTubeHEADmaster

1 files changed, 21 insertions, 7 deletions

diff --git a/README.md b/README.md
index 33fe47c..63c12e0 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,8 @@ Lightweight modern implementation and a very easy way to run locally.
 - External `vtt`/`srt`/`ass` subtitles support

 - External audiotrack / voiceover support

 - `/30`, `/-21`, etc chat commands to rewind video playback by seconds

-- Hotkeys (`Alt-P` for global play/pause, [etc](https://github.com/pinapelz/SyncTube-plus-plus/blob/382f9b2ebedca905028341825350a0fa69d88673/src/client/Buttons.hx#L416-L427))

+- [Hotkeys](#hotkeys) (`Alt-P` for global play/pause, etc)

+- Compact view button with page fullscreen on Android

 - Playback rate synchronization (with leader)

 - Links mask: `foo.com/bar${1-4}.mp4` to add multiple items

 - Override every front-end file you want (`user/res` folder)

@@ -16,13 +17,15 @@ Lightweight modern implementation and a very easy way to run locally.
 ## PlusPlus Features + Changes

 - Admin registration via configuring the `adminToken` config key and then registering on the `/admin-register` page

 - `gatePassword` config option to prevent unwanted users from joining

-- Majority vote skip management (Admins and the original video queuer overrides this behavior)

+- Strict majority skip voting with live vote counts (Admins and the original video queuer can skip immediately)

 - Leader request now requires the current leader to give up the role (via `/giveup <new-leader>`)

 - Overhauled default CSS and improved mobile view

 - Caching and uploading files is limited to Admin users only

 

 ## Supported players

 - Youtube (videos, shorts, streams and playlists)

+- Twitch (streams)

+- Vimeo

 - [Streamable](https://streamable.com)

 - [VK](https://vk.com/video)

 - [Peertube](https://joinpeertube.org) (with `pt:` url prefix)

@@ -30,7 +33,7 @@ Lightweight modern implementation and a very easy way to run locally.
 - Iframes (without sync)

 

 ## Setup

-- Open `4200` port in your router settings (port is cust@omizable)

+- Open `4200` port in your router settings (port is customizable)

 - `npm ci` in this project folder ([NodeJS 14+](https://nodejs.org) required)

 - `haxe build-all.hxml` in this project folder ([HAXE homepage](https://haxe.org/))

 - Run `node build/server.js`

@@ -40,7 +43,7 @@ Lightweight modern implementation and a very easy way to run locally.
 As alternative, you can install Docker and run:

 > ```shell

 > docker build -t synctube .

-> docker run --rm -it -p 4200:4200 -v ${PWD}/user:/usr/src/app/user synctube

+> docker run --rm -it -p 4200:4200 -v ${PWD}/user:/app/user synctube

 > ```

 

 or

@@ -54,9 +57,9 @@ or
 ## "Cache On Server"

 "Cache on Server" is a feature that enables a user to upload videos to the server and serve it to all other users temporarily. The video is deleted after it has been removed from the queue. This feature is limited to admin users only.

 

-This feature requires `ffmpeg` on your server system, it's only used to build single mp4 from downloaded audio/video tracks. Default cache size is 3.0 GiB.

+This feature requires `ffmpeg` and `ffprobe` on your server system. Default cache size is 3.0 GiB.

 

-If you want to enable `Cache on server` feature for Youtube player (effectively download the video on the server-side first), you can also run:

+If you want to enable `Cache on server` feature for Youtube and other [supported sites](https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md), you can also run:

 ```shell

 npm i https://github.com/RblSb/ytdlp-nodejs

 ```

@@ -77,17 +80,28 @@ It just works, but you can also check [user/ folder](/user/README.md) for server
 - `/ad` - Rewind sponsored block in active YouTube video

 - `/fb` (`/flashback`) - Rewind video to a prev time if someone rewinded/restarted video accidentally

 - `/volume 2.6` - Change player volume in `0-1` range or boost it in `0-3` range for quiet videos

+- `/giveup <name>` - Transfer leadership to another user

 - `/clear` - Clear chat. Admin clears chat globally

 - `/help` - Show initial tutorial message

 

 ### Admins only:

 

 - `/ban Guest 1 2h` - Ban user `Guest 1` ip for `2 hours`

-- `/unban Foo` (`/removeBan`) - Unban user `Foo`

+- `/unban Foo` - Unban user `Foo`

 - `/kick Foo` - Force `Foo` disconnection until page reload

 - `/dump` - Download state dump to report issues

 - `/crash` - Crash server if you need to test your auto-restart solution

 

+### Hotkeys

+- `Alt-L` - Request leader

+- `Alt-P` - Request leader and toggle pause/play for everyone

+- `Alt-R` - Refresh player

+- `Alt-F` - Fullscreen player

+- `Alt-S` - Vote for skip

+- `Alt-C` - Retrieve playlist links

+- `Alt-U` - Toggle video synchronization

+- `Alt-click` on playlist item lock icon - Make all items permanent/temporary

+

 ## Plugins

 - [octosubs](https://github.com/RblSb/SyncTube-octosubs) - More colorful `ASS`/`SSA` subtitles support

 - [qswitcher](https://github.com/aNNiMON/SyncTube-QSwitcher) - Raw video quality switcher