Global

Type Definitions


assetConfig

Mods only support image files

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"

overwrite boolean

If you want to overwrite the game's current texture key with this one. Ex: Overwriting the key "Queen-Normal-Naked" will replace the naked queen picture with yours.

Source:
Example
{
    "key": "myImage",
    "url": "assets/image.png"
},
{
    "key": "Queen-Naked-Normal",
    "url": "assets/queen.png",
    "overwrite": true
}

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:
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-Normal-Naked",
            "url": "assets/queen.png",
            "overwrite": true
        }
    ]
}