https://github.com/krestaino/macos-folder-icons

📁 Generate custom folder icons using images or SF Symbols.
https://github.com/krestaino/macos-folder-icons

Last synced: 18 days ago
JSON representation

📁 Generate custom folder icons using images or SF Symbols.

• Host: GitHub
• URL: https://github.com/krestaino/macos-folder-icons
• Owner: krestaino
• License: mit
• Created: 2021-12-02T04:31:43.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-28T10:58:51.000Z (about 2 years ago)
• Last Synced: 2024-10-11T15:46:10.506Z (about 1 month ago)
• Language: Shell
• Homepage:
• Size: 698 KB
• Stars: 218
• Watchers: 3
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# macOS Folder Icons

This script generates custom folder icons using images (SVG, PNG, etc) or [SF Symbols](https://developer.apple.com/sf-symbols/). The blank folder icon is extracted from your system, you may need to change the path location and file name depending on your OS version. This script targets macOS 12.x and 13.0.

![Screenshot](.github/screenshot.png)

## Requirements

ImageMagick 7

## Getting Started

1. Download or clone the repo and open a terminal at the root of the project.

2. Place images in the [custom](custom) folder if you want to use SVGs or PNGs.

3. Copy symbols into the [symbols.txt](symbols.txt) file if you want to use [SF Symbols](https://developer.apple.com/sf-symbols/).

4. Run `./build.sh` to build the icons.

5. Icons are located in the [build](build) folder.

## Using Icons

https://support.apple.com/en-gu/guide/mac-help/mchlp2313/mac

## Building on a different macOS version

1. Edit `ASSETS_LOCATION` to the appropriate path for your OS version.

2. Edit `DARK_FOLDER` and `LIGHT_FOLDER` to the appropriate file names of the extracted assets.

## Contributing

Pull requests are welcome. I don't write Shell scripts much, so there's probably plenty of areas for improvement. A few things I'd like to add:

- Automatically detect the OS version and set the correct asset path and folder file name.

- Error handling. If this script fails, and you'll probably have no idea why.

- Not including [acextract](https://github.com/bartoszj/acextract) in this repo.

- Use something other than ImageMagick, it's quite slow if you build a lot of icons at once.

- Building a web app so users can easily make icons from their browser.