VectoUI Unity Converter Integration Guide

Plugin Overview

VectoUI Unity Converter is the current public plugin for taking design assets into a Unity UI delivery workflow.

It focuses on the path from supported design sources to Unity prefab output, not on replacing every engine-side workflow decision. Before installing the plugin, make sure you already know:

• which source-to-engine path you want to validate
• whether that path is released or still Beta
• how invite-only access and API key binding work in your current environment

1. Install the Unity package

Option A: add the package through Packages/manifest.json

{
  "dependencies": {
    "com.vectoui.unity.convertor": "git@github.com:vecto-ui/com.vectoui.unity.convertor.git"
  }
}

This works best when your environment already has Git access configured.

Option B: install from Git URL in the Unity Package Manager

Open Window > Package Manager, choose Install package from git URL, and use:

git@github.com:vecto-ui/com.vectoui.unity.convertor.git

If your team is validating feasibility first, keep the install scope small. Do not start by replacing an entire production UI pipeline.

2. Accept the data-access disclaimer

When the plugin opens for the first time, VectoUI shows a data-access and responsibility notice. Read it carefully before enabling the plugin.

This matters because VectoUI does not scrape third-party design platforms on your behalf. You must provide your own legally obtained access token or request headers for the design source you already have permission to access.

3. Bind the VectoUI account first

In the plugin settings, start with your API Key from the VectoUI dashboard:

• open Dashboard
• copy the current API key
• paste it into the plugin
• bind the current device

This step validates your current entitlement before you spend time on design-source troubleshooting.

4. Add the design-source access token

After API key binding, add the request headers or token for the design platform you want to use.

Use the prerequisites guide first if you have not extracted the token yet:

• Obtaining Third-Party Data Source Credentials

The important rule is to keep the product boundary clear:

• VectoUI validates your product access
• you provide the legal token for the external design platform

5. Generate the first prefab build

Once account binding and token setup are complete:

1. refresh the remote project list
2. open a small, representative UI screen
3. run Generate Prefab
4. inspect the output before expanding the scope

The safest evaluation path is a small real module, not an all-at-once migration.

6. Validate the design input before blaming output

Most output mismatches come from a combination of:

• unclear layer structure
• unsupported or inconsistent design conventions
• font or slice handling issues
• engine-side rendering expectations

Before treating the problem as a product defect, review:

• Photoshop Art Production Guidelines
• Sketch Art Production Guidelines

7. When to move forward

Move from docs into trial only after these questions are already answered:

• Is the current path released or Beta?
• Is invite-only access already cleared?
• Are the design-source token and API key both valid?
• Is the current test scope intentionally small?

If not, go back to:

• Roadmap
• FAQ
• Pricing

8. What this article does not try to solve

This guide does not replace:

• roadmap status decisions
• pricing or access-policy explanation
• advanced project-specific post-build logic

Use this article for the first working path. Use the advanced guide and community support when your project needs deeper customization.