Skip to content

Latest commit

 

History

History
144 lines (83 loc) · 5.1 KB

README.md

File metadata and controls

144 lines (83 loc) · 5.1 KB
Raw

Unreal 5.2+ Clangd extension for VSCode (Intellisense+)

Extension v2.5.0: For 5.2 and newer releases (Including 5.4+)

This version now uses Native project Intellisense files instead of using the UBT's mode GenerateClangDataBase.

For users who already have created a project, you'll need to run the "Create Unreal Clangd Project" command again and choose Full so that it overwrites old project settings. You shouldn't have to uninstall anything.

Important Info

This extension now uses UBT to Refresh your project to update Intellisense files(compile commands). So this runs when you run the 'Update Compile Commands' command. Since this refreshes your project, your code-workspace will be refreshed removing your clangd settings and others! but...

This extension will automatically backup and restore your clangd settings when you run the Update Compile Commands command.

Note: I've added a setting that allows you to add additional settings to be backed up. See change log for more info: https://github.com/boocs/unreal-clangd/blob/v2/CHANGELOG.md#250-2024-05-05

Table of Contents

Info

  • Provides fast Code Completion, Formatting, and other cool features!

  • Has a command to create a clangd project for you

  • Fixes some clangd/Unreal quirks

  • Has a uninstall command

    Note: Windows users can use clang/clangd for Intellisense and still build with Microsoft's compiler

Top

Other Recommended Extensions

Top

Quick Start Guide (UE 5.2+)

This is generally correct, when using non-full source, but your situation could be different.

  1. Read the Requirements section of the full Documentation
    • Different Unreal Engine versions require different LLVM versions(Unreal 5.3 requires LLVM 16.0.6)

  1. Install the vsix file from this github

  • Click the extensions icon
  • Click the ellipsis (3 dots)
  • Choose Install from VSIX...
  1. Ignore any VSCode warning messages (should go away after creating a project)
  1. Linux: In the next step(project creation), File Dialogues will spawn behind VSCode(known bug)
  1. Run extension command "Create Unreal clangd project" on your Unreal project

    • Example:

      image

  1. Use the Editor suffix and Development config when Building/Running

    • Build

      image

    • Run/Debug

      image

  1. Use DebugGame when you have to Debug something

    • Debugging

      image

  1. Run extension command 'Update Compile Commands' to fix fake red squiggles that may rarely happen.

    image

Top

Documentation

Unreal 5.2+

Note: Make sure to read requirements! Different Unreal version usually require different clang/clangd and XCode versions

Windows Users: The requirements sections has easy instructions on how to install different Build Tools 2022 versions. These are required because other versions may cause fake red error squiggles.

Extension Documentation

Top

Upgrading Older Projects

This version had some changes!

This version now uses Native project Intellisense files instead of using the UBT's mode GenerateClangDataBase.

For users who already have created a project, you'll need to run the "Create Unreal Clangd Project" command again and choose Full so that it overwrites old project settings. You shouldn't have to uninstall anything.

Uninstalling and Reinstalling

You can use this extension's uninstall and create commands when upgrading to a new extension version.

Mac support

This hasn't been proven to work yet(let me know!).

Top