Global

Type Definitions

---

assetConfig

Mods only support image files
To overwrite an existing texture, just use the same key name

Properties:

Name	Type	Description
key	string	The texture key that will be used in game
url	string	The location of the image. Ex: "assets/myImage.png"

Source:

• mod.js, line 30

Example

{
    "key": "myImage",
    "url": "assets/image.png"
},
{
    "key": "Queen-Body-Default",
    "url": "assets/queen.png"
}

---

config

config.json should be in the root folder of your .zip file

Type:

• object

Properties:

Name	Type	Description
id	string	id of your mod
name	string	name of your mod
version	string	version of your mod
description	string	description of your mod
scripts	array.<string>	The name of the .js files used in your mod. Ex: "mods.js"
assets	array.<assetConfig>	Array of assets used in your mod

Source:

• mod.js, line 1

Example

{
    "id": "modID",
    "name": "My mod",
    "version": "1.0.0",
    "description": "A description of my mod.",
    "scripts": ["mod.js"],
    "assets": [
        {
            "key": "myImage",
            "url": "assets/image.png"
        },
        {
            "key": "Queen-Body-Default",
            "url": "assets/queen.png"
        }
    ]
}