beadrelief README

The project's README from github.com/pgp00/beadrelief. As one markdown file: README.md.

BeadRelief heart

BeadRelief

Image in. Editable beads out.

Turn any image into an editable bead pattern or a multicolor 3MF relief — entirely in your browser.

Try the live demo → · Download the sample 3MF · 简体中文

Build and verification

BeadRelief workflow: load an image, edit the bead pattern, and preview the 3D relief

Desktop-first · Use a viewport at least 980 px wide for the complete workspace.

Why BeadRelief?

🔒 Local by design 🧩 Printable bead charts 🖨️ Bambu-ready 3MF
Images and generated files stay in your browser. Use the full MARD palette and export PNG/PDF patterns. Project-filament colors and part assignments are included.

Three-minute quick start

  1. Open the live demo and choose Bead pattern or 3D print.
  2. Select Try the sample or upload a JPG, PNG, or WebP image.
  3. Adjust the size, color limit, crop, and background; then edit cells with the palette and drawing tools.
  4. Export a PNG/PDF pattern, usage workbook, edit-record JSON, or a 3MF in 3D print mode.

The Help button in the app keeps this workflow, keyboard controls, FAQ, and browser support in one place.

Choose an output

The live demo has two explicit workflows that share the same editable canvas:

Open the live demo, choose Bead pattern or 3D print, then upload a JPG, PNG, or WebP image.

From image to print, without guesswork

1 · Frame 2 · Build 3 · Inspect 4 · Calibrate
Crop, zoom, reposition, and clean the background. Choose solid or layered color and add a border, detachable backplate, hanging loop, or recessed back text. Scrub through print layers, isolate a layer, or explode the stack; the same mesh is used for preview and export. Print the generated swatch, enter measured colors, then save the printer/nozzle/material profile for reuse.

Every project JSON, layered workbook, and 3MF carries the bottom-to-top print recipe. The 3MF also embeds the selected nozzle and material assignments.

The usage panel can safely merge isolated color speckles in one undoable pass. Layered calibration is tied to the physical filament order, TD, printer, nozzle, and layer height; changing those inputs automatically retires stale measurements.

Open it in Bambu Studio

  1. Import the exported .3mf.
  2. Select the Bambu Lab P2S and 0.4 mm nozzle.
  3. Review the included project-filament colors and part assignments, map them to the physical AMS slots, then slice and inspect the color preview.

For layered work, open Material profile → Layered color calibration, download the calibration 3MF, print it with the same printer/nozzle/filaments, and enter the measured swatch colors before marking the profile as physically verified.

[!IMPORTANT] The checked-in heart file has not yet been physically printed. Always confirm the AMS mapping and slice preview before printing.

Try the heart sample

Follow the full editable-project path with the same tiny heart:

Source Edit Print
PNG Project JSON Grouped 3MF

Canvas shortcuts

Input Action
Arrow keys Move the keyboard cursor
Space or Enter Draw at the cursor
Delete or Backspace Clear the cursor cell
Hold Space and drag Temporarily pan the canvas
Mouse wheel Zoom the canvas
Right-click drag Pan or erase, based on the right-click setting

Browser support

Releases are verified in current Chromium. The supported setup is the latest Chrome or Edge with a desktop viewport at least 980 px wide; WebGL is required for the 3D preview. Firefox and Safari are not yet part of the supported release contract.

FAQ

Are my images uploaded?

No. Image conversion and exports run locally in your browser.

How should I back up a project?

The current draft is stored in this browser. Export the edit-record JSON for any project you need to keep or move to another device.

Why is 3MF export unavailable?

Switch to 3D print, keep the canvas at 32 × 32 cells or smaller, and resolve any print-setting validation message before exporting.

Run locally

Requires Node.js 22.9 or newer.

npm ci
npm run check
npm run dev

Open http://127.0.0.1:5174/.

Verification status

