1. Welcome to the official Starbound Mod repository, Guest! Not sure how to install your mods? Check out the installation guide or check out the modding help thread for more guides.
    Outdated Mods have been moved to their own category! If you update your mod please let a moderator know so we can move it back to the active section.
    Dismiss Notice
  2. Hey Guest! Our new game Wargroove has released! Check out the forums or wiki for more information!
    Dismiss Notice

Custom Jukeboxes 1.1

Add your own Jukeboxes with your own music!

  1. Iroaseta
    If you wish to put multiple tracks in one single jukebox, then refer to this mod instead! If you want multiple standalone jukeboxes that play a single track on their own with customized colours, then read further.
    http://community.playstarbound.com/resources/multi-track-jukebox.4602/

    If you need an easier mod / furniture that has increment / decrement volume based on distance / radio, refer to Custom Radios

    Description:

    An asset and a simple tutorial to guide you to create one yourself, in case you didn't like my collection.

    You'll need this to craft them:
    Iroaseta's Workbench







    Tutorial:
    Let us do it step by step.
    First and foremost, punctuation is EXTREMELY important! Make sure you DO NOT miss a typo or else you'll have to track back later to see what's wrong, and this will not be pleasant.
    Next, you'll need to download Notepad++ since it's A LOT EASIER to replace texts with its function.
    Now that you're ready, we'll do it step by step.




    Your music
    1) First of all, you need to convert your music into .ogg format. If you just want a working online converter without downloading any software, give media.io a try! It supports batch converting so it should suit your need. Ignore the product it suggests though, it need to be purchased to be useful.
    2) In case you need to lower the volume for a better ambiance, I recommend Audacity to do this.
    3) Next, you need to put them into 'Custom Jukeboxes > sfx > objects' folder.
    4) Please ensure punctuation are all correct to ensure an easier time later. And it MUST be in English as well,
    NO special character or whatsoever. JUST PURE A-Z AND 0-9 ONLY.


    LOOK HERE:
    1) If you're to create and use multiple instances of jukeboxes mods (example : Jukebox mod A and Jukebox mod B with OST from C and D respectively), make sure you rename customjukebox1.object and every other .object files to something unique so that they don't clash. THIS APPLIES FOR .recipe FILE AS WELL. IF YOU'RE JUST CREATING ONE ONLY, THEN IGNORE THIS SECTION AND MOVE TO 'The objects folder'.



    The objects folder
    1) Now the real editing part begins. Go into 'Custom Jukeboxes > objects > human > jukebox' folder, right-click on an empty space and pick 'Sort by > Type'.
    2) Right-click on the customjukebox1.object file, pick 'Open with...', then select Notepad++ as your default software to open any other .object files.
    3) Now you should have opened the customjukebox1.object file with Notepad++, use Ctrl + F, and click to the Replace tab.
    4) Key in 'name1' in 'Find what', and key in your music file's name in 'Replace with', then hit 'Replace All'. PUNCTUATION IS IMPORTANT! Make sure all the upper cases and lower cases are exactly same as your .ogg files (Example : If your .ogg file is Abc Def.ogg, then type in Abc Def).
    5) Now, please take a moment and look at the first line. If there's any spaces in between the words, make sure you delete the spaces.

    Example :
    Instead of :
    "objectName" : "Ai no Melodyjukebox",
    It should be :
    "objectName" : "AinoMelodyjukebox",


    6) Next, you key in 'colour' in 'Find what', and key in the colour you want to put for your jukebox, and hit 'Replace All' again.

    The available colours are :
    customred
    custompink
    customorange
    customgreen
    customblue
    customcyan
    custompurple
    customblack


    Please make sure that all the words are in lower case. Which means it should be 'customred' instead of Custom'Red' or 'CUSTOMRED' or any other combination.

    7) Next, key in '000' in 'Find what', and key in the numbers you want to put for your jukebox, and hit 'Replace All' again. This defines the colour of the light it produce.

    The available colours are :
    red = 146, 14, 1
    pink = 242, 2, 109
    orange = 242, 83, 2
    green = 136, 253, 78
    blue = 2, 121, 242
    cyan = 2, 242, 171
    purple = 95, 2, 242
    black = 97, 97, 97


    8) And that's it! Use Ctrl + Save and you've finished your first one!
    9) Now repeat step 1 to 8 again with your other music jukebox!
    10) If you didn't used all the 18 files, simply delete the extra ones.


    TIPS :
    1) When highlighting the text in 'Find what', you can press up and down to cycle around 'name1', 'colour' and '0, 0, 0' quickly!
    2) To ensure faster editing, you can open all the .object files on Notepad++ by highlighting them all and drag them to Notepad++, so that you can just Ctrl + S then Ctrl + W to close the finished one and jump to the new one without the need to double clicking the file again and again! THIS TIP APPLIES TO .recipe FILES AS WELL SO USE IT TOO!


    The recipes folder:
    1) Go to 'Custom Jukeboxes > recipes > iroasetacraftingstation' folder.
    2) Right-click on the customjukebox1.recipe file, pick 'Open with...', then select Notepad++ as your default software to open any other .recipe files.
    3) Now you should have opened the customjukebox1.recipe file with Notepad++, simply add in your music's title in front of 'jukebox'. Make sure there's no spaces, which is same as objectName above.

    Example :
    Original :
    "item" : "jukebox",
    After :
    "item" : "AinoMelodyjukebox",


    4) Use Ctrl + S and you're done!
    5) If you feel like 1k pixels is too much or just want to buy it for 1 pixel, simply change { "item" : "money", "count" : 1000 } to { "item" : "money", "count" : 1 } or any other values you want.
    6) Repeat step 1 to 5 for the rest of your music! Only one more step now!
    7) If you didn't used all the 18 files, simply delete the extra ones.




    The player.config.patch
    1) Go to 'Custom Jukeboxes'.
    2) Right-click on the player.config.patch file, pick 'Open with...', then select Notepad++ as your default software to open any other player.config.patch files.
    3) Now you should have opened the player.config.patch file with Notepad++, similar to the recipes, simply add in your music's title in front of 'jukebox' and make sure there's no spaces.

    Example :
    Original :
    { "op" : "add", "path" : "/defaultBlueprints/tier1/-", "value" : { "item" : "jukebox" }},
    After :
    { "op" : "add", "path" : "/defaultBlueprints/tier1/-", "value" : { "item" : "AinoMelodyjukebox" }},


    4) Use Ctrl + S and you're done!
    5) If you didn't used all the 18 files, simply delete the extra ones. But make sure the last line has no comma in the end.
    5) Now it's all done! Enjoy your music in Starbound now!

    The _metadata
    NOTE : This can be skipped if you're uploading it to Steam Workshop.
    1) Go to 'Custom Jukeboxes'.
    2) Right-click on the _metadata file, pick 'Open with...', then select Notepad++ as your default software to open any other _metadata files.
    3) Put in a unique name and friendly name instead of "Custom Jukeboxes".
    4) Write your name in the author instead of "YOUR NAME HERE".
    5) Change XX to the number of jukeboxes you add in, or any other descriptions you want to put.




    WHY IT DOESN'T WORK?
    Simply report it in the discussion tab and I'll help you out! If possible, please include your edited files without the .ogg files for me to take a look.
    Mod Pack Permissions:
    Anyone can use this mod in their mod compilation without the author's consent.
    Mod Assets Permissions:
    Anyone can alter/redistribute the mod's assets without the author's consent.
    Nancok likes this.

Recent Updates

  1. Changed a bit for better dependency.