The config.json file

The config.json file

This file provides some settings of the application, like the colors or the default values. It allows to fill directly the application when you launch it. Here's the list of all commands.

Note: bool variables values can be 0 (false) or 1 (true).

app_name

str The name of the application, displayed in at the top left of the window.

app_version

str Version of the application. Displayed at the top of the window.

check_ffmpeg

(since v1.1.5)

bool Try to detect FFMPEG. If FFMPEG isn't detected, an error window will appear and the program wont start.

colors

dict Colors used in the application. Each color is a str, which is a hex color in the #rrggbb format.

• red: the color of red buttons or text.
• green: the color of green buttons or text.
• link: the color of links in the window, which opens the web browser to a specific url.
• title: text color of the title displayed at the top left of the window.
• top_background: color of the background at the top of the window.

delete_files_when_cancel

bool: Used when during the export, the export is manually stopped ('Cancel' button for example). If 1, the generated files (the folder and eventually the .osz file) will be deleted.

init

dict All value of the widgets when the application is opened.

• song_title (str): The song title.

• song_artist (str): The song artist.

• username (str): The osu! username of the mapper. Should be the user of this app.

• audio_1 (str): Path to the audio 1 file (a .ogg audio).

• audio_2 (str): Path to the audio 2 file (a .ogg audio).

• audio_1_volume (int): Volume /100 of the audio 1.

• audio_2_volume (int): Volume /100 of the audio 2.

• audio_offset (int): Offset in milliseconds of the audio.

• meter (str): Meter of the map. Must be in the format "n/4" where n is a number between 1 and 7 included.

  Example:

  "meter": "4/4"

• unique_bpm (bool): Check or not the option 'Unique BPM'.

• unique_bpm_value (float): BPM value if the option 'Unique BPM' is checked.

• difficulties (dict): dictionary used for the difficulties to make. The keys are the difficulties names and their elements an array of 2 elements: [map_type, fnf_chart], where

  • map_type (str): type of the map. See Map types. You must write the full name.
  • fnf_chart(str): path to the FnF chart file, which is a .json file.

  Example:

  "difficulties": {
      "normal": [
          "[4K] Player 1 (Boyfriend)",
          "/home/fnf/assets/data/milf/milf.json"
      ],
      "hard": [
          "[4K] Player 1 (Boyfriend)",
          "/home/fnf/assets/data/milf/milf-hard.json"
      ]
  }

• background (str): path to the bakcground file (can be nothing, a .jpg, a .png, or any picture file supported by osu!)

url_ffmpeg_tutorial

(since v1.1.5)

str Url to a FFMPEG installation tutorial(s).

url_github

str Url to the GitHub of this application. Used when the user click the 'GitHub' link.

url_help

str Url to the help/documentation of this application. Used when the user click the 'Help' link.

verify_inputs

(since v1.1)

bool Check inputs before exporting and error message will spawn if needed.