* Add back stream idle mode
* Shut up codespell
* Correct serialization; only expose at user level
* cargo fmt
* tsc lint fmt
* Move engineStreamMachine as a global actor; tons of more work
* Fix up everything after bumping kittycad/lib
* Remove camera sync
* Use pause/play iconology
* Add back better ping indicator
* wip
* Fix streamIdleMode checkbox being wonky
* yarn fmt
* Massive extinction event for waitForExecutionDone; try to stop projects view switching from crashing
* Clear diagnostics when unmounting code editor!
* wip
* Rework initial root projects dir + deflake many projects tests
* More e2e fixes
* Deflake revolve some revolve tests
* Fix the rest of the mfing tests
* yarn fmt
* yarn lint
* yarn tsc
* Fix tsc after rebase
* wip
* less flaky point and click
* wip
* Fixup after rebase
* Fix more tests
* Fix 2 more
* Fix up named-views tests
* yarn fmt lint tsc
* Fix up new changes
* Get rid of 1 cyclic dependency
* Fix another cyclic mfer!
* fmt
* fmt tsc
* Fix zoom to fit being frigged
* a new list of circular deps
* Remove NetworkHealthIndicator test that was shit
* Fix the bad reload repeat issue kevin started on
* Fix zoom to fit at the right moments...
* Fix cache count numbers in editor test
* Remove a test race - poll window info.
* Qualify fail function
* Try something
* Use scene.connectionEstablished
* Hopefully fix snapshots at least
* Add app console.log
* Fix native menu tests more
* tsc lint
* Fix camera failure
* Try again
* Test attempt number 15345203, action!
* Add back old window detection heuristic
* Remove firstWindow to complete the work of 2342d04fe2
* Tweak some tests for MacOS
* Tweak "set appearance" test for MacOS
Revert this if it messes up any other platform's color checks!
* Are you serious? This was all that needed formatting?
* More color tweaks
Local MacOS and CI MacOS don't agree
* Fixes on apperance e2e test for stream idle branch (#6168)
pierremtb/stream-idle-revamp-appearance-fixes
* Another apperance fix
* Skip one native menu test to make stream idle green (#6169)
* pierremtb/stream-idle-revamp-more-fixes
* Fix lint
* Update snapshot for test_generate_settings_docs
---------
Co-authored-by: lee-at-zoo-corp <lee@zoo.dev>
Co-authored-by: Frank Noirot <frankjohnson1993@gmail.com>
Co-authored-by: Pierre Jacquier <pierrejacquier39@gmail.com>
Co-authored-by: Pierre Jacquier <pierre@zoo.dev>
272 lines
4.7 KiB
Markdown
272 lines
4.7 KiB
Markdown
---
|
|
title: "User Settings"
|
|
excerpt: "User specific settings for the app. These live in `user.toml` in the app's configuration directory. Updating the settings 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
|
|
---
|
|
|
|
# User Settings
|
|
|
|
User specific settings for the app. These live in `user.toml` in the app's configuration directory. Updating the settings 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.
|
|
|
|
## User Configuration Structure
|
|
|
|
```toml
|
|
[settings.app]
|
|
# Set the appearance of the application
|
|
[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 millimeters as the default measurement unit
|
|
base_unit = "mm"
|
|
|
|
[settings.text_editor]
|
|
# Disable text wrapping in the editor
|
|
text_wrapping = false
|
|
|
|
```
|
|
|
|
## 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
|
|
|
|
##### project_directory
|
|
|
|
Backwards compatible project directory setting.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### theme
|
|
|
|
Backwards compatible theme setting.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### theme_color
|
|
|
|
The hue of the primary theme color for the app.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### enable_ssao
|
|
|
|
Whether or not Screen Space Ambient Occlusion (SSAO) is enabled.
|
|
|
|
|
|
**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, teardown the stream after some time.
|
|
|
|
|
|
**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
|
|
|
|
|
|
#### 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
|
|
|
|
##### camera_projection
|
|
|
|
The projection mode the camera should use while modeling.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### camera_orbit
|
|
|
|
The methodology the camera should use to orbit around the model.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### mouse_controls
|
|
|
|
The controls for how to navigate the 3D view.
|
|
|
|
**Possible values:** `zoo`, `onshape`, `trackpad_friendly`, `solidworks`, `nx`, `creo`, `autocad`
|
|
|
|
**Default:** None
|
|
|
|
##### highlight_edges
|
|
|
|
Highlight edges of 3D objects?
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### show_debug_panel
|
|
|
|
Whether to show the debug panel, which lets you see various states of the app to aid in development. Remove this when we remove backwards compatibility with the old settings file.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### enable_ssao
|
|
|
|
Whether or not Screen Space Ambient Occlusion (SSAO) is enabled.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### show_scale_grid
|
|
|
|
Whether or not to show a scale grid in the 3D modeling view
|
|
|
|
|
|
**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
|
|
|
|
|
|
#### project
|
|
|
|
Settings that affect the behavior of project management.
|
|
|
|
|
|
**Default:** None
|
|
|
|
This setting has the following nested options:
|
|
|
|
##### directory
|
|
|
|
The directory to save and load projects from.
|
|
|
|
|
|
**Default:** None
|
|
|
|
##### default_project_name
|
|
|
|
The default project name to use when creating a new project.
|
|
|
|
|
|
**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
|
|
[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 millimeters as the default measurement unit
|
|
base_unit = "mm"
|
|
|
|
[settings.text_editor]
|
|
# Disable text wrapping in the editor
|
|
text_wrapping = false
|
|
|
|
``` |