Skip to content

vlicecream/UBuildTool.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

UBuildTool.nvim

Standalone Unreal Engine build tooling for Neovim.

UBuildTool.nvim is the first split-out piece from UCore.nvim. It focuses on:

  • building the configured default Unreal target
  • stopping running builds
  • opening the current project in Unreal Editor or Game mode
  • preparing compile_commands.json for clangd
  • build log coloring and quickfix population
  • optional shared bottom output tabs when UCore.nvim is present

Install

{
  "vlicecream/UBuildTool.nvim",
  main = "ubuildtool",
  lazy = false,
  opts = {},
}

Commands

:UBuildTool
:UBuildTool build [configuration] [platform] [target]
:UBuildTool build-stop
:UBuildTool launch
:UBuildTool launch !
:UBuildTool editor
:UBuildTool game
:UBuildTool editor !
:UBuildTool game !
:UBuildTool clangd-db
:checkhealth ubuildtool

Defaults

require("ubuildtool").setup({
  cache_dir = vim.fn.stdpath("cache") .. "/ubuildtool",
  engine_roots = {},
  startup = {
    mode = "editor", -- "editor" | "game"
    configuration = "Development", -- use "DebugGame" / "Debug" for debug-style builds
    platform = "Win64",
    editor_target = nil,
    game_target = nil,
  },
  build = {
    open_quickfix_on_error = true,
    include_warnings = true,
    color_log = true,
    autosave = true,
  },
  editor = {
    build_before_open = true,
    autosave = true,
  },
  clangd = {
    auto_generate_compile_commands = true,
    prewarm_on_setup = true,
    remove_source_compile_commands = true,
  },
})

startup.mode only controls whether normal launch opens editor or game.

If you want what you call "debug mode", set startup.configuration to DebugGame or Debug. Do not put that into startup.mode.

Notes

  • Engine root resolution supports:
    • explicit engine_roots
    • Epic Launcher installs
    • source-build registry entries on Windows
  • launch uses this plugin's own normal startup config. It does not read UDebugTool.nvim config.
  • editor always forces Unreal Editor launch.
  • game always forces Unreal Game launch.
  • build without explicit arguments uses startup.configuration, startup.platform, and the mode-specific target from this plugin's config.
  • clangd-db stages compile_commands.json into the plugin cache under stdpath("cache")/ubuildtool/
  • when UCore.nvim is loaded, build logs and Unreal Editor launch messages are sent into the shared bottom output workspace instead of opening a separate build split

About

Unreal Build Tool Debug

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages