DSL of desktopStarter

desktopStarter DSL

A desktopStarter is an application. It can be a single standolone desktop app, a shortcut from the program menu or a special runAfter {} or runBeforeUninstall {} application of the setup.

Desktop Starters can usually be defined multiple times.

The following options are available to desktopStarter:

desktopStarter {

    displayName   = "My Application Service" 
    
    description   = "This is an Application service"
    
    // optional, main jar file of the service. Defaults to setupBuilder.mainJar
    mainJar       = "MyApplication.jar"
    
    // optional, main class of the service. Defaults to setupBuilder.mainClass
    mainClass     = "com.application.my.Service"
    
    // an alternative executable. Overrides the mainJar and mainClass
    // either relative to installation root or absolute
    executable    = "myexecutable"
    
    // The working directory of the service, relative to installation root
    workDir        = "."
    
    // optional, additional arguments to start the service with
    startArguments = "--open"

    // optional, an icon file. Defaults to setupBuilder.icons
    icons          = "service.icns"
}

Please note, that several options default to the one defined by the setupBuilder base.

The following options extend the service functionality.

desktopStarter {

    // Supported mime types of the application (only for deb and rpm)
    mimeTypes = "text/html;text"
    
    // Categories of the application (only for deb and rpm)
    categories = "software;game"
	
    // Where should this desktopStarter item be placed? (Windows only)
    location = StartMenu
    
    // supported document types of the application.
    documentType { ... }
}

The following options add the capability to let the application respond to protocols:

desktopStarter {

    // optional, define a protocol scheme this desktopStarter responds to
    // must not contain characters other than a-z or A-Z
    // can be defined multiple times.
    scheme "reporting"
}

Hints

Property: location

The location property of a desktopStarter defines where it will be placed. The following options are available:

• StartMenu
• ApplicationMenu
• InstallDir
• DesktopDir

The property is available to Windows Builders only.

Property: documentType

This option can be defined multiple times to support several document types. The following properties are available:

documentType {

    // file extension to support. Can be defined multiple times
    fileExtension "*.rpt"
    
    // alternative syntax to add support for an extension
    fileExtension [ "*.rpt", "*.reportfile" ]
    
    // optional, name of the extension to display to users
    name = "This is my RPT extension"
    
    // optional, mime type of this document Type. Defaults to application/{fileExtension[0]}
    mimetype = "application/rpt"
    
    // optional, role of the given documentType. Used in macOS only.
    // allowed options: "Viewer", "Editor"
    role = "Viewer"
    
    // optional, icons of the file with the given type. Defaults to setupBuilder.icons
    icons = "fileType.icns"
}