INSTRUMENTS / GENERATORS

Dashboard: Component API

This page explains how to customize and create new components for Dashboard.

Basics

A Dashboard component is built of an initialization file (*.INI) and a set of bitmap images (*.BMP, *.JPG and *.TGA are supported) that define the component appearance (skin). The INI files resides in the Artwork folder of Dashboard ([FL Studio]/Plugins/Fruity/Generators/Dashboard/Artwork), or in subfolder of that folder. The images can be placed anywhere, but it is best to place them where the INI file is, so you can reference the images directly, without path.

There can be several section in the INI file:

Each section contains one or more properties. A property entry looks like this:

propertyName=value

For ease of use, it is best to use relative paths when you link to image files. You can link to a folder relative to the INI position or the Artwork folder:

INI File Sections

The INI file contains the following sections:

[Info] Section

You should include these properties in the info section:

[Properties] Section

This section defines the values to be used for the properties of a control. They are all optional. You can see a full list of properties you can set here in the component inspector for each component.

[Items] Section

This section is only valid for selectors and patch selectors. It defines the values that will be available in the selector. The values are specified as a list of text lines (each line is a value) ending with "=":

valueName=

For patch selector controls, you also include the bank and program numbers that correspond to the instrument names:

valueName=Bank MSB, Bank LSB, Program Number

EXAMPLE:

[items]
100% Left=
50% Left=
Centered=
50% Right=
100% Right=

Component Types

This is a more in depth description for each component type (you specify in the Kind property).There are currently ten different control kinds.

DigiWheel (Kind=0)

This additional parameter is supported in the [Properties] section (not visible in the component inspector):

Slider (Kind=1)

Wheel (Kind=2)

This additional parameter is supported in the [Properties] section (not visible in the component inspector):

Panel (Kind=3)

This additional parameter is supported in the [Properties] section (not visible in the component inspector):

Switch (Kind=4)

Label (Kind=5)

Image (Kind=6)

Selector (Kind=7)

Patch Selector (Kind=8)

Page Selector (Kind=9)

Notes & Tips