初めてのゲームプロジェクト バージョン管理

チームメンバーで安全、迅速にファイルやフォルダを共有することはプロジェクトを成功に導くために必要不可欠です。
それらを比較的簡単に実現するためのツールを実演交えて紹介します。

Transcript

1. 初めてのゲームプロジェクト バー
   ジョン管理
   GGJ21 オンライン
   

   View Slide

2. 内容
   - ファイル共有について
   - プロジェクト立ち上げ
   - 作業操作
   - 注意点
   - GGJ 成果物提出について
   

   View Slide

3. 自己紹介
   PN: ゆーり
   新しいものスキ。趣味で格闘ゲームを開発しています。
   

   View Slide

4. プロジェクト共有について
   

   View Slide

5. 要件
   - ファイル、フォルダの共有
   - ファイルの変更履歴
   - オンライン
   - 無料
   - 簡単
   

   View Slide

6. プロジェクトの共有方法
   USBメモリを介したファイル受け渡し。
   Google Drive 等ネットワークストレージを介したファイル受け渡し。
   バージョン管理を使う。
   

   View Slide

7. バージョン管理ツールの利点
   複数メンバーと共有できる。
   作業内容を保存できる。元に戻れる。
   作業内容を把握できる。
   

   View Slide

8. いろいろなバージョン管理
   名称 所感
   CSV 昔からある。
   SVN ゲーム業界で使われている。
   Perforce 巨大なプロジェクトで活躍。すごい。
   Git 一番人気。
   Unity Collaborate Unity専用。一番簡単。
   Plastic SCM 最近Unityファミリーに加わった。
   

   View Slide

9. GitHub Desktop
   GitHub社製。
   シンプルなUI。
   デザイナー向け。
   

   View Slide

10. いろいろなGitホスティングサービス（無料）
    サービス名 人数制限 容量制限
    GitHub 無制限 Repo 10GB LFS 1GB
    Bitbucket 5人 Repo 2GB LFS 1GB
    GitLab 無制限 Repo 10GB LFS ?
    Unity Collaborate 3人 1GB
    * 2021/1月現在無料で利用できる範囲での制限
    

    View Slide

11. 準備
    1. Unity Hub ダウンロード。インストール。
    https://unity3d.com/jp/get-unity/download
    2. Unityインストール。
    3. GitHub サインアップ。
    4. GitHub Desktop ダウンロード、
    インストール。
    https://desktop.github.com/
    5. GitHub Desktop に GitHub アカウント
    を紐付ける。
    

    View Slide

12. プロジェクト立ち上げ
    

    View Slide

13. リポジトリ
    フォルダやファイルの変更履歴の保存場
    所。
    ローカルとリモートがある。
    プル … リモートの内容をローカルに反
    映。
    プッシュ … ローカルの内容をリモートに
    反映。
    

    View Slide

14. プロジェクト作成手順
    1. Unityプロジェクト作成。
    2. Gitリポジトリ作成。
    3. GitリポジトリをGitHubのリモートリポジトリへパブリッシュ。
    

    View Slide

15. プロジェクト参加手順
    1. GitHubで招待してもらう。
    2. Gitリポジトリをローカルにクローンする。
    

    View Slide

16. 操作
    

    View Slide

17. History 履歴
    更新履歴を見ることができる。
    

    View Slide

18. Changes 変更内容
    変更したファイルとその中身を確認できる。
    中身を確認できるのはテキストのみ。
    

    View Slide

19. Discard 破棄
    ファイルを元の状態に戻します。
    

    View Slide

20. Commit コミット
    変更内容を確定する。
    １行のメッセージをつける必要がある。
    １つの作業完了で１回コミットするとよい。
    

    View Slide

21. Undo アンドゥ
    直前のコミット操作をなかったことにする。
    何回でも戻れる。
    サーバーにプッシュするとアンドゥできなくなる。
    

    View Slide

22. リモートに新しい変更があるか確認する場合 > Fetch フェッチ。
    リモートに新しい変更がある場合 > Pull プル。
    ローカルに新しい変更がある場合 > Push プッシュ。
    Sync 同期
    

    View Slide

