Skip to content

Use the git Package

Jump to bottom
guntrumm edited this page Jan 17, 2025 · 4 revisions

Unity Editor Icon Scraper

While this repository is set up in a way so that you can always search for icons using the README.md file of the project, you can also install this as a .git unity package and create the relevant files yourself based on your installed unity version.

Installation

  1. Add via Unity Package Manager
    • In Unity, open Window > Package Manager.
    • Click the + button and select “Add package from git URL...”.
    • Paste in the repository URL: 
      https://github.com/Doppelkeks/Unity-Editor-Icons.git
    • Unity will fetch and install the package automatically.

Configuration

  1. Open Project Settings

    • Go to Edit > Project Settings.
    • Under Tools (in the left sidebar), select UnityEditorIconScraper.

  2. Adjust Settings

    • Max Icon Width: Maximum pixel width of small icons for readme generation.
    • Original Icons Output Path: Folder where full-sized icons will be exported (e.g., Icons/Original).
    • Small Icons Output Path: Folder where reduced-size icons will be exported (e.g., Icons/Small).
    • README Output Path: Folder (or path) for the generated README file.
    • pngquant Arguments: Command-line flags for PNG compression (optional).
    • pngquant Exe Path: Absolute or relative path to pngquant.exe.
    • Template GUIDs: GUID references to your custom README and icon partial templates.

Usage

  1. Export Icons

    • From the Unity menu, choose Tools > EditorIconScraper > Export Icons (or the label set in your Settings).
    • This exports all built-in Unity Editor icons to the Original Icons Output Path.

  2. Generate README

    • From the Unity menu, choose Tools > EditorIconScraper > Generate README (or the label set in your Settings).
    • This process:
      1. Exports smaller icons into the Small Icons Output Path.
      2. Optionally runs pngquant (on Windows) for compression.
      3. Generates a README file based on your template(s).

Tips & Extras

  • If pngquant is not present or you’re on a non-Windows platform, the compression step is simply skipped.
  • Templates:
    • The README template can contain placeholders for the Unity version and other details.
    • The icon partial template inserts rows for each exported icon in your final README.
  • File IDs (if used) let you reference internal icon file IDs directly in the README.

Enjoy a fully automated Unity Editor Icon Scraper workflow!

Clone this wiki locally