vaporwaver-ts v1.0.1

Python usage

A Python3 script to create vaporwave image based on PNG files. An improved version of the PHP one I did 2 years ago. However, this time I used multiple third-party libraries, which are:

• PIL (Pillow)
• glitch-this (https://github.com/TotallyNotChase/glitch-this)
• opencv-python

You can install them with pip install -r requirements.txt.

This program uses tkinter for the GUI tool (very pretty)

How does it works

The program takes an image, with or without transparency (though, please use an image with transparency for a better result!), we will call this image the "character" You can move the character in the X and Y axis, and scale it. You can apply a glitch amount and seed on it and also a predefined gradient map filter. The gradients are the built in opencv colormap

You can add a predefined misc item behind the character, which you can :

• Move
• Rotate
• Scale

And you can select one of the predefined background image. The output image will have a size of 460 x 595 px

Image ressources

⚠️ WARNING ⚠️

For launching, this program needs three files in specific paths. They are already in the repository, but please do not rename nor delete them. You can replace their content tho.

• picts/backgrounds/default.png
• picts/crt/crt.png
• picts/miscs/none.png

Do not remove thoses files, at any cost !

Backgrounds

The backgrounds size, in order to be selectable in the GUI list, must have the size of the output image, which means 460 x 595 px. You can name them as you want, they must be PNG files located at the picts/backgrounds folder.

Miscs

The miscs items are just decorations to put behind the character. There is no specific restriction on it. You can take any size, but they still musts be PNG files.

What does the program looks like ?

CLI mode

You can also use this program with the CLI. Fill the correct arguments to create your vaporwavec image. You can have more informations with py vaporwaver.py -h Here is the correct usage:

usage: vaporwaver.py [-h] [-b background] [-m misc] [-mx miscPosX] [-my miscPosY] [-ms miscScale] [-mr miscRotate] [-c characterPath] [-cx characterXpos] [-cy characterYpos]
                     [-cs characterScale] [-cr characterRotation] [-cg characterGlitch] [-cgs characterGlitchSeed] [-cgd characterGradient] [-cgl characterGlow] [-crt crt] [-o output]

Vaporwave image editor

optional arguments:
  -h, --help            show this help message and exit
  -b                    Background image name for the vaporwaver render (without extension) in picts/backgrounds/ folder (default: default)
  -m                    Misc image name for the vaporwaver render (without extension) in picts/miscs/ folder (default: none)
  -mx                   Misc X position (default: 0) [-100, 100]
  -my                   Misc Y position (default: 0) [-100, 100]
  -ms                   Misc scale (default: 100) [1, 200]
  -mr                   Misc rotation (default: 0) [-360, 360]
  -c                    Character image path for the vaporwaver render (default: none) [REQUIRED]
  -cx                   Character X position (default: 0) [-100, 100]
  -cy                   Character Y position (default: 0) [-100, 100]
  -cs                   Character scale (default: 100) [1, 200]
  -cr                   Character rotation (default: 0) [-360, 360]
  -cg                   Character glitch (default: 0.1) [0.1, 1]
  -cgs                  Character glitch seed (default: 1) [0, 100]
  -cgd                  Character gradient to apply, cvt colormap name (default: none) [none, autumn, bone, jet, winter, rainbow, ocean, summer, spring, cool, hsv, pink, hot, parula, magma, inferno, plasma, viridis, cividis, deepgreen]
  -cgl                  Character glow to apply (default: none) [none, red, green, blue, yellow]
  -crt                  CRT effect (default: False)
  -o                    Output file name with path (default: output.png) PNG format only

TypeScript usage

Install the package with using the command npm i vaporwaver-ts and import the main package with

import { vaporwaver } from "vaporwaver-ts";

The vaporwaver() function takes as parameter one object, IFlags, which should be configured like this:

interface IFlag {
    // the background image of the vaporwave image
    background?: string;
    
    // the misc image of the vaporwave image
    misc?: string;
    // the misc image's x position
    miscPosX?: number;
    // the misc image's y position
    miscPosY?: number;
    // the misc image's scale
    miscScale?: number;
    // the misc image's rotation
    miscRotate?: number;

    // the character image of the vaporwave image (required)
    characterPath: string;
    // the character image's x position
    characterXPos?: Number;
    // the character image's y position
    characterYPos?: number;
    // the character image's scale
    characterScale?: number;
    // the character image's rotation
    characterRotate?: number;
    // the character image's glitch value
    characterGlitch?: number;
    // the character image's glitch seed value
    characterGlitchSeed?: number;
    // the character image's gradient value accorded to cvt color gradients maps
    characterGradient?: string;


    // crt effect on the vaporwave image
    crt?: boolean;

    // output path of the vaporwave image
    outputPath?: fs.PathLike;
};

• characterGradient must be a valid predefined cv2 gradient colormap.
• misc and background are not path, but name of the background and misc. For example, neon is a valid background, and diamonds is a valid misc.

The function uses the CLI mode for the vaporwaver script, so the output is the same as the CLI mode.