Git VRC は VRC のプロジェクトで発生する意味のない diff をへらすための git 拡張です。

ローカル環境でのみ意味のある値を .asset、 .prefab、 .unity ファイルから git の上でのみ削除します。

Windows をお使いの場合は、releases からダウンロードできるインストーラーを使用できます。

最新バージョンの setup.exe は こちら からダウンロードできます。

このインストーラーは単に exe を所定の場所に配置するだけでなく、下記の setup 手順も実行します。

releases からバイナリをダウンロードして、任意の場所に手動でインストールできます。

実行ファイルの名前を git-vrc に変更し、PATH 環境変数に追加すること、そして下記の setup 手順を実行することを忘れないでください。

cargo binstall を使っている場合は、以下のコマンドでインストールできます：

cargo binstall --git https://github.com/anatawa12/git-vrc.git git-vrc

Rust ツールチェーンがある場合は、以下のコマンドでインストールできます：

cargo install --git https://github.com/anatawa12/git-vrc.git git-vrc

このツールを Git に設定するには、次のコマンドを実行してください：

# もしこのツールをシステム全体(git config の --system と同等)にインストールしたい場合
$ sudo git vrc install --config --system
# もしこのツールをユーザー単位(git config の --global と同等)にインストールしたい場合
$ git vrc install --config --global

また、 .gitattributes をレポジトリに追加するため、以下のコマンドを実行してください。

$ cd /path/to/YourUnityProject
$ git vrc install --attributes
$ git add .gitattributes

または以下のような .gitattributes ファイルを作成してください。

*.asset filter=vrc eol=lf text=auto
*.prefab filter=vrc eol=lf text=auto
*.unity filter=vrc eol=lf text=auto

最後に、もしすでに unity のファイルを git にコミットしたことがある場合、 git に再 index してもらうため以下のコマンドを実行してください。

# レポジトリ内のファイルすべてを touch することで、 git に再 index してもらいます。
# all files in your repository to let git re-index files.
$ find . -type f -print0 | xargs -0 touch
# そしてコミットします
$ git commit -am "chore: start using git-vrc"

unityyamlのファイル内の要素を fileid でソートすることができます。 unity-sort を attributes で set してください。

*.asset filter=vrc eol=lf text=auto unity-sort

git-vrc-filter-version 属性に数値を設定することで、古いバージョンの git-vrc の動作を使用したり、リポジトリがより新しいバージョンの git-vrc フィルタリングを使用している場合にエラーを発生させたりすることができます。

*.asset filter=vrc eol=lf text=auto git-vrc-filter-version=1