txtatech / qreeper

A qr code encoder and decoder that first uses gzip, on the data field text and then encodes a qr code with base64 and another qr code with hex to generate qr codes

qreeper

A qr code encoder and decoder that first uses gzip, on the data field text and then encodes a qr code with base64 and another qr code with hex to generate qr codes

QReeper is a pair of Rust applications that provide QR code data compression and decompression functionality.

The qreeper_encoder encodes and compresses given text data into QR codes in both Hex and Base64 encoding formats.

The qreeper_decoder is capable of decoding these QR codes and decompressing the data back into its original form.

The applications use a GTK interface.

Installing QReeper

To install QReeper, follow these steps:

1. Clone the GitHub repository:

git clone https://github.com/txtatech/qreeper.git

2. Change into the qreeper directory:

cd qreeper

Using QReeper

To use QReeper, you can run each program individually as follows:

QReeper_Encoder

Encodes and compresses text data into QR codes. To use it, navigate to the qreeper_encoder directory and run the following command:

cargo run

This will launch the compressor application. You can enter your text data into the text field and click "Generate QR Codes" to create the QR codes. The compressed data will be shown in the application window and the generated QR codes will be saved as .png files in the same directory.

QReeper_Decoder

Decodes and decompresses data from QR codes. To use it, navigate to the qreeper_decoder directory and run the following command:

cargo run

This will launch the decompressor application. You can use the file chooser to select a QR code .png file and click "Decode QR Code" to decompress the data. The decompressed data will be shown in the application window.

NOTE:

When encoding data as base64, it pads the data to a length that's a multiple of 4. If you are splitting base64 data into chunks, you need to make sure that each chunk (except possibly the last one) ends on a multiple of 4 characters. If you don't, the padding can be cut off, which can cause decoding to fail later on. So, whenever dealing with base64 data in chunks, it is important to keep this in mind.

License

This project uses the MIT License.