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

A File Icon

by ihodev ST3

Sublime file-specific icons for improved visual grepping

Labels theme, file, icons

Details

Installs

  • Total 83K
  • Win 41K
  • OS X 24K
  • Linux 18K
May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10
Windows 123 465 472 491 367 392 502 539 545 492 510 347 299 487 538 527 542 522 325 369 480 483 522 507 395 331 322 484 567 531 552 468 329 376 470 500 505 515 435 352 359 456 575 338 270 290
OS X 58 241 272 235 168 165 221 220 251 267 274 166 176 247 270 284 245 228 161 152 238 258 257 280 204 175 227 287 292 302 290 255 195 186 255 282 334 321 282 176 216 313 422 286 156 119
Linux 59 205 232 229 157 157 251 240 236 247 235 162 156 200 196 195 238 217 169 177 172 223 227 244 183 162 205 227 208 257 263 196 189 222 224 234 238 229 228 188 212 231 250 125 117 117

Readme

Source
raw.​githubusercontent.​com

A File Icon

Install via Package Control Star on GitHub Make a donation at Patreon Share via Twitter Join the chat at Gitter 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

Getting Started

Getting Started with A File Icon

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.

Themes that already have support of the icon customization include:

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).
  • Also you can provide this script which recommends user to install A File Icon for enhanced support 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.

Contributing

Want to contribute some code? Excellent! Read up on our guidelines.

Resources

Colors

Colors are from the Boxy Theme icon color palette. They 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). We convert them to @1x and @2x PNG assets before each release via a custom gulp task.

Rasterized icons can be found in icons folder.

Share The Love

I've put a lot of time and effort into making A File Icon awesome. If you love it, you can buy me a coffee. I promise it will be a good investment 😉.

Donate with: Patreon.