Application manifest file

Every application should contain a manifest file named settings.json.

settings.json is in json format!

    "app": {
        "name": "Application name",
        "description": "Application description",
        "version": "v0.2.3",
        "author": "your name",
        "url": "your Application url",
        "license": "your license"
    },
    "window": {
   "hint_type" : "leave empty for a standard window",
        "width": 1024,
        "height": 768,
        "full_screen": true,
        "resizable": true,
        "decorated": false,
        "transparent": false,
        "icon": "/logo.svg"
    },
    "webkit": {
        "debug": true,
        "cache": "local",
        "context_menu": true,
        "user_agent": "your user agent",
        "same_frame": ""
    }
}	

Required Fields

The manifest file must provide all the following fields in its settings.json descriptor file, all the fields are string type:

Manifest File Options

hint_type:

• 11 options:

• type string lowcase

  • The keyword 'dock' can be used to create panels or widgets that will stay on top of any other window.
  • The keyword 'desktop' will spawn a fullscreen undecorated window that will stay below all windows.
  • No keyword is needed for a default decorated window.
  • More info - https://lazka.github.io/pgi-docs/#Gdk-3.0/enums.html#Gdk.WindowTypeHint

width and height:

• type integer
• desired window width and height dimensions, will be ignored if fullscreen is true.

fullscreen:

• type boolean
• fullscreen window which will override specified width and height

resizable:

• If left blank the default value 'yes' will be used or alternatively type 'no' for a fixed size window

decorated:

• type boolean
• activate or remove window decorations

transparent:

• type boolean
• transparent window background, not working

debug

• type boolean
• Alternatively you can use 'jak -d' in the command line for debug mode.

cache

• type string

• without settings.json default will be local.

• 3 options:

• Leave empty to disable the cache completely, which substantially reduces memory usage. Useful for applications that only access a single local file, with no navigation to other pages, no remote resources will be cached.

• local - A cache model optimized for viewing a series of local files -- for example, a documentation viewer or a website designer. WebKit will cache a moderate number of resources.

• online - Improve document load speed substantially by caching a very large number of resources and previously viewed content. Cookies, DNS prefetch and offline web application cache will also be activated.