Create your own package

Please contact us on Discord if you have any additional questions: https://discord.gg/pmAtpESgbH

Please check "examples" folder to get some ideas. You can find it by clicking on the OPEN PACKAGES DIRECTORY button and going into examples folder.

Feature video preview

Files structure

Folder

Each package is a folder with a following structure: {AirlineICAO}_{AuthorName}, where you'll have to replace {AirlineICAO} and {AuthorName}.

Examples:

WZZ_FlyingArt - for WizzAir airline, author FlyingArt
LOT_TestAuthor - for LOT Polish Airlines, author TestAuthor
_John - for ALL airlines, author John

Manifest file

Each package should contain manifest.json file with the following structure:

{
"name": "Airline Name",
"description": "Example package",
"version": "1.0"
}

You can put here full airline name, some description and set package version.

Audio and Video files

Audio and video files are located under audio directory. Each file name can handle multiple configuration options in it. Cabby will determine for which flight stage certain file is.

Examples

Example configuration:

languages=EN,category=crew-safety-briefing,id=1,weight=1,aircraftICAO=B788.mp4

video (.mp4 file format)
languages: EN
category: crew-safety-briefing
id: 1 (it's not mandatory)
weight: 1 (it's not mandatory)
aircraftICAO: B788 (Dreamliner)

That means this safety briefing will be played only for LOT Polish Airlines flights with one of the languages set to English and aircraft B788.

Another example

category=crew-boarding,repeat=1.mp3

audio (.mp3 file format)
no languages argument: that means this can be played regardless of languages set
category: crew-boarding
repeat: 1 (that means this file will be played repetitively)

The last example

languages=EN+PL,category=crew-safety-briefing,timeout=5-10.mp4:

video (.mp4 file format)
category: crew-safety-briefing
languages: English and Polish (joined by '+' symbol)
timeout: 5-10 (that means this file will be played between 5 and 10 seconds after the message trigger is activated)

This video will be played for all LOT Polish Airlines flights, regardless of the aircraft type. The only condition that has to be meet - English AND Polish has to be set as flight languages

File arguments

As you can see - file name consists of arguments, joined by , symbol.

Available arguments:

languages - language codes joined by + symbol
category - mandatory! name of the announcement category (see list below)
id - this is not mandatory, however it may be helpful if you'll have multiple files with same conditions set (same names) - id can be used to distinct them
weight - it's not mandatory, however: if you encounter scenario as described above - Cabby will randomly pick one of the message for given category. Weight parameter may be used if you want to hear some file more often that another
originICAO - not mandatory. If you want to prepare some specific message for a specific route - this may be helpful
destinationICAO - as above
aircraftICAO - as above. If you want to use some message specifically for a given aircraft
chime - if chime sound should be played before your audio. Available values: DING, DONG, DING_DONG
repeat - if set to 1 audio file will repeat (for example during boarding)
timeout - not mandatory. If you want to set a timeout for the message. For example: timeout=0-30 will start playing this message between 0 and 30 seconds after the message trigger is activated

Please visit our Discord https://discord.gg/pmAtpESgbH if you'd like to share your work. Thank you!

Feature video preview​

Files structure​

Folder​

Manifest file​

Audio and Video files​

Examples​

File arguments​

Available categories​

Sharing your package​