Skip to content

keith-turner/ecoji

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Repository files navigation

Ecoji 2.0 馃彛馃攭馃馃┗馃崍馃殲馃す馃シ

Ecoji encodes data using 1024 emojis. This repository contains the canonical implementation of the Ecoji standard written in Go. Version 2 of the Ecoji standard was released in 2022 with an improved set of emojis. Ecoji version 2 produces output that is much more interesting and visually stimulating than what version 1 produced.

Visit ecoji.io to try Ecoji in your browser.

Usage

$ ecoji -h
usage: ecoji [OPTIONS]... [FILE]

Encode or decode data as Unicode emojis. 馃榿

For compatability, when given no options stdin will be encoded using Ecoji 
version 1. When using the new -e option, stdin is encoded using Ecoji 
version 2.  The -e and -d options are mutually exclusive.

Options:
    -e, --encode          Encode data using Ecoji version 2.  Omitting this
                          option will encode using Ecoji version 1.
    -d, --decode          Decodes data encoded using the Ecoji version 1 or 2 standard.
    -w, --wrap=COLS       wrap encoded lines after COLS character (default 76).
                          Use 0 to disable line wrapping.  This options is
                          ignored when decoding.
    -h, --help            Print this message
    -v, --version         Print version information.

馃彛馃攭馃馃┗馃崍馃殲馃す馃シ

Examples

Encoding:

$ echo "Base64 is so 1999, isn't there something better?" | ecoji -e
馃馃摡馃馃悋馃馃摌馃敮馃殰馃挒馃樈鈾忦煇婐煄别煡侌煔勷煂别煉烉煒煉湂馃挗馃獱馃惌馃┐馃崏馃毑馃馃惗馃挗馃獱馃敭馃┕馃崏馃摳馃惍馃尲馃懄馃殶馃ゴ馃搼

Decoding:

$ echo 馃馃摡馃馃悋馃馃摌馃敮馃殰馃挒馃樈鈾忦煇婐煄别煡侌煔勷煂别煉烉煒煉湂馃挗馃獱馃惌馃┐馃崏馃毑馃馃惗馃挗馃獱馃敭馃┕馃崏馃摳馃惍馃尲馃懄馃殶馃ゴ馃搼 | ecoji -d
Base64 is so 1999, isn't there something better?

Concatenation:

$ echo -n abc | ecoji -e
馃憱馃摳馃巿鈽
$ echo -n 6789 | ecoji -e
馃帴馃馃摖馃浖
$ echo XY | ecoji -e
馃惒馃憽馃獨鈽
$ echo 馃憱馃摳馃巿鈽曫煄ヰ煠狆煋狆煕拣煇拆煈○煪氣槙 | ecoji -d
abc6789XY

Making Hashes More Interesting

$ cat encode.go  | openssl dgst -binary -sha1 | ecoji -e
馃馃幒馃ェ馃椊馃嵒馃徍馃挩馃タ馃崥馃搰馃尡馃憺馃懟馃寔馃馃椌
$ echo 馃馃幒馃ェ馃椊馃嵒馃徍馃挩馃タ馃崥馃搰馃尡馃憺馃懟馃寔馃馃椌 | ecoji -d | openssl base64
Qo7e3rIs0pdfySSfYaWNaoO+ZrM=
$ cat encode.go  | openssl dgst -binary -sha1 | openssl base64
Qo7e3rIs0pdfySSfYaWNaoO+ZrM=

(If you want to use Ecoji for hashes, consider the dangers inherent in older systems without utf8 emoji support, different fonts, and similar emojis.)

A URL Shortener

Four base1024 emojis can represent 1 trillion unique IDs. In the example below af82dd48f7 represents a 5 byte id for a URL in a key value store like Accumulo. When someone enters the URL, the 5 byte id could be used to obtain the actual URL from the database and then redirect.

$ printf "https://ecoji.io/%s\n" $(echo af82dd48f7 | xxd -r -p | ecoji -e)
https://ecoji.io/馃槈馃馃馃弰

Other Implementations

Libraries implementing the Ecoji encoding standard. Submit a PR to add a library to the list. Libraries are given a quick review if time permits and tested before being added. However, libraries are not examined after being added. Adding something to the list is not an endorsement of its correctness or the projects security practices.

Before Ecoji V2 there was not a standard cross language test script, so the testing done for V1 only implementations was inconsistent adhoc manual tests.

Language Version Comments
D V1 Implementation of Ecoji written in the D programming language.
Go V1,V2 This repository offers a Go library package with three functions ecoji.Encode() ecoji.EncodeV2() and ecoji.Decode().
Java V1 Implementation of Ecoji written in Java, usable in any JVM language.
JavaScript V1,V2 A collection of base converters, which includes an implementation of Ecoji written in JavaScript.
.NET V1 Implementation of Ecoji written in C# targeting .NET Standard 2.0: dotnet add package Ecoji.
PHP V1 PHP 7.x implementation of Ecoji. Available as rayne/ecoji on Packagist.
Python V1 Implementation of Ecoji written in the Python3 programming language.
Ruby V1,V2 Implementation of Ecoji written in the Ruby programming language: gem install ecoji
Rust V1 Implementation of Ecoji written in the Rust programming language.
Swift V1 Implementation of Ecoji written in the Swift programming language.

Building

To build the command line version of ecoji, run the following commands.

git clone https://github.com/keith-turner/ecoji.git
cd ecoji/cmd
go build ecoji.go
./ecoji --help

For an example of how to use Ecoji as library see library-example.md.