Unreal Engine (UE) は、Windows の C++ プロジェクト用のデフォルト IDE として Microsoft Visual Studio をサポートしていますが、さらに軽量で無料のオープンソースのもう 1 つの選択肢として Visual Studio Code (VS コード) もサポートしています。VS コードは機能を完備している Visual Studio ほど豊富な機能を備えていないものの、拡張性がきわめて高く、Windows、MacOS、Linux で使用できるため、複数のプラットフォームで作業するデベロッパーに共通の基盤を提供することができます。
ただし、VS コードでは、Visual Studio for Windows と同等の機能を装備させるためには、追加の手動設定が必要です。このガイドでは、VS コードの環境を完全に UE 開発向けに装備するために、その追加手順について説明します。
VS コードを使用するために、Visual Studio をフル インストールする必要はありません。
必要な設定
このガイドでは、Unreal Engine がインストールされ、C++ プロジェクトが作成済みであることを前提としています。
VS コードとお使いの OS に必要な拡張機能をインストールする
-
VS コード と公式の C/C++ 拡張パック および VS コード向けの C# 拡張機能 をダウンロードしてインストールします。これらは、Unreal Engine とその ビルド ツール の両方のソース コードを読み取るために必要です。
-
お使いの OS 向けのコンパイラ ツールセットをダウンロードし、インストールします。
-
Windows: Microsoft Visual C++ (MSVC) コンパイラ ツールセット。
-
Mac: LLVM/Clang.
-
Linux: LLVM/Clang.
-
これらのコンポーネントの設定方法については、「コンパイラ ツールセットをインストールする」を参照してください。
-
Mac または Linux でデバッグする場合は、LLDB 拡張機能 をダウンロードしてインストールします。
-
VS コードをデフォルトの IDE として設定する必要がある場合は、Unreal Editor を開いて[Edit (編集)] > [Editor Preferences (エディタの環境設定)] > [General (一般)] > [Source Code (ソース コード)] を選択し、[Source Code Editor (ソース コード エディタ)] を [Visual Studio Code] に設定します。この変更を有効にするため、エディタを再起動します。これは、VS コード ソリューション (手順 5c を参照) を生成するためには必要ありませんが、Visual Studio に代わるデフォルトになります。
画像を拡大するにはクリックします。
-
VS コードのワークスペースを生成します。これには次の 3 通りの方法があります。
-
Unreal Editor を開き、[Tools (ツール)] > [Refresh Visual Studio Code Project (Visual Studio Code プロジェクトを更新)] をクリックします。
-
Windows と Mac では、プロジェクトの
.uproject
ファイルを右クリックし、[Generate Project Files (プロジェクト ファイルの生成)] をクリックします。完了すると、プロジェクトのフォルダに.code-workspace
ファイルが表示されます。 -
コマンドラインで、
/GenerateProjectFiles.bat -vscode
を実行します。-vscode
パラメータを追加すると、Visual Studio.sln
ではなく、.vscode
ワークスペースが作成されます。この方法を使用すると、デフォルトのソース コード エディタを変更する必要はありません。
-
コンパイラ ツールセットをインストールする
各デスクトップ OS は VS コードでプロジェクトをコンパイルするために、異なるコンパイラ ツールセットを使用します。それぞれのインストール プロセスはシンプルですが、セットアップを開始するためには、それぞれ異なる場所を確認する必要があります。
Windows
VS コードは、Windows で Microsoft Visual C++ コンパイラ (MSVC) ツールセットを使用します。
-
「Microsoft Visual Studio Downloads (Visual Studio Tools のダウンロード)」ページを開きます。
-
[All Downloads (すべてのダウンロード)] セクションまでスクロールし、[Tools for Visual Studio (Visual Studio のツール)] を展開します。
-
[Build Tools for Visual Studio 2022] の横にある [Download (ダウンロード)] ボタンをクリックし、インストールします。
画像を拡大するにはクリックします。
MacOS
Unreal Engine は、MacOS ではコンパイラのツールセットとして LLVM/Clang を使用します。インストールおよび有効化手順の詳細については、Microsoft のドキュメント『』Using Clang for Visual Studio Code』を参照してください。
Linux
Unreal Engine は Linux では LLVM/Clang ツールセットを使用します。このツールセットを設定するには、以下の手順を実行します。
-
ターミナルを開き、次のコマンドを実行します。
sudo apt install clang
-
「
SetupToolchain.sh
」を実行します。これは、Engine のインストール ディレクトリの「Build/BatchFiles/Linux
」にあります。 -
GenerateProjectFiles.sh
を実行すると、VS コードのワークスペースが作成されます。
VS コード向けの IntelliSense を設定する
VS コードでは IntelliSense を使用してコードのヒントを提示することができますが、Unreal Engine でこれを使用するには、追加の設定手順を実行して、プロジェクトのコードを IntelliSense に公開する必要があります。
-
エクスプローラ で、
.vscode/c_cpp_properties.json
を開きます。 -
以下のように
includePath
プロパティを追加します。"includePath": [ "${workspaceFolder}\\Intermediate\\**", "${workspaceFolder}\\Plugins\\**", "${workspaceFolder}\\Source\\**" ],
これにより、プロジェクトでこれらのパスが IntelliSense に公開され、プロジェクトのコードを検出できます。
${workspaceFolder}
はプレースホルダー テキストではありません。これは、ワークスペースの現在のディレクトリを示すショートカットです。このショートカットにより、これらのファイルを編集する際に絶対パスが不要になります。 -
[Extensions (拡張機能)] パネルを開きます。C/C++ 拡張機能の歯車アイコンをクリックし、[Extension Settings (拡張機能設定)] をクリックします。
画像を拡大するにはクリックします。
-
C_Cpp:IntelliSense Engine Fallback エントリを見つけます。ドロップダウンをクリックし、[Enabled (有効)] に設定します。
画像を拡大するにはクリックします。
-
ステータス トレイの コンフィギュレーション を
c_cpp_properties.json
のコンフィギュレーション名と一致するように設定します。 -
これで、VS コード ウィンドウの右下にある VSCode ステータス トレイ (青色のバー) に、小さなデータベース アイコンが表示されます。このアイコンにマウスを重ねると、IntelliSense によるプロジェクトの解析の進行状況が表示されます。
C/C++ コンフィギュレーション ファイルの例
以下は、作業中の c_cpp_properties.json
ファイルの例です。
{
"configurations": [
{
"name": "CustomGame Editor Win64 Development",
"intelliSenseMode": "msvc-x64",
"compileCommands": "",
"cStandard": "c17",
"cppStandard": "c++17",
"includePath": [
"${workspaceFolder}\\Intermediate\\**",
"${workspaceFolder}\\Plugins\\**",
"${workspaceFolder}\\Source\\**"
],
"defines": [
"UNICODE",
"_UNICODE",
"__UNREAL__",
"UBT_COMPILED_PLATFORM=Windows",
"WITH_ENGINE=1",
"WITH_UNREAL_DEVELOPER_TOOLS=1",
"WITH_APPLICATION_CORE=1",
"WITH_COREUOBJECT=1"
]
}
],
"version":
}
完了したら、IntelliSense は コンテキストに応じたオートコンプリート機能など、プロジェクトでコードのヒントを提供します。
VS コードでプロジェクトをビルドして、起動する
プロジェクトをビルドするには、VS コードが確実に正しい ビルド コンフィギュレーション に設定されている必要があります。正しく設定されていない場合、エディタではなく、ゲームのスタンドアローンまたはシッピング ビルドのビルドおよび実行が試行されます。
-
ウィンドウの左側にある [Play (プレイ)] ボタン タブをクリックするか、Ctrl + Shift + D キーを押して、[Run and Debug (実行してデバッグ)] パネルを開きます。
-
パネル上部の [RUN AND DEBUG] の隣にあるドロップダウンをクリックします。プロジェクトの Development Editor コンフィギュレーションを選択します。たとえば、プロジェクト名が TestGame の場合は、[Launch TestGameEditor (Development) (TestGame)] を選択します。
これらのオプションの詳細については、「ビルド コンフィギュレーションのリファレンス」を参照してください。
-
[Play] ボタンをクリックするか、F5 キーを押して、Editor モードでプロジェクトのビルドを開始します。プロジェクトをコンパイルします。コンパイルが完了すると Unreal Editor が開きます。コンパイルの際に、Unreal Editor がまだ開いていないことを確認してください。
ビルド コンフィギュレーションを選択したら、F5 キーを押すか、ツールバーの [Run (実行)] > [Start Debugging (デバッグを開始)] をクリックすると、[Run and Debug] パネルを使用しているかどうかを問わず、プロジェクトをビルドして、デバッグすることができます。