Skip to content
This repository was archived by the owner on Sep 21, 2024. It is now read-only.

Application manifest file

Vitor Lopes edited this page Mar 18, 2017 · 11 revisions

Every application package should contain a manifest file named application-settings.json, it will tell JAK (Jade Application Kit) your application name, version, window size, author, and tell the browser how to behave and display that information for the user.

application-settings.json is in json format!

 {
  "application": {
  
  "name":        "my application name",
  "description": "some description",
  "version":     "0.1",
  "author":      "your name",
  "url":         "your application url",
  "license":     "GPL"
  
  },
  
  "window": {
    
    "hint_type":   "", 
    "width":       "800",
    "height":      "600",
    "fullscreen":  ""
    "resizable":   "",  
    "decorated":   "",  
    "transparent": ""  
    
  },
  
  "webkit": {
  
    "debug":  "yes"   
  }
}

Required Fields

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

Manifest File Options

hint_type:

  • you have 3 options:

    • The keyword 'dock' can be used to create panels or widgets.
    • The keyword 'desktop' will spawn a fullscreen undecorated window that will stay below all windows.
    • No keyword is needed for a normal application window.

width and height:

  • desired window width and height dimensions

fullscreen:

  • Type 'yes' for fullscreen window which will override width and height
  • Default value is not full screen when left blank, specified sizes in width and height will be used

resizable:

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

decorated:

  • If left blank the default value will be 'yes' and show window decorations or alternatively type 'no' to remove window decorations

transparent:

  • The default value when left blank will show a solid background, type 'yes' for a transparent window

debug

  • The default value when left blank will be production mode, type 'yes' for debug mode. Alternatively you can use '-d' in the command line for debug mode.
Clone this wiki locally