ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

A File Icon

by ihodev, DeathAxe ST3 Top 25

Sublime Text File-Specific Icons for Improved Visual Grepping

Labels theme, file, icons

Details

Installs

  • Total 1.19M
  • Win 699K
  • Mac 260K
  • Linux 234K
Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17
Windows 99 183 213 236 175 179 199 198 192 217 213 173 181 219 223 228 246 225 165 206 238 274 177 236 213 149 168 150 224 218 218 189 177 155 216 212 239 246 252 174 143 224 238 252 278 205
Mac 32 64 55 67 47 55 48 71 55 82 57 47 49 70 83 55 62 89 49 57 64 89 61 62 74 43 44 41 71 62 71 40 48 46 60 79 83 67 57 39 42 53 54 56 65 71
Linux 22 51 45 57 39 35 49 45 58 64 66 59 43 58 67 62 57 76 68 56 69 79 67 65 56 46 60 45 59 74 49 50 55 55 64 43 57 79 61 57 62 62 55 54 74 60

Readme

Source
raw.​githubusercontent.​com

A File Icon

Star on GitHub Join the chat at Sublime Forum

This package adds file-specific icons to Sublime Text for improved visual grepping. It's heavily inspired by Atom File Icons.

Its aims are:

  • To be a tmPreferences storage for UI themes those support file-specific icons.
  • To provide icons for themes those don't (fully) support file-specific icons.

If you have any problems, please search for a similar issue first, before creating a new one.

Also, check the list of known issues before doing so.

Users

Installation

Package Control

The easiest way to install is using Sublime's Package Control. It's listed as A File Icon.

  1. Open Command Palette using menu item Tools → Command Palette...
  2. Choose Package Control: Install Package
  3. Find A File Icon and hit Enter

Download

  1. Download the .zip
  2. Unzip and rename folder to A File Icon
  3. Copy folder into Packages directory, which you can find using the menu item Preferences → Browse Packages...

Note: Don't forget to restart Sublime Text after installing this package.

Customization

You can change the color, opacity level and size of the icons by modifying your user preferences file, which you can find by:

  • Preferences → Package Settings → A File Icon → Settings,
  • Choose A File Icon: Settings in Command Palette.

Wrong Icons

Sublime Text uses syntax scopes for file-specific icons. That's why icons of packages provided by the community require them to be installed.

See the list of community packages that you may need to install to see the right icon.

Themes

If your theme supports an icon customization you can choose what icons you want to use – provided by the theme (by default) or provided by the package. Otherwise this package adds its own icons only.

Troubleshooting

If something goes wrong try to:

  1. Open Command Palette using menu item Tools → Command Palette....
  2. Choose A File Icon: Revert to a Freshly Installed State.
  3. Restart Sublime Text.

Developers

Bring Support of the File Icon Customization to Your Theme

If you are a theme developer and you want to support a file icon customization, you should:

  • Remove all stuff related to the icon setup: .tmPreferences, .sublime-settings, .sublime-syntax and .tmLanguage files.
  • Rename all your existing icons to match these ones.
  • Add .supports-a-file-icon-customization file to the root of your theme (this is how we check if the theme supports customization of the file-specific icons).

How It Works

In simple terms, A File Icon does the following:

  1. Copies all the necessary files right after install or upgrade to zzz A File Icon zzz directory
  2. Searches all installed themes
  3. Checks if themes are already patched, if not
  4. Patches them by generating <theme-name>.sublime-theme files from a template
  5. For themes those support file icon customization, it provides .tmPreferences files and missing icons by default (user can override icons provided by the theme via "force_mode": true).

The real process is just a little bit more complex to minimize hard drive I/O.

Resources

Colors

Colors are bright because they should look good with most themes. However you can change color and opacity level of all icons. See customization.

Palette

Icons

This package contains icons provided by:

Source icons are provided in SVG format (Sublime Text doesn't currently support it). They are convert to @1x and @2x PNG assets before each release via python build script py build -i.

Rasterized icons can be found in icons folder.