ChatMask
/install chatmask
\r \r
ChatMask Skill\r
\r When the user sends chat screenshots and asks to pixelate or hide identity\r elements, follow the steps below in order: Setup → Workflow.\r \r No external API key is required. This skill uses your existing AI\r capabilities to locate regions in the image, then delegates only the image\r manipulation to the local Python script.\r \r ---\r \r
Setup (run once, idempotent)\r
\r Run this block before the first job. Every step is guarded so re-running is safe.\r \r
# Default install path — override by setting CHAT_PIXELATE_PATH before calling the skill\r
CHAT_PIXELATE_PATH="${CHAT_PIXELATE_PATH:-$HOME/.openclaw/skills/chatmask}"\r
\r
# 1. Clone repo and checkout the pinned, audited commit\r
# Audited commit: 62b0d1132e8cad8455ef29f74a98da486ff102d4 (frankz2020/chatmask, v1.1.0)\r
PINNED_SHA="62b0d1132e8cad8455ef29f74a98da486ff102d4"\r
if [ ! -d "$CHAT_PIXELATE_PATH/.git" ]; then\r
git clone https://github.com/frankz2020/chatmask.git "$CHAT_PIXELATE_PATH"\r
fi\r
# Enforce the pinned commit — prevents silent drift if the branch moves\r
(cd "$CHAT_PIXELATE_PATH" && git fetch --quiet origin && git checkout --quiet "$PINNED_SHA")\r
\r
# 2. Create virtualenv if not already present\r
if [ ! -d "$CHAT_PIXELATE_PATH/.venv" ]; then\r
python3 -m venv "$CHAT_PIXELATE_PATH/.venv" \\r
|| { apt-get install -y python3-venv && python3 -m venv "$CHAT_PIXELATE_PATH/.venv"; }\r
fi\r
\r
# 3. Install / upgrade dependencies (Pillow, python-dotenv — no network calls at runtime)\r
"$CHAT_PIXELATE_PATH/.venv/bin/pip" install -q -r "$CHAT_PIXELATE_PATH/requirements.txt"\r
\r
export CHAT_PIXELATE_PATH\r
PYTHON="$CHAT_PIXELATE_PATH/.venv/bin/python3"\r
```\r
\r
> **What this installs:** Pillow (image processing) and python-dotenv (.env loader\r
> for standalone use only). The `requests` package is **not** installed by the\r
> skill — it is only needed for standalone/non-skill mode and lives in\r
> `requirements-standalone.txt`. No network calls are made by the script at runtime.\r
\r
> **Network behavior:** The only outbound calls in Setup are `git clone` (one-time)\r
> and `pip install` (one-time). During Workflow, `process.py` makes **no network\r
> calls** when `--bbox-json` is supplied — all processing is local.\r
\r
---\r
\r
## Workflow\r
\r
Read **Element Selection** and **Option Configuration** to translate natural-language\r
requests into the correct flags before running.\r
\r
### 1. Prepare directories\r
\r
```bash\r
JOB_ID="job_$(date +%s)"\r
OUT_DIR="/tmp/chat_pixelate_out_$JOB_ID"\r
mkdir -p "$OUT_DIR"\r
```\r
\r
### 2. Process each image individually\r
\r
**Each image must be analysed and pixelated separately.** Different screenshots\r
have different element positions — passing one image's bounding boxes to another\r
would leave sensitive regions unredacted. Repeat the following block for every\r
image the user sent.\r
\r
> **Why per-image?** `--bbox-json` is scoped to a single image. `process.py`\r
> enforces this: it exits with an error if more than one image is present in the\r
> input directory when `--bbox-json` is used.\r
\r
For each image `\x3Cfilename.png>`:\r
\r
#### 2a. Copy the image into its own input directory\r
\r
```bash\r
# Use a fresh single-image input dir for each file\r
IMG_FILE="\x3Cfilename.png>" # replace with the actual filename\r
IN_DIR="/tmp/chat_pixelate_in_${JOB_ID}_${IMG_FILE%.*}"\r
mkdir -p "$IN_DIR"\r
cp "$HOME/.openclaw/media/inbound/$IMG_FILE" "$IN_DIR/"\r
```\r
\r
#### 2b. Analyse the image with your vision capabilities\r
\r
Use the prompt below on `$IN_DIR/$IMG_FILE` and capture the JSON output.\r
The schema uses **normalized coordinates (0-1000)** where (0,0) is top-left\r
and (1000,1000) is bottom-right, in `y_min, x_min, y_max, x_max` order.\r
\r
```\r
You are a privacy specialist analyzing a chat/messaging app screenshot.\r
The app could be WeChat, WhatsApp, Telegram, iMessage, Slack, Discord, LINE,\r
KakaoTalk, or any other messaging application. The UI may be in English,\r
Chinese, or any other language. Identify the requested elements by their\r
visual layout and position, not by app-specific labels.\r
\r
YOUR TASK:\r
Locate ALL occurrences of the following elements and return their bounding boxes:\r
1. chat_names — The text title in the top navigation/header bar (conversation\r
name, group name, channel title, back-button contact name).\r
2. profile_pics — Circular or rounded avatar images next to message bubbles,\r
in the header, or on the participants list. Each distinct\r
avatar occurrence is its own region.\r
3. display_names — Text username/nickname labels directly next to or above\r
message bubbles (sender names, distinct from the header title).\r
\r
RULES:\r
- Return ONLY the elements listed above.\r
- Each element occurrence must be its own region.\r
- Cover the full visible area with a small amount of padding.\r
- If an element type is not visible, return an empty list for that key.\r
- Use normalized coordinates (0-1000) where (0,0) is top-left and (1000,1000) is bottom-right.\r
- Coordinate order: y_min, x_min, y_max, x_max (top, left, bottom, right).\r
- All values must be integers between 0 and 1000.\r
\r
Respond ONLY with a JSON object using this exact schema (no extra text outside the JSON):\r
{\r
"chat_names": [{"y_min": int, "x_min": int, "y_max": int, "x_max": int}],\r
"profile_pics": [{"y_min": int, "x_min": int, "y_max": int, "x_max": int}],\r
"display_names": [{"y_min": int, "x_min": int, "y_max": int, "x_max": int}]\r
}\r
```\r
\r
Omit keys for elements the user did not request (see **Element Selection** below).\r
\r
#### 2c. Run pixelation for this image\r
\r
Pass the JSON from 2b via `--bbox-json`. No API key is read or written.\r
\r
```bash\r
BBOX='\x3CJSON output from 2b>'\r
"$PYTHON" "$CHAT_PIXELATE_PATH/process.py" \\r
"$IN_DIR" \\r
"$OUT_DIR" \\r
--bbox-json "$BBOX" \\r
[OPTIONS] # see Element Selection and Option Configuration below\r
```\r
\r
Repeat steps 2a–2c for every image before proceeding.\r
\r
### 3. Return results to user\r
\r
```bash\r
ls "$OUT_DIR/"*_pixelated.png\r
```\r
\r
Attach or share all processed images from `$OUT_DIR/`.\r
\r
---\r
\r
## Element Selection\r
\r
Translate the user's intent to `--elements`. Default (no flag) pixelates all three.\r
\r
| User says (EN / 中文) | `--elements` flag |\r
|---|---|\r
| all / default / 全部 / 默认 / 全部打码 | *(omit flag — default: all three)* |\r
| chat name only / 只隐藏聊天名称 | `--elements chat_name` |\r
| profile pics only / 只隐藏头像 | `--elements profile_pic` |\r
| display names only / 只隐藏昵称 / 只隐藏用户名 | `--elements display_name` |\r
| avatars and display names / 隐藏头像和昵称 | `--elements profile_pic,display_name` |\r
| chat name and avatars / 隐藏聊天名称和头像 | `--elements chat_name,profile_pic` |\r
| chat name and display names / 隐藏聊天名称和昵称 | `--elements chat_name,display_name` |\r
\r
When not all three elements are requested, omit the unused keys from the\r
bounding-box JSON prompt in step 2 to reduce noise.\r
\r
**Element definitions:**\r
- **chat_name**: Title text in the top navigation bar (group name, contact name, channel title)\r
- **profile_pic**: Circular/rounded avatar images next to message bubbles\r
- **display_name**: Text username/nickname labels next to or above message bubbles\r
\r
---\r
\r
## Option Configuration\r
\r
| User says (EN / 中文) | Flag |\r
|---|---|\r
| soft blur / mist effect / 模糊效果 / 雾化(默认)| `--pixel-mode A` *(default)* |\r
| block / mosaic / pixelate blocks / 马赛克 / 方块效果 | `--pixel-mode B` |\r
\r
---\r
\r
## Full Example (copy-paste ready)\r
\r
Two images processed, each with its own per-image bounding-box analysis:\r
\r
```bash\r
# (Assumes Setup block has already run and exported CHAT_PIXELATE_PATH and PYTHON)\r
\r
JOB_ID="job_$(date +%s)"\r
OUT_DIR="/tmp/chat_pixelate_out_$JOB_ID"\r
mkdir -p "$OUT_DIR"\r
\r
# --- Image 1: screenshot_a.png ---\r
IN_A="/tmp/chat_pixelate_in_${JOB_ID}_a"\r
mkdir -p "$IN_A"\r
cp "$HOME/.openclaw/media/inbound/screenshot_a.png" "$IN_A/"\r
# (analyse screenshot_a.png with your vision model, capture JSON as BBOX_A)\r
BBOX_A='{"chat_names":[{"y_min":20,"x_min":100,"y_max":80,"x_max":900}],"profile_pics":[{"y_min":150,"x_min":10,"y_max":220,"x_max":80}],"display_names":[{"y_min":160,"x_min":90,"y_max":190,"x_max":350}]}'\r
"$PYTHON" "$CHAT_PIXELATE_PATH/process.py" "$IN_A" "$OUT_DIR" --bbox-json "$BBOX_A"\r
\r
# --- Image 2: screenshot_b.png --- (analyse separately; elements at different positions)\r
IN_B="/tmp/chat_pixelate_in_${JOB_ID}_b"\r
mkdir -p "$IN_B"\r
cp "$HOME/.openclaw/media/inbound/screenshot_b.png" "$IN_B/"\r
# (analyse screenshot_b.png with your vision model, capture JSON as BBOX_B)\r
BBOX_B='{"chat_names":[{"y_min":10,"x_min":200,"y_max":70,"x_max":800}],"profile_pics":[],"display_names":[{"y_min":200,"x_min":60,"y_max":240,"x_max":400}]}'\r
"$PYTHON" "$CHAT_PIXELATE_PATH/process.py" "$IN_B" "$OUT_DIR" --bbox-json "$BBOX_B"\r
\r
echo "=== Output images ==="\r
ls "$OUT_DIR/"*_pixelated.png\r
```\r
\r
### More examples\r
\r
```bash\r
# Only blur profile pics for one image — omit unused keys from JSON\r
IN_IMG="/tmp/chat_pixelate_in_${JOB_ID}_img"\r
mkdir -p "$IN_IMG"\r
cp "$HOME/.openclaw/media/inbound/chat.png" "$IN_IMG/"\r
BBOX='{"profile_pics":[{"y_min":150,"x_min":10,"y_max":220,"x_max":80}]}'\r
"$PYTHON" "$CHAT_PIXELATE_PATH/process.py" "$IN_IMG" "$OUT_DIR" \\r
--elements profile_pic \\r
--bbox-json "$BBOX"\r
\r
# Hide chat name and display names, block mosaic style\r
BBOX='{"chat_names":[{"y_min":0,"x_min":100,"y_max":60,"x_max":900}],"display_names":[{"y_min":160,"x_min":90,"y_max":190,"x_max":350}]}'\r
"$PYTHON" "$CHAT_PIXELATE_PATH/process.py" "$IN_IMG" "$OUT_DIR" \\r
--elements chat_name,display_name \\r
--pixel-mode B \\r
--bbox-json "$BBOX"\r
```\r
\r
---\r
\r
## Troubleshooting\r
\r
| Symptom | Cause | Fix |\r
|---|---|---|\r
| `--bbox-json ... but N images were found` | Multiple images in input dir with `--bbox-json` | Use a separate `$IN_DIR` per image and run `process.py` once per image |\r
| `python3 -m venv` fails | Missing venv module | Run `apt-get install -y python3-venv` then re-run Setup |\r
| `git clone` fails | No git installed or no network | Run `apt-get install -y git` or check network connectivity |\r
| `No images found in input directory` | Copy step failed | Check `ls $IN_DIR/` and confirm the filename is exact |\r
| Image copied unchanged with `SKIPPED` in summary | JSON parse failure | Check printed warning; verify the bbox JSON is valid |\r
| Wrong regions pixelated | Bounding boxes were inaccurate | Re-analyse the image and adjust coordinates; try `--pixel-mode B` |\r
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install chatmask - 安装完成后,直接呼叫该 Skill 的名称或使用
/chatmask触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
ChatMask 是什么?
Pixelate chat/messaging app screenshots (WeChat, WhatsApp, Telegram, iMessage, Slack, Discord, etc.) to hide chat name, profile pics, and/or display names. U... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 153 次。
如何安装 ChatMask?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install chatmask」即可一键安装,无需额外配置。
ChatMask 是免费的吗?
是的,ChatMask 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
ChatMask 支持哪些平台?
ChatMask 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 ChatMask?
由 frankz2020(@frankz2020)开发并维护,当前版本 v1.1.1。