How to Use

This guide provides a high-level overview of the different ways you can leverage pckgs.io for your Unity projects. For detailed instructions on each step, please refer to the linked dedicated documentation pages.

---

Consume Packages

To begin using pckgs.io, first add our scoped registry to your Unity project.
See our guide: Add pckgs.io to Unity.

Once set up, you can install packages either manually or directly from the Unity Package Manager Window.

Manual Installation

To install a package manually, open your project’s manifest.json file and add the package name and version under the dependencies section.

💡 Make sure to prefix the package name with pckgs.io. so Unity knows to fetch it from our registry.

Example
If the original package name is:

com.some-company.package-name

Then you should write it as:

"dependencies": {
  "pckgs.io.com.some-company.package-name": "1.0.0"
}

---

Publish Packages

Share your own amazing Unity tools and assets with the community. Publishing public packages on pckgs.io is completely free and a great way to contribute to the ecosystem.

1. Create a pckgs.io Account
   To manage your packages, you’ll need a user account first. You can create an account here.

   For more information, check our Create an Account guide.

2. Create an Organization
   pckgs.io is organization-based — every package must belong to an organization rather than a personal account. You can create an organization here.

   For more details, see our Create an Organization guide.

3. Create a Package
   If you haven’t created your Unity package yet, refer to our Create a Package guide if needed.

4. Upload Your Package
   Once your package is ready, go to the Upload Page and select the package folder (the folder contains your package’s package.json file) to upload.

   For detailed instructions, see our Upload a Package guide.

   You can also upload packages using our upload-package GitHub Action. For setup instructions, see Upload Packages with GitHub Actions.

---

See Also

• Add pckgs.io to Unity — Step-by-step guide for adding pckgs.io scoped registry to unity project.