build_plugin.main

Full path: schola.scripts.utils.build_plugin.main

schola.scripts.utils.build_plugin.main

main

main(
    plugin_folder=WindowsPath("."),
    uat_path=None,
    package_dir=None,
    target_platform=None,
    ue_version=None,
    clean=False,
    extra_args="",
    verbose=False,
)

Build/package an Unreal plugin using RunUAT BuildPlugin.

Parameters

plugin_folder (Path) : Path to the root of the plugin (should contain a .uplugin file).

uat_path (Optional[str]) : Explicit path to RunUAT (e.g. RunUAT.bat). If not provided, a reasonable default for UE_5.6 on Windows will be used.

package_dir (Optional[Path]) : Output directory for the packaged plugin. If not provided, a ‘Packaged/<platform-or-All>’ folder under the plugin folder is used.

target_platform (Optional[str]) : Target platform to pass to BuildPlugin (e.g. ‘Win64’).

ue_version (Optional[str]) : Unreal Engine version hint (unused except for diagnostic).

clean (bool) : If True, remove the package_dir before running BuildPlugin.

extra_args (str) : Extra arguments forwarded to RunUAT (string will be split with shlex).

verbose (bool) : Increase logging verbosity.

---