fumen-svg

0.1.5 • Public • Published

fumen-svg

Build Status codecov install size

Convert fumen data into animated SVG.

example

Installation

npm install fumen-svg

Usage

const {createSVG} = require("fumen-svg");

const output = createSVG({
  data: FUMEN_DATA
});

// save to the disk
const fs = require("fs");
fs.writeFileSync("animated.svg", output);

API

This module exports following members:

  • createSVG

createSVG

createSVG({
  data: String,
  index?: Number,
  delay?: Number,
  size?: Number,
  comment?: String
}) => output: String

data is the fumen data.

If index is specified, create an SVG of the specified frame instead of an animated image.

delay controls the delay between each frame. Unit: ms. Default: 500.

size is the width/height of a single tile. Unit: px. Default: 16.

Use comment to control whether to draw the comment box. Available values:

  • "always" - always draw the comment box.
  • "none" - don't draw the comment box.
  • "auto" (default) - draw the comment box if there is a comment.

Changelog

  • 0.1.5 (Dec 20, 2019)

    • Fix: reuse comment background.
    • Change: alter the color of T.
  • 0.1.4 (Dec 19, 2019)

    • Fix: lines to be cleared should be lighten.
  • 0.1.3 (Dec 19, 2019)

    • Fix: draw background before minos.
    • Fix: can't fill piece error.
    • Fix: images height is not an integer.
    • Fix: remove duplicated comment.
    • Add: grid to background.
  • 0.1.2 (Dec 19, 2019)

    • Add: comment option.
  • 0.1.1 (Dec 19, 2019)

    • Fix: deps.
  • 0.1.0 (Dec 19, 2019)

    • Initial release.

Readme

Keywords

Package Sidebar

Install

npm i fumen-svg

Weekly Downloads

1

Version

0.1.5

License

MIT

Unpacked Size

10.8 kB

Total Files

4

Last publish

Collaborators

  • eight04