aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRblSb <msrblsb@gmail.com>2020-04-04 04:15:56 +0300
committerGitHub <noreply@github.com>2020-04-04 04:15:56 +0300
commitdb1c5a4523acb1d4a47773a8261930037153c309 (patch)
tree000ec1e119c605125795861127d3b00a5daf9262 /README.md
parent58fd9ecaffbc21962842244d9160a0a4322987c8 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index 8160f8b..67533fc 100644
--- a/README.md
+++ b/README.md
@@ -5,27 +5,36 @@ Based on CyTube layout, but with lightweight implementation and very easy way to
Default channel example: http://synctube-example.herokuapp.com/
### New features
-Even if some original features are not implemented yet, there is some new things:
- Multi-Language support
- Mobile view with page fullscreen
- Way to play local videos for network users (without NAT loopback feature)
+- Playback rate synchronization (with leader)
- `/30`, `/-21`, etc to rewind video playback in seconds
+- Links mask: `foo.com/bar${1-4}.mp4` to add multiple items
- Override every front-end file you want (`user/res` folder)
- Reworked Modern theme
### Supported players
-- Youtube
-- Raw mp4 and iframe videos
+- Youtube (videos and playlists)
+- Raw mp4 videos (or any other media format supported in browser)
+- Iframes (without sync)
### Setup
-- Open `4200` port in your router settings
-- `npm install ws`
+- Open `4200` port in your router settings (port is customizable)
+- `npm install ws` in this project folder ([NodeJS](https://nodejs.org) requred)
- Run `node build/server.js`
- Open showed "Local" link for yourself and send "Global" link to friends
### Configuration
It's just works, but you can also check [user/ folder](/user/README.md) for server settings and additional customization.
+### How to use
+- Login with any nickname
+- Add your video url with "plus" button below (youtube or direct link to mp4 for example)
+- Now it plays and syncs for all page users, well done
+- You can click "leader" button to get access to global video controls (play/pause, time setting, playback speed)
+- If you want to restrict permissions or add admins/emotes, see `Configuration` above
+
### Intergations
#### Heroku:
- Create app and commit repo to get build
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage