Started writeup for CS class

This commit is contained in:
dylan-fournier 2024-05-24 13:07:01 -04:00
parent 942dd102eb
commit 0070f42c00
4 changed files with 7 additions and 4 deletions

3
.gitignore vendored
View file

@ -1 +1,2 @@
server/sound/
server/sound/
server/songDatabase.json

View file

@ -0,0 +1 @@
,OCSB/s285242,SPH-0019932273,24.05.2024 13:02,file:///C:/Users/s285242/AppData/Roaming/OpenOffice/4;

BIN
Writeup_Class.odt Normal file

Binary file not shown.

View file

@ -2,7 +2,8 @@
*This project requires VLC to play sound files*
## Purpose
The **Party Jukebox** is a program that allows many people to add music, skip songs, play, and pause from any web device to the same device and playlist. \
This was created for a personal use case for parties, and is a simple, (mostly) functional solution to have a collective playlist for local mp3 files.
This was created for a personal use case for parties, and is a simple, (mostly) functional solution to have a collective playlist for local mp3 files. \
Main strenghts compared to doing something similar using Spotify are that you can limit the songs that can be played to your selection. Songs can be chosen, but only from a list
## Basic Setup
### Client Setup:
The client is a web application that can be hosted on any server, it need not be the same device running the music player.
@ -62,8 +63,8 @@ From left to right:
- The search button opens the search screen (pictured)
- The settings button (top right) opens the settings menu
- Server IP allows you to change the ip that the site connects to
- Alert time changes how long error/confirmation messages are shown for (Default 2)
- Alert time changes how long error/confirmation messages are shown for (Default 2s)
- Party Mode adds new songs to the queue when the queue has only 1 song in it
-
- Volume controls the vlc volume of the connected server