https://github.com/piglig/go-qr

A native, high-quality and minimalistic QR code generator
https://github.com/piglig/go-qr

go golang qr qr-code qr-generator qrcode qrcode-generator

Last synced: 8 months ago
JSON representation

A native, high-quality and minimalistic QR code generator

Host: GitHub
URL: https://github.com/piglig/go-qr
Owner: piglig
License: mit
Created: 2023-06-29T06:05:45.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-12-16T06:29:14.000Z (12 months ago)
Last Synced: 2025-03-29T03:23:13.643Z (8 months ago)
Topics: go, golang, qr, qr-code, qr-generator, qrcode, qrcode-generator
Language: Go
Homepage:
Size: 252 KB
Stars: 37
Watchers: 0
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-go-cn - go-qr - quality and minimalistic QR code generator. [![godoc][D]](https://godoc.org/github.com/piglig/go-qr) (公用事业公司 / 实用程序/Miscellaneous)
awesome-go - go-qr - A native, high-quality and minimalistic QR code generator. (Utilities / Utility/Miscellaneous)
fucking-awesome-go - go-qr - A native, high-quality and minimalistic QR code generator. (Utilities / Utility/Miscellaneous)
awesome-go-plus - go-qr - A native, high-quality and minimalistic QR code generator. ![stars](https://img.shields.io/badge/stars-37-blue) (Utilities / Utility/Miscellaneous)
awesome-go-with-stars - go-qr - A native, high-quality and minimalistic QR code generator. (Utilities / Utility/Miscellaneous)
awesome-go - go-qr - A native, high-quality and minimalistic QR code generator. (Utilities / Utility/Miscellaneous)
awesome-go - piglig/go-qr - quality and minimalistic QR code generator ☆`45` (Utilities / Utility/Miscellaneous)
awesome-go - go-qr - A native, high-quality and minimalistic QR code generator. (Utilities / Utility/Miscellaneous)
awesome-go - go-qr - A native, high-quality and minimalistic QR code generator. (Utilities / Utility/Miscellaneous)
awesome-go-cn - go-qr - quality and minimalistic QR code generator. [![近一周有更新][G]](https://github.com/piglig/go-qr) [![godoc][D]](https://godoc.org/github.com/piglig/go-qr) (公用事业公司 / 实用程序/Miscellaneous)

README

          # go-qr

[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go#utilities)

[![Go Report Card](https://goreportcard.com/badge/github.com/piglig/go-qr)](https://goreportcard.com/report/github.com/piglig/go-qr)

[![Build Status](https://github.com/piglig/go-qr/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/piglig/go-qr/actions/workflows/go.yml?query=branch%3Amain)

[![Codecov](https://img.shields.io/codecov/c/github/piglig/go-qr)](https://app.codecov.io/github/piglig/go-qr)

[![GoDoc](https://godoc.org/github.com/piglig/go-qr?status.svg)](https://pkg.go.dev/github.com/piglig/go-qr)

[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/piglig/go-qr/blob/main/LICENSE)

> 🎶 Go Community Minimalist QR Code Generator Library.

## Overview

This library is native, high quality and minimalistic. Generate QR code from string text

 

It is mostly a translation of [project Nayuki's Java version of the QR code generator](https://www.nayuki.io/page/qr-code-generator-library).

## Features

* Minimalist native code implementation

* Based on QR Code Model 2 standard, supports all 40 versions and all 4 error correction levels

* Output format: Raw modules/pixels of the QR symbol

* Detects finder-like penalty patterns more accurately than other implementations

* Encoding space optimisation for numeric and special alphanumeric texts

* Japanese Unicode Text Encoding Optimisation

* For mixed numeric/alphanumeric/general/kanji text, computes optimal segment mode switching

* Good test coverage

* MIT's Open Source License

## Installation

```go

go get github.com/piglig/go-qr

```

## [Examples](https://github.com/piglig/go-qr/tree/master/example/main.go)

```go

package main

import (

	go_qr "github.com/piglig/go-qr"

	"image/color"

)

func main() {

	doBasicDemo()

}

func doBasicDemo() {

	text := "Hello, world!"

	errCorLvl := go_qr.Low

	qr, err := go_qr.EncodeText(text, errCorLvl)

	if err != nil {

		return

	}

	config := go_qr.NewQrCodeImgConfig(10, 4)

	err = qr.PNG(config, "hello-world-QR.png")

	if err != nil {

		return

	}

	err = qr.SVG(config, "hello-world-QR.svg", "#FFFFFF", "#000000")

	if err != nil {

		return

	}

	err = qr.SVG(go_qr.NewQrCodeImgConfig(10, 4, go_qr.WithSVGXMLHeader(true)), "hello-world-QR-xml-header.svg", "#FFFFFF", "#000000")

	if err != nil {

		return

	}

}

```

## Command Line Tool

**generator** command line tool to generate the QR Code.

### Installation

In order to use the tool, compile it using the following command

```shell

go install github.com/piglig/go-qr/tools/generator@latest

```

### Usage

```shell

generator [options] [arguments]

  -content string

        Content to encode in the QR code

  -png string

        Output PNG file name

  -svg string

        Output SVG file name

  -svg-optimized

        Output optimized SVG file name - regions with connected black pixels are merged into a single path

```

### Example

* **Text Art**

```shell

generator -content hello

```

![Gif](./docs/assets/text_art.gif)

* **Image Type**

```shell

generator -content hello -png hello.png -svg hello.svg

```

![Gif](./docs/assets/image_type.gif)

* **Optimized SVG Type**

```shell

generator -content hello -svg hello.svg -svg-optimized hello-optimized.svg 

```

The optimized svg output create paths around connected black regions. This reduces the file size and rendering artifacts.

![svg](./docs/assets/optimized_path.svg)

## License

See the [LICENSE](LICENSE) file for license rights and limitations (MIT).

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/piglig/go-qr

Awesome Lists containing this project

README