Addition of the Jukebox #20418

iNV3RT3D · 2023-09-23T02:22:23Z

About the PR

Added the jukebox, a machine capable of playing any music added to its music list.

Why / Balance

After a suggestion, I tried my hand at creating a Jukebox for use in the bar. This would likely see more use when there is no musician in the game to fill the role. The Jukebox can only play files defined in the Standard.yml file, so additional songs have to be added there.

Being able to drag around a Jukebox playing music to all who would rather not listen would be quite annoying. So, the Jukebox has a power requirement to prevent such an issue.

Technical details

The Jukebox component makes use of a new prototype, the musicList. The musicList stores several MusicListDefinitions. MusicListDefinitions store a string display name, a string file path, a string for copyright, and a float for song length in seconds.

The Jukebox by default uses the Standard.yml file for its list of music, but additional .yml files could be created for separate and unique song lists. When a song is selected, a message storing the list ID of the song is sent to the server. Pausing and resuming a song is handled by storing the time the song was played. When instructed to play, the Jukebox will check and store the current time, subtracted by any existing offset, in the components SongStartTime variable. Then, when told to pause, it will compare the current time to the stored SongStartTime. This will get the offset for the next time it plays, stored in the SongTime variable. Setting the time via the slider updates the SongTime, recalculates SongStartTime based on the offset, and then restarts the audio stream at the new time.

The current list of songs has a size of 14.3 MB combined.

Media

[✓ ] I have added screenshots/videos to this PR showcasing its changes ingame, or this PR does not require an ingame showcase

2023-09-22.16-48-15-1.mp4

Breaking changes

None

Changelog

🆑

add: The Jukebox, a machine capable of playing a wide variety of songs, is now available.

Just-a-Unity-Dev · 2023-09-23T03:26:15Z

license of the music??

AJCM-git

Nice, i have always wanted the jukebox, it gives a vibe to the bar y'know?, tho the implementation has some issues, but before that i got two questions for ya:

Is this ported from some other fork? If so, do mention em
Did you use AI to help you out in some places?

Resources/Textures/Structures/Machines/jukebox.rsi/meta.json

Resources/Prototypes/Entities/Structures/Machines/jukebox.yml

Resources/Prototypes/Catalog/Jukebox/Standard.yml

Content.Shared/Jukebox/SharedJukeboxSystem.cs

AJCM-git · 2023-09-23T03:20:53Z

Content.Client/Jukebox/UI/JukeboxSystem.cs

+using Robust.Shared.Timing;
+namespace Content.Client.Jukebox;
+
+
+public sealed class JukeboxSystem : SharedJukeboxSystem


AJCM-git · 2023-09-23T03:21:49Z

Content.Client/Jukebox/UI/JukeboxMenu.xaml.cs

+using Robust.Shared.Timing;
+using Range = Robust.Client.UserInterface.Controls.Range;
+
+namespace Content.Client.Jukebox.UI


filescope your namespaces (this applies to the other files as well)

AJCM-git · 2023-09-23T03:22:12Z

Content.Client/Jukebox/UI/JukeboxMenu.xaml.cs

