Skip to content

Commit 3be58ce

Browse files
qianmoQqianmoQ
committed
feat: add readme
1 parent b212602 commit 3be58ce

2 files changed

Lines changed: 266 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# DockMaster Pro
2+
3+
A powerful, customizable multi-row Dock replacement for macOS.
4+
5+
![Platform](https://img.shields.io/badge/platform-macOS%2013%2B-blue)
6+
![Swift](https://img.shields.io/badge/Swift-5.9-orange)
7+
![License](https://img.shields.io/badge/license-MIT-green)
8+
9+
[English](README.md) | [中文](README_zh.md)
10+
11+
## Features
12+
13+
### Custom Dock Overlay
14+
- **Multi-row / Multi-column layout** — Display icons in a grid, not just a single line
15+
- **Three positions** — Bottom, Left, or Right edge of your screen
16+
- **Configurable icon size** — 32px to 128px
17+
- **Auto-hide** — Hide when not in use, show on mouse proximity
18+
- **Scrollable overflow** — Smooth scrolling when content exceeds available space
19+
- **Recent Apps** — Toggleable section showing currently running unpinned apps
20+
21+
### Dock Sections
22+
- **Multiple named sections** — Organize apps into logical groups
23+
- **Add, rename, reorder, delete** — Full section management
24+
- **Visual separators** — Clear boundaries between sections
25+
- **Drag & drop** — Reorder sections and items intuitively
26+
27+
### Rich Animations
28+
- **20 hover styles** — Bounce, Shake, Pulse, Flip 3D, Glitch, Tada, Heartbeat, and more
29+
- **8 launch animations** — Scale, Fade, Slide, Pop, and more
30+
- **7 quit animations** — Shrink, Fade, Dissolve, and more
31+
- **Respects Reduce Motion** — Honors macOS accessibility settings
32+
33+
### Workspaces
34+
- **Multiple workspaces** — Each with its own dock layout and pinned apps
35+
- **Space binding** — Bind workspaces to macOS Spaces for automatic switching
36+
- **Custom hotkeys** — Assign keyboard shortcuts (e.g. Cmd+Opt+1) for instant switching
37+
- **Quick switch** — Switch via Menu Bar extra
38+
39+
### Theme Engine
40+
- **3 built-in themes** — Dark, Light, and Minimal
41+
- **Full theme editor** — Customize colors, corner radius, blur, shadows, icon padding
42+
- **Import / Export** — Share themes as `.dmtheme` files
43+
- **Custom icon packs** — Per-app icon overrides bundled with themes
44+
- **Live preview** — See changes in real-time with a mini dock preview
45+
46+
### Quick Search
47+
- **Spotlight-like search** — Search apps, files, documents, bookmarks, and recent items
48+
- **Keyboard navigation** — Arrow keys to navigate, Enter to open
49+
- **Recent items view** — Quick access when search field is empty
50+
- **Global shortcut** — Open with Option+Space
51+
52+
### System Monitor Widget
53+
- **CPU & Memory** — Mini ring charts with usage percentages
54+
- **Network speed** — Real-time download/upload speed
55+
- **Expandable** — Tap to see detailed metrics
56+
57+
### Native Dock Replacement
58+
- **Hide macOS Dock** — Seamlessly replace the native Dock
59+
- **Auto-restore** — Original Dock settings restored on app quit
60+
61+
### Menu Bar Integration
62+
- **Menu Bar extra** — Configurable icon (Dock, Grid, Circle, Star)
63+
- **Workspace switcher** — Quick access to all workspaces
64+
- **Settings access** — One-click to open preferences
65+
66+
### Internationalization
67+
- **4 languages** — English, Simplified Chinese, Traditional Chinese, Japanese
68+
- **In-app language switch** — Change language without restarting
69+
70+
## Requirements
71+
72+
- macOS 13.0 (Ventura) or later
73+
- Apple Silicon (arm64)
74+
75+
## Installation
76+
77+
### From Release
78+
Download the latest `.zip` from [Releases](https://github.com/qianmoQ/DockMaster/releases), unzip, and drag `DockMaster Pro.app` to your Applications folder.
79+
80+
### Build from Source
81+
82+
```bash
83+
# Clone the repository
84+
git clone https://github.com/qianmoQ/DockMaster.git
85+
cd DockMaster
86+
87+
# Release build
88+
./build.sh
89+
90+
# Debug build
91+
./build.sh --debug
92+
93+
# Build with code signing
94+
./build.sh --sign "Developer ID Application: Your Name (TEAMID)"
95+
```
96+
97+
The built app will be in `build/DockMaster Pro.app`.
98+
99+
## Permissions
100+
101+
DockMaster Pro requires the following permissions:
102+
103+
- **Accessibility** — Required to control the Dock process and manage other applications
104+
- **Apple Events** — Required to launch and interact with other applications
105+
106+
Grant these in **System Settings > Privacy & Security > Accessibility**.
107+
108+
## Project Structure
109+
110+
```
111+
DockMasterPro/
112+
├── App/ # Entry point & app delegate
113+
├── Core/ # Business logic engines
114+
│ ├── DockEngine/ # Dock layout management
115+
│ ├── ThemeEngine/ # Theme loading, editing, import/export
116+
│ ├── WorkspaceManager/ # Workspace CRUD & switching
117+
│ ├── SearchEngine/ # Global search controller
118+
│ └── SystemMonitor/ # CPU, Memory, Network monitors
119+
├── Features/ # UI feature modules
120+
│ ├── DockOverlay/ # Main dock overlay UI
121+
│ ├── QuickSearch/ # Spotlight-like search panel
122+
│ ├── StatusWidget/ # System monitor widget
123+
│ └── ContextMenu/ # Right-click context menus
124+
├── Settings/ # Preferences UI & view models
125+
├── Models/ # Data models & preferences
126+
├── Services/ # System integrations
127+
├── Support/ # Localization, errors, logging
128+
└── Extensions/ # SwiftUI & AppKit extensions
129+
```
130+
131+
## License
132+
133+
MIT License. See [LICENSE](LICENSE) for details.

‎README_zh.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# DockMaster Pro
2+
3+
一款强大的 macOS 自定义多行 Dock 替代工具。
4+
5+
![Platform](https://img.shields.io/badge/platform-macOS%2013%2B-blue)
6+
![Swift](https://img.shields.io/badge/Swift-5.9-orange)
7+
![License](https://img.shields.io/badge/license-MIT-green)
8+
9+
[English](README.md) | [中文](README_zh.md)
10+
11+
## 功能特性
12+
13+
### 自定义 Dock 覆盖层
14+
- **多行 / 多列布局** — 以网格形式展示图标，不再局限于单行
15+
- **三个停靠位置** — 屏幕底部、左侧或右侧
16+
- **可配置图标大小** — 32px 至 128px
17+
- **自动隐藏** — 不用时隐藏，鼠标靠近时显示
18+
- **可滚动溢出** — 内容超出可用空间时平滑滚动
19+
- **最近应用** — 可切换的最近运行未固定应用区域
20+
21+
### Dock 分区
22+
- **多个命名分区** — 将应用按逻辑分组
23+
- **添加、重命名、排序、删除** — 完整的分区管理
24+
- **视觉分隔线** — 分区之间清晰分隔
25+
- **拖拽排序** — 直观地调整分区和项目顺序
26+
27+
### 丰富的动画系统
28+
- **20 种悬停动画** — 弹跳、抖动、脉冲、3D 翻转、故障、Tada、心跳等
29+
- **8 种启动动画** — 缩放、淡入、滑入、弹出等
30+
- **7 种退出动画** — 缩小、淡出、溶解等
31+
- **尊重无障碍设置** — 遵循 macOS 减弱动效设置
32+
33+
### 工作区
34+
- **多个工作区** — 每个工作区拥有独立的 Dock 布局和固定应用
35+
- **Spaces 绑定** — 将工作区绑定到 macOS Spaces，实现自动切换
36+
- **自定义快捷键** — 分配键盘快捷键（如 Cmd+Opt+1）快速切换
37+
- **快速切换** — 通过菜单栏快速切换工作区
38+
39+
### 主题引擎
40+
- **3 个内置主题** — 暗色、亮色、极简
41+
- **完整主题编辑器** — 自定义颜色、圆角、模糊、阴影、图标间距
42+
- **导入 / 导出** — 以 `.dmtheme` 文件格式分享主题
43+
- **自定义图标包** — 每个应用可单独替换图标
44+
- **实时预览** — 迷你 Dock 实时预览主题效果
45+
46+
### 快速搜索
47+
- **类 Spotlight 搜索** — 搜索应用、文件、文档、书签和最近项目
48+
- **键盘导航** — 方向键导航，回车键打开
49+
- **最近项目视图** — 搜索框为空时显示最近使用的项目
50+
- **全局快捷键** — Option+Space 打开
51+
52+
### 系统监控小组件
53+
- **CPU 和内存** — 迷你环形图表显示使用百分比
54+
- **网络速度** — 实时下载/上传速度
55+
- **可展开** — 点击查看详细指标
56+
57+
### 原生 Dock 替换
58+
- **隐藏 macOS Dock** — 无缝替换系统原生 Dock
59+
- **退出时自动恢复** — 退出应用时恢复原始 Dock 设置
60+
61+
### 菜单栏集成
62+
- **菜单栏图标** — 可配置图标（Dock、网格、圆形、星形）
63+
- **工作区切换器** — 快速访问所有工作区
64+
- **设置入口** — 一键打开偏好设置
65+
66+
### 国际化
67+
- **4 种语言** — 英语、简体中文、繁体中文、日语
68+
- **应用内切换** — 无需重启即可切换语言
69+
70+
## 系统要求
71+
72+
- macOS 13.0 (Ventura) 或更高版本
73+
- Apple Silicon (arm64)
74+
75+
## 安装
76+
77+
### 从 Release 安装
78+
从 [Releases](https://github.com/qianmoQ/DockMaster/releases) 下载最新的 `.zip` 文件，解压后将 `DockMaster Pro.app` 拖入应用程序文件夹。
79+
80+
### 从源码构建
81+
82+
```bash
83+
# 克隆仓库
84+
git clone https://github.com/qianmoQ/DockMaster.git
85+
cd DockMaster
86+
87+
# Release 构建
88+
./build.sh
89+
90+
# Debug 构建
91+
./build.sh --debug
92+
93+
# 带代码签名构建
94+
./build.sh --sign "Developer ID Application: Your Name (TEAMID)"
95+
```
96+
97+
构建后的应用位于 `build/DockMaster Pro.app`。
98+
99+
## 权限
100+
101+
DockMaster Pro 需要以下权限：
102+
103+
- **辅助功能** — 控制 Dock 进程和管理其他应用
104+
- **Apple 事件** — 启动和与其他应用交互
105+
106+
请在 **系统设置 > 隐私与安全性 > 辅助功能** 中授予权限。
107+
108+
## 项目结构
109+
110+
```
111+
DockMasterPro/
112+
├── App/ # 入口点与应用代理
113+
├── Core/ # 业务逻辑引擎
114+
│ ├── DockEngine/ # Dock 布局管理
115+
│ ├── ThemeEngine/ # 主题加载、编辑、导入/导出
116+
│ ├── WorkspaceManager/ # 工作区 CRUD 与切换
117+
│ ├── SearchEngine/ # 全局搜索控制器
118+
│ └── SystemMonitor/ # CPU、内存、网络监控
119+
├── Features/ # UI 功能模块
120+
│ ├── DockOverlay/ # 主 Dock 覆盖层 UI
121+
│ ├── QuickSearch/ # 类 Spotlight 搜索面板
122+
│ ├── StatusWidget/ # 系统监控小组件
123+
│ └── ContextMenu/ # 右键上下文菜单
124+
├── Settings/ # 偏好设置 UI 与视图模型
125+
├── Models/ # 数据模型与偏好设置
126+
├── Services/ # 系统集成服务
127+
├── Support/ # 国际化、错误、日志
128+
└── Extensions/ # SwiftUI 与 AppKit 扩展
129+
```
130+
131+
## 许可证
132+
133+
MIT 许可证。详见 [LICENSE](LICENSE) 文件。

0 commit comments

Comments
 (0)