Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keith-turner/ecoji
Encodes (and decodes) data as emojis
https://github.com/keith-turner/ecoji
ecoji emoji encoding fun golang unicode
Last synced: 5 days ago
JSON representation
Encodes (and decodes) data as emojis
- Host: GitHub
- URL: https://github.com/keith-turner/ecoji
- Owner: keith-turner
- License: apache-2.0
- Created: 2018-03-05T05:02:09.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T18:13:25.000Z (6 months ago)
- Last Synced: 2025-01-09T23:32:34.226Z (12 days ago)
- Topics: ecoji, emoji, encoding, fun, golang, unicode
- Language: Go
- Homepage: https://ecoji.io
- Size: 1.31 MB
- Stars: 839
- Watchers: 11
- Forks: 25
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - ecoji - turner | 690 | (Go)
README
# Ecoji 2.0 🏣🔉🦐🩻🍈🚞🤹🥷
Ecoji encodes data using 1024 [emojis][emoji]. This repository contains the
canonical implementation of the [Ecoji standard](docs/encoding.md) written in
[Go](https://go.dev). 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](https://ecoji.io) to try Ecoji in your browser.
## Usage
```bash
$ 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:
```bash
$ echo "Base64 is so 1999, isn't there something better?" | ecoji -e
🧏📩🧈🐇🧅📘🔯🚜💞😽♏🐊🎱🥁🚄🌱💞😭💮✊💢🪠🐭🩴🍉🚲🦑🐶💢🪠🔮🩹🍉📸🐮🌼👦🚟🥴📑
```
### Decoding:
```bash
$ echo 🧏📩🧈🐇🧅📘🔯🚜💞😽♏🐊🎱🥁🚄🌱💞😭💮✊💢🪠🐭🩴🍉🚲🦑🐶💢🪠🔮🩹🍉📸🐮🌼👦🚟🥴📑 | ecoji -d
Base64 is so 1999, isn't there something better?
```
### Concatenation:
```bash
$ echo -n abc | ecoji -e
👖📸🎈☕
$ echo -n 6789 | ecoji -e
🎥🤠📠🛼
$ echo XY | ecoji -e
🐲👡🪚☕
$ echo 👖📸🎈☕🎥🤠📠🛼🐲👡🪚☕ | ecoji -d
abc6789XY
```
### Making Hashes More Interesting
```bash
$ 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](https://accumulo.apache.org). 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](https://github.com/ohdatboi/ecoji-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()](https://github.com/keith-turner/ecoji/blob/1afbae30233e80e8fb712b3521ab4cb5bf470002/v2/encode.go#L172) [ecoji.EncodeV2()](https://github.com/keith-turner/ecoji/blob/1afbae30233e80e8fb712b3521ab4cb5bf470002/v2/encode.go#L177) and [ecoji.Decode()](https://github.com/keith-turner/ecoji/blob/1afbae30233e80e8fb712b3521ab4cb5bf470002/v2/decode.go#L107). |
| [Java](https://github.com/netvl/ecoji-java) | V1 | Implementation of Ecoji written in Java, usable in any JVM language. |
| [JavaScript](https://github.com/UmamiAppearance/BaseExJS) | V1,V2 | A collection of base converters, which includes an implementation of Ecoji written in JavaScript. |
| [.NET](https://github.com/abock/dotnet-ecoji) | V1 | Implementation of Ecoji written in C# targeting .NET Standard 2.0: [`dotnet add package Ecoji`](https://www.nuget.org/packages/Ecoji). |
| [PHP](https://github.com/Rayne/ecoji-php) | V1 | PHP 7.x implementation of Ecoji. Available as [`rayne/ecoji` on Packagist](https://packagist.org/packages/rayne/ecoji). |
| [Python](https://github.com/mecforlove/ecoji-py) | V1 | Implementation of Ecoji written in the Python3 programming language. |
| [Ruby](https://github.com/makenowjust/ecoji.rb) | V1,V2 | Implementation of Ecoji written in the Ruby programming language: [`gem install ecoji`](https://rubygems.org/gems/ecoji) |
| [Rust](https://github.com/netvl/ecoji.rs) | V1 | Implementation of Ecoji written in the Rust programming language. |
| [Swift](https://github.com/Robindiddams/ecoji-swift) | V1 | Implementation of Ecoji written in the Swift programming language. |
## Building
To build the command line version of ecoji, run the following commands.
```bash
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](docs/library-example.md).
[emoji]: https://unicode.org/emoji/
[video]: https://www.youtube.com/watch?v=XCsL89YtqCs
[tour]: https://tour.golang.org/welcome/1