> For the complete documentation index, see [llms.txt](https://cglibrary.gitbook.io/edge-decal-studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cglibrary.gitbook.io/edge-decal-studio/decal-studio.md).

# Decal Studio

***

## <mark style="color:yellow;">Key Features</mark>

* <mark style="color:yellow;">**Edge Placement with Vertex Snapping**</mark>\
  Quickly apply edge decals along mesh corners and seams using smart **vertex and Edge snapping** with **shortest path detection**.
* <mark style="color:yellow;">**One-Click Precision**</mark>\
  Streamlined, one-click operations for fast decal placement on any geometry.
* <mark style="color:yellow;">**4K Decal Pack (240+)**</mark>\
  Includes a high-quality library of tileable, seamless **edge decals** optimized for performance and next-gen visuals.
* <mark style="color:yellow;">**Intuitive UI & Shortcuts**</mark>\
  Designed with artists and level designers in mind. Decals snap and align with minimal input, maximizing workflow efficiency.
* <mark style="color:yellow;">**Optimized for Performance**</mark>\
  Lightweight decals and efficient blueprint systems ensure minimal performance overhead in real-time projects.

***

{% hint style="info" %}
Please note that the orientation of the decal is based on the normal of the surface you are clicking on.
{% endhint %}

{% hint style="info" %} <mark style="color:$info;">**This plugin requires the "ScriptableToolsFramework", "ScriptableToolsEditorMode" & "GeometryScripting" plugins to be on, but no worries, they are included and active with your Unreal Engine by default!**</mark>
{% endhint %}

{% hint style="info" %} <mark style="color:$info;">**Please note that this tool uses the collision geometry as a placeholder to find all the vertex and edges of the assets, if there is no collission geometry, please, change the "collision complexity" from your target geometry to "Use Complex Collision As Simple".**</mark>
{% endhint %}

***

## <mark style="color:yellow;">The tool</mark>

<details>

<summary><mark style="color:yellow;">How to install Edge Decal Studio</mark></summary>

* Open your project in <mark style="color:yellow;">**Unreal Engine**</mark>.
* Open the <mark style="color:yellow;">**Fab**</mark> tab and log in.
* Search for **"**<mark style="color:yellow;">**Edge Decal Studio**</mark>**"** by <mark style="color:yellow;">**cgLibrary**</mark>.
* Click <mark style="color:yellow;">**Add to Project**</mark>.
* Go to <mark style="color:yellow;">**Edit > Plugins**</mark>, enable <mark style="color:yellow;">**Edge Decal Studio**</mark>, and restart the editor.
* Find everything in <mark style="color:yellow;">**Game/Plugins/EdgeDecalStudio/**</mark> — start using the blueprint tool and 240+ 4K decals right away.

</details>

<details>

<summary><mark style="color:yellow;">How to use Edge Decal Studio</mark></summary>

To use <mark style="color:yellow;">**Edge Decal Studio**</mark>, there are a few things to keep in mind regarding required plugins and activation steps. The good news? <mark style="color:yellow;">**Everything is automatic and built into Unreal Engine.**</mark>

<mark style="color:yellow;">**Edge Decal Studio**</mark> depends on the following Unreal Engine plugins:

* **Scriptable Tools Framework**
* **Scriptable Tools Editor Mode**
* **Geometry Scripting**

These plugins are included by default in Unreal Engine and are **automatically enabled** when you install EDS via Fab. No manual setup is required.

To launch and use the **tool** inside Unreal Engine:

1. Change the <mark style="color:yellow;">**Selection Mode**</mark> to <mark style="color:yellow;">**Scriptable Tools**</mark>.
   * You can do this from the top toolbar by clicking the **Selection Mode dropdown** and choosing **Scriptable Tools**.
   * Or use the shortcut: **Shift + 9**.
2. Once you're in <mark style="color:yellow;">**Scriptable Tools Mode**</mark>, you’ll see the <mark style="color:yellow;">**Edge Decal Studio**</mark> interface appear in the editor.
3. From there, you can start placing decals directly along mesh edges using snapping, shortest path detection, and other built-in alignment tools.

</details>

<details>

<summary><mark style="color:yellow;">Parameters Overview</mark></summary>

### <mark style="color:yellow;">**Working Method**</mark>

&#x20;  <mark style="color:yellow;">**Snap Mode:**</mark>\
&#x20;     Defines how objects snap during placement.

&#x20;  <mark style="color:yellow;">**Distribution:**</mark>\
&#x20;     Determines how objects are placed or spaced.

&#x20;  <mark style="color:yellow;">**Scale:**</mark>\
&#x20;     Controls the size of the object during placement or distribution.\
&#x20;     (Alt + Mouse Wheel).

&#x20;&#x20;**&#x20;**<mark style="color:yellow;">**Number Of Copies:**</mark>\
&#x20;     Sets how many copies of the object will be placed along the path.\
&#x20;     (Ctrl + Mouse Wheel).

&#x20;&#x20;**&#x20;**<mark style="color:yellow;">**Rotation:**</mark>\
&#x20;     Adjusts the rotation of the object during placement or distribution.\
&#x20;     (Shift + Mouse Wheel).

### <mark style="color:yellow;">**Geometry**</mark>

&#x20;  <mark style="color:yellow;">**Shape A:**</mark>\
&#x20;     The primary shape that will be placed or scaled alogn the path.\
&#x20;     (Switch to "Shape B" by pressing "x").

&#x20;  <mark style="color:yellow;">**Shape B:**</mark>\
&#x20;     The secondary shape that will be placed or scaled alogn the path.\
&#x20;     (Switch to "Shape A" by pressing "x").

### <mark style="color:yellow;">Material</mark>

&#x20;  <mark style="color:yellow;">**Material:**</mark>\
&#x20;     Default Decal Material, usually is a black and white border just to show \
&#x20;     the user where the decal is being placed.&#x20;

### <mark style="color:yellow;">Material Library</mark>

&#x20;  <mark style="color:yellow;">**Seed:**</mark>\
&#x20;     The Seed controls the randomness of the material applyed to the \
&#x20;     generated decals.

&#x20;  <mark style="color:yellow;">**Material Collection:**</mark>\
&#x20;     Here the user can load the family of decal Materials that want to be assigned \
&#x20;     to the generated decals.

### <mark style="color:yellow;">Advanced</mark>

&#x20;  <mark style="color:yellow;">**Name:**</mark>\
&#x20;     The name that will be assigned to the new generated decals.

&#x20;  <mark style="color:yellow;">**Tag:**</mark>\
&#x20;     The tag that will be assigned to the new generated decals.

&#x20;  <mark style="color:yellow;">**Viewport Help:**</mark>\
&#x20;     This option allows the user tho show/hide the viewport help.

### <mark style="color:yellow;">Merge Decals</mark>

&#x20;  <mark style="color:yellow;">**Merged Decals Project Path:**</mark>\
&#x20;     Specifies the file location where merged decal assets will be saved.

</details>

<details>

<summary><mark style="color:yellow;">Decal library</mark></summary>

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

2x Chamfer\
20x ChamferDent\
20x ConcreteDent\
20x Concrete\
20x Stone\
20x ConcreteHit\
20x Oxide\
20x ChamferDetails\
20x ChamferConcrete\
20x ChamferStone\
20x MetalHits\
20x ChamferScratch\
20x ChamferSciFi

</details>

***

## <mark style="color:yellow;">Credits</mark>

<mark style="color:yellow;">**Edge Decal Studio + 4K Decal Pack**</mark> was developed by <mark style="color:yellow;">**cgLibrary**</mark>, a team of talented artists and tool developers with over **10 years of experience** in the **video game** and **film** industries.

We are dedicated to create high-quality tools that streamline workflows, enhance visual fidelity, and empower technical artists and designers around the world.\
\
This product was <mark style="color:yellow;">**entirely created by humans**</mark> — no AI tools were used in the creation of assets, textures, or code. Every decal, blueprint, and material was designed <mark style="color:yellow;">**by artists, for artists**</mark>, with care, intention, and industry insight.\
\
\---*Lets add the companies where we work/worked here please, thnks!*


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://cglibrary.gitbook.io/edge-decal-studio/decal-studio.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
