Skip to content

Commit e99fa68

Browse files
std-microblockstd-microblock
authored
merge: i18n: english configure file document
2 parents 765786a + 87ded21 commit e99fa68

File tree

4 files changed

+266
-87
lines changed

4 files changed

+266
-87
lines changed

‎CONFIG.md‎

Lines changed: 74 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,156 +1,162 @@
1-
# 配置文件格式说明
1+
# Configuration File Format Description [FOR CHINESE CONFIG](./CONFIG_zh.md)
22

3-
本项目的配置文件采用 JSON 格式，推荐使用 VSCode 进行编辑。
3+
This project's configuration file adopts the JSON format, and it is recommended to use **VSCode** for editing.
44

5-
本项目配置文件默认位于 `%USERPROFILE%/.breeze-shell/config.json`。
5+
The default location of the configuration file is:
6+
`%USERPROFILE%/.breeze-shell/config.json`.
67

7-
编辑配置文件并保存后，插件将会自动重载配置，无需重新启动。
8+
When the configuration file is saved, the plugin will automatically reload the configuration without requiring a restart.
89

9-
**如果保存后弹出了黑窗口，这大概是因为你的配置文件有错误，请阅读黑窗口内的报错信息并修复错误**
10+
**If a black window appears after saving, it indicates an error in the configuration file. Please read the error message in the black window and fix the issue accordingly.**
11+
12+
---
1013

1114
## Schema
1215

13-
Breeze Shell 配置文件的 JSON Schema 位于
14-
[resources/schema.json](./resources/schema.json)，在配置文件内写入
16+
The JSON Schema for the Breeze Shell configuration file is located at
17+
[resources/schema.json](./resources/schema.json). To enable type checking and autocompletion in VSCode, add the following line to your configuration file:
1518

1619
```json
1720
{
1821
"$schema": "https://raw.githubusercontent.com/std-microblock/breeze-shell/refs/heads/master/resources/schema.json"
1922
}
2023
```
2124

22-
即可在 VSCode 中看到配置文件类型检查及补全。
25+
This allows VSCode to provide real-time validation and suggestions .
26+
27+
---
2328

24-
## 配置文件结构
29+
## Configuration File Structure
2530

26-
以下为一份带有注释的完整默认 JSON 配置，注意其**不能**直接填入 config.json
27-
当中，因为配置文件解析当前不支持注释
31+
The following is a fully annotated default JSON configuration. Note that this **cannot** be directly copied into `config.json` as JSON does not support comments.
2832

