Files
modeling-app/docs/kcl-src/settings.md
Nick Cameron 16f5d9c284 Docs improvements (#6615)
Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-01 08:56:27 -07:00

1.6 KiB

title, excerpt, layout
title excerpt layout
KCL Settings Documentation of settings for the KCL language and Zoo Design Studio. manual

KCL Settings

There are three levels of settings available in Zoo Design Studio:

  1. User Settings: Global settings that apply to all projects, stored in user.toml
  2. Project Settings: Settings specific to a project, stored in project.toml
  3. Per-file Settings: Settings that apply to a single KCL file, specified using the @settings attribute

Configuration Files

Zoo Design Studio uses TOML files for configuration:

Per-file settings

Settings which affect a single file are configured using the settings attribute. This must be at the top of the KCL file (comments before the attribute are permitted). For example:

// The settings attribute.
@settings(defaultLengthUnit = in)

// The rest of your KCL code goes below...

x = 42 // Represents 42 inches.

The settings attribute may contain multiple properties separated by commas. Valid properties are:

  • defaultLengthUnit: the default length unit to use for numbers declared in this file.
    • Accepted values: mm, cm, m, in (inches), ft (feet), yd (yards).
  • defaultAngleUnit: the default angle unit to use for numbers declared in this file.
    • Accepted values: deg (degrees), rad (radians).

These settings override any project-wide settings (configured in project.toml or via the UI).