Friend Maker

This README includes both Simplified Chinese and English sections. Use the buttons above to jump to your preferred language. 本页同时包含简体中文与 English 内容，请使用上方按钮跳转。

简体中文

朋友制作器 是一个面向 Nintendo Switch《朋友收集：梦想生活》 / Tomodachi Life 的自动绘制工作台。 它把 刷入 ESP32 固件、测试手柄连接、调试输入时序、导入图片并执行绘制 放进同一套本地界面。图片会被转换成像素预览和动作脚本，再通过 ESP32-WROOM-32 / ESP-32S 模拟 Switch Pro Controller 输入完成自动绘制。

项目是什么

• 面向当前实机链路的本地工作台
• 目标是把 ESP32 固件、串口 ACK 发送、Switch 手柄链路测试 和 图片转绘制脚本 串成一套闭环
• 当前默认围绕桌面端四页工作流组织：刷入固件、手柄测试、调试测速、脚本生成

现在能做什么

• 导入 PNG / JPG / SVG 图片，生成像素预览、统计信息与动作脚本
• 支持 单色绘制、官方色绘制 和 自定义多色
• 支持 1 / 3 / 7 / 13 / 19 / 27 六种画笔大小
• 支持 256x256 画布建模、模板裁切、辅助线预览和自动扣背景
• 支持在界面里完成 PlatformIO 固件刷写、串口枚举、Windows 驱动安装辅助、蓝牙连接测试与 timing 调整
• 支持暂停、继续、中断并保存恢复点；异常或重启后也能从本地恢复任务继续

适合谁

• 已经有 Nintendo Switch 和 ESP32-WROOM-32 / ESP-32S 开发板
• 想优先使用带界面的闭环工作流，而不是手工维护串口脚本
• 能接受当前版本仍然优先追求 输入稳定性，而不是极限速度或零校准上手

开始前提示

• 这不是 零门槛、即装即用 的纯消费级工具
• 首次使用通常仍需要完成 ESP32 刷写、串口或驱动识别、Switch 手柄配对和 timing 调整
• 如果你之前没有接触过 ESP32、PlatformIO 或类似链路，建议严格按文档逐步验证；首次环境准备通常需要稳定外网，并预留一定的准备与调试时间

当前推荐怎么用

当前公开文档默认支持两条进入路线，它们在安装方式上并列，但最终都会汇合到同一套四页工作流：

进入路线	适合场景	入口
桌面端安装包	想最快开始试用	macOS .dmg / Windows x64 .exe
仓库源码路线	想从源码运行、调试或二次开发	npm install + npm run ui:dev + PlatformIO

启动后统一按下面顺序使用：

1. 刷入固件：确认 PlatformIO、串口和固件环境正常
2. 手柄测试：完成 Switch 配对、按钮和方向测试
3. 调试测速：先调 inputDelay，再微调 buttonPressDuration
4. 脚本生成：导图、检查预览、开始绘制，并在需要时从页面内的恢复任务继续

当前使用建议与限制

• 当前主线已正式支持 单色绘制、官方色绘制 和 自定义多色
• 第一次试用时，仍建议先用 单色绘制 或结构更简单的图片验证整体链路
• 当前系统固定按 256x256 和 画布中心起步 建模
• 当前第一优先级仍然是 稳定性，不是 速度
• 已知部分 ESP32 兼容板存在连接个体差异；如果出现频繁断链、串键或异常连发，除软件重试外，也建议一起排查数据线、供电和板子做工差异
• 保持蓝牙环境尽量干净、减少附近同时活跃的蓝牙设备，通常会更有利于连接稳定
• 某些板子在长时间运行或温度偏高时稳定性会下降；适当降温也可能改善表现

平台与硬件支持

平台

• 支持桌面端安装包：macOS
• 支持桌面端安装包：Windows x64
• 暂不支持：Windows ARM64
• 暂未正式支持：Linux

硬件

• 推荐开发板：ESP32-WROOM-32 / ESP-32S
• 常见兼容板：ESP32 DevKitC、NodeMCU-32S
• 建议选择带 USB 串口、可直接刷机的版本
• 当前不建议把 ESP32-C3 / ESP32-S3 / ESP32-C6 当作主线板型
• 需要一根可传输数据的 USB 线

快速开始

路线 A：桌面端安装包

