🚀

Verseコード保管庫として始めたい Git/GitHub

2024/09/21に公開

はじめに

Verseコードを書いていて、
コードをストックしたり、記録として残したい
GitHubを使ったことがないけど、GitHubにあげてみたい
そう思われている方の参考になるかもしれません。

なぜGitHub

UEFNにはUnreal Revision Control(URC)という、リビジョンコントロール機能が組み込まれています。有効にすることでプロジェクト全体のバージョン管理をすることができ、とても便利です。

ただし、URCを使うということはUEFNが入っているPCが手元に必要です。
プロジェクト全体はURCで管理するとして、見返したいVerseコードを閲覧しやすい場所に保存しておくと、そのコードを使ったり振り返ったりするのが簡単になります。繰り返すことでコードを改善していけるでしょう。
ほとんどのVerseプログラムはFortniteの仕掛けを使用していて、コードのみでは完結しないのですが、コードを振り返って改善していく手立てとしてよいのではないでしょうか。

♦ GitHub を利用することでの期待
・PC からでもスマホからでも見られる
・リポジトリの公開設定がpublic とprivate があり、public にすることで誰でも見られる
・差分が取れて、バージョン管理できる

この記事のゴール

本記事のゴールは、Verseコードの保管庫としてのリモートリポジトリをGitHub上に作成し、VerseコードをGitHubにあげることです。
Gitのワークフローを丁寧にお伝えすることはできませんが、Gitのインストール~VerseファイルをGitHubに登録するまでの流れをなるべく具体的に残しています。

♦ 作業環境
Windows11
Git(インストール後) 2.46.1
VSCode 1.93.1

Git のインストール

Git ダウンロード

Git がインストールされているか確認する場合、以下をコマンドプロンプトに入力します。

git --versiion

インストールされていなければ、Git をダウンロードします。
今回インストールしたGitのバージョンは2.46.1 でした。
https://git-scm.com/download/win

Git インストール

ダウンロードしたexeファイルを実行します。



こちらのサイトが選択する項目の説明をしてくれていて参考になります。
https://www.curict.com/item/60/60bfe0e.html

ほぼそのままの設定に次々と進みます。
変更したのは以下2つの設定です。
①エディタはVSCode を選択

②新しいリポジトリのデフォルトのブランチ名を「main」に設定

最後の画面まで完了後、以下をコマンドプロンプトに入力します。
Git がインストールできている場合、バージョン情報が表示されます。

git --versiion

GitHub のアカウント作成

https://github.com/
「Sign up」 から登録開始。

料金プランについては、GitHub を小規模に利用していく予定のため、Freeプランを選択します。
https://github.co.jp/pricing.html

Git/GitHub での作業

Git のインストール後、Git Bash を開くことができるようになります。
Git コマンドの入力は、VSCode でもできますが、以降の作業ではGit Bash で行っていきます。
Git Bash を検索して起動します。

これからプッシュが終わるまで、ひたすら作業を進めていきます。
Gitの用語は出てきますが、解説はしていないので全体像が掴みづらいかもしれません。
こちらの記事は、Gitの流れがとても掴みやすかったです。
https://qiita.com/k_uki512/items/7c1856edbade1bc7b98a

Git のユーザー情報設定

Git コマンドでユーザー情報を設定します。

git config --global user.name "{GitHubユーザー名}"
git config --global user.email {GitHubメールアドレス}

設定後、C:\Users\{Windowsのユーザー名}.gitconfig が作成されます。
cat ~/.gitconfig で .gitconfigファイルの内容を見ることができます。
ユーザー名とメールアドレスが設定されているとOKです。

ローカルリポジトリの作成

エクスプローラー上でフォルダを作成する

Gitに登録するフォルダ(のちのリポジトリ)を作成します。
私はDドライブ上に shareフォルダを作成しました。

コマンドでフォルダの場所に移動する

移動するにはcdを使用します。
フォルダがデスクトップにある場合、