2933
```json5
3034
{
3135
"context_menu": {
3236
"theme": {
33-
// 在 Windows 11 下使用 DWM 圆角而不是 SetWindowRgn 圆角
37+
// Use DWM-rounded corners instead of SetWindowRgn rounded corners on Windows 11
3438
"use_dwm_if_available": true,
35-
// 启用亚克力背景效果
39+
// Enable acrylic background effect
3640
"acrylic": true,
37-
// 圆角大小，仅在不使用 DWM 圆角时生效
41+
// Corner radius (only effective when DWM-rounded corners are not used)
3842
"radius": 6.0,
39-
// 字体大小，可调整此项以对齐缩放后的整数倍率字体大小以避免模糊
43+
// Font size (adjust to align with scaled integer font sizes to avoid blurring)
4044
"font_size": 14.0,
41-
// 项高度
45+
// Item height
4246
"item_height": 23.0,
43-
// 项间距
47+
// Item spacing
4448
"item_gap": 3.0,
45-
// 项圆角大小
49+
// Item corner radius
4650
"item_radius": 5.0,
47-
// 外边距
51+
// Margin
4852
"margin": 5.0,
49-
// 内边距
53+
// Padding
5054
"padding": 6.0,
51-
// 文笔内边距
55+
// Text padding
5256
"text_padding": 8.0,
53-
// 图标内边距
57+
// Icon padding
5458
"icon_padding": 4.0,
55-
// 右侧图标（展开图标）边距
59+
// Right icon (expand icon) padding
5660
"right_icon_padding": 20.0,
57-
// 横排按钮间距（此处为负值以抵消项边距的效果）
61+
// Horizontal button spacing (negative value to offset item spacing)
5862
"multibutton_line_gap": -6.0,
59-
// 在亮色主题下的亚克力背景颜色
63+
// Acrylic background color in light themes
6064
"acrylic_color_light": "#fefefe00",
61-
// 在暗色主题下的亚克力背景颜色
65+
// Acrylic background color in dark themes
6266
"acrylic_color_dark": "#28282800",
63-
// 背景透明度
64-
"background_opacity":1.0,
65-
// 动画相关
67+
// Background opacity
68+
"background_opacity": 1.0,
69+
// Animation settings
6670
"animation": {
67-
// 菜单项动画
71+
// Menu item animations
6872
"item": {
69-
// animated_float_conf: 通用动画配置
73+
// animated_float_conf: General animation configuration
7074
"opacity": {
71-
// 持续时长
75+
// Duration in milliseconds
7276
"duration": 200.0,
73-
// 动画曲线
74-
// 可为：
75-
// mutation (关闭动画)
76-
// linear (线性)
77-
// ease_in, ease_out, ease_in_out (三种缓动曲线)
77+
// Animation curve
78+
// Options:
79+
// mutation (disable animation),
80+
// linear (linear),
81+
// ease_in, ease_out, ease_in_out (easing curves)
7882
"easing": "ease_in_out",
79-
// 对延迟时间的缩放
80-
// 即：如果本来是在开始总动画 50ms 后显示该动画，
81-
// 若 delay_scale 为 2 则在 100ms 后才显示
83+
// Delay scaling factor
84+
// Example: If the original delay is 50ms,
85+
// a delay_scale of 2 results in a 100ms delay
8286
"delay_scale": 1.0
8387
},
84-
// 同 opacity，以下均省略
88+
// Same structure as opacity for x, y, width
8589
"x": animated_float_conf,
8690
"y": animated_float_conf,
8791
"width": animated_float_conf
8892
},
89-
// 主菜单的背景
93+
// Main menu background animation
9094
"main_bg": {
9195
"opacity": animated_float_conf,
9296
"x": animated_float_conf,
9397
"y": animated_float_conf,
9498
"w": animated_float_conf,
9599
"h": animated_float_conf
96100
},
97-
// 子菜单的背景，同主菜单
101+
// Submenu background animation (same as main menu)
98102
"submenu_bg": {
99103
...
100104
}
101105
},
102-
// 使用自绘边框、阴影（需关闭 dwm 边框）
106+
// Use custom-drawn border/shadow (disable DWM border)
103107
"use_self_drawn_border": true,
104-
// 自定义边框示例配置
108+
// Custom border width example
105109
"border_width": 2.5,
106-
// 支持渐变 [linear-gradient(angle, color1, color2) / radial-gradient(radius, color1, color2)]
110+
// Gradient support: [linear-gradient(angle, color1, color2) / radial-gradient(radius, color1, color2)]
107111
"border_color_dark": "linear-gradient(30, #DE73DF, #E5C07B)",
108112
"shadow_size": 20,
109113
"shadow_color_dark_from": "#ff000033",
110114
"shadow_color_dark_to": "#00ff0000"
111115
},
112-
// 启用垂直同步
116+
// Enable vertical sync
113117
"vsync": true,
114-
// 不替换 owner draw 的菜单
118+
// Do not replace owner-drawn menus
115119
"ignore_owner_draw": true,
116-
// 在向上展开时将所有项反向
120+
// Reverse all items when expanding upward
117121
"reverse_if_open_to_up": true,
118-
// 调试选项，搜索更大范围的图标，不建议打开
122+
// Debug option: search a larger range for icons (not recommended)
119123
"search_large_dwItemData_range": false,
120-
// 定位相关
124+
// Positioning settings
121125
"position": {
122-
// 竖直边距
126+
// Vertical padding
123127
"padding_vertical": 20,
124-
// 水平边距
128+
// Horizontal padding
125129
"padding_horizontal": 0
126130
},
127-
// 是否启用热键
128-
"hotkeys" : true,
131+
// Enable hotkeys
132+
"hotkeys": true
129133
},
130134

131-
// 开启调试窗口
135+
// Enable debug console
132136
"debug_console": false,
133137

134-
// 主字体
138+
// Primary font path
135139
"font_path_main": "C:\\WINDOWS\\Fonts\\segoeui.ttf",
136-
// 副字体
140+
// Fallback font path
137141
"font_path_fallback": "C:\\WINDOWS\\Fonts\\msyh.ttc",
138-
// 使用 hook 方式加载更多 resid
142+
// Use hook to load additional resource strings
139143
"res_string_loader_use_hook": false,
140-
// 调试选项，避免更改 UI 窗口大小
144+
// Debug option: avoid resizing UI windows
141145
"avoid_resize_ui": false,
142-
// 插件加载顺序，在越前面的越先加载
143-
// 格式为插件的无拓展名文件名
144-
// 如：Windows 11 Icon Pack
146+
// Plugin load order (plugins listed first load earlier)
147+
// Format: plugin filename without extension
148+
// Example: "Windows 11 Icon Pack"
145149
"plugin_load_order": [],
146-
// 全局默认动画效果
150+
// Global default animation
147151
"default_animation": animated_float_conf
148152
}
149153
```
150154

