Starbound

Starbound

Not enough ratings
[Dye Suite] Creating your own Palette Pack
By OxOOFFOO
This guide is about creating your own custom package of palettes for the Green's Dye Suite mod, it involves adding custom categories, palettes, generated colours and so on.
   
Award
Favorite
Favorited
Unfavorite
Introduction
In this guide, I will lead you through how to create your own colour pack for the Green's Dye Suite mod for clothing customisation.

To begin with, if you aren't already familiar with the creation of patches via mods and the file directory of the dye suite, please download this zip file and unzip it into a work space of your choice.

This folder contains all that you need to create a basic palette package for expanding the dye suite and adding your own content.

Template palette pack: https://www.dropbox.com/s/y4hqkvc3eus5ht4/templateDyePack.zip?dl=1

Enclosed are a series of nested folders, and inside the /interface/configs/ directory, you will find two patches, this is where we will be doing our edits and inserting our own palettes.

We shall start off by creating a simple monochrome, generated palette in the next section.

A simple monochrome palette
In the dye suite, there are two types of palette: Default and Simple.
Simple palettes are generated from a single colour automatically and are automatically sorted into colour categories based on their name, this is designed to be very simple for people who don't want the complexity of full custom palettes or would perhaps want to add their preferred colours in bulk.

We shall start by opening the colourPack.config.patch file located in \interface\configs directory, this file is a JSON format table that patches the colourPack.config inside of the dye suite mod.

The file should appear as follows:
[ { "op" : "add", "path" : "/test palette", "value" : "a09060" } ]

For those unfamiliar with the format of these patch files, the "op" key is the operation the patch will perform, in this case an "add" function that adds the value of "patch" as a key and sets that key's value as value, which in this case is the key "test palette" set as "a09060", which is a hexadecimal format colour.

When loaded into the dye suite and selected, it appears as this:


Note the prefix "Gen" has been added to the name, and the name is automatically capitalised, please keep all "path" values in lower case for neatness where possible when patching in a simple colour.

All of these generated dyes will appear in no specific order inside of the "Generated" category, accessed via the down arrow on the category selector panel.

More of these colours can be added as follows, by dividing them with a comma, make sure the last one in the list does not have a comma or it will break the dye suite.
[ { "op" : "add", "path" : "/test palette 1", "value" : "a09060" }, { "op" : "add", "path" : "/test palette 2", "value" : "9060a0" }, { "op" : "add", "path" : "/test palette 3", "value" : "60a090" } ]

Next we shall continue onto creating more advanced colour palettes for prettier effects.

A more complex palette
The palettes created here will be

We shall start by opening the defaultDyes.config.patch file located in \interface\configs directory similar to before, this file patches the defaultDyes.config.

The file should appear as follows:
[ { "op" : "add", "path" : "/palettes/-", "value" : { "name" : "Test Magenta", "categories" : [ "all", "template" ], "colours" : { "FFCA8A" : "ff00ff", "E0975C" : "bb00bb", "A85636" : "880088", "6F2919" : "330033" } } } ]

As you can observe, the structure is much more complex than the simple palette.

To start off, the "path" no longer sets the name of the palette and contains /- which tells the operation to insert inside of the path's directory in the table.

The "value" value instead here is a table instead of a string with a hex colour value in it.
The table contains a list of keys and values tied to them, the colour on the left is replace by the colour on the right, and this list can be any length, the hex values accepted are lengths 3, 4, 6 and 8, which allows for full RGBA colour support and transparent colours.

The "categories" key is a list of string of names of categories, you can add as many as you like and the dye suite will automatically add them as a category, as seen here:

As seen above in the code, the categories this colour will appear in are "template" and "all".

And should contain palettes like this:


When our test magenta colour is selected, it should appear like this:


Any categories added will be populated by all the colours with the same category, the colour of the button's end caps is the same palettes as the first palette added to the category. So if you'd like the button to be your shade of blue, pink or green, make sure that one is at the top of the list in the patch file.

By default, most palettes in the dye suite target the 4 shades used in other recolourable clothes, but by adding more keys to the palette list, you may target other colours and replace them and have more complex palettes for the clothing you like. Remember that the hex values of the colours you want to replace have to be exact, so I highly suggest a program such as GIMP to pick the colours.

Finally, to add more of these palettes, you may extend it like before, by dividing the tables with a comma, making sure not to put a comma at the end of the last one:
[ { "op" : "add", "path" : "/palettes/-", "value" : { "name" : "Test Yellow", "categories" : [ "all", "template" ], "colours" : { "FFCA8A" : "ffff00", "E0975C" : "bbbb00", "A85636" : "888800", "6F2919" : "333300" } } }, { "op" : "add", "path" : "/palettes/-", "value" : { "name" : "Test Cyan", "categories" : [ "all", "template" ], "colours" : { "FFCA8A" : "00ffff", "E0975C" : "00bbbb", "A85636" : "008888", "6F2919" : "003333" } } }, { "op" : "add", "path" : "/palettes/-", "value" : { "name" : "Test Magenta", "categories" : [ "all", "template" ], "colours" : { "FFCA8A" : "ff00ff", "E0975C" : "bb00bb", "A85636" : "880088", "6F2919" : "330033" } } } ]

And it's a simple as that to make your own pack!

Closing statements
Make sure to edit the _metadata file to your liking, and make sure to keep the priority at 1 in order to correctly add your colours.
And of course, make sure to add a snazzy preview image and upload the mod like any other.

Be sure to add the dye suite mod as a dependant mod after uploading and linking to the mod itself.
This concludes our guide on palette pack creation!

Good luck and go dye happy!

8 Comments
FlaMarie 27 Jun, 2021 @ 5:12pm 
thank you a lot! I'll try that!
OxOOFFOO  [author] 9 Jun, 2021 @ 6:29am 
Open the properties of the steam app and browse the local files, the mods folder should be in there.
FlaMarie 27 Apr, 2021 @ 12:32pm 
i will love to create palettes with this awesome tutorial, but i don't seem to find the files (my mods folder are empty, i'm using the mods subscribing to them here), any help? :)
Wakefield 2 Oct, 2020 @ 5:59pm 
nice, now I can finally do a tan armor, cheers
dormouse enjoyer 10 Nov, 2019 @ 12:25am 
I didn't know this tutorial existed. Damn, I really love your mod.
SenselessSpirit 29 Aug, 2019 @ 7:28am 
If I could understand this I would be super happy
OxOOFFOO  [author] 18 Aug, 2019 @ 5:27pm 
YOU'RE WELCOME!
LoneWolf 18 Aug, 2019 @ 2:39pm 
THANK YOU! I COULDN'T FIND ANY GUIDES ON HOW TO DO THIS! YOU'VE MADE MY ENTIRE DAY! THAAAAANK YOOOOU!!! ^_^ :lunar2019grinningpig: