Paint by Numbers Generator 技术文档

1. 安装指南

1.1 环境准备

• Node.js: 确保你的系统上已经安装了Node.js。你可以从Node.js官网下载并安装。
• npm: Node.js安装完成后，npm（Node Package Manager）会自动安装。

1.2 安装项目依赖

1. 克隆项目到本地：

   git clone https://github.com/drake7707/paintbynumbersgenerator.git
   

2. 进入项目目录：

   cd paintbynumbersgenerator
   

3. 安装项目依赖：

   npm install
   

2. 项目的使用说明

2.1 使用Web版本

1. 启动本地服务器：

   npm start
   

2. 打开浏览器，访问http://localhost:3000，即可使用Web版本的Paint by Numbers Generator。

2.2 使用CLI版本

1. 运行CLI版本：

   paint-by-numbers-generator-win.exe -i input.png -o output.svg
   

2. 你可以通过-c参数指定自定义的settings.json文件，例如：

   paint-by-numbers-generator-win.exe -i input.png -o output.svg -c path_to_settings.json
   

3. 项目API使用文档

3.1 主要参数说明

• randomSeed: 随机种子，用于确定k-means聚类算法的初始起点。确保每次生成相同的结果。
• kMeansNrOfClusters: 图像量化后的颜色数量。
• kMeansMinDeltaDifference: k-means聚类的阈值距离，达到该距离后停止聚类。较大的值会加快聚类速度，但可能产生次优的聚类结果。默认值为1。
• kMeansClusteringColorSpace: 聚类时使用的颜色空间。
• kMeansColorRestrictions: 指定使用的颜色。可以是一个RGB值数组或颜色名称数组（参考颜色别名）。如果不指定颜色，则不应用任何限制。
• colorAliases: 颜色别名映射，键是颜色名称，值是RGB颜色（数字数组）。你可以在颜色限制中使用这些颜色名称。
• removeFacetsSmallerThanNrOfPoints: 移除小于指定像素数的区域。降低该值会生成更详细的结果，但可能更难以实际绘制。
• removeFacetsFromLargeToSmall: 从大到小移除区域，防止边界扭曲形状，但可能会显著减慢速度。
• maximumNumberOfFacets: 如果区域数量超过指定最大值，则移除最小的区域，直到达到限制。
• nrOfTimesToHalveBorderSegments: 减少边界线段中的点数（使用Haar小波减少），会平滑二次曲线，但会损失细节。线段始终保留其起点和终点。
• narrowPixelStripCleanupRuns: 窄像素清理，移除单像素行，防止区域边界线段过窄。小区域移除可能会引入新的窄像素条，因此会重复几次迭代运行。
• resizeImageIfTooLarge: 如果输入图像大于指定尺寸，则调整大小以适应，但保持比例。
• resizeImageWidth: 宽度限制。
• resizeImageHeight: 高度限制。

3.2 输出配置文件

你可以定义输出配置文件，以指定输出格式（SVG、PNG、JPG）和特定设置。例如：

{
  "name": "full",
  "svgShowLabels": true,
  "svgFillFacets": true,
  "svgShowBorders": true,
  "svgSizeMultiplier": 3,
  "svgFontSize": 50,
  "svgFontColor": "#333",
  "filetype": "png"
}

4. 项目安装方式

4.1 本地运行

1. 安装项目依赖：

   npm install
   

2. 启动本地服务器：

   npm start
   

4.2 编译CLI版本

1. 安装pkg工具：

   npm install pkg -g
   

2. 在项目根目录下运行编译命令：

   pkg .
   

   这将生成适用于Linux、Windows和macOS的可执行文件。