✍️ HANDWRITTEN.js
Convert typed text to realistic handwriting
[](#contributors-)
[](https://www.npmjs.com/package/handwritten.js)
[](https://github.com/alias-rahil/handwritten.js/blob/master/LICENSE)
## Demo
🌐 [handwritten.js](https://alias-rahil.github.io/handwritten.js/)
## Installation
### For browsers:
```html
```
> This will expose the latest version of `handwritten.js` as a global variable called `handwritten` which you can start using right away. Check the contents of [docs/](https://github.com/alias-rahil/handwritten.js/blob/master/docs/) folder for a simple implementation. For other versions, install the required version with npm and use [browserify](https://www.npmjs.com/package/browserify) to compile it. Optionally, use [babel-minify](https://www.npmjs.com/package/babel-minify) to compress the bundled javascript file.
### For nodejs projects:
```bash
npm install handwritten.js
```
or
```bash
yarn add handwritten.js
```
### Install globally:
```bash
npm install handwritten.js -g
```
or
```bash
yarn global add handwritten.js
```
> Note: **DO NOT** use sudo to install global packages! The correct way is to tell npm where to install its global packages: `npm config set prefix ~/.local`. Make sure `~/.local/bin` is added to `PATH`.
## Usage
### For nodejs projects:
```javascript
const handwritten = require('handwritten.js')
const fs = require('fs')
const rawtext = "Hello, world!"
handwritten(rawtext).then((converted) => {
converted.pipe(fs.createWriteStream('output.pdf'))
})
```
### CLI usage with npx:
```bash
npx handwritten.js -f "path/to/inputfile.txt" -o "path/to/outputfile.pdf"
```
> Note: Use this method only if you plan to use handwritten.js for one time, installing handwritten.js globally (see-below) is recommended for multiple time usages.
### CLI usage after installing globally:
```bash
handwritten.js -f "path/to/inputfile.txt" -o "path/to/outputfile.pdf"
```
## API
### Command line
```bash
handwritten.js -f path/to/inputfile.txt -o path/to/outputfile.pdf
handwritten.js -f path/to/inputfile.txt -o path/to/outputfile.pdf --ruled
handwritten.js -f path/to/inputfile.txt -o path/to/outputfolder --images png
```
Check `--help` or `--version` option for more details.
### In code
```javascript
handwritten(rawtext)
handwritten(rawtext, { ruled: true })
handwritten(rawtext, { outputType: "jpeg/buf" })
handwritten(rawtext, { ruled: true, outputType: "jpeg/b64" })
handwritten(rawtext, { ruled: true, outputType: "jpeg/b64" , inkColor: COLORS.RED})
```
Default outputType: "pdf". Supported output types are: `pdf`, `jpeg/buf`, `jpeg/b64`, `png/buf` and `png/b64`. If the output type is set to `pdf`, it returns a promise that will resolve in a [pdfkit](https://github.com/foliojs/pdfkit#readme) document instance. Else it will return a promise that will resolve in an array containing the buffer or base64 value of the images according to the output type provided.
Default `inkColor` is `black`, more ink colors are available through `COLORS` under `handwritten.js/constants`
## Screenshot
## Author
👤 **Rahil Kabani **
## Show your support
Give a ⭐️ if this project helped you!
## 🤝 Contributing
Contributions, issues and feature requests are welcome! Feel free to check [issues page](https://github.com/alias-rahil/handwritten.js/issues).
> handwritten.js only supports English letters. I am not planning to add support for other languages for now. Please do not any more make issues about this. However, I will merge pull requests if any. See the issue [#18](https://github.com/alias-rahil/handwritten.js/issues/18) for more details.
## Credits
[GDGVIT/HandWriter](https://github.com/GDGVIT/HandWriter) - For the cleaned dataset.
## Handwritten.JS
🏠 [Homepage](https://github.com/alias-rahil/handwritten.js#readme)
## License
[MIT](https://github.com/alias-rahil/handwritten.js/blob/master/LICENSE)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