151-
## 示例配置文件
155+
---
152156

153-
#### 禁用所有动画
157+
## Example Configuration
158+
159+
### Disable All Animations
154160

155161
```json
156162
{
@@ -159,3 +165,5 @@ Breeze Shell 配置文件的 JSON Schema 位于
159165
}
160166
}
161167
```
168+
169+
This configuration disables all animations by setting the easing curve to `mutation` .

‎CONFIG_zh.md‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
# 配置文件格式说明
2+
3+
本项目的配置文件采用 JSON 格式，推荐使用 VSCode 进行编辑。
4+
5+
本项目配置文件默认位于 `%USERPROFILE%/.breeze-shell/config.json`。
6+
7+
编辑配置文件并保存后，插件将会自动重载配置，无需重新启动。
8+
9+
**如果保存后弹出了黑窗口，这大概是因为你的配置文件有错误，请阅读黑窗口内的报错信息并修复错误**
10+
11+
## Schema
12+
13+
Breeze Shell 配置文件的 JSON Schema 位于
14+
[resources/schema.json](./resources/schema.json)，在配置文件内写入
15+
16+
```json
17+
{
18+
"$schema": "https://raw.githubusercontent.com/std-microblock/breeze-shell/refs/heads/master/resources/schema.json"
19+
}
20+
```
21+
22+
即可在 VSCode 中看到配置文件类型检查及补全。
23+
24+
## 配置文件结构
25+
26+
以下为一份带有注释的完整默认 JSON 配置，注意其**不能**直接填入 config.json
27+
当中，因为配置文件解析当前不支持注释
28+
29+
```json5
30+
{
31+
"context_menu": {
32+
"theme": {
33+
// 在 Windows 11 下使用 DWM 圆角而不是 SetWindowRgn 圆角
34+
"use_dwm_if_available": true,
35+
// 启用亚克力背景效果
36+
"acrylic": true,
37+
// 圆角大小，仅在不使用 DWM 圆角时生效
38+
"radius": 6.0,
39+
// 字体大小，可调整此项以对齐缩放后的整数倍率字体大小以避免模糊
40+
"font_size": 14.0,
41+
// 项高度
42+
"item_height": 23.0,
43+
// 项间距
44+
"item_gap": 3.0,
45+
// 项圆角大小
46+
"item_radius": 5.0,
47+
// 外边距
48+
"margin": 5.0,
49+
// 内边距
50+
"padding": 6.0,
51+
// 文笔内边距
52+
"text_padding": 8.0,
53+
// 图标内边距
54+
"icon_padding": 4.0,
55+
// 右侧图标（展开图标）边距
56+
"right_icon_padding": 20.0,
57+
// 横排按钮间距（此处为负值以抵消项边距的效果）
58+
"multibutton_line_gap": -6.0,
59+
// 在亮色主题下的亚克力背景颜色
60+
"acrylic_color_light": "#fefefe00",
61+
// 在暗色主题下的亚克力背景颜色
62+
"acrylic_color_dark": "#28282800",
63+
// 背景透明度
64+
"background_opacity":1.0,
65+
// 动画相关
66+
"animation": {
67+
// 菜单项动画
68+
"item": {
69+
// animated_float_conf: 通用动画配置
70+
"opacity": {
71+
// 持续时长
72+
"duration": 200.0,
73+
// 动画曲线
74+
// 可为：
75+
// mutation (关闭动画)
76+
// linear (线性)
77+
// ease_in, ease_out, ease_in_out (三种缓动曲线)
78+
"easing": "ease_in_out",
79+
// 对延迟时间的缩放
80+
// 即：如果本来是在开始总动画 50ms 后显示该动画，
81+
// 若 delay_scale 为 2 则在 100ms 后才显示
82+
"delay_scale": 1.0
83+
},
84+
// 同 opacity，以下均省略
85+
"x": animated_float_conf,
86+
"y": animated_float_conf,
87+
"width": animated_float_conf
88+
},
89+
// 主菜单的背景
90+
"main_bg": {
91+
"opacity": animated_float_conf,
92+
"x": animated_float_conf,
93+
"y": animated_float_conf,
94+
"w": animated_float_conf,
95+
"h": animated_float_conf
96+
},
97+
// 子菜单的背景，同主菜单
98+
"submenu_bg": {
99+
...
100+
}
101+
},
102+
// 使用自绘边框、阴影（需关闭 dwm 边框）
103+
"use_self_drawn_border": true,
104+
// 自定义边框示例配置
105+
"border_width": 2.5,
106+
// 支持渐变 [linear-gradient(angle, color1, color2) / radial-gradient(radius, color1, color2)]
107+
"border_color_dark": "linear-gradient(30, #DE73DF, #E5C07B)",
108+
"shadow_size": 20,
109+
"shadow_color_dark_from": "#ff000033",
110+
"shadow_color_dark_to": "#00ff0000"
111+
},
112+
// 启用垂直同步
113+
"vsync": true,
114+
// 不替换 owner draw 的菜单
115+
"ignore_owner_draw": true,
116+
// 在向上展开时将所有项反向
117+
"reverse_if_open_to_up": true,
118+
// 调试选项，搜索更大范围的图标，不建议打开
119+
"search_large_dwItemData_range": false,
120+
// 定位相关
121+
"position": {
122+
// 竖直边距
123+
"padding_vertical": 20,
124+
// 水平边距
125+
"padding_horizontal": 0
126+
},
127+
// 是否启用热键
128+
"hotkeys" : true,
129+
},
130+
131+
// 开启调试窗口
132+
"debug_console": false,
133+
134+
// 主字体
135+
"font_path_main": "C:\\WINDOWS\\Fonts\\segoeui.ttf",
136+
// 副字体
137+
"font_path_fallback": "C:\\WINDOWS\\Fonts\\msyh.ttc",
138+
// 使用 hook 方式加载更多 resid
139+
"res_string_loader_use_hook": false,
140+
// 调试选项，避免更改 UI 窗口大小
141+
"avoid_resize_ui": false,
142+
// 插件加载顺序，在越前面的越先加载
143+
// 格式为插件的无拓展名文件名
144+
// 如：Windows 11 Icon Pack
145+
"plugin_load_order": [],
146+
// 全局默认动画效果
147+
"default_animation": animated_float_conf
148+
}
149+
```
150+
151+
## 示例配置文件
152+
153+
#### 禁用所有动画
154+
155+
```json
156+
{
157+
"default_animation": {
158+
"easing": "mutation"
159+
}
160+
}
161+
```

0 commit comments

Comments
 (0)