Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tomblack.ca/llms.txt

Use this file to discover all available pages before exploring further.

Use this page when adding Pixelate to a project for the first time.

Requirements

  • Unity version supported by your Pixelate release. This branch is maintained against Unity 6000.4.1f1.
  • A Unity project with assets under the project Assets/ folder.
  • Unity’s 2D Sprite package if you want to inspect or edit generated sprite slices.
  • Universal Render Pipeline installed only if your project uses URP.

Import Pixelate

1

Choose the package for your project

Import the Pixelate package that matches your render pipeline. If your release includes separate Built-in and URP packages, choose the one that matches the Unity project.
2

Import the package

In Unity, select Assets > Import Package > Custom Package, choose the Pixelate .unitypackage, and import the files.
3

Confirm the folder

After import, confirm that Assets/Pixelate exists in the Project window.
4

Open the capture scene

Open Assets/Pixelate/Scenes/Capturing.unity if you want to start from the included scene.

Important folders

FolderPurpose
Assets/Pixelate/ScriptsCapture, slicing, profile, and editor scripts.
Assets/Pixelate/ShadersShaders used for Pixelate capture and sprite lighting.
Assets/Pixelate/SettingsExample PixelateProfile assets.
Assets/Pixelate/ScenesDemo scenes for capture and visualization.
Assets/Pixelate/DEMODemo model, animation, palette, and sprite assets.
Keep generated Pixelate exports inside the Unity project’s Assets/ folder. Pixelate validates this before capture.

Next step

Go to Quickstart to capture your first sprite sheet.