Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Background music, score and limit songs by user #455

Merged

Conversation

lvmasterrj
Copy link
Contributor

Hi @vicwomg, i've created some features that some users and my friends asked for.

  • Background music on splash screen
  • Score at the end of songs
  • Limit user songs in queue

I've also created the possibility for the user to change preferences in the info.html, that are stored in a file called config.ini, so it doesn't have to change them in the command line everytime.

I've added a sounds folder inside the static folder, to serve the sounds.

== Background music ==

  • A music that plays when the splash screen is in the screen.
  • I've setted the bg music to play on default but added a --disable-bg-music command line to disable it.
  • Also added a --bg-music-volume to set it's volume and a --bg-music-path so that the user can change the default bg music.

== Score ==

  • A fake score screen after each song is played.
  • It's in the splash screen.
  • I've created a score.js script and added a fireworks.js script to the static folder.
  • The score reaction (claps, fireworks and review) varies depending on the fake score value (under 30, under 60 or above 60).
  • The score reviews are stored in a variable inside the splash screen so that it can be translated.
  • I've setted the score to be shown by default but added a --disable-score command line to disable it.

== Limit user songs by ==

  • Limits songs a user can put simultaneously in queue.
  • The default limit is 0 (illimited)
  • The user can use the command line --limit-user-songs-by to set the desired limit.

== User preferences ==

  • In the info page, the user can set it's preferences.
  • Now it only holds this preferences (score on/off, bg music on/off, bg music volume and limit songs in queue) but we can add more reusing the same the api endpoint in app and the change preferencesfunction in karaoke.

There's more to do, and I hope to find some time to make it happen.

If you have any doubts don't hold to ask me.

Happy new year. :)

@vicwomg vicwomg changed the base branch from master to bg-music-score-song-limit January 1, 2025 19:37
@vicwomg
Copy link
Owner

vicwomg commented Jan 1, 2025

Wow this is great, there are a lot of changes in the current release candidate that hopefully wont conflict too much, but I will open a new branch to resolve any conflicts

@Romeo1984
Copy link

Romeo1984 commented Jan 1, 2025 via email

@vicwomg vicwomg merged commit f6f92a7 into vicwomg:bg-music-score-song-limit Jan 1, 2025
4 of 5 checks passed
@vicwomg
Copy link
Owner

vicwomg commented Jan 1, 2025

Question: Is there a way to allow a single user to have unlimited song queue loads but limit all others? I usually DJ and sometimes I’m the only one loading songs. 

I'll have to double check, but looking at the code, if the user name is "Pikaraoke" they are unlimited.

@vicwomg
Copy link
Owner

vicwomg commented Jan 1, 2025

I have created a conflict resolution branch for this PR. There are some things I'd like to change before merging, which I will outline and do there:

#456

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants