Global

Type Definitions


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

description string

description of your mod

version string

version of your mod

compatible string

what minimum version of Queen's Brothel does this mod need

Source:
Example
{
    "id": "modID",
    "name": "My mod",
    "description": "A description of my mod.",
    "version": "1.0.0",
    "compatible": "0.7.3"
}

loadpackConfig

See https://photonstorm.github.io/phaser3-docs/Phaser.Loader.LoaderPlugin.html#pack__anchor for more info on Phaser asset packs
urls will be relative to your assets.zip directory

Type:
  • object
Properties:
Name Type Description
assetHeader object
Properties
Name Type Description
files array
Source:
Example
{
    "type": "script",
    "key": "myModScript",
    "url": "myMod.js"
},
{
    "type": "image",
    "key": "hotGirl",
    "url": "assets/hotGirl.png"
}