Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dannyben/icodi

Deterministic Random SVG Icon Generator
https://github.com/dannyben/icodi

avatar-generator avatar-placeholder gem identicon identicon-generator ruby svg svg-generator

Last synced: 3 days ago
JSON representation

Deterministic Random SVG Icon Generator

Host: GitHub
URL: https://github.com/dannyben/icodi
Owner: DannyBen
License: mit
Created: 2018-12-15T19:46:03.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-12-19T11:04:20.000Z (15 days ago)
Last Synced: 2024-12-24T13:13:01.563Z (10 days ago)
Topics: avatar-generator, avatar-placeholder, gem, identicon, identicon-generator, ruby, svg, svg-generator
Language: Ruby
Homepage: http://icodi.dannyb.co/sandbox
Size: 76.2 KB
Stars: 32
Watchers: 3
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        ![logo](assets/logo.svg)

Icodi - Deterministic Random SVG Icon Generator

==================================================

[![Gem Version](https://badge.fury.io/rb/icodi.svg)](https://badge.fury.io/rb/icodi)

[![Build Status](https://github.com/DannyBen/icodi/workflows/Test/badge.svg)](https://github.com/DannyBen/icodi/actions?query=workflow%3ATest)

[![Maintainability](https://api.codeclimate.com/v1/badges/0b74be3877413501c7a9/maintainability)](https://codeclimate.com/github/DannyBen/icodi/maintainability)

---

Generate repeatable random SVG icons from any string, similar to 

[GitHub identicons].

---

Installation

--------------------------------------------------

    $ gem install icodi

Demo

--------------------------------------------------

Visit the [Icodi Playground] to experiment with the parameters.

Examples

--------------------------------------------------

### Grid: 5x5, Mirror: X (default settings)

![strip1](assets/strip_default.svg)

### Grid: 6x6, Mirror: Y, Stroke: 4

![strip2](assets/strip_mirror_y.svg)

### Grid: 8x8, Stroke: 7, Density: 0.3

![strip3](assets/strip_thick_stroke.svg)

### Grid: 7x7, Mirror: X/Y, Stroke: 3, Density: 0.8

![strip4](assets/strip_mirror_both.svg)

### Grid: 5x5, Jitter: 0.9, Stroke: 2

![strip4](assets/strip_jitter.svg)

### Increasing Stroke: 0.1 - 5.0

![strip5](assets/strip_strokes.svg)

### Increasing Density: 0.3 - 0.8

![strip6](assets/strip_densities.svg)

### Increasing Jitter: 0 - 1.0

![strip6](assets/strip_jitters.svg)

### Mirror Styles: X, Y, Both, None

![strip7](assets/strip_mirrors.svg)

Usage

--------------------------------------------------

This is the general usage pattern:

```ruby

require 'icodi'

# initialize with optional text and options

icon = Icodi.new text, options

# get the SVG string

icon.render

# or save to SVG file

icon.save 'logo'

```

Generate a random icon with the default options, and save it to `icon.svg`:

```ruby

icon = Icodi.new

icon.save 'icon'

```

Generate persistent random icon (same input generates the same output):

```ruby

icon = Icodi.new "any string"

icon.save 'icon'

```

Options

--------------------------------------------------

Options can be provided as the first or second argument:

```ruby

Icodi.new "any string", pixels: 8, density: 0.3

Icodi.new pixels: 8, density: 0.3, stroke: 2

```

Parameter   | Default    | Type    | Description

------------|------------|---------|---------------------

`pixels`    | `5`        | Integer | Grid size.

`mirror`    | `:x`       | Symbol  | Mirroring mode: `:x`, `:y`, `:both` or `:none`.

`color`     | Deterministic Random | String | A color string for the pixels.

`density`   | `0.5`      | Float   | A value between 0 and 1 representing the chance for a pixel to be drawn. Lower values mean less pixels.

`stroke`    | `0.1`      | Float   | Width of the border around each pixel. Note that each pixel is a 10x10 box, so a stroke of 1 means it will take 10% of the box. Higher values generate more overlap between the pixels.

`jitter`    | `0`        | Float   | A value between 0 and 1 representing the chance for a pixel to be dislocated by half of its size in a random direction.

`background`| `#fff`     | String  | A named SVG color string (`blue`, `yellow` etc.) or RGB color (for example `#dddddd`).

`id`        | `icodi`    | String  | The ID to assign the SVG object. Normally this should not matter, but if you intend to embed this icon in an HTML, or in another SVG, this can be useful.

`template`  | `:default` | Symbol/String | SVG template to use. Can be `:default`, `:minimal` or a path to a file. Read more on [Victor SVG Templates].

---

Using with Sinatra

--------------------------------------------------

To create a Sinatra server that serves Icodi images, see the 

[config.ru](config.ru) example code.

Contributing / Support

--------------------------------------------------

If you experience any issue, have a question or a suggestion, or if you wish

to contribute, feel free to [open an issue][issues].

---

[GitHub identicons]: https://blog.github.com/2013-08-14-identicons/

[Victor SVG Templates]: https://victor.dannyb.co/extras/templates/

[Icodi Playground]: https://icodi.dannyb.co/sandbox

[issues]: https://github.com/DannyBen/icodi/issues