cd Desktop/{フォルダ名}

Dドライブにフォルダが存在する場合、Dドライブ→フォルダの順で移動します。
例えば、"D:\Git\share" にある場合、

cd /d
cd Git/share

ローカルリポジトリをセットアップする

エクスプローラーで追加したフォルダを、Git コマンドでリポジトリとしてセットアップします。

git init

実行後、フォルダ直下に.git フォルダが作成されます。

登録するファイルをステージに追加(ステージング)

登録するファイルをフォルダに配置する

登録するファイルやフォルダをコピーします。
UEFNを開いている場合、Verse Explorer でファイルを右クリックして「ディレクトリを開く」で、エクスプローラーでファイルの場所を開くことができます。

コピーしたファイルを、ローカルリポジトリにペーストします。

配置したファイルをステージに追加する

ステージに追加したいファイルやフォルダがちゃんと存在しているか、ls で確認します。
なお ls -a にすると隠れフォルダも対象となり、.git も含まれるようになります。

以下のGit コマンドを入力することで、 作業中のフォルダ以下にあるフォルダをすべてステージに追加します。

git add .

私の場合、上記コマンドに失敗しました。

fatal: detected dubious ownership in repository at 'D:/Git/share'
'D:/Git/share' is on a file system that does not record ownership
To add an exception for this directory, call:

        git config --global --add safe.directory D:/Git/share


メッセージで提案されている「git config --global --add safe.directory D:/Git/share」
を実行して、再度git add .したところ、成功しました。
git status で状態の確認ができます。

ステージのファイルをリポジトリに記録(コミット)

以下のコマンドを実行するとVSCode が立ち上がります。

git commit

メッセージを入力後、ファイルを保存して閉じます。画像は入力していない状態です

git status でコミットしていること確認します。

リモートリポジトリの作成

GitHub でリモートリポジトリを作成する

GitHub にアクセスして「New Repository」から作成画面を開きます。

リポジトリ名と公開設定(Public, Private)を入力します。
Public を選択すると誰でも見ることができるようになるのでおススメです。

リモートリポジトリの作成が完了したら、2つのコマンドをメモしておきます。

アクセストークンを発行する

Settings > Developpersettings > Personal access tokens > Tokens(classic)
Generate new token (classic) を選択します。

必要な権限にチェックを入れて、トークンを発行します。
ひとまず全てチェックしています。ご自身で調整してください。

発行したトークンはメモしておきます。
のちほどプッシュする際の認証に使用します。

リモートリポジトリに反映させる(プッシュ)

ローカルリポジトリの変更履歴をリモートリポジトリに反映させます。

リモートリポジトリ作成時にメモしておいたコマンドを実行します

1つ目は、origin という名前でリモートリポジトリにアクセスできるようにします。一般的に
origin。
2つ目は、指定したリモート名(origin)の指定したブランチに、ローカルリポジトリの変更履歴を反映します(プッシュ)

git remote add origin {リモートリポジトリのURL}
git push -u {リモート名} {ブランチ名}

途中、認証のウィンドウが表示されるので、Token を選択して、メモしておいたトークンを入力します。

GitHub にファイルが登録されていることを確認します

おわりに

以前そんな感じのコードを書いた覚えが... が今後減ること願って、活用していきます。

参考

・Unreal Revision Control
https://dev.epicgames.com/documentation/ja-jp/uefn/unreal-revision-control-in-unreal-editor-for-fortnite

・Git(TortoiseGit)で「fatal: detected dubious ownership in repository」というエラーの解決法
https://moondoldo.com/wordpress/?p=8481

・git add ってなんのためにやるの? Gitの「ステージング」をイラストで解説します!
https://kray.jp/blog/expound-git-add/

・サル先生のGit入門
https://backlog.com/ja/git-tutorial/intro/01/

・個人学習で書くコードはpublic公開した方がよい理由
https://qiita.com/nagareboshi/items/04e3c0be148b5dd9feee

Discussion