1.1.0 • Published 6 months ago

image-synth v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

一个可以指定背景图片和文字,并合成图片的 Node.js 工具

🏠 主页

https://github.com/CaoMeiYouRen/image-synth#readme

📦 依赖要求

  • node >=18

🚀 安装

npm install image-synth

👨‍💻 使用

首先安装依赖:

npm install image-synth

然后在代码中使用:

import path from 'path'
import { synthesizeImage } from 'image-synth'

// 合成图片
const image = await synthesizeImage({
    backgroundImagePath: path.resolve(__dirname, './background.png'), // 背景图片路径
    text: 'Hello World', // 要绘制的文字
    outputPath: path.resolve(__dirname, './output.png'), // 输出图片路径
    fontSize: 80, // 字体大小
    textAlign: 'center', // 文字对齐方式
    textY: 200, // 文字Y轴位置
    fontColor: '#ffffff', // 文字颜色
    fontFamily: 'sans-serif' // 字体
})

console.log('图片合成成功!')

参数说明

参数类型说明
backgroundImagePathstring背景图片路径
textstring要绘制的文字
outputPathstring输出图片路径(可选)
fontSizenumber字体大小(默认60)
fontColorstring文字颜色(默认#ffffff)
fontFamilystring字体(默认sans-serif)
textAlign'left'|'right'|'center'|'start'|'end'文字对齐方式(默认left)
textXnumber文字X轴位置(默认0)
textYnumber文字Y轴位置(默认0)
maxWidthnumber文字最大宽度(可选)

🛠️ 开发

npm run dev

🔧 编译

npm run build

🔍 Lint

npm run lint

💾 Commit

npm run commit

👤 作者

CaoMeiYouRen

🤝 贡献

欢迎 贡献、提问或提出新功能!如有问题请查看 issues page. 贡献或提出新功能可以查看contributing guide.

💰 支持

如果觉得这个项目有用的话请给一颗⭐️,非常感谢

🌟 Star History

Star History Chart

📝 License

Copyright © 2025 CaoMeiYouRen. This project is MIT licensed.


This README was generated with ❤️ by cmyr-template-cli

1.1.0

6 months ago

1.0.0

6 months ago