ブログ
UnityプロジェクトをGitHubとSourcetreeで管理する【導入編】
最近ひょんなことからゲームエンジンの「Unity」を触ることになったので、この導入の流れを技術ブログとして残そうと思います。
流れとしては、Unityのインストールから、開発を楽にする「GitHub」と「Sourcetree」の導入までを説明します。
※現在、32bit版のUnityエディターは非推奨となっています。64bitOSでご利用ください。
※使用環境にGitがインストールされていることを前提としています。
まず、Unityをインストールしましょう。以下のリンクにアクセスして進みます。
URL:Unity日本語サイト
「はじめる」をクリック。
個人向けタブを選択し、Personalの「はじめる」クリック。
「始めよう」をクリック。
そして「同意してダウンロードする」をクリックすると、「Unity Hub」のインストーラー(UnityHubSetup.exe)をダウンロードできます。
Unityのマニュアルによると、
“Unity Hub は、Unity のプロジェクトとあらゆるバージョンのインストーラーの検索、ダウンロード、管理などを効率化するスタンドアロンアプリケーションです。また、すでにマシンにインストールされているエディターのバージョンを Hub に手動で追加することもできます。”
(引用:Unity Hub を使用した Unity のインストール – Unity マニュアル)
とあります。こんな便利なものを使わない手はないですね。UnityHubSetup.exeがダウンロードできたら実行します。
「同意する」をクリック。
「インストール」をクリック。
無事「Unity Hub」がインストールできたら、「完了」をクリックして起動します。
「アクセスを許可する」をクリック。
「インストール」をクリックして、「Unity」をインストールします。
ユーザーネーム、メールアドレス、パスワードを入力して、同意にチェックの上「Unity ID を作成」をクリック。すると確認メールが届きます。
メール文面の「Link to confirm email」をクリックしておきます。
プロジェクト名を入力して「次へ」をクリック。デフォルトを利用し「MyFirstGame」とします。
下部のプログレスバーが100%になるのを待ちます。私の環境では、これに一晩かかりました。。。
そして、いよいよ「UNITYを起動」をクリック。
チュートリアルが始まります。
いったんチュートリアルを終了します。
今後は Unity Hub を通してUnityを起動します。
「プロジェクト」項目は、プロジェクトを選択して起動したり、新しいプロジェクトを追加するときに使います。
「使い方を学ぶ」項目では、Unityに慣れていくためのチュートリアルが用意されています。
「コミュニティ」(ベータ)項目では、「フォーラム」や「グループ」などのリンクがあり、利用者同士で交流できるようになっています。
「インストール」項目では、プロジェクトを起動するUnityのバージョンを管理することができます。試しに新しいバージョンのUnityをインストールしてみましょう。
長期サポート版の「Unity 2018.4.21f1(LTS)」にチェックを入れ「次へ」をクリック。
「日本語」にチェックを入れクリック。
利用規約の同意にチェックを入れ、「実行」をクリックするとダウンロード&インストールが始まります
これがまた時間がかかります。。。
インストールされました。
新しくプロジェクトを追加します。まず「プロジェクト」項目の「新規作成」の横にある「▼」をクリック。
先ほどインストールしたUnity のバージョンをクリック。
プロジェクト名と保存先を入力して「作成」をクリック。
しばらく待っていると、
新規でプロジェクトが作成されました。
プロジェクト内をエクスプローラで確認すると5個のフォルダができています。
これでひとまずは開発を進めることができます。しかし、プロジェクトは複数人で管理されることもありますよね。むしろほとんどのプロジェクトはそうでしょう。
ここで欠かせないのが、Gitをオンライン上で管理できるホスティングサービスの存在です。これを使えば複数人での開発も楽になるでしょう。今回はGitのホスティングサービスで人気の「GitHub」を使ってみます。
それでは、GitHubに登録をします。以下のURLにアクセスして進みます。
URL:https://github.com/(GitHub)
Username、Email、Passwordを入力して「Sign up for GitHub」をクリック。
画像認証をアレして、
チェックマークが表示されたら「Next: Select a plan」をクリック。
ここで確認メールが送信されますので、いったんメールを確認します。
メール内の「Verify email address」をクリックしアカウントを登録を完了させます。
画面がブラウザに飛んだら、いま作成したアカウントでサインインしましょう。
まず何をしたいかを聞かれています。先ほどローカルで作った新規プロジェクトをリモートリポジトリにあげるのが目標ですので、「Create a repository」をクリックします。
「Repository name」にプロジェクト名を入力して、「Private」にチェック。「Add .gitignore」で「Unity」を選択して、「Create a repository」をクリック。
これで「.gitignore」ファイルだけが入ったリモートリポジトリを作成することができました。
それでは次にローカルリポジトリを作成します。コマンドラインで先ほど作ったプロジェクトのディレクトリに移動します。私の場合で言えば、「NewUnityProject」です。これをGitリポジトリに変換します。
参考
Qiita:UnityプロジェクトをGitHubで管理するためのシンプルな初期設定
TechAcademyマガジン:今さら聞けない!GitHubの使い方【超初心者向け】
git init
「git init」コマンドで「NewUnityProject」をGitリポジトリに変換できました。
「.git」フォルダが作成されたのが確認できますね。
次にリモートリポジトリのファイルをローカルリポジトリに持ってこようと思います。と言ってもまだ「.gitignore」ファイルだけしかないんですけどね。これにはリモートリポジトリのURLが必要ですので、GitHubのプロジェクトのページから確認します。
「Clone or download ▼」をクリックして、「Clone with HTTPS」と表示された状態でURLをコピーします。
まずはリモートリポジトリの情報の追加です。先ほどコピーしたURLを使います。
git remote add origin https://github.com/Uni-Taro/NewUnityProject.git
「git remote」コマンドでリモートリポジトリ情報が追加されます。続けて「.gitignore」ファイルをローカルリポジトリに追加します。
git pull origin master
「git pull」コマンドでリモートリポジトリの変更をローカルリポジトリに取り込みます。エクスプローラで確認してみると、
ちゃんと「.gitignore」ファイルができていますね。
今リモートリポジトリは「.gitignore」だけの状態なので、ローカルリポジトリの情報と同期させましょう。
git add .
まず「git add」コマンドでインデックスに追加(Git管理の対象化)します。
git commit -m "最初のコミットです"
「git commit」コマンドでファイルとディレクトリの追加をローカルリポジトリに記録します。
git push origin master
最後に「git push」コマンドを実行し、ローカルリポジトリの変更をリモートリポジトリに反映させます。
GitHub上で確認すると、
しっかりとフォルダがプッシュされています。(「Library」と「Logs」については、「.gotignore」ファイルで除外設定されているので同期されません。)
さて、ここまでで開発に最低限必要な準備は整いました。このあと、Gitの操作を楽に行うツール「Sourcetree」を使う準備をします。
SourcetreeはGitをGUIで管理できるツールです。これを使うことによって、コマンド操作が不要になったり作業が可視化されるなどのメリットがあります。
では、Sourcetreeをインストールしましょう。以下のリンクにアクセスして進みます。
URL:Sourcetreeダウンロードサイト
「Download free」をクリック。
同意にチェックを入れ、「Download」をクリック。セットアップ用ファイルがダウンロードされるので実行します。
ここで「Bitbucket」を使うように迫ってきます。BitbucketはSourcetreeを運営するAtlassianのサービスであり、GitHubと同じくバージョン管理リポジトリホスティングサービスであります。
せっかくのお誘いなのですが、GitHubの方を使う予定でいますのでお断りします。しかし、登録をしないという選択肢を提示してくれないので、面倒ですが登録だけすることにします。
登録しても今回は使いません。
メールの認証を済ませます。
ここの手順は飛ばしますので、それぞれ登録していただければいいと思います。
さて、Sourcetreeが無事にインストールされ、アプリが立ち上がりました。試しにさきほどGitHubで作成したリモートリポジトリをクローンしてみましょう。ここではSSHで接続しようと思います。
まずはホスティングサービスをBitbucketからGitHubに変更するとこからですね。
「アカウントを編集」をクリック。
ホスティングサービスを「GitHub」、優先するプロトコルを「SSH」、認証を「OAuth」に変更して、「OAuthトークンを再読み込み」をクリック。
ブラウザに遷移しますので、「Authorize atlassian」をクリック。
認証が成功しました。
「OK」をクリックできるようになりました。
GitHubに変更されましたね。検索欄に「new」と入力すると、下に候補として「NewUnityProject」が表示されますので「Clone」をクリック。
画面が変わるなりアテンションのポップアップが出まくりますが、全部「いいえ」で。
リポジトリタイプのところに「ソースパス/ソースURLとして正しくありません」と表示されています。SSHの設定をまだしていないからですね。
また、新しくローカルに開発用リポジトリを作ってみました。「unity_development」というフォルダの下でプロジェクトを進めるというようなイメージです。元のままでも結構です。
ツールの「SSHキーの作成/インポート」をクリック。
「Generate」をクリック。
マウスを動かしてプログレスバーを先に進めます。
Git Bashを開いてSSHの設定をしていくですが、ここでは割愛します。
参考
Qiita:GitHubでssh接続する手順~公開鍵・秘密鍵の生成から~
Qiita:新しいMacでGitHubのSSH接続をするまでの環境構築手順
SSHの設定を終えると、リポジトリタイプに「これはGitリポジトリです」と表示されるようになりました。「クローン」をクリック。
これでSourcetreeでの設定も終了です。お疲れさまです!
今回は「導入編」ということで、Unity開発環境の導入までをまとめてみました。ゲーム開発には興味があるけど、環境構築について調べるのが面倒・・・という方の一助になれば望外の喜びです。
関連記事
2024.09.30
2024.09.30
2024.04.08