Unityを学ぶ 1回目 - 3D Beginner Game: Roll-a-Ballチュートリアル完了とディレクトリをGit管理する#

概要#

• 以下の目的を達成するまでに、得た知識をまとめる
  • 3D Beginner Game: Roll-a-BallというUnity公式っぽいチュートリアルを完了する
  • 上記で作成したUnityプロジェクトのディレクトリをGit管理しGitHubへ置く
    • 結果: kjirou/Rollaball
• 環境
  • PCは MacBook Pro 16インチ 2021 / Apple M1 Max
    • Windowsの方が良い？と人に聞いたら、その人はMacで困ってないという返答だったのでMacにした
  • UnityのバージョンはLTSの6.0

参考にした資料#

• Unity Learn - 3D Beginner Game: Roll-a-Ball
  • これを完了することが目的のひとつ
• Unity Learn - Project setup processes
  • Unity EditorやUnity Hubのインストールや設定方法の解説
    • この記事のUnityバージョンは6.0より古いが、特に問題なかった
  • Roll-a-Ballのチュートリアルから参照されている
• Get started with the Unity Editor
  • Unity Editorの基本的な操作の解説
  • Roll-a-Ballのチュートリアルから参照されている
• TextMesh Pro ユーザーガイド
  • チュートリアルの途中でTextMesh Proのインストールを求められた時に、チュートリアルの手順と異なりダイアログ的なものが出現しなかったので検索した記事
  • あまり覚えてないが、以下の箇所が参考になった記憶がある

    • "TMP Essential Resources" をインポートするには、メニューを "Window -> TextMeshPro -> Import TMP Essential Resources" の順に選択してください。これらのリソースがプロジェクトのルートの "TextMesh Pro" フォルダーに加えられます。

• [Unity]Input ManagerとInput Systemに初心者狩りされた話
  • チュートリアルのAdd prefabs and other assets to the sceneの手順で"If you enter Play mode now, the character should be able to walk around,"と書いている部分が動かなかった
    • つまり、テストプレイ時にWASDでキャラクターが動くはずが動かなかった
  • それを解決するために参考にした記事
    • 結論として、Edit > Project Settings > Active Input Handling > Both を選択すると解決するとのこと
  • おそらくは、チュートリアルが用意しているスクリプトの不備だと思う
• Unityユーザーマニュアル - Configurable Enter Play Mode
  • Unityができる人に Edit > Project Settings > Editor > Enter Play Mode Settings > When entering Play Mode > Reload Scene only を選択すると、テストプレイ時のコンパイルが早くなるという話を聞き、その代償は何だろなというのを調べるために読んだ記事
  • ちゃんと概念を定義した上でレイヤーを分けて管理しているんだなぁ...以上のことはわからなかった
• Unityユーザーマニュアル - Details of disabling domain and scene reload
  • 上記のために追加で読んだ記事、更にわからなかった
  • 結論として得られた具体的なノウハウは、コンパイル時に何か同期してなかったらこの設定を疑おう、程度のこと
• UnityのエディターとしてVSCodeを利用する
  • 背景
    • コードを編集する際に、Unity Editor自体はテキストエディタを持たないため、外部のテキストエディタと連携する仕組みである
    • 連携をするにあたり、公式推奨のテキストエディタが Visual Studio Code(以下VSCode) である
  • チュートリアル上の設定だけでは、型やLintingなどの静的解析情報がテキストエディタへ出現しないので、その設定の解説
    • VSCodeのプラグインを入れただけでシュッとできた
• PivotとAnchorsの違い
  • チュートリアルの Displaying Score and Text > Create a UI text element > Edit the text position. に、AnchiorsとPivotという概念が出てくるのだけど、それがわからないのでChatGPTへ聞いたもの
  • この記事を書いている時点で、レイアウティングの設定をするための概念である、以上のことを覚えてない
  • 知らないとダメなやつなので、実装をする時には学びましょう
