Add pckgs.io to Unity

This guide walks you through setting up and using pckgs.io with the Unity Package Manager. The setup involves two steps: first, adding the scoped registry to your project, and second, adding your access token so Unity can authenticate and access the registry.

Once setup is complete, you can access your packages by opening Window > Package Manager.
Under the My Registries section, you’ll see pckgs.io listed.

---

Step 1: Add pckgs.io Scoped Registry to Your Project

To integrate pckgs.io with your Unity project, follow these steps:

1. Open your project’s manifest.json file located at:
   YourProject/Packages/manifest.json

2. By default, it should look something like this:

   {
     "dependencies": {
       "com.unity.ai.navigation": "2.0.5",
       "com.unity.collab-proxy": "2.7.1",
       "com.unity.ide.rider": "3.0.31",
       "com.unity.ide.visualstudio": "2.0.22",
       "com.unity.inputsystem": "1.12.0",
       "com.unity.multiplayer.center": "1.0.0",
       "com.unity.render-pipelines.universal": "17.0.3"
     }
   }

3. Add a scopedRegistries section with pckgs.io and your organization scope. The scope for your organization follows the format com.org-name, where org-name is the name you provided when creating the organization.

   Add the following block above the dependencies section :

   "scopedRegistries": [
     {
       "name": "pckgs.io",
       "url": "https://upm.pckgs.io",
       "scopes": [
         "com.my-org-name"
       ]
     }
   ],

4. Save the file and return to the Unity Editor.
   Open Window > Package Manager and look under My Registries to find pckgs.io.

You should now see the pckgs.io registry inside the Unity Package Manager window.
Public packages will be shown in pckgs.io section, to see private packages please continue with Step 2 to configure authentication.

---

Step 2: Configure Authentication for Unity to Access pckgs.io

Unity uses the .upmconfig.toml file to store authentication information for scoped registries requiring secure access.

Generate Your Access Token

Create access token here. For detailed instructions, refer to our How To Create Access Token guide.

Create or Edit .upmconfig.toml

1. Locate or create the .upmconfig.toml file in your user directory:

   • Windows: %USERPROFILE%\.upmconfig.toml
   • macOS/Linux: ~/.upmconfig.toml

2. Add your authentication details following the format below. Replace placeholders accordingly:

[npmAuth."https://upm.pckgs.io"]
token = "<YOUR_ACCESS_TOKEN>"
alwaysAuth = true

You should now also see private packages in pckgs.io section as long as you grant access to generated access token.

For more information on adding authentication for scoped registries, refer to the official Unity documentation Scoped registry authentication.