Installation Instructions
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)
TDRS is pending review for the Unity Asset Store. Stay tuned for updated instructions.
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:
- Open the package manager window by clicking
Window > Package Manager - Click the
+icon in the top left and selectAdd package from git URL ... - Paste only the URL section of the entry provided above (
https:// ....) without the double quotes.
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.
- Find your desired release.
- Download the
tdrs_<VERSION>.tar.gzfrom under theAssetsdropdown (<VERSION> should be the release version you intend to download). - Open your project in Unity
- Navigate to
Window > Package Managerin the top menu. - Click the
+icon in the top left and selectAdd package from tarball.... - Find and select the downloaded tarball
- You should now see "TDRS" appear in the Unity Package Manager window with a version number matching your downloaded version.
- Close the Package Manager window