NathanGibbs3 / 3dIconify

A CLI tool to generate Icons for your Web App using the 3dIcons source.

3dIconify -- Web App Icon Generation.

Build Icons for your Web App using the 3dIcons source.

Generates smaller icons on an optionally transparent background using the requested 3dIcon resource(s).

Supports resource naming prefix, and icon name conversion to meet specific project resource naming standards.

This project enables developers to:

1. Work with a professionally designed open source icon set.
2. Scale icons to the size requirements of their project.
3. Spend less time installing npm compoents or learning yet another REST API just to get icons.
4. Spend more time writing code. 😄

History:

While working on BASE, we needed to standardize the app's iconography.

What we had, Icons:

1. Designed to varying specs & standards.
2. With no consistent resource naming convention.

What we needed, Icons:

1. Designed to the same specs & standards.
2. Compatible with older Web Browsers, PNGs NOT SVGs.
3. That could scale to different sizes and still look good.
4. Released under an Open Source License.
   1. So we can release them as part of our project.
   2. So we can modify them if needed.

The 3dIcons project met all the criteria. We developed a custom tool, that transforms the icons we need to use in BASE, to specific specs and stores them according to our resource naming standrads.

This project:

3dIconify, the open source version of the custom tool, takes a project file, the 3dIcons source; and builds an icon set, with the requested icon size, background transparency, and naming scheme.

Usage:

Command Line Options, great for one off testing, are space sepearated; and support a subset of what can be done in a 3dIconify project file.

Options:

1. Location of 3dIcons or 3dIconify project file. ( defaults to 3dIcons )
   1. 3dIconify project files have the extension .3dicp
   2. See: docs/BASE.example.3dicp for more informarion.
2. Location of generated Icons. ( defaults to Icons )
3. Icon Size. ( Defaults to 96 )
4. Background Transparency. ( Defaults to 1 )On.
5. 3dIcons Icon Set. ( Defaults to f).
   1. d = dynamic
   2. f = front
   3. i = iso
6. 3dIcons Icon Type. ( Defaults to c).
   1. m = clay
   2. c = color
   3. g = gradient
   4. p = premium
7. Icon List.
   1. A comma seperated list of short 3dIcon icon names to convert.

Examples:

3dIconify build/BASE.example Build a set of icons specified in the build/BASE.example.3dicp file.

3dIconify build/3dIcons images - - - - pencil,explorer Build the pencil and explorer icons in images directory using app defaults.

Related Software

3dIcons by @realvjy