Skip to content

Instantly share code, notes, and snippets.

@norlin
Last active November 2, 2024 06:02
Show Gist options
  • Save norlin/6805e16674ff3edea047068e607312bb to your computer and use it in GitHub Desktop.
Save norlin/6805e16674ff3edea047068e607312bb to your computer and use it in GitHub Desktop.
Build system for Unreal Engine projects for Sublime Text
{
"cmd": [
// Default path for UE 5
"C:/Program Files/Epic Games/UE_5.0/Engine/Build/BatchFiles/Build.bat",
// Build configuration is set to "Development" by default
"Development",
// The platform is set to Win64 by default
"Win64",
"-Project",
// The Sublime project name must match the Unreal project filename
// E.g. "MyProject.sublime-project" for "MyProject.uproject"
// Or manually set the different UE project filename in the line below
"$folder/$project_base_name.uproject",
// If you need to build a standalone (non-editor) - replace the line below
"-TargetType=Editor",
// "-TargetType=Game",
"-Progress",
// Hot reload is disabled - need to close the UnrealEditor before build
"-NoHotReloadFromIDE"
],
"shell": true,
// The UE project's root folder must be added to teh project as a first one
// E.g. it should be visible as a first folder in the side bar in Sublime
"working_dir": "$folder",
// Regexpt to parse the unreal's compilation Errors and Warnings
"file_regex": "^\\s*([A-Z]:[^\\(]+)\\((\\d+)\\)()\\s*:\\s(([Ee]rror|[Ww]arning)[^\n]+)",
// Don't wrap the build output
"word_wrap": false,
// Don't log Sublime's error messages in case if build failed
"quiet": true,
}
@norlin
Copy link
Author

norlin commented Sep 26, 2017

Current version

How to use:

  • Put the build system file into %AppData%\Roaming\Sublime Text 3\Packages\User\BuildSystems
  • Add the UE project's root folder to the Sublime Text
  • Save the Sublime's project with exactly the same name as the UE project file
    E.g. if you have MyProject.uproject you'll have to save the Sublime's project as MyProject.sublime-project
  • Profit!

Old versions (look for previous revisions)

How to use:

  • set your project name and paths to the project and working dir in the sublime-build config
  • check/update UE4 path in the node script

Windows requirements:

  • $ npm install windows-registry

@norlin
Copy link
Author

norlin commented May 2, 2019

Not relevant for the current version

Added the notifications script for Windows, thanks @npocmaka!

@norlin
Copy link
Author

norlin commented Nov 28, 2020

  • Removed the nodejs requirement
  • Make it possible to reuse the same build system for different UE4's projects just with the Sublime's build settings

@norlin
Copy link
Author

norlin commented Feb 23, 2022

  • Updated for UE 5, basically it's the same but path changed - there is a bat script for command-line builds.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment