この記事では、GodotプロジェクトをGitでバージョン管理するための方法をGit初心者向けにまとめていきます。
今回は環境構築ということで、Git、GitHubの準備～リポジトリの作成、初回プッシュまでの流れを最小限の機能に絞ってまとめていきます。
1. Gitのインストール
Gitが未インストールの場合は、以下から公式サイトからインストールを行います。
ダウンロードしたインストーラーを起動し、インストールの設定を進めていきます。
→基本的にはデフォルト値で進めて問題ありませんが、以下に何点か抜粋して内容をまとめておきます
Choosing the default editor used by Git :
ここではGitで使用するデフォルトエディタを設定します。
デフォルトで選択されているのは「Vim」となりますが、自身が使い慣れているものを選択するのが良いかと思います。
Adjusting the name of the initial branch in new repositories：
ここでは、新規リポジトリを作成(git init)した際、デフォルトで設定されるブランチ名を設定します。
・Let Git decide：Gitが設定(現在は”master”)
・Override~：自身で設定
(Githubのデフォルトが”main”となったため、ここでは下を選択しています:参考情報)
Ajusting you PATH environment:
ここでは、パスの追加設定を行います。
・Use Git from Git Bush: Git Bashのみ追加
・Git from the ~:最小限のGitラッパーを追加
・Use Git and optional~:GitとUnixツールを追加
WindowsのコマンドプロンプトやPowerShellでもGitを使用するため、推奨の［Git from the～］
を選択します
Configuring extra options:
ここでは、追加オプションの設定を行います。
・Enable file sys~:キャッシュの有効/無効
・Enable symbolic links：シンボリックリンクの有効/無効
※シンボリックリンクはあとから設定も可能なため、必要になった際に適宜設定すればよいかと思います。(ユーザ権限設定等に注意も必要なため)
Configuring experimental options：
ここでは、実験的なオプションの適用可否を設定できますが、基本的にはそのまま［Install］へ進んで問題ありません
※項目はインストール時期によって様々かと思いますので、内容を確認し、必要に応じてチェックしてください。
より詳細にインストール時の各項目を確認したい際は、以下ページがよくまとまっていて参考になります。
インストールが完了したら、インストールされたGitBash(もしくはコマンドプロンプト)にて、
コマンド［git -v］を実行し、画像のようにバージョン情報が出力されていればOKです。
2. GitHub アカウントの作成
Gitがインストールできたら、続いてGithubのアカウントも準備を行います。
※リモートリポジトリの利用が不要な場合はこの手順を省略しても問題ありません
アカウントはユーザー名、パスワード等を設定し、メールに届いた認証コードを入力することで完了です。（画像右下のようにGithubダッシュボードが表示されていればアカウントの作成は完了です）
3. GitとGithubの初期設定
GitとGithubアカウントの用意ができたところで、それぞれを使い始める前に必要な初期設定を済ませてしまいましょう。
3-1. Git：ユーザー名/メールアドレスの設定
Gitではユーザー名とメールアドレスを設定する必要があります。(Githubではコミット者識別に使用)
→コミット履歴からメールアドレスを公開したくない場合は、Githubからダミーアドレスを取得します
Githubのメール設定ページ内の項目「Keep my email addresses private」を有効にし、項目下部に表示されているダミーアドレスをコピーしておきます。
このアドレスをコミットように設定しておくことで、Githubでのユーザー識別に影響を出さず、プライベートなメールアドレスを非公開とすることができます
Git Bash(もしくはコマンドプロンプト)にて、以下コマンドでそれぞれ設定可能です。
$ git config --global user.name <ユーザー名>$ git config --global user.email <メールアドレス>実行例：
設定が完了したら、コマンド：
$ git config --listから、各設定値が反映されていることを確認できます。
3-2. Github：SSH設定
GithubにはHTTPSか、SSHでのアクセスが可能ですが、SSHを設定しておくことで毎回のパスワード認証をパスできます。少しややこしいですが、初めに設定を済ませてしましましょう。
Git Bashを起動し、以下コマンドを実行することで、公開鍵/秘密鍵を発行します。
ssh-keygen -t rsa何度か入力を求められますが、ここではすべて空欄のままEnterで問題ありません。
生成された公開鍵/秘密鍵は「C:\Users\<ユーザー名>\.ssh」内に格納されています。
Githubへ登録するため、以下コマンドにて.pubファイル(公開鍵)の内容をコピーしておきます。
clip < ~/.ssh/<.pubファイル名>GithubのSSH/GPGキー設定ページ内にある、［SSH Keys］の［New SSH key］ボタンをクリックし、SSHキーの設定ページを開きます。
以下のように入力し、［Add Key］に進みます
・Title：任意のタイトルを入力
・Key type：「Authentication Key」を選択
・Key：.pubファイルからコピーした内容を貼付
これで、Githubへの公開鍵アップロードが完了したため、以下コマンドにてSSH接続を確認します。
(接続を続行するか聞かれることがありますが、「yes」で回答すると接続できます)
ssh -T git@github.com→successfully authenticatedが出力されていればOKです。
SSHは自身の持つ秘密鍵をチェックする際、デフォルトでは以下を参照します。
“~/.ssh/id_rsa”、”~/.ssh/id_dsa”、”~/.ssh/identity”
上記設定を変更する場合は、~/.ssh 内にconfigファイルを作成し、以下のように記述します
Host github github.com
HostName github.com
IdentityFile ~/.ssh/<鍵のファイル名>
User git
4. リポジトリの作成と登録
ここまでの手順で基本的なGit、GitHubの準備は完了しました。
ここからは、実際にGodotプロジェクトをGit管理するためのリポジトリの準備を進めていきます。
4-1. GitHubでリモートリポジトリを作成
Githubダッシュボード右上の「＋」から、「New repository」をクリックします
今回は練習のため細かい設定には触れませんが、それぞれ以下を設定します。
・Repository Name：
…任意のリポジトリ名を入力
・Public/Private:
…公開範囲はPrivateに設定
上記設定後、
「Create repository」へ進み、
リモートリポジトリの作成は完了です。
4-2. Godotプロジェクトの作成とローカルリポジトリの作成
Godotを起動し、
新規プロジェクト
→[バージョン管理メタデータ：Git]を設定
→プロジェクトを作成します。
この設定により、初期プロジェクトファイルにGit関連ファイルが用意された状態で作成が行われます。(.git:リポジトリは含まれないため、git initは後で行う形です)
上記でで生成された「.gitignore」 ファイルには、初期値として .godot/ ディレクトリ以下が設定されています。(ここにはGodotの内部処理に必要なデータ類が格納されているため、デフォルトでインデックス登録から無視する設定となっています）
この時点では特に.gitignoreを編集する必要は無い＆Godotが自動で生成するもののため、
初学者の方は「無視するフォルダを設定するデータが用意されている」とだけご認識いただければ大丈夫です！
次に、GitBashを起動し、cdコマンドでGodotプロジェクトフォルダへ移動します。
(当該フォルダを右クリック→［パスのコピー］(Ctrl＋Shift+C)が簡単です)
$ cd <プロジェクトフォルダのパス>
プロジェクトフォルダに移動後、git init でローカルリポジトリを作成します。
$ git init
git init 後、プロジェクトフォルダを見ると
「.git」フォルダが作成されていることを確認できます。
4-3. リモートリポジトリの登録
GitHubにて、4-1.で作成したリモートリポジトリの画面を開き、上部にあるクイックセットアップからボタン「SSH」を選択後、右に続く１行をボタンからコピーします
コピーしたアドレスを使い、以下コマンドをGitBashで実行します
$ git remote add origin <コピーしたアドレス>また、git remote -v でリモートリポジトリの登録状況(リモートリポジトリ名と場所)を確認できます
$ git remote -v
5.初回プッシュ
リポジトリの準備が完了したところで、プッシュを行ってみます。
現時点でGodotプロジェクト内のデータはすべて新規ファイル扱いのため、最初のバージョンとしてにプッシュしてみましょう。
Git作業におけるファイルの状況は、当該フォルダへ移動(cd)→「git status」で確認可能です
5-1. ステージング (git add)
まずは、git add にてインデックスへの追加(ステージング)を行います。
※今回の場合は[–all]オプションで全てのファイルを追加していますが、状況により調整して下さい
$ git add --all
5-2. コミット(git commit)
続けて、git commit にてコミット(ローカルリポジトリへの反映)を行います。
→ -m オプジョンをつけることで、コミットメッセージを入力しながら手早くコミットが可能です。
$ git commit -m "<コミットメッセージ>"
5-3. プッシュ(git push)
最後に、git push にてプッシュ(リモートリポジトリへの反映)を行い、一連の流れは完了です。
git push <リポジトリ名> <ローカルブランチ名>:<リモートブランチ名>
リモートリポジトリ名は「git remote (-v)」、ブランチ名は「git branch (-a)」で確認できます。(ローカルブランチ名はGitBash であればターミナルに括弧括りで表示されています)
GitHubのリモートリポジトリページを確認すると、コミットした内容がコミットコメントを含め、
リモートリポジトリへ反映されていることを確認できます。
→同時に、.gitignore にて除外設定されている[.godot/]ディレクトリ以下の要素は含まれていないことも確認できます。
おわりに
ここまでで環境構築は完了となります。
以降、プロジェクトを更新した際も、5.のような流れで操作を進めていけば最も基本的なGitのバージョン管理は実現できます。（まとめると、以下２ステップ）
Step1. Godotプロジェクトを編集する（Godotでの作業）：
…まずはGodotで作業を行います。シーン追加でもスクリプトの追記/修正でもなんでもOKです
Step2. ステージング～プッシュ(GitBashでの作業)：
…基本的には5.の流れを踏んで行けば同様に更新していくことが可能です。GitBashにて、
［git add -all］（ステージング：反映準備）
→[git commit -m “<コミットメッセージ>”]（コミット：ローカル反映）
→[git push <リポジトリ名> <ローカルブランチ>:<リモートブランチ>](リモート反映)
の手順で進めていけばOKです。
この記事で触れたのは、Gitにおける必要最小限の更新手順です。
Gitに触れるのが初めての方は、まずこの基本的な操作のみに絞ってGitに慣れ、少しずつ新しい機能を覚えていくのがおすすめです。(Git/GitHubは便利な分機能も多く、混乱しがちなため)
当サイトでもGitでの共同編集やブランチ、過去バージョンへの復旧方法、その他便利な機能などを次回以降の記事でまとめていく予定です。
コメント