Skip to content

Commit 0c55bd0

Browse files
committed
docs: add General settings documentation page
1 parent fe125f0 commit 0c55bd0

1 file changed

Lines changed: 112 additions & 0 deletions

File tree

docs/settings/general.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# General Settings
2+
3+
General settings is the first section in the Settings view. It provides quick navigation to the two primary configuration areas: **Inference** and **Notifications**.
4+
5+
[`Section Overview`](overview.md) | [`Home`](../README.md)
6+
7+
## Table of Contents
8+
9+
- [Inference](#inference)
10+
- [Notifications](#notifications)
11+
12+
---
13+
14+
## Inference
15+
16+
Inference settings control the behavior of Stability Matrix's built-in image generation and prompt editing tools. These settings are organized into three subsections: **Prompt**, **General**, and **Dimensions**.
17+
18+
### Prompt
19+
20+
#### Auto Completion
21+
22+
The auto completion feature provides tag suggestions as you type in prompt and negative prompt text boxes. When enabled, a dropdown appears with matching tags from a configurable CSV file.
23+
24+
| Setting | Description |
25+
|---|---|
26+
| **Enable Auto Completion** | Toggle the tag suggestion feature on or off. |
27+
| **Prompt Tags** | Select which CSV tag file to use for completions. Custom tag CSVs can be imported via the **Import** button below this setting. |
28+
| **Replace underscores with spaces** | When enabled, underscores in completed tags are displayed as spaces (e.g., `oil_painting` shows as `oil painting`). |
29+
30+
> [!NOTE]
31+
> Imported CSVs are copied to the `Tags/` folder inside the data directory. After importing, the new file appears in the **Prompt Tags** dropdown for selection.
32+
33+
---
34+
35+
### General
36+
37+
#### Filter Extra Networks by Base Model
38+
39+
When enabled, LoRA and other extra network model lists in the Inference UI are filtered to only show models compatible with the currently selected base model (e.g., SDXL LoRAs when SDXL is selected). This reduces clutter and helps avoid loading incompatible models.
40+
41+
#### Image Viewer
42+
43+
| Setting | Description |
44+
|---|---|
45+
| **Show pixel grid at high zoom levels** | When enabled, a pixel grid overlay appears when zooming into generated images, making it easier to inspect fine details. |
46+
| **Move files to the Recycle Bin when deleting** | When enabled, deleted images are sent to the system Recycle Bin / Trash instead of being permanently erased. This option is only visible on platforms where the Recycle Bin is available. |
47+
48+
#### Output Image Files
49+
50+
Controls how generated images are named when saved.
51+
52+
**File name pattern** — A format string that defines the naming convention for saved output images. Uses curly-brace variables like `{model_name}` and `{seed}`. Clicking into the text field shows a tooltip with all available format variables and examples. The default pattern is the same as the Inference UI template:
53+
54+
```
55+
{model_name}_{seed}_{width}x{height}
56+
```
57+
58+
A live preview of the resulting filename is shown below the input.
59+
60+
#### Floating Search
61+
62+
When enabled, all combo boxes in the Inference UI use a floating search mode: typed text appears as an overlay and auto-selects the first match. When disabled, each combo box uses its own configured search behavior.
63+
64+
---
65+
66+
### Dimensions
67+
68+
#### Step Size
69+
70+
Controls how much the width and height values increase or decrease per step when using the arrow buttons or scroll wheel on dimension input fields. The value is in pixels and can range from 8 to 1024.
71+
72+
#### Favorite Dimensions
73+
74+
A configurable list of frequently used width × height pairs. These appear as quick-select options in the Inference UI's dimensions section, letting you switch between common resolutions without typing.
75+
76+
| Action | How |
77+
|---|---|
78+
| **Add** | Click **+ Add**, enter a width and height, then save. |
79+
| **Remove** | Select a row in the grid and click **Remove**. |
80+
81+
The grid supports sorting by dimension value. Favorite dimensions are saved automatically and persist across restarts.
82+
83+
---
84+
85+
## Notifications
86+
87+
The Notifications page controls how Stability Matrix alerts you about events such as completed downloads, finished inference prompts, and package installations.
88+
89+
Each notification type can be independently configured to use one of three channels:
90+
91+
| Channel | Description |
92+
|---|---|
93+
| **None** | No notification is sent for this event. |
94+
| **In-App** | A toast notification appears inside the Stability Matrix window. |
95+
| **Desktop** | A native OS push notification is sent (e.g., Windows Action Center, macOS Notification Center). |
96+
97+
> [!NOTE]
98+
> On Linux, native push notifications depend on the desktop environment's notification daemon. The default for Linux is **In-App** since native push support varies across distributions.
99+
100+
### Available Notification Events
101+
102+
| Event | Description | Default Channel |
103+
|---|---|---|
104+
| **Inference Prompt Completed** | A single prompt has finished generating. | Native Push (In-App on Linux) |
105+
| **Inference Batch Completed** | An entire batch of prompts has finished. | Native Push (In-App on Linux) |
106+
| **Download Completed** | A model or file download has finished successfully. | Native Push (In-App on Linux) |
107+
| **Download Failed** | A download has failed due to an error. | Native Push (In-App on Linux) |
108+
| **Download Canceled** | A download was manually canceled by the user. | Native Push (In-App on Linux) |
109+
| **Package Install Completed** | A package install has finished successfully. | Native Push (In-App on Linux) |
110+
| **Package Install Failed** | A package install has failed. | Native Push (In-App on Linux) |
111+
112+
Each event row shows the event name and a dropdown to select the notification channel. Changes take effect immediately and are saved automatically.

0 commit comments

Comments
 (0)