Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.63 KB

install-packages.md

File metadata and controls

60 lines (39 loc) · 1.63 KB
Raw

Install Packages

This guide explains how to install any package from the Unity Game Framework registry.

List

Documentation has list of all packages in one place with package version and other information.

Repositories List

Scoped Registry

In order to access packages from different registries, rather than the default registry, Unity provides the way to define and use scoped registries with custom packages.

Read more about scoped registries:

https://docs.unity3d.com/Manual/upm-scoped.html

Manifest

Setup registry information directly in manifest.json file of the Unity project.

This file located at Unity project folder at specific path:

<Root of Unity project>\Packages\manifest.json

Open and edit file to add information for required registry.

Example of manifest.json file with no dependencies and Unity Game Framework registry:

{
  "dependencies": {},
  "scopedRegistries": [
    {
      "name": "Unity Game Framework",
      "url": "https://api.upmhub.org/registries/unity-game-framework",
      "scopes": [
        "com.ugf"
      ]
    }
  ]
}

Preview Packages

Some packages have Preview version of package, with latest changes and features, but some of this packages will not work with Non-Preivew versions of dependencies.

If package have preview version and other dependencies, it is recommened to update all dependencies to preview versions.

To display preview versions of packages, changing Package Manager settings required.

Read about Package Manager Advaced Settings:

https://docs.unity3d.com/2021.1/Documentation/Manual/class-PackageManager.html