2fee3a424c
* Fix various docs errors around std module Signed-off-by: Nick Cameron <nrc@ncameron.org> * remove KCL from lang docs titles and move settings docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Include functions declared in Rust in module docs Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
187 lines
3.4 KiB
Markdown
187 lines
3.4 KiB
Markdown
---
|
|
title: "Project Settings"
|
|
excerpt: "Project specific settings for the app. These live in `project.toml` in the base of the project directory. Updating the settings for the project in the app will update this file automatically. Do not edit this file manually, as it may be overwritten by the app. Manual edits can cause corruption of the settings file."
|
|
layout: manual
|
|
---
|
|
|
|
# Project Settings
|
|
|
|
Project specific settings for the app. These live in `project.toml` in the base of the project directory. Updating the settings for the project in the app will update this file automatically. Do not edit this file manually, as it may be overwritten by the app. Manual edits can cause corruption of the settings file.
|
|
|
|
## Project Configuration Structure
|
|
|
|
```toml
|
|
[settings.app]
|
|
# Set the appearance of the application
|
|
name = "My Awesome Project"
|
|
|
|
[settings.app.appearance]
|
|
# Use dark mode theme
|
|
theme = "dark"
|
|
# Set the app color to blue (240.0 = blue, 0.0 = red, 120.0 = green)
|
|
color = 240.0
|
|
|
|
[settings.modeling]
|
|
# Use inches as the default measurement unit
|
|
base_unit = "in"
|
|
|
|
```
|
|
|
|
## Available Settings
|
|
|
|
### settings
|
|
|
|
|
|
|
|
#### app
|
|
|
|
The settings for the Design Studio.
|
|
|
|
|
|
**Default:** None
|
|
|
|
This setting has the following nested options:
|
|
|
|
##### appearance
|
|
|
|
The settings for the appearance of the app.
|
|
|
|
|
|
**Default:** None
|
|
|
|
This setting has further nested options. See the schema for full details.
|
|
##### onboarding_status
|
|
|
|
The onboarding status of the app.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### dismiss_web_banner
|
|
|
|
Permanently dismiss the banner warning to download the desktop app. This setting only applies to the web app. And is temporary until we have Linux support.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### stream_idle_mode
|
|
|
|
When the user is idle, and this is true, the stream will be torn down.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### allow_orbit_in_sketch_mode
|
|
|
|
When the user is idle, and this is true, the stream will be torn down.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### show_debug_panel
|
|
|
|
Whether to show the debug panel, which lets you see various states of the app to aid in development.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### named_views
|
|
|
|
Settings that affect the behavior of the command bar.
|
|
|
|
|
|
**Default:** None
|
|
|
|
|
|
#### modeling
|
|
|
|
Settings that affect the behavior while modeling.
|
|
|
|
|
|
**Default:** None
|
|
|
|
This setting has the following nested options:
|
|
|
|
##### base_unit
|
|
|
|
The default unit to use in modeling dimensions.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### highlight_edges
|
|
|
|
Highlight edges of 3D objects?
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### enable_ssao
|
|
|
|
Whether or not Screen Space Ambient Occlusion (SSAO) is enabled.
|
|
|
|
|
|
**Default:** None
|
|
|
|
|
|
#### text_editor
|
|
|
|
Settings that affect the behavior of the KCL text editor.
|
|
|
|
|
|
**Default:** None
|
|
|
|
This setting has the following nested options:
|
|
|
|
##### text_wrapping
|
|
|
|
Whether to wrap text in the editor or overflow with scroll.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### blinking_cursor
|
|
|
|
Whether to make the cursor blink in the editor.
|
|
|
|
|
|
**Default:** None
|
|
|
|
|
|
#### command_bar
|
|
|
|
Settings that affect the behavior of the command bar.
|
|
|
|
|
|
**Default:** None
|
|
|
|
This setting has the following nested options:
|
|
|
|
##### include_settings
|
|
|
|
Whether to include settings in the command bar.
|
|
|
|
|
|
**Default:** None
|
|
|
|
|
|
|
|
|
|
## Complete Example
|
|
|
|
```toml
|
|
[settings.app]
|
|
# Set the appearance of the application
|
|
name = "My Awesome Project"
|
|
|
|
[settings.app.appearance]
|
|
# Use dark mode theme
|
|
theme = "dark"
|
|
# Set the app color to blue (240.0 = blue, 0.0 = red, 120.0 = green)
|
|
color = 240.0
|
|
|
|
[settings.modeling]
|
|
# Use inches as the default measurement unit
|
|
base_unit = "in"
|
|
|
|
``` |