Customizations

The customizations.json file allows you to provide extra customizations for character creation (hairstyles, hair colors, and skin tones).

The file is not required, and will only be loaded if you set the customizations property of your mod.json to true.

Initializing customizations with +mod create

In a console, simply run a command to set up customizations in your mod. For more information on this command, see this guide.

cd "C:/Program Files (x86)/Steam/steamapps/common/Wayward/mods"
..\wayward.cmd +mod create HelloWorld +customizations

Example

{
	"skin-colors": [
		"#ff0"
	],
	"hair-colors": [
		"#ff0"
	],
	"hair-styles": [
		"Braid",
		{
			"name": "Pigtails",
			"imagePath": "specialHairstyles/Pigtails"
		}
	]
}

All types of customizations, skin-colors, hair-colors, and hair-styles, are optional. For example, if you only want to provide hair colors, your file can look like this:

{
	"hair-colors": [
		"#ff0"
	]
}

Colors

skin-colors and hair-colors each take an array of strings representing colors in hex.

• The # is not required.
• When providing 3 characters, each character is doubled. For example, ff0 is the same as ffff00. This functionality mirrors the functionality of web browsers (CSS).
• The alpha channel is not supported.

If you need help finding the color you want, consider using a color picker, such as Google's.

Hair Styles

hair-styles takes an array of strings or objects.

• When a string is provided, the mod attempts to load the sprite from <modName>/static/image/hairstyle/<hairstyleName>.png.
• When an object is provided, if the imagePath property is set, it will use the string as the path to the hairstyle sprite instead.
  • For example, using the full example above, the "Pigtails" hairstyle would be loaded from <modName>/specialHairstyles/Pigtails.png

Other Examples & More Info

You can see an example of customizations in action in the Ridiculous Hairdos mod.

Interface:

interface ICustomizations {
	hairColors?: string[];
	skinColors?: string[];
	hairStyles?: Array<string | IHairstyle>;
}

interface IHairstyle {
	name: string;
	path: string;
}

Next:

• Script Mods — Add content or tweak functionality with scripts.
• Languages & Extensions — Add new languages or tweak existing ones.
• Image Overrides — Replace images in the game with your own.
• Stylesheets — Add new CSS to the game in order to change the appearance of the UI.
• Resources & Examples — Help channels and mod examples.