Skip to content

Installation Instructions

Shi Johnson-Bey edited this page Mar 5, 2024 · 4 revisions

Installing Anansi

Third-Party Dependencies

Anansi has the following third-party dependencies. These are installed by following the steps below.

Install from a GitHub URL (Recommended)

These instructions cover adding this repository as a dependency within Unity's package manager. This is the recommended installation method because it facilitates dependency downloading when working on a game with collaborators. Also, it ensures that all dependencies are also installed.

Copy the following lines to the dependencies section of the Packages/manifest.json file in your Unity Project. If they already exist in the file, check that the version numbers are compatible.

"com.inkle.ink-unity-integration": "https://github.com/inkle/ink-unity-integration.git#upm",
"com.shijbey.tdrs": "https://github.com/ShiJbey/TDRS.git?path=/Packages/com.shijbey.tdrs#v2.0.0",
"com.shijbey.anansi": "https://github.com/ShiJbey/Anansi.git?path=/Packages/com.shijbey.anansi#v1.0.0",

Alternatively, You could add each entry manually in the package manager window, but this requires more work.

  1. Open your project in Unity
  2. Open the package manager window by selecting Window > Package Manager in the top menu.
  3. Click the + icon in the top left, and select Add package from git URL....
  4. Paste a URL from those listed above and press enter.
  5. Repeat steps 2 and 3 with the remaining entries above until all packages are installed.
  6. You should see Anansi and its dependencies appear in the package manager window.
  7. Close the package manager window.

Install from tarball

These instructions cover downloading a tarball release and installing it within Unity's package manager. This does not install Anansi's dependencies.

  1. Find your desired release on the Releases Page.
  2. Download the anasi_<VERSION>.tar.gz from under the Assets dropdown (<VERSION> should correspond to your desired release version),
  3. Open your project in Unity
  4. Open the package manager window by selecting Window > Package Manager in the top menu.
  5. Click the + icon in the top left, and select Add package from tarball....
  6. Locate and select the tar.gz file downloaded previously.
  7. Wait, and you should see Anansi appear in the package manager window with a version matching your downloaded version.
  8. Close the package manager window.