Nuke.Unreal
Build Unreal apps in Style.
Loading...
Searching...
No Matches
Nuke.Unreal

light-mode dark-mode
 
Source code

Elegant workflow for automating Unreal Engine project tasks embracing Nuke, providing a consistent way to use UE4/5 tools and reducing chores they come with.

Features:

  • All what the great Nuke can offer
  • Common Unreal build tasks (generate project files, build editor, cook, package, etc)
    > nuke generate
    > nuke build-editor
    > nuke cook
    > nuke package
    > nuke build --config Shipping
    > nuke build --config DebugGame Development --target-type Game --platform Android
  • Unreal engine location is automatically determined (on Windows at least)
  • Execute Unreal tools without the need to navigate to their location
    > nuke run-uat --> <args...>
    > nuke run-ubt --> <args...>
    > nuke run-shell
    > nuke run --tool editor-cmd --> <args...>
  • Install C++ libraries (using xrepo)
    > nuke use-xrepo --spec "imgui 1.91.1 freetype=true" "vcpkg::ryml[dbg]" "conan::zlib/1.2.11"
    > nuke generate
  • Generate boilerplate code and scaffolding from Scriban templates so no editor needs to be opened
    > nuke new-actor --name MyActor
    > nuke new-plugin --name MyPlugin
    > nuke new-module --name MyModule
    > nuke use-cmake --spec MyLibrary
    etc...
  • Auto-generated C# configurators for Unreal tools with documentation gathered from source code. (UBT and UAT)
  • Pluggable way to define targets for reusable plugins and modules.
  • Prepare complex Unreal Plugins for distribution with easy to use API.

Use the sidebar to read further details about them.

Legal

Nuke.Unreal is distributed under MIT license:

Copyright (c) David Mórász

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The following tools and .NET libraries are used: