Properties that only Dyes have - Catman-232/Homebrewery GitHub Wiki

^{This page was up to date as of version 4.0.0}
An item's param.txt file is a JSON formatted set of properties that HB will try to parse into data. You do not need to have every single property in a file, as any you don't have will be given its default value, which is displayed in each code block below.

The file starts with a left brace: {, property names go in speech marks with a colon afterwards: "property": , values go after the colon and will have a comma after them: 10, or "stringvalue", unless it is the last one in the file: 10 or "stringvalue", and finally the file ends with a right brace }

"_dyeParams": {
  "_hue": 0.0,
  "_saturation": 1.0,
  "_brightness": 0.0,
  "_contrast": 1.0
},

Float (decimal places allowed) x 4
Technically this is a nested object called a ColorAdjustShader_Profile, which is comprised of four decimal values. These values are sent to the shader to apply a recolouring effect to the textures of your equipped gear, if it is dyable.

Valid value ranges:

• Hue: -360 to 360
• Saturation: 0 to 2
• Brightness: -1 to 1
• Contrast: 0 to 2

"_consumableObject": "",

String
This property can be used to specify a particle effect object to be spawned when you use the item, the default for Dyes is the Black Dye's effect. If you want the item to have no particle effect, set the value to "Nothing". I will get around to documenting the valid values eventually, there are a lot of them being loaded from the game's resources.