Packages Mirror

Difference between SDK Integration and Packages Mirror

SDK Integration refers to the Unity SDK package downloaded from the developer center, which contains most of the SDK Packages that developers need to use. These Packages are tested before release.

Packages Mirror is a series of open-source Packages on GitHub by PlayForDream. It includes updated versions of the Packages in SDK Integration. Packages Mirror aims to provide convenience for developers with more customized needs or those who want to try the latest SDK features.

Warning

Note that these Packages may not have undergone thorough testing. If you do not have a specific reason, you should use the content in SDK Integration as much as possible.

If you encounter any issues while using a Packages Mirror, feel free to create an issue in its repository.

Why Mirror?

We do not develop these Packages directly on GitHub, but we regularly sync our internal SDK to GitHub. Therefore, what is stored on GitHub is a mirror of the internal Packages. If you submit a Pull Request to the mirror repository, note that it will not be merged, but we will refer to your implementation to improve our Packages.

Note

Even though Pull Requests to Mirror repositories will not be merged, we highly welcome you to submit Issues to help us improve our Packages.

How to use Packages Mirror

All mirrored Packages can be imported through the Unity Package Manager using a Git URL:

  1. Open the Package Manager window.

  2. Click the + button in the upper left corner and select Add package from git URL.

  3. Enter a valid Git URL. For more information about Git URLs, see the Unity official documentation. Generally, the format is: <gitUrl>?path=<subFolderPath>#<CommitSHA | Tag>, for example:

    git@github.com:PlayForDreamDevelopers/com.yvr.core-mirror.git?path=/com.yvr.core#212cf5ea67829799bcd8b9f7f7963b2dfd0b0505

    You can find the Commit SHA of the version you want from the commits in any Packages Mirror repository: Commit SHA

For detailed information on importing Packages using Git URLs, see the Unity official documentation.