Installation and Updating Guide

August 27, 2018 ยท View on GitHub

Installing from a Downloaded Package File
Installing from the Unity Asset Store
Updating a Previously Installed Version

Note: If your Unity project already has the GitHub for Unity plugin installed, see our Getting Started docs before continuing

Installing from a Package File

You can download the latest release from the repository at https://github.com/github-for-unity/Unity/releases or from the website at https://unity.github.com/.

Once you've downloaded the package file, you can quickly install it within Unity.

  1. Open a new Unity Project screen shot 2018-05-18 at 7 10 07 am
  2. Go to Assets -> Import Package -> Custom Package screen shot 2018-05-18 at 7 11 35 am
  3. Find and open the GitHub for Unity Asset Package screen shot 2018-05-18 at 7 12 33 am
  4. Click Import when the dialog pops up screen shot 2018-05-18 at 7 12 42 am
  5. After the package finishes importing, go to Window -> GitHub to open the GitHub window screen shot 2018-05-18 at 7 13 03 am
  6. You should see the GitHub window in your Unity project, with a button to initialize your repository screen shot 2018-05-18 at 7 13 34 am

Installing from the Asset Store

  1. Open a new Unity Project screen shot 2018-05-18 at 7 10 07 am
  2. Go to Window -> Asset Store screen shot 2018-05-18 at 7 20 19 am
  3. Search for "GitHub" in the search bar screen shot 2018-05-18 at 7 20 51 am
  4. Click on the GitHub for Unity Package screen shot 2018-05-18 at 7 22 15 am
  5. Click Download then Install screen shot 2018-05-18 at 7 21 37 am
screen shot 2018-05-18 at 7 21 44 am 6. Click `Import` when the dialog pops up screen shot 2018-05-18 at 7 12 42 am 7. After the package finishes importing, go to `Window -> GitHub` to open the GitHub window screen shot 2018-05-18 at 7 13 03 am 8. You should see the GitHub window in your Unity project, with a button to initialize your repository screen shot 2018-05-18 at 7 13 34 am

Updating the GitHub for Unity Package

  • If you are running Unity and wish to update GitHub for Unity (unless explicitly stated), be sure that the files in x64 and x86 are not selected.

    image

  • Otherwise, it's best to stop Unity and delete GitHub for Unity from your project. Startup Unity and run the package installer like normal. Allowing it to restore everything.