README
¶
randomart
Visual fingerprint hash (e.g. "randomart") library for Go.
Implements the "drunken bishop" algorithm from OpenSSH, with added support for arbitrary grid size and tilesets.
Output formats
Examples of rendering the same data with different settings.
OpenSSH compatible
Dimensions: 17x9, Tileset: randomart.SSHTiles, Armor: true
+-----------------+
| .+. |
| o. |
| .. + |
| Eo = |
| S + . |
| o B . . |
| B o.. |
| *... |
| .o+... |
+-----------------+
Spacey emoji
Dimensions: 10x10, Tileset: randomart.Galaxy, Armor: false
🌒🌔🌑🌑🌑🌑🌑🌑🌑🌑
🌑🌑🌔🌑🌑🌑🌑🌑🌑🌑
🌑🌒🌑🌒🌑🌑🌑🌑🌑🌑
🌑🌑🌚🌑🌔🌑🌑🌑🌑🌑
🌑🌑🌑🌓🌑🌕🌑🌑🌑🌑
🌑🌑🌑🌑🌓🌝🌔🌑🌒🌑
🌑🌑🌑🌑🌓🌔🌔🌒🌑🌒
🌑🌑🌑🌑🌓🌕🌒🌒🌓🌑
🌑🌑🌑🌑🌑🌓🌔🌓🌑🌒
🌑🌑🌑🌑🌑🌒🌔🌔🌒🌒
Examples
- fcaddr: Fingerprint Filecoin f1 addresses
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // All TileSets bundled with the package. BundledTileSets = []TileSet{SSHTiles, GalaxyTiles} // Classic OpenSSH randomart tileset, using basic ASCII. SSHTiles = TileSet{ ID: "openssh", Runes: []rune{' ', '.', 'o', '+', '=', '*', 'B', 'O', 'X', '@', '%', '&', '#', '/', '^'}, Start: 'S', End: 'E', } // A spacey emoji based tileset. GalaxyTiles = TileSet{ ID: "galaxy", Runes: []rune{'🌑', '🌒', '🌓', '🌔', '🌕', '🪐', '🌖', '🌗', '🌘'}, Start: '🌝', End: '🌚', } )
Functions ¶
Types ¶
type Board ¶
type Board struct {
// contains filtered or unexported fields
}
func NewBoard ¶
NewBoard initializes a Board of dimensions x, y with a starting position of the center point.
x 0→n, y 0↓n.
func (*Board) Write ¶
Write writes len(p) bytes to the underlying Board. The provided fingerprint will be used to explore the board using the drunken bishop algorithm.
Implements the io.Writer interface. The returned number of bytes will always equal len(fingerprint), and the error will always be nil
type TileSet ¶
type TileSet struct {
ID string // unique name
Runes []rune
Start rune // special rune for the starting position (optional)
End rune // special rune for the ending position (optional)
// If PreventRuneOverflow is true, the last value of Runes will be used for
// any TileSet.Index(n) where n >= len(Runes). Otherwise, the default
// behavior will be used which is to wrap around.
PreventRuneOverflow bool
}
Source Files
Directories