ゲームエフェクトデザイナーのブログ (新)

レポート記事とかUE4のマテリアルとか。C#とかも触ったり。

GitHubでのツールやソース公開について(CGアーティスト向け)

GitHubって何ぞや?」なんかは「GitHub 初心者」「GitHub 入門」などでググると解説記事やスライドが沢山出てくるのでそこについては割愛して‥

じゃあ実際にGitHubでツールとかソースコードを公開しよう」と思った際に、GUIのあるツールを使った分かりやすい解説記事が案外パっと出てこない‥と思いました。

初心者向け記事の多くが「用語の説明」と「コマンドの説明」ばかりだったりで、結局色んなサイトを漁らないと手順がよく掴めないというか。。

リポジトリとか基本的な用語のいくつかは最初に覚える必要があるとして、アーティストがただ何か公開したいだけならコマンドは何も覚える必要は無いと思うのでご安心を!

という訳で、アーティストの方向けにざっくり要点を書きました。

 

GitHubのはじめ方


① まずは「GitHub」公式サイトでアカウントを取得

 

② 公式サイト上でリポジトリを新規作成する
  色んなツールを1つのリポジトリで公開するのではなく、ツールごとに新規作成します。
  新規作成時の設定は後述の記事を参考にすると良いです。
  ここで言語やライセンスについて設定して、READMEも作っておくと良いです。

GUIで操作できる「GitHub Desktop」をダウンロードしてインストールする
  GitHubGUI付きクライアントとしては「Sourcetree」が定番っぽい(?)ですが
  公式の「GitHub Desktop」を選択。
  機能が絞られるみたいですが公開するだけなら十分そうに感じました。

GitHub Desktop でログインして公開する個人情報を設定
  ログインは、メニューの File>Options>Accounts タブでログインできます。
  隣の Git タブで公開される名前とメアドを入力しておきます。
  メアドをちゃんと入力しないとコミット時にエラーが出るっぽいです。

GitHubのウェブサイトで作ったリポジトリを自分のパソコンに Clone (コピー)する
  メニューの File>Clone Repository...でリポジトリを選択します。
  デフォルトならマイドキュメント>GitHubフォルダ直下に作成されます。

⑥ ⑤で作った作業フォルダ内に公開したいファイル一式を入れる
  公開したいファイルを放り込むだけです。
  ソリューションファイル(Visual Studioのプロジェクトデータ的なもの)も一式放り込めばOK。
  ファイルを変更したり削除したりも普段通りそのフォルダ内で自由に行えばOKです。

GitHub Desktop の「Changes」パネル内に新しく追加されたファイルが入っているので Summary 欄に更新内容についてコメントを入力して「Commit to master」ボタンを押す
  すると更新がコメント付きで記録されます。
  ただしこのままだとリポジトリには反映されない模様。

⑧ ツール上部の「Push origin」ボタンが押せるようになるので押す
  するとリポジトリにデータがアップされて、ローカルのフォルダ内での更新内容が反映されます。

GitHub公式ページを見てチェック
  「README.md」は、ツールの説明や注意事項などを書けば良いかと。
  こちらマークダウン方式で記述します(ATNDの告知ページとかでお馴染のもの)。
  最初はとりあえず日本語で文章書いた後、全ての行末に半角スペース2つ(改行)を追加しとけばOK。

参考サイトと動画


リポジトリを作成する際の設定はこちらの記事を参考にさせて頂きました。

リポジトリ作成時のオプションである「Add .gitignore」では Visual Studio を選択しました。

ここで選択しておくと「.gitignore」というファイルが作られて、テキストエディタなどで中を見ると「GitHubにアップしないファイル」の指定が記述されています。
例えば「.vs」フォルダとか「bin」フォルダとかはアップされません。

Visual Studio ではソリューションファイルとともに一時的に作成されるファイルなどが沢山あり、それらも GitHub にアップしてしまうと、他の方が GitHub からローカルに Clone してソリューションを開いた際に一時ファイルに勝手に更新がかかってチェンジリストに載ってしまったりするので、アップしないのが作法のようです。

初心者向けの解説記事では「Add .gitignore」をスルーするケースが多い感じでしたが、ソリューション一式をアップするような場合ではAddするように設定した方が良いと思いました。

それから、ソースコードではなく何かアセットを公開したいと思った際には、使用条件をちゃんとREADMEにでも明記しておかないと、ダウンロードする側も「これって使って良いの?どうなの?」と困ってしまうようです。

今ならクリエイティブ・コモンズ・ライセンスを提示するのがオシャレなんじゃないでしょうか。


また、実際に GitHub Desktop を使ってローカルにあるファイルをどう反映させるのかの流れは、こちらの動画の最初の12分くらいを見れば大まかに分かりました。

あと気を付けることとしては、再配布禁止の素材なども一緒にアップしてしまわないことでしょうか。

以上です。

何か間違ったことなど書いていた際には、ご指摘お願いしますー!

それから、アップ時の作法など親切に教えてくださった@Iggyさん、ありがとうございましたー!