Online Help > Advanced

White Labeling

Description

 

The white label resources should be packaged inside a 7z (7-Zip https://www.7-zip.org) archive. The files in the archive should be a flat structure (no subdirectories).

 

The archive should include a manifest detailing the contents of the archive. Items that you don't want to include can be removed from the manifest, or simply have an empty value.

 

The archive should be named "branding.7z" and deployed one of the following location:

%APPDATA%\Wayk

%PROGRAMDATA%\Wayk

 

The application will prefer the file in %APPDATA%, if both are available.

 

Example of archive (not for distribution): https://cdn.devolutions.net/download/Documents/help-content/branding.7z

 

White Label Example - Windjammer

White Label Example - Windjammer

 

Format

 

manifest.json

 

{
    "languages": {

         "en": "en.json",

         "fr": "fr.json"

 },

 "colors": {

         "banner_brush": "#717171",

         "selected_brush": "#b8b8b8",

         "selected_pen": "#b8b8b8"

 },

 "images": {

         "logo_image": "windjammer_logo.png",

         "logo_image_2x": "windjammer_logo_2x.png",

         "left_banner_image": "windjammer_text.png",

         "left_banner_image_2x": "windjammer_text_2x.png",

         "right_banner_image": "windjammer_logo_white.png",

         "right_banner_image_2x": "windjammer_logo_white_2x.png",

         "message_box_warning": "windjammer_logo_black.png",

         "message_box_info": "windjammer_logo_black.png",

         "message_box_error": "windjammer_logo_black.png",

         "message_box_question": "windjammer_logo_black.png"

 },

 "icons": {

         "app_icon_ico": "windjammer_blue.ico",

         "app_modern_icon_ico": "windjammer_white.ico"

 },

 "strings": {

         "lblFree": "",

                 "wayk": {

                         "productName": "Windjammer Remote Assistant",

                         "productNameDen": "Windjammer Service Center"
    }
}

 

Archive contents

 

Icons

ICON

DESCRIPTION

app_icon_ico

A Windows icon in .ico format. This icon will be displayed in the taskbar, in the corner of every window, and in the system tray (pre-Windows 10).

app_modern_icon_ico

A Windows icon in .ico format. This icon will be displayed in the task bar on Windows 10 and newer. If a modern icon is not included in the archive, the app_icon will be used.

 

Images

IMAGE

DESCRIPTION

logo_image

A logo in .png format, used in various places (e.g. the "About" window). Recommended size is 64 x 64 with transparent background. On Wayk Now, this is the same image as right_banner_image.

logo_image_2x

A large version of logo_image for use on high DPI displays. It should be double the size (i.e. 128 x 128). If the 2x logo is not included in the archive, the logo_image will be scaled up. In Wayk Now, this is the same image as right_banner_image_2x.

left_banner_image

An image in .png format. Displayed on the left side of the banner on the main window. Maximum size is 288 x 72.

left_banner_image_2x

A large version of left_banner_image for use on high DPI displays. It should be double the size (i.e. up to 576 x 144). If the 2x logo is not included in the archive, the left_banner_image will be scaled up.

right_banner_image

An image in .png format. Displayed on the right side of the banner on the main window. Maximum size is 288 x 72.

right_banner_image_2x

A large version of right_banner_image for use on high DPI displays. It should be double the size (i.e. up to 576 x 144). If the 2x logo is not included in the archive, the right_banner_image will be scaled up.


For the banner images (left and right), the images are aligned left and right respectively, with 12px of padding on the left and right edges of the window (so even if you use the full 288 x 72 size, some of the background color will be visible). It is possible to use one large image of 576 x 72 (1152 x 114 for high DPI), split into two "slices".

message_box_warning

message_box_info

message_box_error

message_box_question

Image(s) in .png format displayed in the appropriate message boxes. Recommended size is 64 x 64 with transparent background.

 

Colors

COLOR

DESCRIPTION

banner_brush

The background color for the banner on the main window. Used as a highlight color in some other places (e.g. the drop target when drag and dropping a bookmark in the bookmarks window). Specified as a hex value.

selected_brush

The background color for various selections (e.g. the category in the options window, or the currently highlighted file transfer). Specified as a hex value.

selected_pen

The border color for various selections (e.g. the category in the options window, or the currently highlighted file transfer). Specified as a hex value.

 

Strings & Languages

Standard Wayk Now localization file(s) can be provided for strings you need to override.

 

The localization .json can be included directly in the strings section of the manifest. You can also provide a separate .json language file for every language you want to override. Language files must be listed in the languages section of the manifest.

The application doesn't make any guarantees for laying out very long strings. Strings that are significantly longer than the defaults may not display properly.

 

The application will look for strings in the following order:

 

FILE

DESCRIPTION

manifest.json

A good location for strings that you want to be the same in all languages (e.g. product name).

\{lang\}.json

(If provided)

en.json

(If provided)