> For the complete documentation index, see [llms.txt](https://latin-tools.gitbook.io/latin-tools-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://latin-tools.gitbook.io/latin-tools-docs/documentation/icon-generator/user-guide.md).

# User Guide

### Installation

1. Import the Icon Generator package into your Unity project.
2. Ensure all necessary scripts and resources are located in the `Assets/Icon Generator` folder.

> 💡 **Important:** Do not change the folder name to avoid potential export issues.

3. If your project uses the Built-in o HDRP rendering channel, import the package located at (../Icon Generator/).

<figure><img src="/files/f9Fx10w73IsorRM6QNix" alt=""><figcaption></figcaption></figure>

### How to Create an Icon

{% stepper %}
{% step %}

### **Select Your Model**

In the Unity hierarchy, choose the 3D model you want to convert to an icon.

<figure><img src="/files/s7NXSddLkVK7nblGlDBj" alt="" width="261"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### **Open Icon Generator**

* Right-click on the model
* Navigate to: Latin Tools > Convert To Icon

<figure><img src="/files/tNs4nL8Lw2DkpM3vOk4J" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/1hlGTNTH5XgKFSvLXjfq" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### **Configure Icon Settings**

The editor window will open, allowing you to customize your icon.

<figure><img src="/files/ZmhqMXMzgAqq3PVi9UxC" alt=""><figcaption></figcaption></figure>

### Preview Resolution

* Set the desired icon resolution

<figure><img src="/files/eM1JWfUP36eRsvnIQk5w" alt=""><figcaption><p>To the right, there is a button with a list of resolutions to help you work faster and more efficiently.</p></figcaption></figure>

<figure><img src="/files/0NuhGyKzuj2Mb9pu51XK" alt="" width="269"><figcaption></figcaption></figure>

* Alternative method: Right-click on the "Icon Generator" text at the top of the editor window

<figure><img src="/files/R90WjpeQ5RZOM9AxCFq8" alt="" width="314"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### **Editing Options**

Use the following sections to customize your icon:

* [General Settings](#general-settings)

<figure><img src="/files/XZr6k9D7TDKqGZmJ7luY" alt=""><figcaption></figcaption></figure>

* Image Settings

<figure><img src="/files/8nLwAfzILrska36gr0xt" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Set the icon name and define the final export path for a seamless workflow.

<figure><img src="/files/jeL24Th5UA8YMvTZAMMP" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Hit "Export" to finalize and save your icon!

<figure><img src="/files/CtAB1DRXO0KvoCRh1hRl" alt=""><figcaption></figcaption></figure>

### **Final results**

***

<figure><img src="/files/oMGvmptoaZ5PzsclZXn6" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/d02q27DXyRPGQrVj3ssr" alt="" width="218"><figcaption></figcaption></figure>

<figure><img src="/files/vYpoYlm74CT9Hl4muZaW" alt="" width="281"><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

***

### General Settings

***

<figure><img src="/files/XZr6k9D7TDKqGZmJ7luY" alt=""><figcaption></figcaption></figure>

**Transparent Background:** This option is blocked if the file type is set to "JPG" in the export settings.<

<figure><img src="/files/LBUcNBOqNQo4xrNvXvIU" alt=""><figcaption></figcaption></figure>

### **Preview Settings**

***

* **Refresh Preview:**
  * Use this button if the view doesn't update after changes
* **Open in Window:**
  * Opens a separate window that continuously updates
  * Mouse events remain active
* **Show Only Capture Objects:**
  * When disabled, shows everything in front of the camera

<figure><img src="/files/XhvpiHeeVlXrrJnrvsf8" alt="" width="318"><figcaption></figcaption></figure>

Preview Resolution

* If you experience performance issues during the preview, use this option to significantly improve performance.

Scroll Action

* Choose what you want to modify when using the mouse wheel: adjust the Field of View (FOV) or scale the object displayed in the preview.

Auto Position

* Automatically centers the model you're previewing for optimal alignment and visualization.

Position Lock & Rotation Lock

* Select the axis you want to lock while dragging with the right mouse button inside the preview window.

Modify Capture Objects

<figure><img src="/files/jpblFHi8K4zjlwnWo0J9" alt=""><figcaption></figcaption></figure>

> 💡 Activate/deactivate and modify model position directly in the editor

### **UI MANAGER**

<figure><img src="/files/210f2yibsE1JAxP71W4o" alt=""><figcaption></figcaption></figure>

Plane Distance: The plane distance is the distance between the camera and the canvas. It is used to determine the size of the canvas.

<figure><img src="/files/9jfqP38s3YjpZcrcqnU0" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/kvvQhaiObfKlJ026uVRc" alt=""><figcaption></figcaption></figure>

###

### **Animation Preview**

<figure><img src="/files/8Hd8VWV29z7YZK8s5lNX" alt=""><figcaption></figcaption></figure>

* Add your model's Animator
* Use "Find Animator" to locate an animator within the model
* Select animations to preview in real-time

### Monochrome

<figure><img src="/files/DjfWh7xtGlwmHN8neJ19" alt=""><figcaption></figcaption></figure>

The **Monochrome** feature allows you to apply a grayscale effect to the visual elements of your project. This tool is especially useful for:

* **Assessing Contrast and Readability:** Analyze your visuals by removing color to focus on contrast and clarity.
* **Testing Visuals in a Colorless Environment:** Preview how your assets will appear in a monochromatic setting.
* **Adding an Outline Effect:** Apply outlines to emphasize shapes and edges in your assets.

**Examples of Use:**

<figure><img src="/files/maOovqjR5ydFjKlqE7MH" alt=""><figcaption></figcaption></figure>

### Outline Effect

<figure><img src="/files/QfiNhJl0rMlqReE7aIx2" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/vovOZhJxju49tfSzzwYF" alt="" width="332"><figcaption></figcaption></figure>

### Glow

Experimental effect, useful in specific cases

<figure><img src="/files/al12ldcjWmNOlCsOUMZ2" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/JZ6ByhcMmgbFT2SC2GMo" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/OcduPBhZWE0HZmkX9q5Z" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/yXYCRJ3TXZk4GEMGY0ZP" alt="" width="325"><figcaption></figcaption></figure>

* Add a **fade effect** that can be combined with disabled transparency to achieve unique visual results, such as this:

<figure><img src="/files/2ODyP2raRawzhiIqGBEf" alt=""><figcaption></figcaption></figure>

### Preset Manager

***

<figure><img src="/files/8FBjQJa9o5LDkrYHR1jq" alt=""><figcaption></figcaption></figure>

The **Preset Manager** allows you to create and save presets, making it easy to reuse your customized settings. You can choose to save presets either temporarily or permanently within the project:

* **Temporary Presets:** These are deleted automatically when the editor window is closed.
* **Project Presets:** These are saved in the directory `.../Icon Generator/Presets` for future use.

> 💡 **Note:** When creating a preset, it’s recommended to use a clear and descriptive name, including unique identifiers, to avoid duplicate or unnecessary presets.

### Export Settings

***

<figure><img src="/files/MxAGYLmzVe2e0RgIBDxb" alt=""><figcaption></figcaption></figure>

* **Path:**
  * Save icons inside or outside the project
* **Compression:**
  * Select texture compression level
  * Reduces final image file size
  * "Compressed" is usually a good default option
* **Additional Export Options:**
  * **Ping Asset On Save:** Locates saved icon
  * **Auto Open Asset On Save:** Opens the image after export
  * **Enforce Size Multiple of Four:** Optimizes texture dimensions

### Tips

* Use clear, descriptive preset names
* Experiment with different effects and settings
* Check exported icons to ensure desired quality

### Troubleshooting

* If preview doesn't update, use the Refresh Preview button
* Adjust preview resolution if experiencing performance issues

Good luck with your project! 🚀