Skip to main content

The App Protocol

[Under Construction]​

A Stellaris Cloud "app" effectively amounts to a configuration object registered with the server which describes the resources the app provides. Those resources can include event/task handlers, custom folder and file actions, embedded UI elements and full size app content UIs with dedicated sidebar links.

{
  "publicKey": "-----BEGIN PUBLIC KEY-----\n ... \n-----END PUBLIC KEY-----\n",
  "description": "A dev module.",
  "actions": {
    "folder": [
      {
        "key": "DEV:SOME_DEV_ACTION_THAT_APPLIES_TO_A_FOLDER",
        "description": "Perform object recognition on all files in this folder."
      }
    ],
    "object": [
      {
        "key": "DEV:SOME_DEV_ACTION_THAT_APPLIES_TO_A_FOLDER_OBJECT",
        "description": "Perform object recognition on this object."
      }
    ]
  },
  "emittableEvents": [
    "DEV:CAT_FOUND",
    "DEV:DOG_FOUND"
  ],
  "menuItems": [{
    "name": "dev-main",
    "label": "Dev Module",
    "iconPath": "/assets/logo.png",
    "uiName": "main"
  }]
}