Skip to content

Preset Configuration

Fredrik Hubinette edited this page Dec 30, 2019 · 12 revisions

In Proffie OS the term Preset means the combination of:

  • Sound Font
  • Music Track
  • Color Style

Presets are defined in object array of type Preset. A single Preset looks something like this:

{
  "fontdir",
  "tracks/track.wav",
  style definition, // NUM_BLADES specifies how many style definitions there are
  "description",
}

Sound Font ("fontdir")

The first part of a preset is the directory of the sound font. ProffieOS supports most of the major sound font formats that are widely used. Sound-playing engine automatically detects through the files in the directory and switches to the appropriate mode.

  • Plecter-style Fonts (Including CFX style fonts, from ProffieOS 3.x)
  • Nec-styled Fonts
  • Smooth Swing V1
  • Smooth Swing V2

Note: Font directory should not exceed 8 characters

Note: Default sample rate in ProffieOS is 44kHz so all sounds with lower sample rates are upsampled automatically.

Music Track ("tracks/track.wav")

In the second field is configured the audio track which can be used for soundtrack music or ambient sound in parallel to the rest of the sounds that are played by the saber. Music Track invoke is configured to be runned via button combination or with Command send via the Serial port/Bluetooth module.

Style definition

The style definition specifies the look and behavior of the blade itself. If more then one blade is used (NUM_BLADES is greater than 1) then more then one styles have to be defined in the current preset. Color styles allows many combinations with the help of template based prototypes (Colors, animations, statements) Color Style can be generated with the help of the Style Editor.

Preset Description

The last element in a preset is the Preset Name. It is in the form of a character string. The preset name is used by BLE, WebUSB and OLED screens to identify the preset. The preset description generally uses the StarJedi font.

Clone this wiki locally