23. Merge マージ
    ふたつの作業内容をいい感じに合成する。
    ローカルでマージした後にプッシュすることで確定。
    

    View Slide

24. Conflict 衝突
    同時期に同じファイルを操作してしまった場合に発生。
    どちらが正しいファイルかを選択するか、もしくは合成する必要がある。
    テキストの場合は自動的に合成してくれる。
    

    View Slide

25. Branch ブランチ
    他人に影響を与えない自分だけの道を作れる。
    Mainから分岐する。
    Mainに合流させることで、プロジェクトを反映する。
    

    View Slide

26. 注意点
    

    View Slide

27. GitHub(無料)の制限
    制限内容
    - １ファイルサイズ制限 100MB。超える場合はLFSを使う。
    - ストレージ容量 Repo 10GB, LFS 1GB。
    - 帯域制限 Download Max 1GB / 月。
    パブリックで開発した場合
    - 再配布禁止のアセットのプッシュ禁止。
    制限を超えるには ...
    - 別サービスを使う
    - 有料プランを選択
    - 自分でホスティングする
    容量使いすぎないように工夫する。
    

    View Slide

28. 無視するファイル
    GitHubを使えば意識する必要は少ない。
    バージョン管理する必要のないファイルパターンを`.gitignore` ファイルに保存する。
    キャッシュやテンポラリフォルダを追加する。
    

    View Slide

29. ファイルへの書き出し
    シーンを保存する。
    .unity ファイル
    プロジェクトを保存する。
    .meta .mat .asset .json ファイル等
    CTRL+S でだいたいOK。
    

    View Slide

30. Metaファイルの扱い
    Unity独自の機構。
    アセット、フォルダ１つに１つのMetaファイル。
    アセットの参照情報やインポート設定等が含まれる。
    一緒にコミットする必要がある。
    

    View Slide

31. 巨大なファイル (GitHub)
    100MB以上のファイルは
    Git LFSを使う。
    `.gitattributes` ファイルに
    ファイルパターンを保存する。
    LFSストレージは1GBまで無料。
    

    View Slide

32. 空フォルダ
    Unityでは空フォルダに対応するMetaファイルが作られるが
    Gitではフォルダのみが作られることはない。フォルダには中身が必要。
    対応策
    - Unityでは空フォルダを作らないように気をつける。
    - 空フォルダ削除ツールを用意する。
    Uni Empty Folder Deleter https://github.com/baba-s/UniEmptyFolderDeleter
    - 無視する。
    

    View Slide

33. GGJ成果物提出について
    

    View Slide

34. ファイル構造
    これらのフォルダをzipで圧縮してアップロードする。
    クラウドストレージを利用する場合はリンクを貼る。恒久的にアクセスできるようにしてお
    く必要がある。
    /src ソースコードやアセットファイルなど全て。
    /release 実行ファイル。README.txt付きで。
    /press ゲームのPR画像（press.jpg: 1024x768以上）。
    /other その他のメディア。プレイ動画など。
    license.txt クリエイティブコモンズライセンス 4.0
    

    View Slide

35. 削除しておくべきファイル、フォルダ
    ダウンロードしたアセットのライセンスを確認する。
    > 必ずライセンス表記に従う。
    > 再配布が可能か？
    再配布墓のアセットを削除する。
    .git フォルダを削除する。
    > .gitフォルダにはファイルの変更履歴がふくまれているため。
    再構成するための手順をテキストファイルに記述する。
    

    View Slide

36. 再配布禁止なもの
    自作したもの 。
    > 問題なし。
    Webからコピペしたコードなど 。
    > ほとんど問題なしだが、ライセンス表記があれば従う。
    Webからダウンロードしたもの。
    > ライセンスを確認し、従う。
    AssetStore にあるもの。
    > ほとんど再配布禁止。別のライセンス表記があれば従う。
    

    View Slide

37. 終わりに
    - チームの決定を優先する。
    - わからないことやトラブルがあれば内容を Discord #質問チャンネルへ。
    - リモートデスクトップを活用する。
    

    View Slide