Q100635: Instructions for building a custom Nuke Server plug-in for Unreal Engine

Todd

Updated : August 08, 2024 15:18

Created : November 23, 2021 16:29

SUMMARY

As of NukeX/Nuke Studio 13.1v1, users can now implement the UnrealReader node to have cross-compatibility with Unreal Engine. Some users might have custom builds of Unreal Engine on their machines, and having the base Nuke Server plug-in may not work correctly. This article outlines how to create a custom Nuke Server plug-in to use with a custom Unreal Engine build.

MORE INFORMATION

If you’re using a custom Unreal Engine build, you may get the following error when trying to launch Unreal Engine after enabling the Nuke Server plug-in:

In order to use the Nuke Server plug-in with a custom Unreal Engine build, it may be necessary to change the BuildId. The following steps will change the BuildId in the Nuke Server plug-in to match that of your custom Unreal Engine BuildId, which will bypass the Unreal Engine version check.

NOTE: In the below examples, the [version] path value is the installed version of the Unreal Engine, such as 5.2.0.

1. Find the UE4.modules or UnrealEditor.modules file from any other plug-in within the Plugins folder in your Unreal Engine build. Example file paths:
   
   Windows (Unreal Engine 4.27.1):
   …/Epic Games/[version]/Engine/Plugins/2D/Paper2D/Binaries/Win64/UE4Editor.modules
   
   Windows (Unreal Engine 5.0.1 / 5.1.0 / 5.2.0 / 5.4.3):
   …/Epic Games/[version]/Engine/Plugins/2D/Paper2D/Binaries/Win64/UnrealEditor.modules
   
   macOS (Unreal Engine 4.27.1):
   …/Epic Games/[version]/Engine/Plugins/2D/Paper2D/Binaries/Mac/UE4Editor.modules
   
   macOS (Unreal Engine 5.0.1 / 5.1.0 / 5.2.0 / 5.4.3):
   …/Epic Games/[version]/Engine/Plugins/2D/Paper2D/Binaries/Mac/UnrealEditor.modules
   
   Linux (Unreal Engine 5.1.0 / 5.2.0 / 5.4.3):
   …/Epic Games/[version]/Engine/Plugins/2D/Paper2D/Binaries/Linux/UnrealEditor.modules
   
   
2. Open the .modules file for the respective [version] in a text editor and copy the BuildId value, shown in the examples below: 
   
   Unreal Engine 4
   

   {
      "BuildId": "23058290",
      "Modules":
          {
              "Paper2D": "UE4Editor-Paper2D.dll"
          }
   } 

   
   Unreal Engine 5

   {
      "BuildId": "23058290",
      "Modules":
          {
           "Paper2D": "UnrealEditor-Paper2D.dll"
          }
   } 

3. Open the Nuke Server UE4Editor.modules or UnrealEditor.modules file in a text editor located in:
   
   Windows:
   .../Epic Game/[version]/Plugins/Foundry/NukeServer/Binaries/Win64
   
   macOS:
   .../Epic Game/[version]/Plugins/Foundry/NukeServer/Binaries/Mac
   
   Linux:
   .../Epic Game/[version]/Plugins/Foundry/NukeServer/Binaries/Linux
   
   
4. Replace the BuildId value with the one copied previously, and save the file: 
   
   Unreal Engine 4
   

   {
      "BuildId": "23058290",
      "Modules": 
          {
              "FoundryCryptomattePass": "UE4Editor-FoundryCryptomattePass.dll",
              "FoundryServer": "UE4Editor-FoundryServer.dll"
          }
   }

   
   Unreal Engine 5
   

   {
      "BuildId": "23058290",
      "Modules": 
          {
              "FoundryCryptomattePass": "UnrealEditor-FoundryCryptomattePass.dll",
              "FoundryServer": "UnrealEditor-FoundryServer.dll"
          }
   }

5. Open Unreal Engine and enable the Nuke Server plug-in, restarting the software afterwards.
   

NOTE:   Please understand that while the above steps may enable you to use your preferred custom Unreal Engine build, we only test against a limited subset of Unreal Engine builds, and as such, the Nuke Server plug-in may not be compatible or work as expected with other Unreal Engine builds. If you encounter issues while using a custom Unreal Engine build we can only offer limited support. Please ensure that your version of Unreal Engine is supported and that your versions of Nuke Server and Unreal Reader are compatible. 

FURTHER READING

• You can download the latest Nuke Server plug-in here.
• Please find more information on the UnrealReader node in our online documentation.
• For installation instructions of the Nuke Server plug-in, please visit the following link for Visualizing Unreal Scenes in NukeX.
• You can find more information on building the Unreal Engine here.

FURTHER HELP

If you are experiencing issues in getting a custom Nuke Server plug-in to run on your machine, then please open a Support ticket and let us know the issue you are encountering, and the troubleshooting steps you have taken so far.

For more information on how to open a Support ticket, please refer to Q100064: How to raise a support ticket.