Store Page
Starbound
All Discussions Screenshots Artwork Broadcasts Videos Workshop News Guides Reviews

Starbound

Store Page
Starbound >  Workshop > Soblow's Workshop > JukeCrate (tm) > Discussions
JukeCrate (tm)
Description Discussions4 Comments29 Change Notes
 This topic has been pinned, so it's probably important
Soblow  [developer] 24 Jul, 2018 @ 4:25am
HOW TO : COMPATIBILITY OF YOUR MOD
This topic will quickly explain how to "edit" your mod to make it compatible with JukeCrate

Keep in mind that you don't have to change your mod content, simply add the two files I'll describe later to your mod. Note that even if JukeCrate isn't available, your mod won't crash

First of all, create, at the root of your mod, two folders : "/datafiles" and "/datafiles/jukecrate"

Then, create "/datafiles/jukecrate/index.json" and add this to your file :
===
[ { "op" : "add", "path" : "/modPresent/-", "value" : "YOURMODNAME" }, { "op" : "add", "path" : "/filesToLoad/-", "value" : "/datafiles/jukecrate/DIRECTORY.json" } ]
```
===
Don't forget to replace :
- YOURMODNAME with the name of your mod
- DIRECTORY with the name of your directory. The directory is the name of the "category" which will be displayed in the list, and in which you will place your musics

The, create "/datafiles/jukecrate/DIRECTORY.json" where DIRECTORY is the name you gave earlier, and add this to your file :
===
{ "folderName" : "DIRECTORY", "files" : [ { "name" : "/PATH/TO/MUSIC.ogg", "duration" : 0, "plainName" : "MUSICNAME" } ] }
===
Don't forget to replace :
- DIRECTORY : The name which will be displayed on the list. (Not necessarily the same as the filename)
- /PATH/TO/MUSIC.ogg : The path to your music (relative to starbound root)
- MUSICNAME : The real name of your music (as it will be displayed in the music list)

Adding duration is optional, but not giving this information will be problematic when random playlists will be added. It should be in seconds (ex : a 2min34s music should have a duration of 2*60+34 = 154)

To add multiple musics
You can duplicate the block above, following the rules I gave above
===
{ "name" : "/PATH/TO/MUSIC.ogg", "duration" : 0, "plainName" : "MUSICNAME" }
===
Don't forget to add a comma at the end of all blocks except the last one
Last edited by Soblow; 24 Jul, 2018 @ 4:37am
< >
Showing 1-3 of 3 comments
Soblow  [developer] 24 Jul, 2018 @ 4:32am 
Example of directory file :

===
{ "folderName" : "Base Cinematics", "files" : [ { "name" : "/sfx/cinematics/finale/finale_music.ogg", "duration" : 54, "plainName" : "Finale" }, { "name" : "/sfx/cinematics/finale/finale_music1.ogg", "duration" : 46, "plainName" : "Finale (version 1)" } ] }
===
Last edited by Soblow; 24 Jul, 2018 @ 4:36am
#1
Freon 26 Jun, 2020 @ 10:34am 
"Folder name cannot contain any of the following characters: / \ * etc. AKA no special characters
#2
Soblow  [developer] 26 Jun, 2020 @ 10:51am 
... yeah ?
Well, that's a common rule, not specific to this Mod ?
Why did you send this ?
#3
< >
Showing 1-3 of 3 comments
Per page: 1530 50