Configuration File Format

Configuration files are JSON files. For complete details on the JSON specification, see http://www.json.org/.

Required Fields

• source_telemetry: The path to the directory where the captured source telemetry is located.
• output_video: The path and filename for the output video.

Optional Fields

• backdrop: The path and filename to an image used as the background for title and results screens.
• column_margin: An integer value that determines the gap between columns of data in title and results screens.
• font: The path and filename to the font file used for most text.
• font_color: An array with 3 integer elements, describing the red, green, and blue values of the font color.
• font_size: An integer value that determines the font size used for most text.
• heading_color: An array with 3 integer elements, describing the red, green, and blue values of the color of the heading on title and results screens.
• heading_font: The path and filename to the font file used for heading text.
• heading_font_color: An array with 3 integer elements, describing the red, green, and blue values of the heading font color.
• heading_font_size: An integer value that determines the font size used for heading text.
• heading_text: The main heading text used on title and results screens.
• logo: The path and filename to an image used as a logo on the backdrop for title and results screens, located in the lower-right corner.
• logo_height: Height of the logo on the backdrop for title and results screens, located in the lower-right corner.
• logo_width: Width of the logo on the backdrop for title and results screens, located in the lower-right corner.
• margin: An integer value that determines the margin around most elements in the layout.
• participant_config: An object containing objects for each driver in the race. The name of each object is the driver's name as it appears in the telemetry, and contains the following:
  • car: Optional string with the car name.
  • display: Optional string with the name to use for displaying the driver's name. If omitted, the object name is used.
  • points: Optional integer with the driver's current series points.
  • short_display: Optional string with the short version of the name to use for displaying the driver. If omitted, the object name is used.
  • team: Optional string with the team name.
• point_structure: An array containing the series point structure. The first entry is the number of points awarded for the fastest lap in the race; additional entries are the number of points awarded for each finish position.
• result_lines: An integer value that determines how many lines should be displayed on title and results screens.
• series_logo: The path and filename to an image file to use as a series logo in the header. The image is automatically scaled so that the height of the image is equal to the height of the header.
• show_champion: If true, the series champion result card is shown.
• source_video: The path and filename to the video file to use as the source video.
• subheading_text: The subheading text used on title and results screens.
• sync_racestart: A decimal value that determines the delay between the start of video playback and the start of telemetry playback, and is guaranteed to confuse you.
• video_skipend: A decimal value indicating the time the source video should cease playback.
• video_skipstart: A decimal value indicating the time the source video should start playback.