YAML/JSON Configuration

Whim can be configured using YAML. During installation, Whim will install this template to your .whim directory. JSON is also supported, in the form of whim.config.json.

Integration with C# scripting is also possible - see YAML/JSON and C# integration.

Schema

Whim's YAML and JSON configuration is validated using a JSON schema, which provides autocompletion and validation in supported text editors, like Visual Studio Code.

The schema can be found in your Whim installation at WHIM_PATH/plugins/Whim.Yaml/schema.json (replace WHIM_PATH with the path to your Whim installation). The latest schema is available here.

To use the schema in your YAML file, add the following line at the top of your file:

# yaml-language-server: $schema=WHIM_PATH/plugins/Whim.Yaml/schema.json

To use the schema in your JSON file, add the following line at the top of your file:

{
  "$schema": "WHIM_PATH/plugins/Whim.Yaml/schema.json",
  ...
}

Errors

Whim will make a best effort to load the parts of the configuration that are valid, even if there are errors in other parts of the configuration. Errors will be shown in:

• your text editor (provided your text editor supports YAML/JSON validation)
• a window that opens when Whim starts
• log files in your .whim directory