언리얼 엔진용 VS Code 구성

언리얼 엔진(UE) 에서는 Microsoft Visual Studio 를 Windows의 C++ 프로젝트용 디폴트 IDE로 지원하는 한편, 보다 가벼운 무료 오픈 소스 대체재로서 Visual Studio Code(VS Code) 또한 지원합니다. VS Code는 Visual Studio와 기본 기능이 동일하지는 않지만 확장성이 뛰어나 Windows, MacOS, Linux에서 사용 가능하므로 여러 플랫폼에서 작업하는 개발자의 공통 기반이 됩니다.

하지만 VS Code 코드에 Windows용 Visual Studio와 동일한 기능을 부여하려면 추가적인 수동 구성이 필요합니다. 이 가이드에서는 UE 개발을 위한 VS Code 환경이 완전히 갖춰지는 데 필요한 추가 단계를 안내합니다.

VS Code 사용을 위해 전체 Visual Studio를 설치할 필요는 없습니다.

필수 구성

이 가이드에서는 언리얼 엔진을 설치했으며 이를 사용하여 C++ 프로젝트를 생성했다고 가정합니다.

OS에 맞는 VS Code 및 필수 익스텐션 설치하기

  1. VS Code와 VS Code용 공식 C/C++ 익스텐션 팩C# 익스텐션을 다운로드 및 설치합니다. 언리얼 엔진과 빌드 툴 둘 모두에서 소스 코드를 읽는 데 필요합니다.

  2. OS용 컴파일러 툴세트를 다운로드 및 설치합니다.

이러한 컴포넌트를 구성하는 방법에 대한 자세한 내용은 컴파일러 툴세트 설치하기를 참조하세요.

  1. Mac 또는 Linux에서 디버깅하는 경우 LLDB 익스텐션을 다운로드 및 설치합니다.

  2. VS Code를 디폴트 IDE로 설정해야 하는 경우 언리얼 에디터 를 열고 편집(Edit) > 에디터 개인설정(Editor Preferences) > 일반(General) > 소스 코드(Source Code) 를 선택한 다음 소스 코드 에디터(Source Code Editor)Visual Studio Code 로 설정합니다. 에디터를 재시작하면 변경 사항이 적용됩니다. 이는 VS Code 솔루션을 생성(5c 단계 참조)하는 데 있어 필수는 아니지만 Visual Studio를 대신하여 디폴트가 됩니다.

    이미지를 클릭하면 확대됩니다.

  3. VS Code 워크스페이스를 생성합니다. 다음과 같은 3가지 방법으로 생성할 수 있습니다.

    1. 언리얼 에디터 를 열고 툴(Tools) > Visual Studio Code 프로젝트 새로 고침(Refresh Visual Studio Code Project) 을 클릭합니다.

      언리얼 에디터에서 VS Code 프로젝트 새로 고침

    2. Windows와 Mac에서 프로젝트의 .uproject 파일을 우클릭하고 프로젝트 파일 생성(Generate Project Files) 을 클릭합니다. 완료되면 프로젝트의 폴더에서 .code-workspace 파일을 확인할 수 있습니다.

      image alt text

    3. 명령줄에서 /GenerateProjectFiles.bat -vscode 를 실행합니다. -vscode 파라미터를 추가하면 Visual Studio .sln 대신 .vscode 워크스페이스가 생성됩니다. 이 방법을 사용하는 경우 디폴트 소스 코드 에디터를 변경할 필요가 없습니다.

컴파일러 툴세트 설치하기

각 데스크톱 OS에서는 VS Code에서 프로젝트를 컴파일하는 데 서로 다른 컴파일러 툴세트를 사용합니다. 각각의 설치 프로세스는 직관적이지만 구성을 시작하는 위치가 서로 다릅니다.

Windows

VS Code는 Windows에서 Microsoft Visual C++ 컴파일러(MSVC) 툴세트를 사용합니다.

  1. Microsoft Visual Studio 다운로드 페이지를 엽니다.

  2. 모든 다운로드(All Downloads) 섹션으로 스크롤을 내린 다음 Visual Studio용 도구(Tools for Visual Studio) 를 펼칩니다.

  3. Visual Studio 2022용 빌드 도구(Build Tools for Visual Studio 2022) 옆에 있는 다운로드(Download) 버튼을 클릭하여 설치합니다.

    이미지를 클릭하면 확대됩니다.

MacOS

언리얼 엔진에서는 MacOS 컴파일러 툴세트로 LLVM/Clang을 사용합니다. 설치 및 활성화 방법에 관한 전체 지침은 Microsoft의 Visual Studio Code에서 Clang 사용하기(Using Clang in Visual Studio Code)에 나와 있는 문서를 참조하세요.

Linux

Linux의 경우 언리얼 엔진은 LLVM/Clang 툴세트를 사용합니다. 구성하려면 다음 단계를 따릅니다.

  1. 터미널을 열고 다음 명령을 실행합니다.

    sudo apt install clang
  2. SetupToolchain.sh 를 실행합니다. Build/BatchFiles/Linux 에 있는 엔진의 설치 디렉터리에 위치해 있습니다.

  3. GenerateProjectFiles.sh 를 실행하고 VS Code 워크스페이스를 빌드합니다.

