mod.json

The mod.json file contains all the metadata for a mod. It describes the mod, it controls how the game will load the mod, it specifies what's in the mod, etc.

Required Properties

name

description

version

author

Content Properties

Each mod requires at least one kind of content.

Script Properties

file (required for scripts)

waywardVersion (required for scripts)

multiplayer

allowUnlockingMilestones

unloadable

Other Content Properties

languages

customizations

imageOverrides

stylesheets

Other Properties

dependencies

tags

publishedFileId

Full Example

^{This example shows every single property.}

{
	"name": "Hello World",
	"description": "Says 'Hello World' in the console.",
	"version": "1.0.0",
	"author": "Yuudaari",
	
	"dependencies": [ "475429613" ],
	"tags": [ "User Interface" ],

	"file": "out/Mod",
	"waywardVersion": "2.8.0-beta",
	"multiplayer": "clientside",
	"unloadable": true,
	"allowUnlockingMilestones": true,
	
	"languages": [ "lang/english" ],
	"customizations": true,
	"stylesheets": [ "style/mod" ],
	"imageOverrides": true,
	
	"publishedFileId": "475429614"
}

Next: Extracting Assets