• github/gitignore/Unity.gitignore
  • GitHubによるUnity用の.gitignoreのサンプル
  • 今のところは、概ね正常にGit管理できているように見える
    • ディレクトリ名を変更すると.vscodeに差分が出たりするので、調整は必要そう
• is8r/example-Ray/.gitattributes
  • 人様のUnity用の.gitattributesの設定例
    • 主たる設定は、Unity作業ならではの設定と、重い素材をGit LFSで管理するため設定
  • 知らない書式があるので調査
    • merge=unityyamlmerge
      • UnityYAMLMerge
        • 現時点でちゃんと検証してないけど、きっと良い感じにマージしてくれるのでしょう
    • -text
      • テキストとして扱わない == バイナリとして扱う、ことを明示する
      • 画像系には不要そうに見えつつ、知らないファイル拡張子も多いのでそれらも一緒に付与しておいて良さそう
  • なお、Git LFSを気軽に使おうとしてみたんだけど、調べるほどに各面で導入コストが重いので、ちゃんと調べないとやばい。別に単体で調査する必要があるので、今は保留。
    • Git LFSの導入に対しての問題
      • 課金
        • Git LFSを使用しているリポジトリの所有者のGitHubアカウントに対しての課金になる
        • ストレージと帯域それぞれで月額課金、Free/Proならどっちも10GB
        • 帯域はともかくストレージはGitHubアカウントに対して蓄積するので、その人がたくさんGit LFSを使ったリポジトリを作ってるとその合計になる
        • そして、累積に対する月額課金なので、合計10GBを超えると毎月超えている分に対して課金される
        • そしてそして、一度LFSへ追加したファイルは、基本的にはGitHubのリポジトリを削除しないと消せない
          • ファイルを Git Large File Storage から削除する - リポジトリにある Git LFSオブジェクト

            • Git LFS からファイルを削除した後でも、Git LFS オブジェクトはそのままリモートストレージに存在し、Git LFS ストレージ容量に対するカウントも継続します。

            • Git LFS オブジェクトをリポジトリから削除するには、リポジトリを削除して再作成します。

          • なんだァ？てめェ...
        • では、必要最小限のファイルだけを後からGit LFSへ登録しようとすると、デフォルトはGitの履歴を改ざんする振る舞いなので、それもまた少し嫌な感じがする
          • git lfs migrate -hのヘルプには"Migrate without rewriting local history"という方法も紹介されているので、改ざんする必要はないのかもしれない
            • git lfs migrate import --no-rewrite -m "Commit Message" foo.zip みたいな --no-rewrite オプションがある。これもまだ試してない。
        • 同様のお困りをしている人は居そう
          • 【備忘録】(自分用)GithubでGitLFSを使いたいけど、節約したい
      • Git LFSが複雑
        • この時点で動作のイメージ掴めてない程度にわからない
          • LFSの管理下から特定のファイルをつけ外しする方法とかもシュッとわからない
          • マニュアルを読もうにも、20個くらいのサブコマンドと、それぞれに対して長文の解説があるので辛い
          • 一応読むだけ読んだ記事
            • Git LFS をちょっと詳しく
            • Gitリポジトリのコピー時、git lfs migrateでGIT-LSF移行
            • Git LFS で困った時に読むやつ
        • git lfs installによりGitの設定へpost-commitやpre-push等のフックが追加されるので、そこはかとない不安がある

その他の知識#

GitリポジトリからUnityプロジェクトを復元した時に、Hierarchy windowが空#

• GitリポジトリからUnityプロジェクトを復元する方法は、基本的にはUnity Hub経由でクローンしたGitリポジトリを起動するだけで完了するよう
• ただ、それをやった直後、存在したはずのSceneの情報がHierarchy windowに存在しない
• Sceneの情報はファイルとして存在しているので、それを展開すれば良い
  • 例えば、冒頭で紹介した自分のリポジトリだと、Project window > Assets / Scenes / MiniGame のファイルをWクリックすると、復元できる