{"id":13897397,"url":"https://github.com/SublimeText/AFileIcon","last_synced_at":"2025-07-17T14:31:32.693Z","repository":{"id":45920711,"uuid":"162116227","full_name":"SublimeText/AFileIcon","owner":"SublimeText","description":"Sublime Text File-Specific Icons for Improved Visual Grepping","archived":false,"fork":true,"pushed_at":"2025-04-27T08:43:15.000Z","size":4948,"stargazers_count":269,"open_issues_count":2,"forks_count":41,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-27T09:29:15.301Z","etag":null,"topics":["sublime-text","sublime-text-icons","sublime-text-package","sublime-text-theme"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"bitst0rm-st3/a-file-icon","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SublimeText.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-12-17T10:51:38.000Z","updated_at":"2025-04-26T08:44:38.000Z","dependencies_parsed_at":"2023-10-04T14:48:59.918Z","dependency_job_id":null,"html_url":"https://github.com/SublimeText/AFileIcon","commit_stats":null,"previous_names":[],"tags_count":71,"template":false,"template_full_name":null,"purl":"pkg:github/SublimeText/AFileIcon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SublimeText%2FAFileIcon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SublimeText%2FAFileIcon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SublimeText%2FAFileIcon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SublimeText%2FAFileIcon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SublimeText","download_url":"https://codeload.github.com/SublimeText/AFileIcon/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SublimeText%2FAFileIcon/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265616668,"owners_count":23798872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sublime-text","sublime-text-icons","sublime-text-package","sublime-text-theme"],"created_at":"2024-08-06T18:03:33.930Z","updated_at":"2025-07-17T14:31:32.085Z","avatar_url":"https://github.com/SublimeText.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# [![A File Icon][img-logo]][downloads]\n\n[![Star on GitHub][img-stars]][stars]\n[![Join the chat at Sublime Forum][img-forum]][forum]\n\nThis package adds file-specific icons to Sublime Text for improved visual grepping. It's heavily inspired by [Atom File Icons](https://github.com/file-icons/atom).\n\nIts aims are:\n\n* Provide globally available file type specific icons for each UI themes, whether they provide their own file type specific icons or not.\n\n* Workaround a ST core bug, which causes no icons to be displayed for file types an installed but not selected/active theme provides definitions for via `tmPreferences` files.\n\n* Display file icons, even if required syntax definition is not installed.\n\n* Display specific icons for files, no dedicated syntax definition exists for.\n\nIf you have any problems, please search for a similar issue first, before creating [a new one][new-issue]. \n\n\u003e Also, check the list of [known issues][known-issues] before doing so.\n\n## Users\n\n### Installation\n\n#### Package Control\n\nThe easiest way to install is using Sublime's [Package Control][downloads]. It's listed as `A File Icon`.\n\n1. Open `Command Palette` using menu item `Tools → Command Palette...`\n2. Choose `Package Control: Install Package`\n3. Find `A File Icon` and hit `Enter`\n\n#### Download\n\n1. [Download the `.zip`][release]\n2. Unzip and rename folder to `A File Icon`\n3. Copy folder into `Packages` directory, which you can find using the menu item `Preferences → Browse Packages...`\n\n\u003e **Note:** Don't forget to restart Sublime Text after installing this package. \n\n### Customization\n\nYou can change the color, opacity level and size of the icons by modifying your user preferences file, which you can find by:\n\n* `Preferences → Package Settings → A File Icon → Settings`,\n* Choose `A File Icon: Settings` in `Command Palette`.\n\n### Wrong Icons\n\nSublime Text uses syntax scopes for file-specific icons. That's why icons of packages provided by the community require them to be installed.\n\nSee the list of [community packages][packages] that you may need to install to see the right icon.\n\n### Themes\n\nIf 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.\n\n### Troubleshooting\n\nIf something goes wrong try to:\n\n1. Open `Command Palette` using menu item `Tools → Command Palette...`.\n2. Choose `A File Icon: Revert to a Freshly Installed State`.\n3. Restart Sublime Text.\n\n## Developers\n\n### Bring Support of the File Icon Customization to Your Theme\n\nIf you are a theme developer and you want to support a file icon customization, you should:\n\n* Remove all stuff related to the icon setup: `.tmPreferences`, `.sublime-settings`, `.sublime-syntax` and `.tmLanguage` files.\n* Rename all your existing icons to match [these ones][icons].\n* 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).\n\n### How It Works\n\nIn simple terms, `A File Icon` does the following:\n\n1. Copies all the necessary files right after install or upgrade to `zzz A File Icon zzz` directory\n2. Searches all installed themes\n3. Checks if themes are already patched, if not\n4. Patches them by generating `\u003ctheme-name\u003e.sublime-theme` files from a [template][template]\n5. 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`).\n\nThe real process is just a little bit more complex to minimize hard drive I/O.\n\n## Resources\n\n### Colors\n\nColors are bright because they should look good with most themes. However you can change color and opacity level of all icons. See [customization][customization].\n\n![Palette][img-palette]\n\n### Icons\n\nThis package contains icons provided by:\n\n- [Atom File Icons](https://github.com/file-icons/atom)\n- [Devicons](http://vorillaz.github.io/devicons/#/main)\n- [Font Awesome](http://fontawesome.io/)\n- [Font Mfizz](http://fizzed.com/oss/font-mfizz)\n- [Icomoon](https://icomoon.io/)\n- [Octicons](https://octicons.github.com/)\n\nSource 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`.\n\nRasterized icons can be found in `icons` folder.\n\n\u003c!-- Misc --\u003e\n\n[customization]: https://github.com/deathaxe/sublime-a-file-icon#customization\n[downloads]: https://packagecontrol.io/packages/A%20File%20Icon 'A File Icon @ Package Control'\n[forum]: https://forum.sublimetext.com/t/a-file-icon-sublime-file-specific-icons-for-improved-visual-grepping/25874\n[icons]: https://github.com/deathaxe/sublime-a-file-icon/tree/develop/icons/multi\n[known-issues]: https://github.com/deathaxe/sublime-a-file-icon/labels/known%20issue\n[new-issue]: https://github.com/deathaxe/sublime-a-file-icon/issues/new\n[packages]: https://github.com/deathaxe/sublime-a-file-icon/blob/develop/PACKAGES.md\n[release]: https://github.com/deathaxe/sublime-a-file-icon/releases\n[stars]: https://github.com/deathaxe/sublime-a-file-icon/stargazers\n[template]: https://github.com/deathaxe/sublime-a-file-icon/blob/develop/common/templates/theme.py\n[issues]: https://github.com/deathaxe/sublime-a-file-icon/issues\n\n\u003c!-- Assets --\u003e\n\n[img-forum]: media/reply-on-forum.svg\n[img-getting-started]: media/getting-started.jpg\n[img-logo]: media/logo.png\n[img-palette]: media/palette.png\n[img-stars]: media/star-on-github.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSublimeText%2FAFileIcon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSublimeText%2FAFileIcon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSublimeText%2FAFileIcon/lists"}