Skip to content

Installation

Requirements

To ensure 2D/3D Paint works correctly, please meet the following requirements:

  • Unity Version: Unity 2019.4 or later.
  • Supported Components: A GameObject with one of the following components—MeshRenderer, SkinnedMeshRenderer, SpriteRenderer, or RawImage—each with an assigned material.
  • UV Map for MeshRenderer/SkinnedMeshRenderer: If you’re using MeshRenderer or SkinnedMeshRenderer, the model must include a UV map.

If your model doesn’t have a UV map, you can generate one in Unity by enabling the Generate Lightmap UVs option in the model settings. This UV map will be stored in the second UV channel. Ensure your shader is compatible with this channel, as most default Unity shaders only support the first UV channel. For optimal results, avoid overlapping areas (no mirroring) in the UV map. Although Unity’s auto-generated UVs can work, creating the UV map in a 3D modeling program usually provides better results.

Install Instructions

To add 2D/3D Paint to your Unity project, follow these straightforward steps:

1.  Create a New Project:
    - Using Unity 2019.4.0f1 or higher (refer to the release notes for the minimum required Unity version), 
    create a new project;
    - Select the “3D” or “2D” template, depending on your project’s needs.
2.  Import 2D/3D Paint via the Package Manager:
    - Open Unity’s Package Manager;
    - Navigate to the 2D/3D Paint page;
    - Click the Download button, then the Import button;
    - Wait for the “Import Unity Package” popup to appear. Ensure all items are checked (this is the default 
        setting), and then click Import.
3.  Install Required Packages:
    - Open Unity’s Package Manager and install the latest version of the following packages:
    - XR: (Optional) Needed only for VR mode.
4.  Test the Installation:
    - Open the Demo scene;
    - Press Play to start the scene and explore the features;
    - Enjoy the painting features in your project!

These steps will get 2D/3D Paint up and running in your Unity project, allowing you to start painting on both 2D and 3D objects right away.