> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pixelatestudio.tomblack.ca/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Import Pixelate Pro, check that it works, and update or remove it later.

This page takes you from the package file to a working **Pixelate** menu. It also covers updating to a new version and removing Pixelate Pro.

## Requirements

| Requirement | Details |
| - | - |
| Unity | Unity 6.0 LTS or newer. |
| Render pipeline | Universal Render Pipeline (URP) or the Built-In Render Pipeline. HDRP is not supported. |
| 2D Sprite package | `com.unity.2d.sprite`. Unity ships it, but some project templates leave it out. Pixelate Pro offers to install it for you. |
| 2D Animation package (optional) | `com.unity.2d.animation` 9.0 or newer, only if you want Sprite Library output. |

See [Compatibility](/help/compatibility) for the tested versions and known limitations.

<Tip>
  Trying Pixelate Pro for the first time? Use a new project or commit your project to version control first, so you can compare before and after.
</Tip>

## Import the package

<Tabs>
  <Tab title="From a .unitypackage file">
    <Steps>
      <Step title="Open your project">
        Open the Unity project you want to add Pixelate Pro to.
      </Step>

      <Step title="Import the package">
        Choose **Assets > Import Package > Custom Package...** and pick the Pixelate Pro `.unitypackage` file.
      </Step>

      <Step title="Import everything">
        In the **Import Unity Package** window, keep every file selected and click **Import**. Everything goes into `Assets/PixelateStudio/PixelatePro`.
      </Step>

      <Step title="Install 2D Sprite if asked">
        If your project doesn't have the 2D Sprite package yet, Unity shows **Pixelate Pro needs the 2D Sprite package**. Click **Install**. Pixelate Pro loads as soon as the package is installed.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From the Asset Store">
    Pixelate Pro is not on the Asset Store yet. Once it is:

    <Steps>
      <Step title="Get Pixelate Pro">
        Add Pixelate Pro to your assets on its Asset Store page.
      </Step>

      <Step title="Open My Assets">
        In Unity, open **Window > Package Manager** and select **My Assets**.
      </Step>

      <Step title="Download and import">
        Select Pixelate Pro, click **Download**, then **Import**. In the **Import Unity Package** window, keep every file selected and click **Import**.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  If you skip the 2D Sprite install, Pixelate Pro stays unloaded and the Console says why. The **Pixelate** menu then holds a single item, **Pixelate > Install 2D Sprite Package**. You can also add **2D Sprite** yourself in **Window > Package Manager**.
</Note>

## What gets added

Everything lives in one folder. Importing Pixelate Pro doesn't change your scenes, your render pipeline asset or your project settings. The only exception is the 2D Sprite package, and only if you click **Install**.

<Tree>
  <Tree.Folder name="Assets" defaultOpen>
    <Tree.Folder name="PixelateStudio" defaultOpen>
      <Tree.Folder name="PixelatePro" defaultOpen>
        <Tree.Folder name="_Samples" defaultOpen>
          <Tree.Folder name="Camera Rigs" />

          <Tree.Folder name="Palettes" />

          <Tree.Folder name="Pixelate Assets" />

          <Tree.Folder name="Source Art" />

          <Tree.Folder name="Style Profiles" />
        </Tree.Folder>

        <Tree.Folder name="Editor" />

        <Tree.Folder name="Runtime" />

        <Tree.Folder name="Shaders" />

        <Tree.File name="README.md" />

        <Tree.File name="Third-Party Notices.md" />
      </Tree.Folder>
    </Tree.Folder>
  </Tree.Folder>
</Tree>

| Folder or file | What it holds |
| - | - |
| `_Samples` | Ready-to-export sample Pixelate Assets, plus Style Profiles, Palettes and Camera Rigs you can reuse. `Source Art` holds the 3D models, prefabs and the particle effect the samples use. Optional; see [Samples](/samples). |
| `Editor` | The editor tools: Inspectors, the Pixelate Browser, the Preview and Export, with their icons and UI styles. |
| `Runtime` | The asset types: Pixelate Asset, Style Profile, Palette, Camera Rig and the effects. |
| `Shaders` | The shaders Pixelate Pro uses to capture and to run the effects. |
| `README.md` | A short getting-started page. |
| `Third-Party Notices.md` | Credits for the sample content made by other people. |

`PixelateStudio` is the family folder for Pixelate Studio products. Other products install next to `PixelatePro`.

You can move the `PixelateStudio` folder, for example under `Assets/Plugins`. Pixelate Pro finds its own files wherever they are.

The `_Samples` folder is optional. You can delete it once you've explored it, but first copy any sample Style Profile, Palette or Camera Rig your own assets link. See [Removing or restoring the samples](/samples#removing-or-restoring-the-samples).

## First launch

After the import, a **Pixelate** menu appears in Unity's menu bar. No window opens by itself.

