VS Codeでなるたけ速くUnity環境構築


前提

  • OSはMac
  • Unityはインストール済み
  • VS Codeはインストール済み

やること

VS CodeをUnityのエディタとして使えるように設定する。
具体的にはC#やUnity関数のインテリジェンス(自動補完)やデバッグを行えるようにする。

コーディング環境構築

※M1チップが搭載されたMacを使用されている場合は、こちらを参考にmonoのインストール・設定をしてください。下記の「monoコンパイラのインストール」と「Unity関数の自動補完の有効化(monoコンパイラ)」の作業は不要です。

monoコンパイラのインストール

Homebrew及びmonoのインストール(MacやVS Codeのターミナル上で実行)

$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
$ brew install mono

Unity関数の自動補完の有効化(monoコンパイラ)

  1. 左のリストから【Manage】アイコンを選択し、【Settings】をクリック

  2. 検索ボックスに「use global mono」と入力し、表示された【Use Global Mono】の項目をプルダウンから【always】を選択し、【Restart OmniSharp】をクリック

    C#環境のインストール

  3. 左のリストから【Extensions】アイコンを選択し、検索ボックスに「C#」と入力し、トップに表示されたプラグインの【Install】をクリック

  4. 下記のエラーメッセージが表示された場合は【Get the .NET Core…】をクリック

  5. 表示されたWebページから【Install for MacOS】をクリックし、任意の場所にダウンロードしてインストール
    ※詳細は割愛。基本的にはウィザード上で【次へ】をクリックしていけばOK

Unity関数の自動補完の有効化(プラグイン)

  1. 左のリストから【Extensions】アイコンを選択し、検索ボックスに「Unity code」または「Monobehaviour」と入力し、表示されたリストの【Unity Code Snippets】の【Install】をクリック

Unityのデフォルトエディタ設定

  1. UnityのPreferencesを開く

  2. 左のリストから【External Tools】をクリックし、【External Scripts Editor】の【Browse】をクリック

  3. 左のリストから【Applications】を選択し、【Visual Studio Code.app】をクリック

  4. Unityの【External Script Editor】がCodeになっていることを確認

デバッグ環境構築

デバッガのインストール

  1. 左のリストから【Extensions】アイコンを選択し、検索ボックスに「unity」または「debugger for unity」と入力し、表示されたリストの【Debugger for Unity】の【Install】をクリック

  2. 左のリストから【Run and Debug】アイコンを選択し、【create a launch.json file】をクリック。
    プルダウンリストの中から【Unity Debugger】を選択

  3. launch.jsonファイルができたことを確認する

デバッグ方法

  1. Unityをプレイモード(▶︎をクリックしてゲームを開始する)にする
  2. VS Codeで処理を止めたい箇所にブレイクポイントをセット(行番号の左をクリック)して左上の▷ボタンをクリック
  3. デバッガが待機状態になるので、Unityの画面で操作
  4. 該当の箇所に到達するとUnity上のプレイモード画面が停止し、VS Code側でデバッグが可能になる

トラブルシュート

コード補完がされない

プロジェクトのルートフォルダ(Assetsフォルダ等があるところ)に.csprojと.slnファイルがあることを確認する。存在しない場合、または存在するがうまく動かない場合は一度これらのファイルを削除し、UnityのAssets > Open C# Projectを選択してVS Codeを起動後、補完ができるか確認する。

また、Unity2019.3以降を使っている場合はUnity > Preferences > External Toolsからも.csprojを生成できる。詳細はこちらを参照。