CI regenerates the checked-in samples, tests every 3MF archive, and verifies the embedded project-filament colors and part assignments. Exact hashes and the compatibility record are in Bambu Studio verification.

Known limits
  • Solid mode exports one grouped relief. Layered mode is experimental, uses one global bottom-to-top filament order, and is not Bambu Studio Mixed Filament metadata.
  • 3D print mode uses up to four materials; those AMS and 3MF limits do not apply to bead-pattern mode.
  • 3MF export is limited to 32 × 32 cells.
  • Confirm the physical AMS slot mapping in Bambu Studio before printing.
Privacy

Image processing and generated files stay in the browser; the app does not upload them to a server. The current editable draft may remain in browser local storage until it is replaced or cleared.

Upstream and license

BeadRelief is based on the MIT-licensed Jett-Wu/Perler_Beads_Generator. See UPSTREAM.md for the imported commit and project-specific changes. This repository is released under the MIT License.

If BeadRelief helped you make something, a GitHub star helps other makers find it. Contributions are welcome — see CONTRIBUTING.md.

beadrelief (pgp00/beadrelief)

Searching Database…

这是什么?BeadRelief 可以把任意图片转换成可编辑的拼豆图纸(类似 Perler beads 拼豆),或用于 3D 打印的多彩 3MF 浮雕,全部在浏览器内完成。
这是我需要安装的桌面应用,还是在浏览器里用的?它是一个基于浏览器的网页应用——你打开在线演示页面即可使用;本地运行只需要一个小型 Node.js 开发服务器,正常使用无需安装。
怎么把照片变成拼豆图纸或 3D 浮雕?打开在线演示,选择 Bead pattern 或 3D print,上传 JPG/PNG/WebP 图片,调整尺寸/颜色上限/裁剪,用工具编辑格子,然后导出 PNG/PDF 图纸或 3MF 文件。
除了浏览器我还需要什么?只需要一个支持 WebGL 的桌面浏览器;最新版 Chrome 或 Edge 是受支持的配置。若要从源码运行项目,则需要 Node.js 22.9 或更新版本。
把设计送去打印之前有什么要注意的?3MF 导出上限为 32×32 格;分层多色模式仍是实验性功能,且只使用一个全局耗材顺序(而非 Bambu Studio 的 Mixed Filament 元数据);Firefox/Safari 也尚未获得官方支持。
它能在手机上或 Firefox 里用吗?不能——它是桌面优先的,完整工作区需要至少 980px 的视口宽度,且只有当前的 Chromium 浏览器(Chrome/Edge)经过验证;Firefox 和 Safari 尚不在受支持的版本之列。
我上传的图片会离开我的电脑吗?不会,所有图像处理和文件生成都在浏览器本地完成;不会向服务器上传任何内容,不过当前草稿在导出或清除之前可能会保存在浏览器本地存储中。
MARD 调色板在拼豆图纸中是干什么用的?它是 Bead pattern 模式内置的调色板系统(Basic/Complete MARD),提供多达 291 种拼豆颜色,并可导出 PNG/PDF/XLSX 用量清单和 JSON。
3MF 文件在 Bambu Studio 里怎么用?导出的 3MF 内嵌了项目耗材颜色和部件分配,你可以把它们映射到实际的 AMS 料槽;该流程已在 Bambu Lab P2S 打印机和 0.4mm 喷嘴上验证。
BeadRelief 是基于什么构建的?它基于采用 MIT 许可证的 Jett-Wu/PerlerBeadsGenerator 项目,BeadRelief 在其上添加了 3D 打印和多彩 3MF 浮雕工作流。
3D 打印浮雕实际能用几种颜色?3D print 模式每个模型最多只能用四种 AMS 耗材颜色,而 bead-pattern 模式不受 AMS 限制,可以使用完整的 291 色调色板。
Creator
pgp00
Size
12.8 MB
Stars
488
Age
1mo
Commits · 90 Days