Template Manifest

The manifest describes the characteristics of your Code. It is necessary to create the Template and present it in the Stagecast Store so it can be selected and configured by the event organizers.

Template Manifest

Manifest Schema

{
  "bundleId": "<string>",
  "version": "<string>",
  "category": "<string>",
  "description": "<string>",
  "tags": "<string[]>",
  "template": {
    "name": "<string>",
    "displayName": "<string>",
    "defaultMessage": "<string>",
    "labels": "<string[]>",
    "icons": [
      {
        "size": "<number>",
        "url": "<string>",
        "name": "<string>",
        "type": "<string>",
        "contentId": "<string>"
      }
    ],
    "presentation": {
      "screenshots": "<string[]>",
      "cover": "<string>",
      "body": "<string>"
    },
    "plugins": "<string[]>",
    "branding": {
      "brandActivation": "<boolean>",
      "theming": "<boolean>",
      "defaultTheme": "<string>"
    },
    "screens": {
      "mobile": "<string>",
      "stage": "<string>"
    },
    "general": {
      "type": "<string>",
      "accessibility": "<string[]>",
      "hasModeration": "<boolean>",
      "isInteractive": "<boolean>",
      "isFeedContent": "<boolean>",
      "feedItemTitle": "<string>",
      "supportedLanguages": "<string[]>"
    },
    "provider": {
      "developer": "<string>",
      "org": "<string>",
      "support": "<string>"
    }
  }
}

manifest.json Example

Root Fields:

• bundleId: the unique template identifier. The suggested format is com.<org_name>.<moment_title> eg. com.stagecast.voting.

• version: the current semantic version .

• category: the name of the category the template falls into. (currently available options: marketing, utils, crowd game, special effect , if your moment doesn't fall into any of these categories, please propose one to our support team).

• description: a brief description of the moment (no more than 140chars)

• tags: a list of tags that could make the search easier

• template: the template body

Template fileds:

• name: the moment title in com.<org_name>.<moment_title>

• displayName: a nice name for smaller screens.

• defaultMessage: the default message that will appear in the mobile push notifications. This default message can be disabled or overwritten by the event organizer;

• labels: a list of label to be applied to the template (eg. "free", "new" etc..)

• icons: the template icons as a list of objects in the following format

  • size

  • url

  • name

  • type

  • contentId

• presentation

  • screenshot: a list of screenshot that will be displayed in the moment description page

  • cover: the template cover image for the description page

  • body: the html of the description page

• plugins: the list of supported plugins. Right now we only offer the sponsors and theming plugins

• branding:

  • brandActivation:

  • theming:

  • defaultTheme: can be left empty

• screens: the supported screen (mobile, results, moderation)

• general

  • type: native or html. You are most likely implementing an html based moment, not a native one.

  • accessibility: where the moment runs.

  • hasModeration:

  • isInteractive: is it a full screen moment?

  • isFeedContent: is it a feed moment

  • feedItemTitle: only if it is a feed moment

  • supportedLanguages: the supported languages as a list of 2-char strings

• provider

  • developer: the developer name

  • org: the organization name

  • support: an email contact