+namespace Content.Client.Jukebox.UI
+{
+    [GenerateTypedNameReferences]
+    public sealed partial class JukeboxMenu : DefaultWindow


make it a FancyWindow

AJCM-git · 2023-09-23T03:22:35Z

Content.Client/Jukebox/UI/JukeboxBoundUserInterface.cs

+        {
+            SendMessage(new JukeboxComponent.JukeboxPlayingMessage());
+
+            //var playing = !jukeboxComp.Playing;


AJCM-git · 2023-09-23T03:27:06Z

Content.Shared/Jukebox/JukeboxListPrototype.cs

+}
+
+[DataDefinition]
+public sealed partial class MusicListDefinition


i dont think this is really necessary? name can perfectly be a field in the component, path needs to be of ResPath type, copyright is never used and cant you get the song lenght directly from the file or something?
Not only that, the prototype doenst seem necessary either, just use a SoundCollectionPrototype instead

potato1234x · 2023-09-23T11:18:57Z

video no load

VektorZ1 · 2023-09-23T11:39:07Z

Nice

iNV3RT3D · 2023-09-23T15:15:50Z

Nice, i have always wanted the jukebox, it gives a vibe to the bar y'know?, tho the implementation has some issues, but before that i got two questions for ya:

Is this ported from some other fork? If so, do mention em

Did you use AI to help you out in some places?

This is not ported from any other fork.
I did not use AI. If anything seems AI like, it's just because I'm bad.

Working on the requested changes now.

github-actions · 2023-09-23T20:52:14Z

RSI Diff Bot; head commit b2497b7 merging into b7cff81
This PR makes changes to 1 or more RSIs. Here is a summary of all changes:

Resources/Textures/Structures/Machines/jukebox.rsi

State	Old	New	Status
off			Added
on			Added
select			Added

Edit: diff updated after b2497b7

CaptainSqrBeard · 2023-09-25T18:53:34Z

Does it work fine when you walk away so you wouldn't hear a sound and then return back?

EmoGarbage404

i'm pretty sure we already have every song you added to the jukebox. in any case, just use the lobby music and the space ambience instead of adding new tracks

iNV3RT3D · 2023-09-27T22:03:13Z

i'm pretty sure we already have every song you added to the jukebox. in any case, just use the lobby music and the space ambience instead of adding new tracks

The lobby music and ambience are stereo audio files. Trying to play a stereo audio file as a location-based audio causes a crash.

iNV3RT3D · 2023-09-27T22:06:24Z

Also, I learned fairly recently that there are going to be changes to how audio is handled. I'm going to wait for those changes to be implemented and then redo the jukebox to make use of that instead.

Pspritechologist · 2023-10-22T22:33:31Z

I implemented pretty much this exact thing ages ago for Parkstation, but it's unmerged :P
You can check there for any ideas if you'd like, and if you're a fan of @DEATHB4DEFEAT's UI they worked on.

My implementation includes cover art for the images, some additional functionality, EMAGged songs, signals for the Jukebox, upgradable parts (which is just funny :P), lots of public functions, and Timestamp markers instead of accumulators, that kinda stuff.
I imagine an ideal implementation would probably be a bit between the two :P

Simple-Station/Parkstation#208

AJCM-git · 2023-11-28T02:23:56Z

@iNV3RT3D hey, the audio rework is finally done, telling you in case you are still interested in doing this

Added Jukebox, along with music for jukebox

a823c2e

github-actions bot added Changes: Sprites Should be reviewed or fixed by people who are knowledgeable with spriting or visual design. Changes: UI Can be reviewed or fixed by people who are knowledgeable with UI design labels Sep 23, 2023

AJCM-git requested changes Sep 23, 2023

View reviewed changes

AJCM-git added the Status: Awaiting Changes This PR needs its reviews addressed or changes to be made in order to be merged. label Sep 23, 2023

iNV3RT3D added 5 commits September 23, 2023 14:33

Fixed Jukebox meta.json copyright

bc32a7e

Removed songs I couldn't find a license for.

b40b90a

Renamed files to solve check failures from spaces

88d838d

Added missing attributions.yml

756b1fe

Fixed lack of description in Jukebox

96b1624

iNV3RT3D added 8 commits September 23, 2023 16:40

Jukebox is now constructable.

417753f

Change Jukebox menu to FancyWindow

e0579fa

Moved Jukebox messages out of jukebox component

8918765

Removed Jukebox OnValueChanged.

fc1d197

JukeboxComp now uses AutoGenerateComponentState

40131a6

Removed state code, since it's auto generated

67ef7b9

Fixed various Jukebox code to match conventions.

ab240f8

Updated Standard.yml to match changed song list.

b2497b7

iNV3RT3D requested a review from EmoGarbage404 as a code owner September 24, 2023 16:20

github-actions bot added Status: Needs Review This PR requires new reviews before it can be merged. and removed Status: Awaiting Changes This PR needs its reviews addressed or changes to be made in order to be merged. labels Sep 24, 2023

EmoGarbage404 requested changes Sep 26, 2023

View reviewed changes

iNV3RT3D closed this Sep 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Addition of the Jukebox #20418

Addition of the Jukebox #20418

iNV3RT3D commented Sep 23, 2023 •

edited

Loading

Just-a-Unity-Dev commented Sep 23, 2023

AJCM-git left a comment

AJCM-git Sep 23, 2023

AJCM-git Sep 23, 2023

AJCM-git Sep 23, 2023

AJCM-git Sep 23, 2023

AJCM-git Sep 23, 2023 •

edited

Loading

potato1234x commented Sep 23, 2023

VektorZ1 commented Sep 23, 2023

iNV3RT3D commented Sep 23, 2023

github-actions bot commented Sep 23, 2023 •

edited

Loading

CaptainSqrBeard commented Sep 25, 2023

EmoGarbage404 left a comment

iNV3RT3D commented Sep 27, 2023

iNV3RT3D commented Sep 27, 2023

Pspritechologist commented Oct 22, 2023 •

edited

Loading

AJCM-git commented Nov 28, 2023

Addition of the Jukebox #20418

Addition of the Jukebox #20418

Conversation

iNV3RT3D commented Sep 23, 2023 • edited Loading

About the PR

Why / Balance

Technical details

Media

Breaking changes

Just-a-Unity-Dev commented Sep 23, 2023

AJCM-git left a comment

Choose a reason for hiding this comment

AJCM-git Sep 23, 2023

Choose a reason for hiding this comment

AJCM-git Sep 23, 2023

Choose a reason for hiding this comment

AJCM-git Sep 23, 2023

Choose a reason for hiding this comment

AJCM-git Sep 23, 2023

Choose a reason for hiding this comment

AJCM-git Sep 23, 2023 • edited Loading

Choose a reason for hiding this comment

potato1234x commented Sep 23, 2023

VektorZ1 commented Sep 23, 2023

iNV3RT3D commented Sep 23, 2023

github-actions bot commented Sep 23, 2023 • edited Loading

CaptainSqrBeard commented Sep 25, 2023

EmoGarbage404 left a comment

Choose a reason for hiding this comment

iNV3RT3D commented Sep 27, 2023

iNV3RT3D commented Sep 27, 2023

Pspritechologist commented Oct 22, 2023 • edited Loading

AJCM-git commented Nov 28, 2023

iNV3RT3D commented Sep 23, 2023 •

edited

Loading

AJCM-git Sep 23, 2023 •

edited

Loading

github-actions bot commented Sep 23, 2023 •

edited

Loading

Pspritechologist commented Oct 22, 2023 •

edited

Loading