Image Overrides

The imageOverrides.json file allows you to override default graphics in the game.

The file is not required, and will only be loaded by setting the imageOverrides property of your mod.json to true.

Initializing image overrides with +mod create

In a console, simply run a command to set up image overrides 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 +imageOverrides

Example

[
	{
		"replace": "doodad/sprucetree"
	},
	{
		"replace": "doodad/mapletree",
		"imagePath": "doodad/superSpecialTree",
		"animated": true
	}
]

The replace property specifies the path to the graphic you intend to replace.

• If the path doesn't end with .png, it is appended automatically.

The imagePath property specifies the mod's path for the image.

• If the path doesn't end with .png, it is appended automatically.
• If the imagePath property is not provided, it defaults to using the same path as replace, but in your mod directory.
  • Using the full example above:
    • static/image/doodad/sprucetree.png would be replaced with <modname>/static/image/doodad/sprucetree.png
    • static/image/doodad/mapletree.png would be replaced with <modname>/static/image/doodad/superSpecialTree.png

The animated property takes a boolean representing whether or not the image is an animated strip.

• If the property isn't provided it defaults to false.

Other Examples & More Info

You can see an example of image overrides in action in the Trees on Fire mod.

Interface:

type IImageOverrides = Array<string | IImageOverride>;
interface IImageOverride {
	replace: string;
	animated?: boolean;
	imagePath?: string;
}

Next:

• Script Mods — Add content or tweak functionality with scripts.
• Languages & Extensions — Add new languages or tweak existing ones.
• Customizations — Add new hair colors, skin tones, and hairstyles to the game.
• Stylesheets — Add new CSS to the game in order to change the appearance of the UI.
• Resources & Examples — Help channels and mod examples.