File Icons

This is the source for the File-Icons package's custom icon-font.

NOTE: Don't request icon additions here. Please do that at the proper repository.

Adding new icons

Currently, IcoMoon is used to generate the icon-font.

To add new icons, repeat the following steps:

1. Open IcoMoon's projects panel, and select Import Project.
2. Select icomoon.json, located in this repo's base directory.
3. Click the imported project's Load button.
4. Press the ☰ icon near the top-right corner. In the menu that opens, click Import to Set.
5. Select one or more SVG files.
6. Select each imported icon, then press Generate Font.
7. Press Download.
8. Extract files to the right locations:
   Linux/macOS:
   1. Move the downloaded ZIP folder to this repo's base directory.
   2. Run `make` from command-line.
   __Windows:__
   1. Copy `file-icons.svg` and `file-icons.woff2` to repo's `dist` directory.
   2. Replace `icomoon.json` with extracted `selection.json`.
   3. Rename `selection.json` to `icomoon.json`.
   4. Convert spaces in `icomoon.json` to tabs.

If IcoMoon didn't give you a WOFF2 file, just add what you can (with the SVG) and a maintainer will take care of the rest.

Requirements when adding icons

Before submitting a pull request, make sure you've followed these steps:

1. Always include newly-added SVGs in your fork's svg folder.
2. Fit icons to a square canvas when possible. More info on that here.
3. Don't add icons that're already included in one of the existing icon-fonts bundled with the package:
   • Font Awesome
   • DevOpIcons
   • MFixx

Exporting icons

If you're exporting an icon from a graphics program, make sure you've optimised it:

1. Outline paths, and delete hidden or unused geometry.
2. Leave everything ungrouped. Compound paths are enough.
3. Merge duplicate control points. Simplify paths if possible.
4. Export with the maximum permitted number of decimal spaces.
   • Adobe Illustrator: Use File → Save as…, not Export as…
   • Inkscape: Save as "Plain SVG", not "Inkscape SVG"
5. Run make lint to clean up source code.

Requirements for maintainers

• Perl 5
• GNU Make
• WOFF2 Encoder

macOS already ships with Perl and Make installed. The remaining dependencies can be installed with Homebrew:

brew tap bramstein/webfonttools
brew install bramstein/webfonttools/woff2

WOFF2 is only necessary for users without a paid IcoMoon account.