You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If true, the menu will introduce a delay of 100ms before opening on Windows to work around the issue where getting the stylus position is otherwise not possible.
If set to a value greater than 0, the menu will be closed if the user clicks outside of the menu and the distance to the center of the menu is greater than this value (in pixels).
Copy file name to clipboardExpand all lines: src/content/docs/create-sound-themes.mdx
+30-4Lines changed: 30 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,10 +97,10 @@ You can also name this file `theme.json`. But [JSON5](https://json5.org/) is a b
97
97
license:'CC0-1.0',
98
98
themeVersion:'1.0',
99
99
100
-
// This theme was created for Kando's sound theme engine version 1.
100
+
// This theme was created for Kando's sound theme engine version 2.
101
101
// Kando will use this to check if the theme is compatible with the
102
102
// current version of Kando.
103
-
engineVersion:1,
103
+
engineVersion:2,
104
104
105
105
// This is a list of sound files which are played when certain events
106
106
// occur in the menu.
@@ -112,7 +112,7 @@ You can also name this file `theme.json`. But [JSON5](https://json5.org/) is a b
112
112
file:"close.mp3",
113
113
volume:0.5,
114
114
},
115
-
hoverItem: {
115
+
hoverButton: {
116
116
file:"hover.mp3",
117
117
minPitch:0.9,
118
118
maxPitch:1.1,
@@ -127,6 +127,29 @@ The following events are available for sound themes.
127
127
For each event, you can specify a sound file which is played when the event occurs.
128
128
It is perfectly fine to reuse the same sound file for multiple events.
129
129
130
+
<Asidetype="note">
131
+
With Kando 3.0, the set of available sound events has changed. Use the tabs below to see which events are available now.
132
+
</Aside>
133
+
134
+
<Tabs>
135
+
<TabItemlabel="Kando 3.0+ (Engine Version 2)">
136
+
137
+
<divstyle="width:120px">Event</div> | Description
138
+
--- | ---
139
+
`openMenu` | This event is triggered when a menu is opened.
140
+
`openSubmenu` | This event is triggered when a submenu is opened.
141
+
`closeMenu` | This event is triggered when a menu is closed. It will play when the close-menu action is executed, regardless of whether an item was selected or not.
142
+
`closeSubmenu` | This event is triggered when a submenu is closed.
143
+
`hoverParent` | This event is triggered when the parent of the current center item is hovered with the mouse.
144
+
`hoverCenter` | This event is triggered when the current center item is hovered with the mouse.
145
+
`hoverButton` | This event is triggered when a leaf item is hovered with the mouse.
146
+
`hoverSubmenu` | This event is triggered when a submenu which could be opened is hovered with the mouse.
147
+
`selectButton` | This event is triggered when an action is executed by selecting an item.
148
+
`activateMenu` | This event is triggered when the center of a submenu is selected.
149
+
150
+
</TabItem>
151
+
<TabItemlabel="Kando 2.x (Engine Version 1)">
152
+
130
153
<divstyle="width:120px">Event</div> | Description
131
154
--- | ---
132
155
`openMenu` | This event is triggered when a menu is opened.
@@ -138,6 +161,9 @@ It is perfectly fine to reuse the same sound file for multiple events.
138
161
`selectParent` | This event is triggered when the user navigates to the parent of the current center item.
139
162
`selectSubmenu` | This event is triggered when a submenu is opened.
140
163
164
+
</TabItem>
165
+
</Tabs>
166
+
141
167
### Advanced Configuration
142
168
143
169
For each event, you can specify the volume of the sound file and the pitch of the sound file.
@@ -147,7 +173,7 @@ You can set them to the same value to play the sound file with a fixed pitch.
0 commit comments