Added support for both UE4 and 5

Plugin won't compile in UE4 yet. UE5 needs different modules, not available in UE4.

openpype/hosts/unreal/hooks/pre_workfile_preparation.py

@@ -71,7 +71,7 @@ class UnrealPrelaunchHook(PreLaunchHook):
             if int(engine_version.split(".")[0]) < 4 and \
                     int(engine_version.split(".")[1]) < 26:
                 raise ApplicationLaunchFailed((
-                    f"{self.signature} Old unsupported version of UE4 "
+                    f"{self.signature} Old unsupported version of UE "
                     f"detected - {engine_version}"))
         except ValueError:
             # there can be string in minor version and in that case
@@ -104,14 +104,14 @@ class UnrealPrelaunchHook(PreLaunchHook):
         project_path = Path(os.path.join(workdir, unreal_project_name))
 
         self.log.info((
-            f"{self.signature} requested UE4 version: "
+            f"{self.signature} requested UE version: "
             f"[ {engine_version} ]"
         ))
 
         detected = unreal_lib.get_engine_versions(self.launch_context.env)
         detected_str = ', '.join(detected.keys()) or 'none'
         self.log.info((
-            f"{self.signature} detected UE4 versions: "
+            f"{self.signature} detected UE versions: "
             f"[ {detected_str} ]"
         ))
         if not detected:
@@ -124,10 +124,10 @@ class UnrealPrelaunchHook(PreLaunchHook):
                 f"detected [ {engine_version} ]"
             ))
 
-        ue4_path = unreal_lib.get_editor_executable_path(
-            Path(detected[engine_version]))
+        ue_path = unreal_lib.get_editor_executable_path(
+            Path(detected[engine_version]), engine_version)
 
-        self.launch_context.launch_args = [ue4_path.as_posix()]
+        self.launch_context.launch_args = [ue_path.as_posix()]
         project_path.mkdir(parents=True, exist_ok=True)
 
         project_file = project_path / unreal_project_filename

openpype/hosts/unreal/lib.py

@@ -70,19 +70,22 @@ def get_engine_versions(env=None):
     return OrderedDict()
 
 
-def get_editor_executable_path(engine_path: Path) -> Path:
-    """Get UE4 Editor executable path."""
-    ue4_path = engine_path / "Engine/Binaries"
+def get_editor_executable_path(engine_path: Path, engine_version: str) -> Path:
+    """Get UE Editor executable path."""
+    ue_path = engine_path / "Engine/Binaries"
     if platform.system().lower() == "windows":
-        ue4_path /= "Win64/UnrealEditor.exe"
+        if engine_version.split(".")[0] == "4":
+            ue_path /= "Win64/UE4Editor.exe"
+        elif engine_version.split(".")[0] == "5":
+            ue_path /= "Win64/UnrealEditor.exe"
 
     elif platform.system().lower() == "linux":
-        ue4_path /= "Linux/UE4Editor"
+        ue_path /= "Linux/UE4Editor"
 
     elif platform.system().lower() == "darwin":
-        ue4_path /= "Mac/UE4Editor"
+        ue_path /= "Mac/UE4Editor"
 
-    return ue4_path
+    return ue_path
 
 
 def _win_get_engine_versions():
@@ -208,22 +211,26 @@ def create_unreal_project(project_name: str,
     # created in different UE4 version. When user convert such project
     # to his UE4 version, Engine ID is replaced in uproject file. If some
     # other user tries to open it, it will present him with similar error.
-    ue4_modules = Path()
+    ue_modules = Path()
     if platform.system().lower() == "windows":
-        ue4_modules = Path(os.path.join(engine_path, "Engine", "Binaries",
-                                        "Win64", "UE4Editor.modules"))
+        ue_modules_path = engine_path / "Engine/Binaries/Win64"
+        if ue_version.split(".")[0] == "4":
+            ue_modules_path /= "UE4Editor.modules"
+        elif ue_version.split(".")[0] == "5":
+            ue_modules_path /= "UnrealEditor.modules"
+        ue_modules = Path(ue_modules_path)
 
     if platform.system().lower() == "linux":
-        ue4_modules = Path(os.path.join(engine_path, "Engine", "Binaries",
+        ue_modules = Path(os.path.join(engine_path, "Engine", "Binaries",
                                         "Linux", "UE4Editor.modules"))
 
     if platform.system().lower() == "darwin":
-        ue4_modules = Path(os.path.join(engine_path, "Engine", "Binaries",
+        ue_modules = Path(os.path.join(engine_path, "Engine", "Binaries",
                                         "Mac", "UE4Editor.modules"))
 
-    if ue4_modules.exists():
+    if ue_modules.exists():
         print("--- Loading Engine ID from modules file ...")
-        with open(ue4_modules, "r") as mp:
+        with open(ue_modules, "r") as mp:
             loaded_modules = json.load(mp)
 
         if loaded_modules.get("BuildId"):
@@ -298,10 +305,11 @@ def create_unreal_project(project_name: str,
         [python_path.as_posix(), "-m", "pip", "install", "--user", "pyside2"])
 
     if dev_mode or preset["dev_mode"]:
-        _prepare_cpp_project(project_file, engine_path)
+        _prepare_cpp_project(project_file, engine_path, ue_version)
 
 
-def _prepare_cpp_project(project_file: Path, engine_path: Path) -> None:
+def _prepare_cpp_project(
+        project_file: Path, engine_path: Path, ue_version: str) -> None:
     """Prepare CPP Unreal Project.
 
     This function will add source files needed for project to be
@@ -420,8 +428,12 @@ class {1}_API A{0}GameModeBase : public AGameModeBase
     with open(sources_dir / f"{project_name}GameModeBase.h", mode="w") as f:
         f.write(game_mode_h)
 
-    u_build_tool = Path(
-        engine_path / "Engine/Binaries/DotNET/UnrealBuildTool/UnrealBuildTool.exe")
+    u_build_tool_path = engine_path / "Engine/Binaries/DotNET"
+    if ue_version.split(".")[0] == "4":
+        u_build_tool_path /= "UnrealBuildTool.exe"
+    elif ue_version.split(".")[0] == "5":
+        u_build_tool_path /= "UnrealBuildTool/UnrealBuildTool.exe"
+    u_build_tool = Path(u_build_tool_path)
     u_header_tool = None
 
     arch = "Win64"