README

base256

:cyclone: Base256 is a binary-to-emoji encoding scheme implementation.

Install

$ go get ekyu.moe/base256

Example

package main

import (
    "fmt"

    "ekyu.moe/base256"
)

func main() {
    fmt.Println(base256.EncodeToString([]byte("Hello, 世界")))   //=> 👾🍧🙆🍬🙇🌱😌🚟💦🏥🐴🏤👈
    fmt.Println(string(base256.DecodeString("👾🍧🙆🍬🙇🌱😌🚟💦🏥🐴🏤👈"))) //=> Hello, 世界
}

Check godoc for further documents.

A CLI utility is also available with go get ekyu.moe/base256/cmd/base256.

Specification

base256 encoding uses two tables to transform a single byte into a single emoji. The tables can be found in table.go. In this implementation, these tables are utilized circularly when encoding, however such rule does not apply to decoding.

To achieve the best compatibility, all the emojis are picked from the classic version and each of them is guaranteed to be 4 bytes long in UTF-8.

License

BSD-3-clause

Base256