Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jaid/render-dead-by-daylight-build

Creates an image of a Dead by Daylight build.
https://github.com/jaid/render-dead-by-daylight-build

dbd dead-by-daylight image image-generation lib library render util utility

Last synced: 26 days ago
JSON representation

Creates an image of a Dead by Daylight build.

Awesome Lists containing this project

README

        

# render-dead-by-daylight-build

License Sponsor render-dead-by-daylight-build
Build status Commits since v1.1.1 Last commit Issues
Latest version on npm Dependents Downloads

**Creates an image of a Dead by Daylight build.**

## Installation

render-dead-by-daylight-build on npm

```bash
npm install --save render-dead-by-daylight-build@^1.1.1
```

render-dead-by-daylight-build on Yarn

```bash
yarn add render-dead-by-daylight-build@^1.1.1
```

@jaid/render-dead-by-daylight-build on GitHub Packages
(if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages))

```bash
npm install --save @jaid/render-dead-by-daylight-build@^1.1.1
```

## Example

![Example Screenshot](./readme/example.png)

This image is rendered by this code:
```javascript
import renderDeadByDaylightBuild from "render-dead-by-daylight-build"
import Jimp from "jimp"

const perkIds = ["wellMakeIt", "noMither", "selfCare", "headOn"]
const screenshotBuffer = await renderDeadByDaylightBuild(perkIds)

const jimp = await Jimp.read(screenshotBuffer)
await jimp.writeAsync("./build.png")
```

## Development

Setting up:
```bash
git clone [email protected]:jaid/render-dead-by-daylight-build.git
cd render-dead-by-daylight-build
npm install
```
Testing:
```bash
npm run test:dev
```
Testing in production environment:
```bash
npm run test
```

## License
[MIT License](https://raw.githubusercontent.com/jaid/render-dead-by-daylight-build/master/license.txt)
Copyright © 2020, Jaid \ (https://github.com/jaid)