Skip to content

Commit ac81875

Browse files
committed
🔧 Add new settings file docs
1 parent 827f2e8 commit ac81875

1 file changed

Lines changed: 25 additions & 10 deletions

File tree

src/content/docs/config-files.mdx

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ Below are the default values of the configuration file.
7979
menuThemeColors: {},
8080
darkMenuThemeColors: {},
8181
enableDarkModeForMenuThemes: false,
82+
enableSelectionWedges: false,
8283
soundTheme: 'none',
8384
soundVolume: 0.5,
8485
enableVersionCheck: true,
@@ -112,6 +113,7 @@ Below are the default values of the configuration file.
112113
gamepadCloseButton: 2,
113114
sameShortcutBehavior: 'nothing',
114115
useDefaultOsShowSettingsHotkey: true,
116+
enableAchievements: true,
115117
}
116118
```
117119

@@ -184,6 +186,13 @@ This is only used if `enableDarkModeForMenuThemes` is set to `true`.
184186
Whether Kando should use the dark menu theme if the system is in dark mode.
185187
If enabled, Kando will use the `darkMenuTheme` and `darkMenuThemeColors` properties to configure the menu theme if the system is in dark mode.
186188

189+
#### enableSelectionWedges <Badge text="soon!" variant="tip" />
190+
191+
<small>Default value: `"enableSelectionWedges": false`</small>
192+
193+
If enabled, the clickable area of each menu item will be highlighted with a wedge when the item is hovered.
194+
This has to be supported by the menu theme.
195+
187196
#### soundTheme
188197

189198
<small>Default value: `"soundTheme": "none"`</small>
@@ -244,6 +253,19 @@ If set to `true`, Kando will check for new version regularly, and show a notific
244253

245254
The zoom factor of the menu. This can be used to scale the menu on high-resolution screens.
246255

256+
#### hideSettingsButton
257+
258+
<small>Default value: `"hideSettingsButton": false`</small>
259+
260+
If true, the settings button will be hidden if not hovered.
261+
262+
#### settingsButtonPosition
263+
264+
<small>Default value: `"settingsButtonPosition": "bottom-right"`</small>
265+
266+
The position of the settings button.
267+
Can be one of `'top-left'`, `'top-right'`, `'bottom-left'`, or `'bottom-right'`.
268+
247269
#### centerDeadZone
248270

249271
<small>Default value: `"centerDeadZone": 50`</small>
@@ -377,18 +399,11 @@ Can be one of the following:
377399

378400
If enabled, pressing <kbd>Command</kbd>+<kbd>,</kbd> on macOS or <kbd>Ctrl</kbd>+<kbd>,</kbd> on Linux or Windows will open the settings window. If disabled, the default hotkey will be ignored.
379401

380-
#### hideSettingsButton
402+
#### enableAchievements <Badge text="soon!" variant="tip" />
381403

382-
<small>Default value: `"hideSettingsButton": false`</small>
383-
384-
If true, the settings button will be hidden if not hovered.
404+
<small>Default value: `"enableAchievements": true`</small>
385405

386-
#### settingsButtonPosition
387-
388-
<small>Default value: `"settingsButtonPosition": "bottom-right"`</small>
389-
390-
The position of the settings button.
391-
Can be one of `'top-left'`, `'top-right'`, `'bottom-left'`, or `'bottom-right'`.
406+
If enabled, the user will earn achievements for completing certain tasks within the menu.
392407

393408
## Menu Configuration: `menus.json`
394409

0 commit comments

Comments
 (0)