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

Application manifest file

Vitor Lopes edited this page Oct 7, 2016 · 11 revisions

Every app package should contain a manifest file named app.json, it will tell JAK your app name, version, window size, author, and tell the browser how to behave and display that information for the user.

app.json is in json format!

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

Required Fields

Each manifest file must provide all the following fields in its app.json descriptor file:

Manifest Options

hint_type:

  • you got 3 options:

    • ( type string )
    • dock can be used to create panels or widgets.
    • desktop will spawn a fullscreen undecorated window that will stay below all windows.
    • leave blank for a normal application window.

icon:

  • ( type string )
  • path to your icon file

width, height:

  • ( type int )
  • desired window width, height

fullscreen:

  • ( type string )
  • will override width, height
  • leave blank and above sizes will be used or type "yes"

resizable:

  • ( type string )
  • leave blank or type "no"

decorated:

  • ( type string )
  • leave blank for decorations or type "no"

transparent:

  • ( type string )
  • leave blank for normal or type "yes"

debug

  • ( type string )
  • leave blank or type "yes", you can also use (-d option in the command line).
Clone this wiki locally