41 lines
1.6 KiB
Markdown
41 lines
1.6 KiB
Markdown
|
|
Install the UPM package in Unity:
|
|
|
|
=== "**Option 1:** Add the VEL package registry"
|
|
|
|
{ align=right }
|
|
|
|
Using the scoped registry allows you to easily install a specific version of the package by using the Version History tab.
|
|
|
|
- In Unity, go to `Edit->Project Settings...->Package Manager`
|
|
- Under "Scoped Registries" click the + icon
|
|
- Add the following details, then click Apply
|
|
- Name: `VEL` (or anything you want)
|
|
- URL: `https://npm.ugavel.com`
|
|
- Scope(s): `edu.uga.engr.vel`
|
|
- Install the package:
|
|
- In the package manager, select `My Registries` from the dropdown
|
|
- Install the `VEL-Connect` package.
|
|
|
|
=== "**Option 2:** Add the package by git url"
|
|
|
|
1. Open the Package Manager in Unity with `Window->Package Manager`
|
|
- Add the local package:
|
|
- `+`->`Add package from git URL...`
|
|
- Set the path to `https://github.com/velaboratory/VEL-Connect`
|
|
|
|
To update the package, click the `Update` button in the Package Manager, or delete the `packages-lock.json` file.
|
|
|
|
=== "**Option 3:** Add the package locally"
|
|
|
|
1. Clone the repository on your computer:
|
|
`git clone git@github.com:velaboratory/VEL-Connect.git`
|
|
- Open the Package Manager in Unity with `Window->Package Manager`
|
|
- Add the local package:
|
|
- `+`->`Add package from disk...`
|
|
- Set the path to `VEL-Connect/package.json` on your hard drive.
|
|
|
|
To update the package, use `git pull` in the VEL-Connect folder.
|
|
|
|
Then check out the [quick start guide](quick-start.md).
|