Update README.md

This commit is contained in:
Calvin Montgomery 2013-10-12 01:34:54 -05:00
parent 4f7240244f
commit 5deb07acec

View file

@ -7,9 +7,8 @@ calzoneman/sync
About About
----- -----
CyTube (formerly Sync) is a server/client combination providing media synchronization, chat, CyTube is a web application providing media synchronization, chat, and more for an arbitrary number of channels.
and administration for an arbitrary number of channels. I began developing this as a hobby project, and when synchtube.com announced their closure, I
I began developing this as a hobby project, and when Synchtube announced their closure, I
began polishing it and readying it for the public. began polishing it and readying it for the public.
I am hosting a CyTube server at http://cytu.be I am hosting a CyTube server at http://cytu.be
@ -22,18 +21,58 @@ The clientside is written in JavaScript and makes use of Socket.IO and
jQuery as well as the APIs for various media providers. jQuery as well as the APIs for various media providers.
The web interface uses Bootstrap for layout and styling. The web interface uses Bootstrap for layout and styling.
The following media sources are currently supported: Features
- YouTube (individual videos) --------
- YouTube Playlists - Standalone web/socket.io server
- Optional SSL support for socket.io and the account API
- Synchronized playback from the following sources:
- YouTube (individual videos + playlists)
- Vimeo - Vimeo
- Dailymotion - Dailymotion
- Soundcloud - Soundcloud
- Livestream.com - Raw video/audio files (via JWPlayer)
- Twitch.tv - Embedding of the following sources:
- Justin.tv - livestream.com
- Ustream.tv - twitch.tv
- RTMP livestreams - justin.tv
- Custom `<iframe>` and `<object>` tags - ustream.tv
- RTMP streams
- Icecast (via JWPlayer)
- Custom `<iframe>` and `<object>` embeds
- Channel customization
- HTML Message of the Day
- CSS
- JavaScript
- Permissions
- Tiered ranks (Site admin > Channel admin > Moderator > Leader > Member > Guest > Anonymous)
- Chat filters (based on regular expressions)
- Lock/unlock playlist to allow additions by non-moderators (configurable with permissions)
- Searchable library of videos
- Integrated YouTube search
- Save/load playlists per user account
- Polls
- Voteskip (can be disabled by a channel moderator)
- Auto-AFK status (can be configured per-channel)
- Leader
- Grants control of playback to a user (can pause/seek)
- Can also be used to grant temporary mod-like powers to a user
- Not necessary for synchronization as the server has an internal timer
- Channel state saves/loads on restart
- Account management
- Password change
- Password reset (via email)
- Profile avatar and text
- Moderation
- Mute users
- Kick users
- Ban users by name
- Ban users by IP address (and by /24 range)
- Administration
- Log viewer
- Global bans
- Search registered channels and users
- Currently loaded channels
- Stats (usercount, channelcount, RAM usage
Installing Installing
---------- ----------