Skip to content

Unreal Engine Tools extension for Visual Studio Code

Notifications You must be signed in to change notification settings

tiagodsp/uetools

Repository files navigation

Unreal Engine Tools

Unreal Engine Tools is an extension to Visual Studio Code with some shortcuts and code editor enhancements to improve the experience of developing C++ modules for Unreal Engine projects.

Note 0: Finally an initial Windows support! 🥳🎉

Note 1: I am still developing, so this extension currently only have MacOS and an initial Windows support using Unreal Engine version >= 5.0. Soon I will give fully support for Windows and Linux environment. Stay tuned! 👨🏻‍💻

Features

Unreal Engine Tools in-editor section:

Section that provides some shortcuts and a overview of the current project in the Workspace.

Unreal Engine Tools editor section

Build project from editor with Hot Reload:

Build shortcut that offers the engine installation selection and forces hot reload on editor.

Build entire project

It is possible to build individual modules too, also with hot reload.

Build module individually

Improved code completion with Clangd extension (only Unreal Engine 5):

Automatically invokes UnrealBuildTool in GenerateClangDatabase mode to generate the compile_commands.json file that is required by Clangd extention, allowing the editor to have a better code completion experience. It is not perfect, but helps to get the job done. 🙌🏻

Code completion feature

Requirements

  • clangd - For code improved completion experience (only Unreal Engine 5).
  • MacOS or Windows - Currently I developed the extension in a MacOS and Windows only, but as soon I get a Linux machine I will port it to its developing environment.

Extension Settings

This extension contributes the following settings:

  • uetools.unrealEngineInstallationSearchPath: Path to search for Unreal Engine installation for. Usually C:\Program Files\Epic Games\ on Windows, or /Users/Shared/Epic Games/ on Mac.

Known Issues

  • Currently support only Mac systems;
  • Some code completion seems not work due to forward declaration of Unreal Engine classes and structs provided by CoreMinimal.h. I guess...;
  • Still in development, so give it a try guys...

If you liked this project, feel free to suggest code, features and improvements. Enjoy!