| Menu item | What it does |
| - | - |
| **Pixelate > Browser** | Opens the [Pixelate Browser](/guides/browser): every Pixelate Asset, Style Profile, Palette and Camera Rig in the project. Also in **Window > Pixelate > Browser**. |
| **Pixelate > Samples** | Opens the Project window at the sample Pixelate Assets. |
| **Pixelate > Documentation** | Opens this documentation in your browser. |
| **Pixelate > Get Help on Discord** | Opens the Pixelate Studio Discord, for questions, feedback and bug reports. |
| **Pixelate > Check for Updates** | Checks the Asset Store for a newer version. |
| **Pixelate > Settings** | Opens **Edit > Project Settings > Pixelate**. See [Settings](/guides/settings). |

Pixelate Pro also checks for updates once per editor session at startup. It stays silent unless a newer version exists; then a small window shows your version and the latest one, with **Get the latest version** and **Skip this version**. Turn the startup check off with **Check for Updates On Startup** in **Edit > Project Settings > Pixelate**. That setting applies to your computer only.

## Check that it works

<Steps>
  <Step title="Open the samples">
    Choose **Pixelate > Samples**. The Project window opens at `_Samples/Pixelate Assets`.
  </Step>

  <Step title="Select a sample">
    Click **Chest**. Its settings open in the Inspector, and the Preview at the bottom shows a pixel-art chest.
  </Step>

  <Step title="Export it">
    Click **Export** at the top of the Inspector. A status message appears under the button, and the Project window highlights the new sprite sheet in `_Samples/Pixelate Assets/Chest/Static`.
  </Step>
</Steps>

<Check>
  If you see the chest in the Preview and a new `Chest` folder with the exported PNG next to the sample, Pixelate Pro is installed and working.
</Check>

If the Preview stays empty or you see an error, see [Troubleshooting](/help/troubleshooting), or ask on the [Pixelate Studio Discord](https://discord.gg/ASkVNuet8K).

## Render pipelines

There is nothing to set up. Pixelate Pro captures with your project's active render pipeline, URP or Built-In, and uses each source's own materials.

The samples use a small unlit shader that ships with them, so they look the same in every supported pipeline. Pixelate Pro adds lighting itself through the [Lighting](/effects/lighting) effect, so your sources don't need lit materials either.

For URP with the 2D Renderer, HDRP and other details, see [Compatibility](/help/compatibility#render-pipelines).

## Update to a new version

Your Pixelate Assets, Style Profiles, Palettes, Camera Rigs and exported sprites live outside the package folder, so an update doesn't touch them. Neither does `ProjectSettings/PixelateProSettings.asset`.

<Steps>
  <Step title="Back up">
    Commit your project to version control, or make a copy.
  </Step>

  <Step title="Check what changed">
    Read the [Changelog](/reference/changelog) for the new version. If it asks for a clean install, delete the `Assets/PixelateStudio/PixelatePro` folder before the next step.
  </Step>

  <Step title="Import the new version">
    Import the new package the same way you installed it. Unity updates the existing files in place, even if you moved the folder.
  </Step>
</Steps>

<Warning>
  An update overwrites the package's own files, including the samples. If you changed a sample, those changes are lost. Duplicate a sample into your own folder before you edit it. See [Samples](/samples#use-the-samples-in-your-own-project).
</Warning>

To see which version you have, choose **Pixelate > Check for Updates**; the message shows the current version.

## Uninstall

<Steps>
  <Step title="Decide what to keep">
    Exported sprite sheets, Animation Clips, Animator Controllers, Sprite Libraries and normal maps are standard Unity assets. They keep working after you remove Pixelate Pro.

    Your Pixelate Assets, Style Profiles, Camera Rigs and Pixelate Palettes need Pixelate Pro. Without it Unity can't load them. Delete them, or keep them in case you reinstall later. Palette files you imported (`.gpl`, `.pal`, `.hex`) stay in the project as plain files.
  </Step>

  <Step title="Delete the package folder">
    Delete `Assets/PixelateStudio/PixelatePro`. If no other Pixelate Studio product is installed, delete the whole `Assets/PixelateStudio` folder.
  </Step>

  <Step title="Delete the settings file">
    Delete `ProjectSettings/PixelateProSettings.asset` if it exists. Pixelate Pro only writes it once you change a project setting.
  </Step>
</Steps>

The two per-computer settings (**Check for Updates On Startup** and **Show Previews in Project Window**) are stored in Unity's editor preferences on your computer, not in the project. They have no effect once Pixelate Pro is gone.

## Next steps

<Columns cols={2}>
  <Card title="Quick start" icon="rocket" href="/quickstart">
    Make your first sprite sheet.
  </Card>

  <Card title="Samples" icon="shapes" href="/samples">
    See what each sample shows and how to reuse it.
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.