AnointedAutomation.Algorithms 1.0.5

.NET 10.0

dotnet add package AnointedAutomation.Algorithms --version 1.0.5

NuGet\Install-Package AnointedAutomation.Algorithms -Version 1.0.5

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="AnointedAutomation.Algorithms" Version="1.0.5" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="AnointedAutomation.Algorithms" Version="1.0.5" />
                    

                            Directory.Packages.props

<PackageReference Include="AnointedAutomation.Algorithms" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add AnointedAutomation.Algorithms --version 1.0.5

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: AnointedAutomation.Algorithms, 1.0.5"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package AnointedAutomation.Algorithms@1.0.5

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=AnointedAutomation.Algorithms&version=1.0.5
                    

                            Install as a Cake Addin

#tool nuget:?package=AnointedAutomation.Algorithms&version=1.0.5
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

AnointedAutomation.Algorithms

Jesus is King ✝️

Reusable algorithms with no dependencies for the AnointedAutomation suite. Today it ships a pure C# QR code encoder (ISO/IEC 18004) with Reed-Solomon error correction, for developers who need QR codes without pulling in a native or third party imaging library.

Installation

dotnet add package AnointedAutomation.Algorithms

Target framework: net10.0
Dependencies: none

Quick start

using System;
using AnointedAutomation.Algorithms.QrCode;

QrMatrix matrix = QrEncoder.Encode("https://store.anointed.company", QrErrorCorrectionLevel.M);

for (int y = 0; y < matrix.Size; y++)
{
    for (int x = 0; x < matrix.Size; x++)
    {
        Console.Write(matrix.IsDark(x, y) ? "##" : "  ");
    }
    Console.WriteLine();
}

To turn the matrix into an SVG or PNG, add AnointedAutomation.Imaging.

API overview

Namespace: AnointedAutomation.Algorithms.QrCode

Type	Kind	Purpose
`QrEncoder`	static class	`QrMatrix Encode(string text, QrErrorCorrectionLevel ecc = QrErrorCorrectionLevel.M)` encodes UTF-8 text into a QR symbol.
`QrMatrix`	sealed class	The encoded symbol. `int Size` is the module count per side; `bool IsDark(int x, int y)` reads one module.
`QrErrorCorrectionLevel`	enum	`L` (~7% recovery), `M` (~15%), `Q` (~25%), `H` (~30%).

What Encode does for you:

Byte mode (the input is encoded as UTF-8).
Automatic version selection: the smallest version from 1 to 10 that fits the data.
Reed-Solomon error correction with block interleaving.
Finder, timing and alignment patterns, plus format and version information (BCH coded).
Automatic mask selection using the four ISO/IEC 18004 penalty rules.

Galois field arithmetic, the Reed-Solomon encoder, mask scoring and the version tables are internal implementation details, not public API.

Capacity and errors

Versions 1 to 10 are supported (up to 57 x 57 modules). The maximum payload, in UTF-8 bytes, is:

Level	Max bytes
`L`	271
`M`	213
`Q`	151
`H`	119

Encode throws ArgumentNullException when text is null and ArgumentException when the text does not fit any supported version. That comfortably covers URLs and short text.

AnointedAutomation.Imaging: renders a QrMatrix to SVG or PNG.

License

Support This Project

This library is free and open source. The best way to support the work is to shop with us:

Christian items: https://store.anointed.company
Pets: https://www.animaldander.com
Everything else: https://www.mart.club

Found a bug or have a request? Open an issue: https://github.com/AnointedAutomation/AnointedAutomation/issues

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on AnointedAutomation.Algorithms:

Package	Downloads
AnointedAutomation.Imaging Renders QR codes from AnointedAutomation.Algorithms to SVG and PNG using only the .NET base class library, with no third party image dependency.	667