Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 43 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,27 @@

## English

TuckPup keeps a crowded macOS menu bar tidy. Choose which icons should stay
visible, tuck the rest away, and click the Bichon whenever you want to see them
again.
TuckPup 0.8.8 keeps a crowded macOS menu bar tidy. Open Settings to organize
icons into three sections—Shown, Collapsed, and Hidden—and drag icons to set
their category and order.

### Highlights

- Show or hide your chosen menu bar icons with one click.
- Keep important icons permanently visible.
- Put rarely used icons in an always-hidden section and open them in a compact,
horizontally scrollable bar.
- Scroll up or down over the Bichon to show or hide normally hidden icons.
- Use Settings to drag menu bar icons between Shown, Collapsed, and Hidden,
and to reorder them within each section.
- Left-click the Bichon to natively expand or collapse the Collapsed section.
- Hidden icons do not appear during normal expansion. Move them out of Hidden
in Settings, or temporarily open them from the right-click **Permanently
Hidden Icons** submenu.
- Use the scroll wheel over the Bichon to control the Collapsed section.
- Rehide icons automatically after a configurable delay.
- Launch automatically when you sign in to your Mac.
- Follow the macOS language automatically, or choose English, Simplified
Chinese, or Japanese in Settings.
- Native AppKit app with no account, analytics, ads, or network access.
- Accessibility and Screen Recording are requested only when using the
always-hidden icon bar.
- Accessibility is used to recognize, move, and temporarily open menu bar
icons. Screen Recording is used only to improve previews of their real
icons.

### Requirements

Expand All @@ -55,20 +58,18 @@ it from **System Settings → Privacy & Security → Open Anyway**.
### First-time setup

1. Launch TuckPup and choose **Start Setup**.
2. Hold `⌘` and drag the Bichon icon between the icons you want to hide and the
icons you want to keep visible.
3. Still holding `⌘`, drag the temporary separator directly to the left of the
Bichon.
4. Icons to the left of the separator will be tucked away. Icons to the right
will remain visible.
2. Open **Settings**.
3. Drag icons into **Shown**, **Collapsed**, or **Hidden**, then drag them into
the order you want.

### Controls

| Action | Result |
| --- | --- |
| Left-click the Bichon | Show or hide tucked icons |
| Left-click the Bichon | Natively expand or collapse the Collapsed section |
| Scroll over the Bichon | Control the Collapsed section |
| Right-click the Bichon | Open the TuckPup menu |
| `⌘` + drag | Reposition the Bichon or separator |
| Right-click → **Permanently Hidden Icons** | Temporarily open Hidden icons |

### Build from source

Expand All @@ -80,12 +81,15 @@ chmod +x scripts/build-app.sh
```

The app will be created at `dist/TuckPup.app`.
The build script requires an Apple Development or Developer ID signing
certificate in your login keychain so macOS permissions remain stable across
updates.

### Privacy

TuckPup does not connect to the internet, read your files, or collect analytics.
The optional always-hidden icon bar uses Accessibility to temporarily move and
click an original menu bar item, and Screen Recording to render its real icon.
Accessibility is used to recognize, move, and temporarily open original menu bar
icons. Screen Recording is used only to improve previews of their real icons.

### How it works

Expand All @@ -101,21 +105,24 @@ The core geometry technique was informed by the MIT-licensed

## 中文

TuckPup 是一款由小比熊守着的原生 macOS 菜单栏收纳工具。你可以选择哪些图标
保持显示、哪些图标暂时收起,需要时点击小比熊即可重新展开
TuckPup 0.8.8 是一款由小比熊守着的原生 macOS 菜单栏收纳工具。打开“设置”,
即可把图标拖入“显示区”“收起区”或“隐藏区”,并调整各区中的顺序

### 主要功能

- 单击即可展开或收起选中的菜单栏图标。
- 重要图标可以始终保持显示。
- 不常用图标可以放入“永久隐藏”区,需要时在菜单栏下方的紧凑横向栏中打开。
- 在比熊头像上向上或向下滚动,可展开或收起普通隐藏图标。
- 在“设置”中拖动菜单栏图标,在“显示区”“收起区”“隐藏区”之间分类,
并调整每个分区中的排序。
- 左键点击比熊,只会原生展开或收起“收起区”。
- “隐藏区”中的图标不会随普通展开出现;只能在“设置”中将其移出“隐藏区”,
或从右键菜单的“永久隐藏图标”子菜单临时打开。
- 在比熊上滚动鼠标滚轮,控制“收起区”的展开或收起。
- 支持按设定时间自动收起。
- 支持登录 Mac 时自动启动。
- 支持自动跟随 macOS 系统语言,也可在设置中手动选择 English、简体中文或
日本語。
- 原生 AppKit 应用,无账户、无广告、无统计、无网络访问。
- 只有使用“永久隐藏”图标栏时才会请求辅助功能和屏幕录制权限。
- 辅助功能权限用于识别、移动和临时打开菜单栏图标;屏幕录制权限只用于改善
原生图标真实外观的预览。

### 系统要求

Expand All @@ -136,17 +143,17 @@ TuckPup 采用本地签名,尚未经过 Apple 公证。第一次启动若被
### 首次设置

1. 启动 TuckPup,选择“开始设置”。
2. 按住 `⌘`,把比熊头像拖到隐藏区与常显区之间。
3. 继续按住 `⌘`,把临时出现的细分隔线紧贴在头像左侧。
4. 分隔线左侧的图标会被收纳,头像右侧的图标始终显示。
2. 打开“设置”。
3. 将图标拖入“显示区”“收起区”或“隐藏区”,再拖动调整顺序。

### 操作方式

| 操作 | 效果 |
| --- | --- |
| 左键点击比熊 | 展开或收起隐藏图标 |
| 左键点击比熊 | 原生展开或收起“收起区” |
| 在比熊上滚动鼠标滚轮 | 控制“收起区” |
| 右键点击比熊 | 打开 TuckPup 菜单 |
| 按住 `⌘` 拖动 | 调整比熊或分隔线的位置 |
| 右键 → “永久隐藏图标” | 临时打开“隐藏区”图标 |

### 从源码构建

Expand All @@ -158,11 +165,13 @@ chmod +x scripts/build-app.sh
```

构建结果位于 `dist/TuckPup.app`。
构建脚本要求登录钥匙串中存在 Apple Development 或 Developer ID 签名证书,
以便应用更新后继续保持稳定的 macOS 权限身份。

### 隐私

TuckPup 不联网、不读取用户文件、不收集数据。“永久隐藏”图标栏会使用辅助功能
权限临时移动并点击原生菜单栏图标,并使用屏幕录制权限显示图标的真实外观
TuckPup 不联网、不读取用户文件、不收集数据。对“隐藏区”图标的识别、移动和临时
打开会使用辅助功能权限;屏幕录制权限只用于改善图标真实外观的预览

### 实现说明

Expand Down