• macOS：安装 .dmg 后直接启动 Friend Maker
• Windows x64：运行 .exe 安装包后直接启动 Friend Maker
• 首次进入 刷入固件 页时，如果提示缺少 PlatformIO，点击 准备 PlatformIO
• 刷入固件 页现在会先让你选择 Switch 型号：Switch、Switch 2、Switch Lite
• Switch 2 / Switch Lite 当前只给主线 ESP32-WROOM-32 / ESP-32S 提供专用固件；如果你的板子更接近 NodeMCU-32S，继续优先使用标准 Switch 固件
• 首次准备 PlatformIO、下载工具链与部分依赖时，需要 稳定联网
• 如果应用提示缺少 Python，允许它下载一个供 Friend Maker 使用的本地运行环境即可
• Windows 下如果 PlatformIO 已就绪但没有串口，可在应用里优先安装 CP210x 驱动，再尝试 CH340/CH341

路线 B：仓库源码

建议先准备：

• Node.js 20+
• npm 10+
• PlatformIO Core 6+
• Windows 手动安装 PlatformIO 时还需要可用的 Python 3

常用命令：

cd /path/to/friendmaker
npm install
npm run check
npm run ui:dev

刷入固件：

cd /path/to/friendmaker/firmware/esp32

# 标准 Switch / OLED / V2
pio run -e esp32dev_wireless -t upload

# Switch 2（仅限 ESP32-WROOM-32 / ESP-32S）
pio run -e esp32dev_wireless_switch2 -t upload

# Switch Lite（仅限 ESP32-WROOM-32 / ESP-32S）
pio run -e esp32dev_wireless_switch_lite -t upload

如果 pio 不在 PATH 里，请改用完整路径：

• macOS：~/.platformio/penv/bin/pio
• Windows：%USERPROFILE%\.platformio\penv\Scripts\pio.exe

中文文档导航

• 快速上手：第一次试用、安装启动、刷固件、连接手柄、调 timing、开始绘制
• 排障说明：看不到串口、准备环境失败、刷写失败、连接不稳、串键、漂移、颜色偏差
• 硬件连接说明：支持板型、连接方式、线材与供电注意事项
• Windows 平台补充：驱动、winget、COM 口和 Windows 特有注意事项
• macOS 平台补充：串口驱动、源码启动和 macOS 特有注意事项
• 开发板到手检查清单：板子到手后的串口确认、刷写、冒烟测试与首轮导图验证
• 开发手册：当前建模、颜色路线、协议扩展与开发优先级
• PRD：当前产品目标、范围、里程碑与验收标准

当前能力边界

• 当前绘图与恢复流程都只支持“重新进入绘图页后，从画布中心继续”这一条起点假设
• 当前不把主画布当成可以稳定“归左上角”的有边界平面
• 官方色绘制 依赖游戏默认的 9 个色盘槽位起始状态
• 自动扣背景 适合白底、浅灰底和棋盘格假透明素材，不是 AI 抠图
• 如果开始绘制后继续操作手柄或触碰屏幕，容易造成错位

许可证与来源

本仓库采用 GPL-3.0-or-later 开源协议。完整协议内容请查看 LICENSE。

firmware/esp32 中的 Switch 蓝牙兼容实现，引入并改写自 UARTSwitchCon 的思路与代码路径，因此仓库采用 GPL 以保持许可证一致。

• 来源作者：小红书作者 惜羽拓麻镇
• 如公开转发、转载或二次分享，建议注明作者名称 惜羽拓麻镇
• 建议同时附上原始发布地址

---

English

Friend Maker is a local automatic-drawing workspace for Nintendo Switch Tomodachi Life. It brings ESP32 firmware flashing, controller connection testing, input timing tuning, and image-to-drawing execution into one interface. Images are converted into pixel previews and action scripts, then sent through an ESP32-WROOM-32 / ESP-32S that emulates Switch Pro Controller input.

What it is

• A local workspace for the current real-device loop
• Designed to connect ESP32 firmware, serial ACK transport, Switch controller testing, and image-driven drawing into one usable workflow
• Organized around the current four-page desktop flow: Firmware Flash, Controller Test, Timing Tune / Benchmark, and Script Studio

What it can do now

• Import PNG / JPG / SVG images and generate pixel previews, stats, and action scripts
• Support mono drawing, official palette drawing, and custom multicolor
• Support six brush sizes: 1 / 3 / 7 / 13 / 19 / 27
• Support 256x256 canvas modeling, template cropping, preview guides, and automatic background removal
• Handle PlatformIO flashing, serial-port enumeration, Windows driver helper flows, controller tests, and timing adjustments from the same UI
• Preserve recovery sessions for pause, resume, stop, crash, or restart scenarios

Who it is for

• People who already have a Nintendo Switch and an ESP32-WROOM-32 / ESP-32S board
• People who want a UI-first end-to-end workflow instead of hand-maintained serial scripts
• People who are okay with the current priority being input stability rather than maximum speed

Before you start

