mirror of
https://github.com/KevinMidboe/zoff.git
synced 2025-10-29 18:00:23 +00:00
69 lines
4.6 KiB
Markdown
69 lines
4.6 KiB
Markdown
# Zoff-Serverside
|
|
|
|
## Install
|
|
|
|
Prerequisites:
|
|
|
|
```
|
|
MongoDB : https://www.mongodb.org/
|
|
NodeJS : https://nodejs.org/en/
|
|
npm : https://www.npmjs.com/
|
|
```
|
|
|
|
Clone this repository into a folder, and navigate to it. Use ```npm install``` in the project folder and use ```$ node server.js``` to start the server.
|
|
|
|
### Events
|
|
|
|
Emitted events between the server and client
|
|
```
|
|
socket.emit("end", {id: video_id, channel: channel_name}); Tells the server the song is clientside
|
|
socket.emit("pos", {channel: channel_name}); Asks server where in the song it should be
|
|
socket.emit('list', CHANNEL_NAME); Tells the server the client wants the list
|
|
socket.emit("add", {id: VIDEO_ID, title: VIDEO_TITLE, adminpass: sha256(PASSWORD), duration: VIDEO_DURATION, list: channel_name, playlist: true_if_importing_playlist, num: current_number_of_sending_songs, total: total_number_of_sending_songs}); Sends info about a song the client wants to add
|
|
socket.emit("change_channel"); Tells the server to disconnect the user from the current channel, is used for remote controlling on the host side
|
|
socket.emit("all,chat", TEXT); Sends chat text to all chat
|
|
socket.emit("chat", TEXT); Sends chat text to channelchat
|
|
socket.emit('vote', {channel: CHANNEL_NAME, id: VIDEO_ID, type: VOTE_TYPE, adminpass: PASSWORD}); Sends info about song the user wants to vote on. If VOTE_TYPE is del, its deleting the song, if its pos, its just voting
|
|
socket.emit('skip', {channel: CHANNEL_NAME, adminpass: PASSWORD, id: video_id}); Sends skip message to server
|
|
socket.emit("password", {password: PASSWORD, channel: CHANNEL_NAME, oldpass: old_pass_if_changing_password}); Sends password for instant log in to server
|
|
socket.emit('frontpage_lists'); Tells the server the client wants frontpage lists
|
|
socket.emit("id", {id: CHANNEL_ID, type: "play", value: "mock"}); Sends message to the host channel for play
|
|
socket.emit("id", {id: CHANNEL_ID, type: "pause", value: "mock"}); Sends message to the host channel for pause
|
|
socket.emit("id", {id: CHANNEL_ID, type: "skip", value: "mock"}); Sends message to the host channel for skip
|
|
socket.emit("id", {id: CHANNEL_ID, type: "volume", value: VALUE}); Sends message to the host channel to change volume
|
|
socket.emit("id", {id: CHANNEL_ID, type: "channel", value: NEW_CHANNEL_NAME}); Sends message to the host channel to change channel
|
|
|
|
socket.on("toast", STRING) Recieves a string from server for what type of toast to be triggered
|
|
socket.on("pw", STRING) Recieves the password for the channel if the user sent the right in the first place
|
|
socket.on("conf", [ARRAY]) Recieves configuration array from server
|
|
socket.on("chat.all", {from: CLIENT_NAME, msg: STRING, channel: CLIENT_CHANNEL_NAME}) Recieves chat message from allchat
|
|
socket.on("chat", {from: CLIENT_NAME, msg: STRING}) Recieves chat message from channelchat
|
|
socket.on("id", STRING) Recieves the ID of the current client, used for remote listening
|
|
socket.on(id, {type: STRING, value: VALUE}) Recieves the messages sent on CHANNEL_ID above
|
|
socket.on("channel", {type: TYPE, value: value, time: time_of_occurence}) Recieves updates from channel. type is one of the following: list, added, deleted, vote, song_change
|
|
socket.on("get_list") Recieves message from the server that its ready to send the playlist and info
|
|
socket.on('playlists', {channels: array, viewers: number}) Recieves the playlists for the frontpage
|
|
socket.on("np", {np: NOW_PLAYING, conf: CONFIGURATION, time: SERVER_TIME}) Recieves array of now playing song. Is triggered on song-change
|
|
socket.on("viewers", VALUE) Recieves number of viewers on the current channel
|
|
```
|
|
|
|
## About
|
|
|
|
Zoff is a shared (free) YouTube based radio service, built upon the YouTube API.
|
|
|
|
Zoff is mainly a webbased service. The website uses NodeJS with Socket.IO, MongoDB and PHP on the backend, with JavaScript, jQuery and Materialize on the frontend.
|
|
|
|
The team consists of Kasper Rynning-Tønnesen and Nicolas Almagro Tonne, and the project has been worked on since late 2014.
|
|
|
|
The team can be reached on contact@zoff.no
|
|
|
|
### Legal
|
|
|
|
Copyright © 2017
|
|
Nicolas Almagro Tonne and Kasper Rynning-Tønnesen
|
|
|
|
Creative Commons License
|
|
Zoff is licensed under a
|
|
<a href="http://creativecommons.org/licenses/by-nc-nd/3.0/no/">Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Norway License.</a>.
|
|
Do not redistribute without permission from the developers.
|