1.0.0 • Published 6 years ago

crazycode v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

crazycode

An encoding like base64 and base58 that looks cooler. Like base64, base64, hex, octal, etc. crazycode is an encoding that turns binary data into text and vice-versa. The main difference is that crazycode is way cooler!

    Hex:    8262d0c3f0d78c73e007
    Base64: gmLQw/DXjHPgBw==
    crazy:  ӻվƕɇʃɽѫӟʝπ

crazycode will output the same number of characters as there are bytes in the input. When encoded UTF-8, the output will have at most twice the number of bytes as the input. Crazycode (unlike hex and base64) cannot be encoded using non-unicode encodings.

crazycode will work in most browsers and most terminals. In most browsers and editors, crazycode output will be considered as a single word and double clicking should select all of the text.

selecting

Examples

Input:  [1,2,3,4,5]
Hex:    0102030405
Base64: AQIDBAU=
crazy:  χіȼрд

Input:  [100,33,42,209,87]
Hex:    64212ad157
Base64: ZCEq0Vc=
crazy:  їϗσկȣ

Input: (32 random bytes)
Hex:    8262d0c3f0d78c73e00770f68b6f94abe5153d696074e5f755bd7497351675c6
Base64: gmLQw/DXjHPgB3D2i2+Uq+UVPWlgdOX3Vb10lzUWdcY=
crazy:  ӻվƕɇʃɽѫӟʝπԧnjбhџljжոɛɱӈҳжçκքҳѭաҥɀv

Notes

crazycode will fail to output correctly if the destination (e.g. the console) does not support unicode (e.g. the Windows cmd console by default).

crazycode (like base64, base58, and hex) does not make the data smaller. It will in practice result in data that is way bigger than the source data. The output, however, will look shorter than base64, base58, or hex (see examples below). All of the characters used in crazycode are letters or numbers, so crazycode output can usually be selected in its entirety by double clicking it. Furthermore there are 256 possible characters for crazycode so the output will have the same number of characters that the input has bytes.

Using crazycode

How to use:

const { encode, decode } = require('crazycode');

const input = [1,2,3,4,5];
const encoded = encode(input);

// outputs: χіȼрд
console.log(encoded);

const decoded = decode(encoded);

// outputs: [ 1, 2, 3, 4, 5 ]
console.log(decoded);

Functions

There are two functions: encode and decode

Encode

encode takes an array or Buffer and returns a string. If it's an array it expects the array to contain numbers between 0 and 255. If the input contains invalid data an exception will be thrown.

Example:

const input = [1,2,3,4,5];
const encoded = encode(input);

// outputs: χіȼрд
console.log(encoded);

Decode

decode takes a string and returns an array. If the input contains unacceptable characters an exception will be thrown.

Example:

const input = 'χіȼрд';
const decoded = decode(input);

// outputs: [ 1, 2, 3, 4, 5 ]
console.log(decoded);

License

MIT License. Copyright 2018 (c) Cillié Malan. See LICENSE.