はじめに
この記事は、Unity初心者およびGitHub初心者が、まずは最低限の操作をできるようになることを目的にした記事です。
UnityのプロジェクトをGitHubでバージョン管理することになったときの、最初のセットアップ方法を解説します。
Unityのプロジェクトは、先に作成しておいてください。
この記事の目標
- GitHubのアカウントを作成する
- GitHub Desktopをインストールする
- Unityプロジェクト用のリポジトリを作成し、セットアップを完了させる
環境
- Windows11
作業手順
GitHubアカウントの作成
GitHub公式サイトでアカウントを作成します。
- ユーザー名
- メールアドレス
- パスワード
必要な情報を入力して登録しましょう。
作成して間もないメールアドレスを使用すると認証が通らない場合があります。
GitHub Desktopのインストール
GitHub Desktopのダウンロードサイトから、お使いのPCに合ったものを選んでください。
画面左、 Download for Windows (64bit) をクリックしてください。
ダウンロードできた.exeファイルを実行してください。
リポジトリの作成
再びGitHub公式サイトへアクセスし、サインインした状態で、画面左上のNewという緑色のボタンをクリックしてください。
- Repository name を分かりやすい英数字にします。
- Configuration の Choose visibility を Private に設定します。
- Configuration の Add .gitignore を Unity に設定します。
- 最後に右下の Create repository をクリックしてください。
以下のような画面が出れば成功です。
Code と書いてある緑のボタンをクリックして出てきたURLをコピーしておいてください。あとで使います。
GitHub Desktopの操作
クローン
GitHub Desktopを開き、左上の File メニューから Clone repository を選択してください。
- URL のタブを選択してください。
- 先ほどコピーしたURLをここに貼り付けてください。
- 今回は、Local path を
C:\unityのような分かりやすい場所にして、その中にリポジトリ用のフォルダを作成します。 - 最後に Clone をクリックしてください。
Unityのプロジェクトはデータ容量が大きいのでOneDriveなどの自動で同期されるフォルダ Local path に指定しないでください。
以下のような画面が現れたら成功です。
Unityプロジェクトをリポジトリに移す
適当な場所にUnityのプロジェクトを作成します。
今回は、C:\unity 内に My project という名前のUnityプロジェクトを作成します。
すると、現在の C:\unity には、クローンしたフォルダ test と、Unityプロジェクトの My project が存在している状態になります。
My project フォルダを開くと、以下のようになっています。
ここで、Unityを起動中の場合は閉じてください。
Ctrl+Aで全選択し、Ctrl+Xで切り取り、C:\unity\test に移動してCtrl+Vで貼り付けてください。
C:\unity\test 内が以下のようになっていれば成功です。
この操作をしたあと、Unity Hubからこのプロジェクトを開く場合は、 Add project from disk から貼り付け先のフォルダを選択してください。今回で言うと C:\unity\test です。
コピー元のフォルダは今後使わないので、フォルダ自体もUnity Hub上の一覧からも削除しておきましょう。今回で言うと My project のことです。
変更をコミットする
この状態で、GitHub Desktopを開くと、以下のように複数のファイル変更が表示されているはずです。
Changed files が数百以上ある場合は、先に進めません。.gitignore が正常に認識されていない可能性が高いです。Unity用gitignoreをコピーしてフォルダ内に入れましょう。このとき、ファイル名は .gitignore である必要があります。
次に、Summary と Description を記入し、一番下の青い Commit ボタンをクリックしてください。Summary には、ファイルの変更内容が分かるような短い説明を書きます。今回は「initial commit」や「unityのプロジェクト作成」のような内容です。どのような文を書くべきかは開発チームごとにルールがあることが多いので、そのルールに従いましょう。一人で開発する場合は、自分が分かるメモで構いません。Description は空欄でも問題ありません。
リモートリポジトリに反映する
このような画面になっていれば、commit は成功しています。
この状態で、画面右上の Publish origin を押してください。
この状態で、ブラウザでGitHubのリポジトリを再度開いてください。 Ctrl+Shift+G で開けます。
すると、以下のようにUnityのプロジェクトファイルが含まれているはずです。
ファイルの数が減っていることに気づいた方へ。これで正常です。逆にリモートリポジトリに Library フォルダなどが含まれている場合は、.gitignore が正常に動作していない可能性が高いです。
以上で最低限のセットアップは完了です。
セットアップ後の基本フロー（Unityでの変更を反映する）
ここからは、実際に開発するときに毎回行う流れです。
「Unityで変更した内容をGitHubに反映する」ときは、次の手順で進めます。
- Unityで作業し、シーンやスクリプトを保存する
- GitHub Desktopを開いて、変更されたファイルを確認する
- Summary （必要なら Description ）を書いて、 Commit to main を押す
- 右上の Push origin を押して、リモートリポジトリに反映する
(5. ブラウザでGitHubを開き、反映されているか確認する)
複数人で作業している場合は、作業を始める前に最新状態を取り込むために
Fetch origin や Pull origin を行うのがおすすめです。
この記事はセットアップ体験を優先して main ブランチで説明しています。実際のチーム開発では、作業用ブランチを作成してからコミットし、 Pull Request でmainブランチへ取り込む運用を推奨します。
補足：コミットメッセージの書き方に迷ったとき
- 「何をしたか」が短く伝わる文がおすすめです
例：プレイヤー移動処理を追加、タイトル画面UIを調整 - 1コミット1内容を意識すると、あとで履歴が読みやすくなります
- 参考サイト：https://www.conventionalcommits.org/ja/v1.0.0/
まとめ
- GitHubでリモートリポジトリを作成する
- GitHub Desktopでクローンする
- Unityプロジェクトをリポジトリの中に移す
- 変更をコミットする
- リモートリポジトリに反映する