https://github.com/caomeiyouren/image-synth
一个可以指定背景图片和文字，并合成图片的 Node.js 工具
https://github.com/caomeiyouren/image-synth
image nodejs npm-package synth typescript
Last synced: 6 months ago
JSON representation
一个可以指定背景图片和文字，并合成图片的 Node.js 工具
- Host: GitHub
- URL: https://github.com/caomeiyouren/image-synth
- Owner: CaoMeiYouRen
- License: mit
- Created: 2025-01-19T14:48:17.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-04-11T14:19:47.000Z (6 months ago)
- Last Synced: 2025-04-23T23:13:48.682Z (6 months ago)
- Topics: image, nodejs, npm-package, synth, typescript
- Language: TypeScript
- Size: 623 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
image-synth
> 一个可以指定背景图片和文字，并合成图片的 Node.js 工具
## 🏠 主页
[https://github.com/CaoMeiYouRen/image-synth#readme](https://github.com/CaoMeiYouRen/image-synth#readme)
## 📦 依赖要求
- node >=18
## 🚀 安装
```sh
npm install image-synth
```
## 👨💻 使用
首先安装依赖：
```sh
npm install image-synth
```
然后在代码中使用：
```typescript
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('图片合成成功！')
```
### 参数说明
| 参数 | 类型 | 说明 |
|------|------|------|
| backgroundImagePath | string | 背景图片路径 |
| text | string | 要绘制的文字 |
| outputPath | string | 输出图片路径（可选） |
| fontSize | number | 字体大小（默认60） |
| fontColor | string | 文字颜色（默认#ffffff） |
| fontFamily | string | 字体（默认sans-serif） |
| textAlign | 'left'\|'right'\|'center'\|'start'\|'end' | 文字对齐方式（默认left） |
| textX | number | 文字X轴位置（默认0） |
| textY | number | 文字Y轴位置（默认0） |
| maxWidth | number | 文字最大宽度（可选） |
## 🛠️ 开发
```sh
npm run dev
```
## 🔧 编译
```sh
npm run build
```
## 🔍 Lint
```sh
npm run lint
```
## 💾 Commit
```sh
npm run commit
```
## 👤 作者
**CaoMeiYouRen**
* Website: [https://blog.cmyr.ltd/](https://blog.cmyr.ltd/)
* GitHub: [@CaoMeiYouRen](https://github.com/CaoMeiYouRen)
## 🤝 贡献
欢迎 贡献、提问或提出新功能！
如有问题请查看 [issues page](https://github.com/CaoMeiYouRen/image-synth/issues).
贡献或提出新功能可以查看[contributing guide](https://github.com/CaoMeiYouRen/image-synth/blob/master/CONTRIBUTING.md).
## 💰 支持
如果觉得这个项目有用的话请给一颗⭐️，非常感谢
## 🌟 Star History
[](https://star-history.com/#CaoMeiYouRen/image-synth&Date)
## 📝 License
Copyright © 2025 [CaoMeiYouRen](https://github.com/CaoMeiYouRen).
This project is [MIT](https://github.com/CaoMeiYouRen/image-synth/blob/master/LICENSE) licensed.
***
_This README was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_