VS Code용 IntelliSense 구성

VS Code는 코드 힌팅을 위해 IntelliSense 를 사용할 수 있지만 언리얼 엔진에서 사용하려면 추가 구성 단계를 거쳐 프로젝트의 코드를 노출시켜야 합니다.

  1. 탐색기 에서 .vscode/c_cpp_properties.json 을 엽니다.

    cpp properties json 파일

  2. includePath 프로퍼티를 다음과 같이 추가합니다.

    "includePath": [ "${workspaceFolder}\\Intermediate\**", "[Workspace Folder]\\Plugins\**", "[Workspace Folder]\\Source\**" ],

    이렇게 하면 프로젝트의 이 경로가 IntelliSense에 노출되어 프로젝트 코드를 검색할 수 있습니다.

    ${workspaceFolder} 는 자리표시자 텍스트가 아닙니다. 워크스페이스의 현재 디렉터리를 나타내는 바로가기로, 이러한 파일을 편집할 때 절대 경로에 대한 필요성을 없앱니다.

  3. 익스텐션(Extensions) 패널을 엽니다. C/C++ 익스텐션의 기어 아이콘을 클릭한 다음, 익스텐션 세팅(Extension Settings) 을 클릭합니다.

    이미지를 클릭하면 확대됩니다.

  4. C_Cpp: IntelliSense Engine Fallback 항목을 찾습니다. 드롭다운을 클릭하고 활성화됨(Enabled) 으로 설정합니다.

    이미지를 클릭하면 확대됩니다.

  5. 상태 트레이에서 환경설정 이 `c_cpp_properties.json`의 환경설정 이름과 일치하도록 설정합니다.

  6. VS Code 창 오른쪽 하단의 VSCode 상태 트레이(파란색 막대)에서 작은 데이터베이스 아이콘이 표시됩니다. 이 아이콘에 커서를 대면 IntelliSense의 프로젝트 파싱 진행 상황이 표시됩니다.

    상태 트레이의 데이터베이스 아이콘

다음은 c_cpp_properties.json 작업 파일의 예시입니다.

"configurations": [ 
{ 
"name": "CustomGame Editor Win64 Development", 
"intelliSenseMode": "msvc-x64", 
"compileCommands": "", 
"cStandard": "c17",
"cppStandard": "c++17", 
"includePath": [ "${workspaceFolder}\\Plugins\**", "C:\\${workspaceFolder}\\Source\**", "${workspaceFolder}\\Intermediate\**" ], 
"defines": [ 
"UNICODE", 
"_UNICODE", 
"__UNREAL__", 
"UBT_COMPILED_PLATFORM=Windows", 
"WITH_ENGINE=1", 
"WITH_UNREAL_DEVELOPER_TOOLS=1", 
"WITH_APPLICATION_CORE=1", 
"WITH_COREUOBJECT=1" 
] 
} 
],
 "version": 4

완료되면 IntelliSense는 컨텍스트에 따른 자동 완료 기능을 포함하여 프로젝트의 코드 힌팅을 제공합니다.

VS Code에서 프로젝트 빌드 및 실행

프로젝트를 빌드하기 전에 VS Code가 올바른 빌드 환경설정 으로 설정되어 있어야 합니다. 그렇지 않으면 에디터 대신 게임의 독립형 또는 출시 빌드를 빌드 및 실행하려고 시도합니다.

  1. 창의 왼쪽에 있는 플레이 버튼 탭을 클릭하거나 CTRL+SHIFT+D 키를 눌러 실행 및 디버그(Run and Debug) 패널을 엽니다.

  2. 패널 상단의 실행 및 디버그(RUN AND DEBUG) 옆에 있는 드롭다운을 클릭합니다. 프로젝트의 개발 에디터(Development Editor) 환경설정을 선택합니다. 예를 들어 프로젝트의 이름이 TestGame인 경우 TestGameEditor 실행(Launch TestGameEditor) (Development) (TestGame) 을 선택합니다.

    빌드 환경설정 세팅

    이 옵션에 관한 자세한 내용은 빌드 환경설정 레퍼런스 페이지를 참조하세요.

  3. 플레이(Play) 버튼을 클릭하거나 F5 를 눌러 에디터 모드에서 프로젝트 빌드를 시작합니다. 프로젝트가 컴파일되며, 완료 시 언리얼 에디터에서 열립니다. 언리얼 에디터를 먼저 열어두어서는 안 됩니다.

    빌드 환경설정(Build Configuration)을 선택한 후 F5를 누르거나 툴바에서 실행(Run) > 디버깅 시작(Start Debugging) 을 클릭하여 실행 및 디버그(Run and Debug) 패널을 사용 중인지 여부와 상관없이 프로젝트를 빌드하고 디버그합니다.