ツールを取り除いてコンパイルする方法

特定の環境でツールを取り除いてコンパイルする方法を解説します。
リリース環境では、必ずNOA Debuggerを除外してアプリケーションをビルドしてください。

コマンドライン

アプリケーションのビルド前にコマンドラインから NoaDebugger.NoaPackageManager.ExcludeFromCompile を実行することで、
NOA Debuggerをコンパイル対象から除外できます。
Unityが提供するコマンドラインの詳細は、公式ページを参照してください。

# Windowsの場合
"C:\Program Files\Unity\Hub\Editor\<unity-version>\Editor\Unity.exe" -quit -batchmode -nographics -projectPath <project-path> -executeMethod NoaDebugger.NoaPackageManager.ExcludeFromCompile

# Macの場合
/Applications/Unity/Hub/Editor/<unity-version>/Unity.app/Contents/MacOS/Unity -quit -batchmode -nographics -projectPath <project-path> -executeMethod NoaDebugger.NoaPackageManager.ExcludeFromCompile

コンパイルから除外したNOA Debuggerを元に戻す方法

NOA Debuggerをコンパイル対象から除外した後にビルドを行い、元のNOA Debuggerを取り込んだ状態に戻す方法を解説します。

アプリケーションのビルド後にコマンドラインから NoaDebugger.NoaPackageManager.IncludeInCompile を実行することで、元に戻すことができます。

# Windowsの場合
"C:\Program Files\Unity\Hub\Editor\<unity-version>\Editor\Unity.exe" -quit -batchmode -nographics -projectPath <project-path> -executeMethod NoaDebugger.NoaPackageManager.IncludeInCompile

# Macの場合
/Applications/Unity/Hub/Editor/<unity-version>/Unity.app/Contents/MacOS/Unity -quit -batchmode -nographics -projectPath <project-path> -executeMethod NoaDebugger.NoaPackageManager.IncludeInCompile

NOA Debugger Editor

Unityメニューの Window -> NOA Debugger を選択して、NOA Debugger Editorを起動します。
Window内のPackage項目にある[Exclude from compile]ボタンを押下することで、コンパイル対象から除外できます。
※CI/CD環境からコマンドラインで取り除く前に、コンパイルエラー等が発生しないかUnityEditor上で確認したい場合に利用できます。

Unityメニューから操作する際のイメージ画像

コンパイルから除外したNOA Debuggerを元に戻す方法

UnityメニューからNOA Debuggerをコンパイル対象から除外した後に、元のNOA Debuggerを取り込んだ状態に戻す方法を解説します。

Unityメニューの Window -> NOA Debugger を選択して、NOA Debugger Editorを起動します。
Window内のPackage項目にある[Include in compile]ボタンを押下することで、元に戻すことができます。

その他注意事項

NOA Debugger導入時に Scripting Define Symbols に自動で設定した NOA_DEBUGGER のシンボル定義を取り除くだけでは、
一部のリソースデータ等がアプリケーションに含まれてしまうため、必ず上述のコマンドを実行してコンパイル対象から除外してください。

コンパイルから除外したNOA Debuggerを元に戻す操作がエラーになる場合の対処方法

コンパイルからNOA Debuggerを除外した状態でバージョン管理ツールの操作を行うなどすると、 元に戻す際に以下のエラーが発生する場合があります。

IOException: Cannot create '<path-to-project>/Packages/com.exnoa.noa.debugger/Runtime/' because a file or directory with the same name already exists.
IOException: Cannot create '<path-to-project>/Assets/NoaDebuggerSettings/Resources/Custom/' because a file or directory with the same name already exists.

この場合は、以下の手順をお試しください。

  1. コマンドラインもしくはファイル管理ツールなどで以下の . で始まるディレクトリを削除する。Macの場合は隠しフォルダー扱いとなるため、Finderに表示されない場合があります。
    • <path-to-project>/Packages/com.exnoa.noa.debugger/.Runtime/
    • <path-to-project>/Assets/NoaDebuggerSettings/Resources/.Custom/
  2. バージョン管理ツールを用いてNOA Debuggerが含まれている状態のリビジョンに対しての差分がない状態にする。