Skip to content
This repository has been archived by the owner on Nov 9, 2019. It is now read-only.

christopherreed/ue4-cpptools

Repository files navigation

ue4-cpptools

https://github.com/christopherreed/ue4-cpptools

WARNING - USE AT YOUR OWN RISK!

This is an unofficial extension and it is not affiliated in any way with Epic Games. This extension shouldn't be used in a production environment. Things will probably change and/or break regulary.

VSCode extension that provides tools for working with Unreal Engine 4 C++ projects.

You may want to check out VSCodeSourceCodeAccess, an Unreal Engine 4 plugin that provides source code access for working with C++ projects using VSCode.

Unreal Engine 4.18

Unreal Engine 4.18 ships with official VSCode support.

Future development of this extension will halt and become maintenance and bug fixes only.

The extension will be removed from the VSCode extension marketplace once the official support makes it redundant. The github repo will remain avaialble for use with pre 4.18 versions of Unreal Engine.

Install

  1. Download this extension as a .vsix package.

  2. Install the .vsix package. [?]

  3. Set ue4-cpptools.engineVersion to "4.18" if you are using Unreal Engine version 4.18

  4. Set ue4-cpptools.engineRootPath and any additional settings you need to configure the extension for you workspace. [?]

engineRootPath is required and should point to the root folder for the engine version you are using (.../Epic Games/UE_4.17). This folder should include Engine / FeaturePacks / Samples / Templates sub folders.

  1. For C++ language support, debug support, and IntelliSense install CppTools extension.

Edit your project

Setup:

  1. Install CppTools extension. This provides support for c++ language and IntelliSense.

  2. Run Generate CppTools Configuration. This will generate CppTools configuration for your project. [?]

  3. Run Generate Task Configurations. This will generate editor tasks for your project.

Command Search Unreal Engine Online Documentation : Search Unreal Engine Online Documentation for selected text.

Task Open Project With Editor [Development/GameDebug Editor] : Open build of your project with Unreal Editor.

Task Run Project With Editor [Development/GameDebug Editor] : Run build of your project with Unreal Editor.

Task Launch Unreal Editor : Launch Unreal Editor

Build your project

Setup:

  1. Run Generate Task Configurations. This will generate build tasks for your project. [?]

The generated build task configurations matrix is determined by the settings buildConfigurations and buildConfigurationTargets

  1. Customize tasks. [?]

  2. Run tasks. [?]

Task Generate Project Project Files : Generate project files for your project. [?]

Task Build Project [buildConfigurations buildConfigurationTargets] Build your project.

Task Clean Project [buildConfigurations buildConfigurationTargets] Clean your project.

Task Rebuild Project [buildConfigurations buildConfigurationTargets] Clean and build your project.

Debug your project

Setup:

  1. Install CppTools extension. This provides support for c++ debuggers. [?]

  2. Run Generate Debug Configurations. This will generate CppTools launch configurations for your project.

  3. Customize configurations. [?]

  4. Debug with the VSCode integrated debugger. [?]

Debug Attach Editor Project [GameDebug Editor] : Attach debug session to open editor.

Editor must be opened with [GameDebug Editor] build of your project.

Debug Launch Editor Project [GameDebug Editor] : Launch editor debug session.

Debug Launch Project [GameDebug Editor] : Launch debug session without open editor.

Advanced Settings (you probably shouldn't touch these)

ue4-cpptools.overrideUnrealBuildTool : Advanced - Override the command to run Unreal Build Tool.

ue4-cpptools.overrideUnrealEditor : Advanced - Override the command to run Unreal Editor.

Known Issues

https://github.com/christopherreed/ue4-cpptools/issues

  • Mac untested - implemenations are 'best guess' at the moment

  • Generate CppTools Configuration will only include default system configuration if it is present in c_cpp_properties.json at generation time

  • Generate CppTools Configuration will only include intermediate include paths if the folders are present at generation time

  • Relies on the Unreal Build Tool CodeLite project generator

License

This software is licensed under the MIT License, see LICENSE for more information

Buy Me a Coffee at ko-fi.com

About

VSCode extension that provides tools for working with Unreal Engine 4 C++ projects

Resources

License

Stars

Watchers

Forks

Packages

No packages published