# pjsekai-background-generator-pixi

> Generate PJSekai background by PixiJS.

Latest version **1.0.3** (published 2022-02-11) · GPLv3 license · 0 weekly downloads

## Install

```sh
npm install pjsekai-background-generator-pixi
pnpm add pjsekai-background-generator-pixi
yarn add pjsekai-background-generator-pixi
bun add pjsekai-background-generator-pixi
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-02-11 |
| First published | 2021-12-29 |
| Weekly downloads | 0 |
| License | GPLv3 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | mkpoli |
| Maintainers | mkpoli |
| Keywords | pixi.js, pjsekai |

## Links

- npm: https://www.npmjs.com/package/pjsekai-background-generator-pixi
- Repository: https://github.com/mkpoli/pjsekai-background-generator-pixi
- Homepage: https://github.com/mkpoli/pjsekai-background-generator-pixi#readme
- Issues: https://github.com/mkpoli/pjsekai-background-generator-pixi/issues
- npm.io page: https://npm.io/package/pjsekai-background-generator-pixi

## Recent versions

- 1.0.3 (latest) — 2022-02-11
- 1.0.2 — 2022-02-11
- 1.0.1 — 2021-12-29
- 1.0.0 — 2021-12-29

## README

# pjsekai-background-generator-pixi
[![npm version](https://badge.fury.io/js/pjsekai-background-generator-pixi.svg)](https://badge.fury.io/js/pjsekai-background-generator-pixi)

A simple tool for generating PJSekai style background with a jacketImage.

## Example

```javascript
import { generate } from 'pjsekai-background-generator-pixi'

(async () => {
  const response = await fetch('./examples/jacket.png')
  const image = await response.blob()
  return await generate(image)
})().then(image => {
  const img = document.createElement('img')
  img.src = URL.createObjectURL(image)
  document.body.appendChild(img)
})
```

### Input
![Example input](/examples/jacket.png)

### Output
![Example output](/examples/output.png)

## Development
```bash
$ pnpm install
$ pnpm watch
```

### Commit Message Convention

```regex
(F|R|D|S|V|I): <Verb Phrase>
```

- **F** for **F**eature (Additions, Fixes, Ajustments of functionalities, etc.)
- **R** for **R**efactor (Adjustments of code structure, naming, typing, comments, etc.)
- **D** for **D**ocumentation (Documentation, README, etc.)
- **S** for **S**tyle (Styling, Visual Design Adjustments, etc.)
- **V** for **V**ersion (Versioning, Dependencies, Licensing, etc.)
- **I** for **I**18n (Translation, Localisation, etc.)

## Acknowledgement

- Some of the data and assets are from [FriedPotato](https://github.com/sevenc-nanashi/FriedPotato) server.
[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=sevenc-nanashi&repo=FriedPotato&theme=gradient&bg_color=30,ff57ab,6040ff&title_color=fff&text_color=fff)](https://github.com/sevenc-nanashi/FriedPotato)

---
_Source: https://npm.io/package/pjsekai-background-generator-pixi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