• This is not a zero-setup, consumer-style plug-and-play tool
• A first successful run still usually involves ESP32 flashing, serial-port or driver setup, Switch controller pairing, and timing adjustment
• If you have never worked with ESP32, PlatformIO, or similar device workflows before, follow the docs step by step; first-time environment setup usually needs stable internet access, and you should leave time for setup and debugging

Recommended way to use it

The public docs support two entry routes. They are parallel at install time, then converge into the same four-page workflow once the app is running:

Route	Best for	Entry
Packaged desktop app	Fastest first-run path	macOS .dmg / Windows x64 .exe
Repo-based workflow	Source-based runs, debugging, and contribution	npm install + npm run ui:dev + PlatformIO

After startup, use the same flow:

1. Firmware Flash: confirm PlatformIO, serial port, and firmware target
2. Controller Test: pair with Switch and verify button / direction behavior
3. Timing Tune / Benchmark: adjust inputDelay first, then fine-tune buttonPressDuration
4. Script Studio: import images, review previews, start drawing, and resume from in-page recovery tasks when needed

Current guidance and limits

• The current mainline officially supports mono drawing, official palette drawing, and custom multicolor
• For a first successful run, it is still safer to start with mono drawing or structurally simpler images
• The current system models the drawing flow as 256x256 and start from canvas center
• Stability still matters more than speed
• Some ESP32-compatible boards still vary in controller-link quality, so frequent disconnects or ghost inputs may also require checking cable quality, power delivery, and board variance
• A cleaner Bluetooth environment with fewer nearby active devices is usually better for stability
• Some boards also become less stable after heating up during longer runs, so cooling them down can help

Platform and hardware support

Platforms

• Packaged desktop app supported: macOS
• Packaged desktop app supported: Windows x64
• Not supported: Windows ARM64
• Not officially supported yet: Linux

Hardware

• Recommended boards: ESP32-WROOM-32 / ESP-32S
• Common compatible labels: ESP32 DevKitC, NodeMCU-32S
• Prefer boards with built-in USB serial for direct flashing
• ESP32-C3 / ESP32-S3 / ESP32-C6 are not the current recommended mainline path
• Use a USB cable that supports data transfer

Quick start

Route A: packaged desktop app

• macOS: install the .dmg, then launch Friend Maker
• Windows x64: run the .exe installer, then launch Friend Maker
• On first entry to Firmware Flash, click Prepare PlatformIO if it is missing
• The first toolchain and dependency preparation step needs a stable network connection
• If the app says Python is missing, allow it to download an app-local runtime for Friend Maker
• On Windows, if PlatformIO is ready but no serial port appears, try the in-app CP210x helper before CH340/CH341

Route B: repo-based workflow

Recommended prerequisites:

• Node.js 20+
• npm 10+
• PlatformIO Core 6+
• working Python 3 if you install PlatformIO manually on Windows

Common commands:

cd /path/to/friendmaker
npm install
npm run check
npm run ui:dev

Flash firmware:

cd /path/to/friendmaker/firmware/esp32
pio run -e esp32dev_wireless -t upload

If pio is not in PATH, use the full path instead:

• macOS: ~/.platformio/penv/bin/pio
• Windows: %USERPROFILE%\.platformio\penv\Scripts\pio.exe

English docs

• Quick Start: first run, installation, flashing, pairing, timing tuning, and first drawing
• Troubleshooting: serial, tooling, flashing, connection stability, ghost inputs, drift, and color mismatch
• Wiring Notes: supported boards, connection layout, cable, and power notes
• Windows Notes: Windows-specific driver, winget, and COM-port notes
• macOS Notes: macOS-specific serial, driver, and source-run notes
• Arrival-Day Checklist: first board check, serial verification, flashing, smoke test, and first image-driven validation
• Development Manual: current modeling assumptions, color routes, protocol additions, and implementation priorities
• PRD: product goals, scope, milestones, and acceptance criteria

Current boundaries

• The drawing and recovery flow only supports one restart assumption: re-enter the drawing page and continue from the canvas center
• The main canvas is not modeled as a plane that can reliably reset to the top-left corner
• Official palette drawing assumes the game's 9 palette slots still start from their default colors
• Automatic background removal is for white, light gray, and checkerboard fake-transparency sources; it is not AI cutout
• Touching the screen or using the controller during drawing can still cause drift

License and attribution

This repository is licensed under GPL-3.0-or-later. See LICENSE for the full text.

The Switch Bluetooth compatibility path under firmware/esp32 borrows from and adapts ideas and code paths from UARTSwitchCon, so the repository follows GPL for license compatibility.

• Original source author: Xiaohongshu creator 惜羽拓麻镇
• If you publicly repost or mirror this project, it is recommended that you credit 惜羽拓麻镇
• It is also recommended that you include the original publication link

Star History