Installation Instructions

Installing TDRS

Third-Party Dependencies

Users do not need to download the following dependencies. They are listed here for transparency and come pre-packaged with TDRS on installation.

• YamlDotNet 15.1.1 or higher (Comes with TDRS)
• RePraxis version 1.1.0 or higher (Comes with TDRS)

Installing from the Unity Asset Store

TDRS is pending review for the Unity Asset Store. Stay tuned for updated instructions.

Installing using GitHub URL (recommended)

The following instructions will install TDRS as a package in your Unity project, using a GitHub URL. Currently, this is the recommended method of installation since using Tarballs can expose users' local file system details within the Packages/manifest.json file. Git URLs in Unity's package manager use a special syntax to specify the version and path to download the package.

Add the following line to your Packages/manifest.json file to install TDRS:

"com.shijbey.tdrs": "https://github.com/ShiJbey/TDRS.git?path=/Packages/com.shijbey.tdrs#v2.0.0"

#v2.0.0 specifies what version to install. You can change #v2.0.0 to any other tagged release version.

Or you can install it in the Unity editor by:

1. Open the package manager window by clicking Window > Package Manager
2. Click the + icon in the top left and select Add package from git URL ...
3. Paste only the URL section of the entry provided above (https:// ....) without the double quotes.

Download tarball release from GitHub

To add TDRS to your Unity project, you must download the latest version of the package from GitHub. All releases are on the Unity-TDRS GitHub Releases page. Please follow the steps below.

1. Find your desired release.
2. Download the tdrs_<VERSION>.tar.gz from under the Assets dropdown (<VERSION> should be the release version you intend to download).
3. Open your project in Unity
4. Navigate to Window > Package Manager in the top menu.
5. Click the + icon in the top left and select Add package from tarball....
6. Find and select the downloaded tarball
7. You should now see "TDRS" appear in the Unity Package Manager window with a version number matching your downloaded version.
8. Close the Package Manager window