1.0.2 • Published 1 year ago

stripes-maker v1.0.2

Weekly downloads
-
License
SEE LICENSE IN LI...
Repository
github
Last release
1 year ago

ミ☆ Stripes Maker ☆彡

GitHub package.json version NPM

Node.js stripe pattern generator and maker. It can create multi-line static and animated SVG stripe patterns.

example.svg

Table of Contents

How to use

  1. Install the module using npm: npm install stripes-maker
  2. Edit stripes.config.js file.
  3. Run npm start
  4. The output SVG file will be in the './out/' folder.

stripes.config.js

This is an example stripes configuration file that will create an SVG file with four stripes.

const config = {
    out: './out/example.svg', // the pass to the output file
    width: 300, // SVG width
    height: 300, // SVG height
    bgColor: '#fff', // SVG background color
    lineRotation: 45, // stripes rotation angle in degrees

    // optional animation -----------
    animationType: 4, // linear animation - see types list below
    animationDuration: 30, // seconds
    
    // the list of stripes ----------
    stripes: [
        {
            color: '#505050',
            size: 20,
        },
        {
            color: '#92CBFA',
            size: 10,
        },
        {
            color: '#AB3C83',
            size: 20,
        },
        {
            color: '#ffffff',
            size: 10,
        }
    ]
};

Animation Types

There are four possible types of animation that can be specified in the configuration file.

  • NoAnimation = 1
  • RotateClockWise = 2
  • RotationCounterClockwise = 3
  • Linear = 4

How to run from another folder

The script can also be run globally using the following command:

stripes-maker

You can also pass another configuration file:

stripes-maker another.config.js