Page tree
Skip to end of metadata
Go to start of metadata

All information about your package resides in a manifest file that is loaded by the host process. It describes the modules in the package, and the files and metadata for each module. For a manifest to be usable by a retail WinGate, it needs to be signed with the Manifest Prep tool which is found in the tools directory of the SDK. For developing your modules in Developer Mode you do not need to sign your manifest file.

Here is an example manifest file. 

 

 

<wingatePackage>

All packages must have this node, along with a packageVersion attribute with a value of "1.0". The Manifest Prep tool will fail if this node is not present. 

<package>

Describes the package as a whole. See About Packages, Modules, Components and Interfaces for more information.

id - The UUID of your package.

name - The user displayable name of your package.

description - A user displayable description of your package.

<modules>

Root node for the modules within your package. There can be any number of modules in a package.

<module>

Describes a single module within your package. 

name - User friendly name of this module.

You may wish to distinguish between the UI or Engine versions of your module when specifying the name in order to make it easier to identify in the Modules panel in the WinGate Management Console

host - What host should be used to load this module. Acceptable values are "UI", "Engine" and "All". Only specified hosts will attempt to load the module.

id - The UUID of the module, including the braces.

mandatory - Whether this module is mandatory and therefore cannot be disabled by a user.

subPath - Must be empty.

debugPath - The path relative to the manifest file where module files are located when running in debug mode. NOTE: Only valid when running with a WinGate Developer License

releasePath - The path relative to the manifest file where module files are located when running in release mode. NOTE: Only valid when running with a WinGate Developer License

debugPath and releasePath attributes are stripped by the Manifest Prep tool.

<dependencies>

Root path for module dependencies. See About Packages, Modules, Components and Interfaces for more information.

<dependency>

Describes a single dependency file for the enclosing module. 

file -  The filename of the file

entryPoint - Indicates whether this file is considered the Entry Point for the module. Value values are "1" and "0"

<md5>

value - Filled out by the Manifest Prep tool with the MD5 of this dependency file's contents. Leave blank.

<platform>

os - The operating system that this dependency will be synchronised for. Supported values are WinAny, WinNt351, WinNt4, WinXp, Win2k, Win2k3, WinVista, Win7, Win2k8, Win2k8R2, Win2k12, Win2k12R2, Win8, Win81, Win10

<destination>

value - Where the dependency's destination is. Values are:

local - File is placed in the same location as the manifest file

shared - File is placed in the WinGate installation directory

<signInfo>

path - The folder that holds the final version of this dependency that should be signed. See SourceRoot for more information.

 

 

 

  • No labels