Skip to content

Commit 3b1d5ce

Browse files
author
mikachu2333
committed
feat: 更新README.md,增加核心功能、使用方法和配置说明
1 parent 486c563 commit 3b1d5ce

1 file changed

Lines changed: 116 additions & 53 deletions

File tree

README.md

Lines changed: 116 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,128 @@
1-
# sc_starter
1+
# SC_Starter
22

3-
A starter for ScreenCapture
3+
本软件是 [ScreenCapture](https://github.com/xland/ScreenCapture) 的启动器
4+
5+
A launcher and manager for ScreenCapture with global hotkeys and tray integration.
46

57
## 功能说明 / Features
68

7-
本软件是 [ScreenCapture](https://github.com/xland/ScreenCapture) 的启动器,提供以下功能:
9+
### 核心功能 / Core Features
10+
11+
- **内置截图程序** / Embedded ScreenCapture exe - 无需额外安装,一键运行
12+
- **全局快捷键** / Global Hotkeys - 系统级快捷键,任意位置触发
13+
- **路径管理** / Path Management - 支持多种保存方式和自定义路径
14+
- **文件保护机制** / File Protection - 自动监控和恢复核心文件
15+
- **单例运行** / Singleton Mode - 防止程序多开造成冲突
16+
- **托盘集成** / System Tray Integration - 便捷的托盘操作界面
17+
18+
### 托盘操作 / Tray Operations
19+
20+
- **左键单击** / Left Click: 普通截图 / Normal screenshot
21+
- **左键双击** / Left Double Click: 长截图 / Long screenshot
22+
- **右键单击** / Right Click: 退出程序 / Exit application
23+
24+
### 自启动支持 / Auto Startup
25+
26+
- **开机自启** / Boot Startup - 可配置的开机自动启动
27+
- **配置管理** / Configuration Management - 自动创建和管理启动项
828

9-
- 内置截图程序,无需额外安装 / Related exe is embedded
10-
- 自动注册全局快捷键 / Auto reg hotkey
11-
- 支持自定义保存路径 / Support save pics in custom dir/path
12-
- 文件防删除保护 / Avoid related file deletion
13-
- 托盘左键单击截图,右键退出 / Left click tray icon to shot and Right to exit
14-
- 自启动设置 / Support Auto Startup
29+
## 使用方法 / Usage Guide
1530

16-
## 使用方法 / Usage
31+
### 1. 快捷键操作 / Hotkey Operations
1732

18-
1. 默认快捷键 / Default Hotkeys:
19-
- `Ctrl+Win+Alt+P`: 截屏 / Screen capture
20-
- `Ctrl+Win+Alt+L`: 长截屏 / Long screenshot
21-
- `Ctrl+Win+Alt+T`: 钉图 / Pin image
22-
- `Win+Ctrl+Shift+Esc`: 退出 / Exit
23-
- `Ctrl+Win+Alt+O`: 打开配置 / Open settings
33+
#### 默认快捷键 / Default Hotkeys
2434

25-
2. 自定义设置 / Custom Settings:
26-
- 使用 `Ctrl+Win+Alt+O` 打开配置文件 / Use `Ctrl+Win+Alt+O` to open config file
27-
- 修改后保存并关闭文件 / Save and close file after modification
28-
- 使用 `Win+Ctrl+Shift+Esc` 退出程序 / Use `Win+Ctrl+Shift+Esc` to exit program
29-
- 重新启动程序应用新配置 / Restart program to apply new settings
35+
| 功能 / Function | 快捷键 / Hotkey | 说明 / Description |
36+
| ------------------------ | -------------------- | ---------------------------------------------------- |
37+
| 普通截图 / Screenshot | `Ctrl+Win+Alt+P` | 矩形区域截图 / Rectangular area capture |
38+
| 长截图 / Long Screenshot | `Ctrl+Win+Alt+L` | 滚动截图 / Scrolling capture |
39+
| 钉图 / Pin Image | `Ctrl+Win+Alt+T` | 将剪贴板图片钉到屏幕 / Pin clipboard image to screen |
40+
| 打开配置 / Open Config | `Ctrl+Win+Alt+O` | 打开配置文件编辑 / Open config file for editing |
41+
| 退出程序 / Exit | `Win+Ctrl+Shift+Esc` | 完全退出程序 / Exit application completely |
3042

31-
## 配置说明 / Configuration
43+
### 2. 配置自定义 / Configuration Customization
3244

33-
配置文件包含三个部分:
45+
#### 修改配置步骤 / Configuration Steps
3446

35-
### [hotkey] 快捷键设置 / Hotkey Settings
47+
1.`Ctrl+Win+Alt+O` 打开配置文件 / Press `Ctrl+Win+Alt+O` to open config file
48+
2. 根据需要修改设置 / Modify settings as needed
49+
3. 保存并关闭配置文件 / Save and close the config file
50+
4.`Win+Ctrl+Shift+Esc` 退出程序 / Press `Win+Ctrl+Shift+Esc` to exit
51+
5. 重新启动程序加载新配置 / Restart program to load new settings
3652

37-
- 格式:`控制键1+控制键2+...@实际键`
38-
- 示例:`Ctrl+Win+Alt@P`
39-
- 至少需要两个控制键
40-
- 支持的控制键:Win/Ctrl/Alt/Shift
41-
- 支持的实际键:字母A-Z、数字0-9、功能键F1-F24等
53+
## 配置详解 / Configuration Details
4254

43-
### [path] 保存路径设置 / Save Path Settings
55+
配置文件位于:`%LOCALAPPDATA%\SC_Starter\config.toml`
56+
57+
### [hotkey] 快捷键配置 / Hotkey Configuration
58+
59+
#### 格式说明 / Format Description
60+
61+
```toml
62+
功能名 = "修饰键1+修饰键2+...@目标键"
63+
function = "Modifier1+Modifier2+...@TargetKey"
64+
```
4465

45-
- `&`: 每次手动选择位置(默认)
46-
- `@`: 保存到桌面
47-
- `*`: 保存到图片文件夹
48-
- 自定义路径:如 `D:/Screenshots`
49-
- 路径分隔符**必须使用** `/``\\`
66+
#### 支持的修饰键 / Supported Modifiers
5067

51-
### [sundry] 其他设置 / Other Settings
68+
- `Win` / `Windows` / `Super`: Windows键
69+
- `Ctrl` / `Control`: Ctrl键
70+
- `Alt`: Alt键
71+
- `Shift`: Shift键
5272

53-
- `startup`: 是否自启动(0=否,1=是)
54-
- `gui_config`: 普通截图工具栏配置
55-
- `long_gui_config`: 长截图工具栏配置
73+
#### 支持的目标键 / Supported Target Keys
5674

57-
## 注意事项 / Notes
75+
- **字母键** / Letters: `A-Z`
76+
- **数字键** / Numbers: `0-9`
77+
- **功能键** / Function Keys: `F1-F24`
78+
- **特殊键** / Special Keys: `VK_ESCAPE`, `VK_SPACE`, `VK_TAB`
5879

59-
1. 程序会自动以单例模式运行,防止多开
60-
2. 配置文件自动保存在 `AppData/Local/SC_Starter` 目录
61-
3. 程序会自动监控核心文件,防止被误删除
62-
4. 所有快捷键不区分大小写
63-
5. 修改配置后必须重启程序才能生效
80+
#### 配置要求 / Requirements
6481

65-
---
82+
- **至少两个修饰键** / Minimum 2 modifiers required
83+
- **避免系统快捷键冲突** / Avoid system hotkey conflicts
6684

67-
1. Program will automatically run in singleton mode to prevent multiple instances
68-
2. Configuration file is automatically saved in `AppData/Local/SC_Starter` directory
69-
3. Program will automatically monitor core files to prevent accidental deletion
70-
4. All hotkeys are case-insensitive
71-
5. Program restart is required after configuration changes
85+
### [path] 保存路径配置 / Save Path Configuration
7286

73-
## 附,完整设置文件
87+
| 设置值 / Value | 功能 / Function | 说明 / Description |
88+
| ---------------- | ---------------------------- | ------------------------ |
89+
| `&` | 手动选择 / Manual Selection | 每次截图时弹出保存对话框 |
90+
| `@` | 桌面 / Desktop | 自动保存到桌面 |
91+
| `*` | 图片文件夹 / Pictures Folder | 自动保存到用户图片文件夹 |
92+
| `D:/Screenshots` | 自定义路径 / Custom Path | 保存到指定文件夹 |
93+
94+
#### 路径格式要求 / Path Format Requirements
95+
96+
- 使用正斜杠: `D:/Screenshots`
97+
- 使用双反斜杠: `D:\\Screenshots`
98+
- 不要使用单反斜杠: `D:\Screenshots`
99+
100+
### [sundry] 杂项 / Advanced Settings
101+
102+
- **auto_start**: 开机自启动 (`true`/`false`)
103+
- **comp_level**: 压缩级别 (0-100)
104+
- **scale_level**: 缩放级别 (0-100)
105+
106+
### GUI 工具栏配置 / GUI Toolbar Configuration
107+
108+
**可用工具 / Available Tools:**
109+
110+
- `rect`: 矩形工具 / Rectangle tool
111+
- `ellipse`: 椭圆工具 / Ellipse tool
112+
- `arrow`: 箭头工具 / Arrow tool
113+
- `number`: 序号工具 / Number tool
114+
- `line`: 直线工具 / Line tool
115+
- `text`: 文本工具 / Text tool
116+
- `mosaic`: 马赛克工具 / Mosaic tool
117+
- `eraser`: 橡皮擦工具 / Eraser tool
118+
- `undo`/`redo`: 撤销/重做 / Undo/Redo
119+
- `pin`: 钉图功能 / Pin function
120+
- `clipboard`: 复制到剪贴板 / Copy to clipboard
121+
- `save`: 保存功能 / Save function
122+
- `close`: 关闭功能 / Close function
123+
- `|`: 分隔符 / Separator
124+
125+
## 完整配置文件示例 / Complete Configuration Example
74126

75127
```toml
76128
# 设置文件使用说明 / Configuration File Instructions:
@@ -139,6 +191,16 @@ dir = "&"
139191
# true->启用, false->禁用
140192
startup = false
141193

194+
# 图像压缩与缩放比例
195+
# Image compression and scaling ratio settings
196+
# 压缩等级:0-10(清晰->模糊),-1代表默认
197+
# 缩放:1%-100%,(模糊->清晰)
198+
# Compression level: 0-10 (clear->blur), -1 for default
199+
# Scale: 1%-100% (blur->clear)
200+
comp_level = -1
201+
scale_ratio = 100
202+
203+
[gui]
142204
# GUI配置,默认全部启用
143205
# rect:方框
144206
# ellipse:椭圆
@@ -154,6 +216,7 @@ startup = false
154216
# save:保存
155217
# close:关闭
156218
gui_config = "rect,ellipse,arrow,number,line,text,mosaic,eraser,|,undo,redo,|,pin,clipboard,save,close"
219+
# 参数只少不多
220+
# Only fewer parameters are allowed
157221
long_gui_config = "pin,clipboard,save,close"
158-
159222
```

0 commit comments

Comments
 (0)