You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 5, 2024. It is now read-only.
@@ -22,8 +18,98 @@ The GitHub for Unity extension brings [Git](https://git-scm.com/) and GitHub int
22
18
23
19
### Installation
24
20
25
-
- Create a new Unity project.
26
-
- Download the latest release from the [releases page](https://github.com/github-for-unity/Unity/releases) and double-click the unitypackage file. The package will install itself into the project currently opened in Unity, and Unity will automatically load it once all the files are in the project.
21
+
To install the extension, download the latest package from [the releases page](https://github.com/github-for-unity/Unity/releases) and double click on it.
22
+
23
+
#### Opening the GitHub window
24
+
25
+
You can access the GitHub window by going to Windows -> GitHub. The window opens by default next to the Inspector window.
If the current Unity project is not in a Git repository, the GitHub for Unity extension will offer to initialize the repository for you. This will:
32
+
33
+
- Initialize a git repository at the Unity project root via `git init`
34
+
- Initialize git-lfs via `git lfs install`
35
+
- Set up a `.gitignore` file at the Unity project root.
36
+
- Set up a `.gitattributes` file at the Unity project root with a large list of known binary filetypes (images, audio, etc) that should be tracked by LFS
37
+
- Configure the project to serialize meta files as text
38
+
- Create an initial commit with the `.gitignore` and `.gitattributes` file.
39
+
40
+
#### Authentication
41
+
42
+
To set up credentials in Git so you can push and pull, you can sign in to GitHub by going to `Window` -> `GitHub` -> `Account` -> `Sign in`. You only have to sign in successfully once, your credentials will remain on the system for all Git operations in Unity and outside of it. If you've already signed in once but the Account dropdown still says `Sign in`, ignore it, it's a bug.
1. Go to [github.com](https://github.com) and create a new empty repository - do not add a license, readme or other files during the creation process.
49
+
2. Copy the **https** URL shown in the creation page
50
+
3. In Unity, go to `Windows` -> `GitHub` -> `Settings` and paste the url into the `Remote` textbox.
51
+
3. Click `Save repository`.
52
+
4. Go to the `History` tab and click `Push`.
53
+
54
+
#### Commiting your work - Changes tab
55
+
56
+
You can see which files have been changed and commit them through the Changes tab. `.meta` files will show up in relation to their files on the tree, so you can select a file for comitting and automatically have their `.meta`
The history tab includes a `Push` button to push your work to the server. Make sure you have a remote url configured in the `Settings` tab so that you can push and pull your work.
63
+
64
+
To receive updates from the server by clicking on the `Pull` button. You cannot pull if you have local changes, so commit your changes before pulling.
The GitHub for Unity extension ships with a bundle of Git and Git LFS, to ensure that you have the correct version. These will be installed into `%LOCALAPPDATA%\GitHubUnityDebug` when the extension runs for the first time.
83
+
84
+
You can open a command line with the same Git and Git LFS version that the extension uses by going to the GitHub -> Command line menu.
85
+
86
+
Make sure a Git user and email address are set in the `%HOME%\.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `%HOME%\.gitconfig` file and adding the following section, if it doesn't exist yet:
87
+
88
+
```
89
+
[user]
90
+
name = Your Name
91
+
email = Your Email
92
+
```
93
+
94
+
##### Log files
95
+
96
+
The extension log file can be found at `%LOCALAPPDATA%\GitHubUnityDebug\github-unity.log`
97
+
98
+
#### macOS
99
+
100
+
The current release has limited macOS support. macOS users will need to install the latest [Git](https://git-scm.com/downloads) and [Git LFS](https://git-lfs.github.com/) manually, and make sure these are on the path. You can configure the Git location in the Settings tab on the GitHub window.
101
+
102
+
Make sure a Git user and email address are set in the `~/.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `~/.gitconfig` file and adding the following section, if it doesn't exist yet:
103
+
104
+
```
105
+
[user]
106
+
name = Your Name
107
+
email = Your Email
108
+
```
109
+
110
+
##### Log files
111
+
112
+
The extension log file can be found at `~/.local/share/GitHubUnityDebug/github-unity.log`. This is a temporary location and will be changed in the future.
0 commit comments