Manifest

Every extension archive must include a manifest.json file at the root level. The manifest describes which slots your extension occupies, how pages map to those slots, and optionally defines backend actions.

Minimal Example

{
    "version": "v2.0",
    "views": {
        "slots": [
            "EXTENSION_SLOT_RIGHT_OVERLAY", 
            "EXTENSION_SLOT_MAIN_GAME_FUN", 
            "EXTENSION_SLOT_BACKGROUND"],
        "pages": {
            "rightOverlay": "rightOverlay.html",
            "mainGameFun": "mainGameFun.html",
            "background": "background.html"
        },
        "resolveSlotPageScript": "resolveSlotPage.js"
    }
}

Full Example

{
  "version": "v2.0",
  "views": {
    "settings": "settings.html",
    "slots": [
            "EXTENSION_SLOT_MAIN_SEX_TOY", 
            "EXTENSION_SLOT_MOVEABLE_OVERLAY", 
            "EXTENSION_SLOT_BACKGROUND"],
    "pages": {
      "menu": "menu.html",
      "overlay": "overlay.html",
      "background": "background.html"
    },
    "resolveSlotPageScript": "resolveSlotPage.js"
  },
  "moveableSlot": {
    "width": 400,
    "height": 600
  },
  "storage": {
    "mutexes": [
      {
        "name": "game_round",
        "read": "everyone",
        "write": "everyone"
      }
    ],
    "strings": [
      {
        "name": "chat_log",
        "read": "everyone",
        "write": "everyone"
      }
    ],
    "ints": [
      {
        "name": "total_votes",
        "read": "everyone",
        "write": "everyone"
      }
    ],
    "top": [
      {
        "name": "tips",
        "read": "everyone",
        "write": "model"
      }
    ]
  },
  "actions": []
}

Fields Reference

Top-level Fields

Field	Type	Required	Description
version	string	Yes	Manifest format version. Must be "v2.0".
views	object	Yes	Defines the rendering contract — slots, pages, resolver, and settings.
moveableSlot	object	Conditional	Required when EXTENSION_SLOT_MOVEABLE_OVERLAY is listed in views.slots.
storage	object	No	Declares Extension Storage keys and mutexes used by the storage data APIs.
actions	array	No	Backend action definitions. See Backend Actions.

views Object

Field	Type	Required	Description
views.slots	string[]	Yes	Array of slot names your extension occupies.
views.pages	object	Yes	Map of page names to HTML file paths. Each key is an arbitrary name; each value is a path to an HTML file in the archive.
views.resolveSlotPageScript	string	Yes	A script that maps each slot to a page key from views.pages at runtime. See Resolve Slot Page.
views.settings	string	No	Settings HTML entry point. See Extension Settings.

moveableSlot Object

Defines the dimensions of the moveable overlay container. Required only when views.slots includes "EXTENSION_SLOT_MOVEABLE_OVERLAY".

Field	Type	Required	Description
moveableSlot.width	number	Yes	Width of the moveable overlay in pixels. Must be a positive integer, max 450px.
moveableSlot.height	number	Yes	Height of the moveable overlay in pixels. Must be a positive integer, max 740px.

storage Object

Declares the keys and mutexes your extension uses with the Extension Storage data APIs.

Field	Type	Required	Description
storage.mutexes	StorageEntry[]	No	Mutex names for exclusive lock, unlock, and state operations.
storage.strings	StorageEntry[]	No	String storage keys used by string get, set, and append operations.
storage.ints	StorageEntry[]	No	Integer counter keys used by counter get, increment, and reset operations.
storage.top	StorageTopEntry[]	No	Top counter keys used by leaderboard-style top get, increment, and reset operations.

Storage Entry Object

Each entry in storage.mutexes, storage.strings and storage.ints uses the same shape.

Field	Type	Required	Description
name	string	Yes	Key or mutex name. Must be unique within its list and 1-256 UTF-8 bytes long. Dynamic segments may use exactly {uint64} or {string} placeholders, for example user_{uint64}_state.
read	string	Yes	Read permission for this resource. Allowed values: owner, owner_and_model, everyone, model.
write	string	Yes	Write permission for this resource. Allowed values: owner, owner_and_model, everyone, model.

Storage Top Entry Object

The storage.top array has different allowed values for the write field. Only models can write to the top storage.

Field	Type	Required	Description
name	string	Yes	Key or mutex name. Must be unique within its list and 1-256 UTF-8 bytes long. Dynamic segments may use exactly {uint64} or {string} placeholders, for example user_{uint64}_state.
read	string	Yes	Read permission for this resource. Allowed values: owner, owner_and_model, everyone, model.
write	string	Yes	Write permission for this resource. Allowed values: model.

• v1.storage.string.set, v1.storage.string.get, and v1.storage.string.append
• v1.storage.int.get, v1.storage.int.increment, and v1.storage.int.reset
• v1.storage.mutex.lock, v1.storage.mutex.unlock, and v1.storage.mutex.getState
• v1.storage.top.get, v1.storage.top.increment, and v1.storage.top.reset

Slots

The views.slots array determines which UI slots your extension will render into. Available slot keys depend on the extension category selected in the Extension Platform.

Each slot listed in views.slots must have a corresponding HTML page mapped through views.pages and the resolver script.

For a detailed explanation of what each slot does and where it appears in the UI, see Extension Slots.