mrkite / qrkit

QR code generator with a variety of flexible options.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

QR Kit

Generate QR codes with a variety of features using an input configuration JSON file.

Features

  • Control the pattern of the dots and style of the alignment corners.
  • Control the quality, padding, and scale.
  • Customize various colors.
  • Embed an icon into the generated QR code.
  • Command-line application.
  • Ultra-fast QR code generation at any quality level.

Build Instructions

In the src directory, run:

make

Upon successful compile, run in the parent directory:

./qrkit --usage

To get a list of options.

-c filename  specifies the config file to use (it'll default to config.json if unspecified)
-e filename  specifies the image to embed in the center (video.png, people.png, camera.png)
-o filename  specifies the name of the png to generate (qr.png is default)

JSON Options

  • minECL - A string containing one of "L", "M", "Q", or "H". The minimum Error Correction Level. Default is "L".
  • padding - An integer containing the number of pixels of padding around the QR code. Default is 10.
  • scale - An integer containing the scale of each dot in pixels. Default is 10.
  • background - A string containing a HTML hex color for the background and padding. Default is "#FFFFFF".
  • pattern - A string containing a HTML hex color for the pattern (corner boxes). Default is "#000000".
  • align - A string containing a HTML hex color for the alignment box in the lower-right corner. Default is "#000000".
  • code - A string containing a HTML hex color for the code/data. Default is "#000000".
  • icon - A string containing a HTML hex color for the center icon, if used. Default is "#000000".
  • style - A string containing one of "none" (square), "dots" (perfect dots), "hdots" (dots blended horizontally), "vdots" (dots blended vertically), or "hvdots" (dots blended both directions). Default is "none".
  • patstyle - A string containing one of "none", "rounded" (rounded rectangle), "circle". Default is "none".
  • corners - An array of strings containing one or more of "tl", "tr", "bl", "br". Only used when patstyle is "rounded". Default is none.

About

QR code generator with a variety of flexible options.

License:MIT License


Languages

Language:C++ 99.6%Language:Makefile 0.4%