Configuring Rider for Multiple Unreal Engine Versions

Question

How can I configure JetBrains Rider to seamlessly work with multiple versions of Unreal Engine, particularly when building an Unreal Engine plugin across different versions?

Answer

JetBrains Rider is designed to work flexibly with different versions of Unreal Engine. When switching between engine versions, the key aspect is ensuring the configuration in your Unreal Engine project (.uproject) file is correct.

General Configuration:

1. EngineAssociation Field in .uproject File:

   • Rider maps the project to the Unreal Engine version specified in the EngineAssociation field in the .uproject file.
   • EngineAssociation may include:
     • A GUID for the engine installation.
     • An exact version number (e.g., "5.6" for non-source builds).
     • An empty string, which indicates a special case.

2. Switching Unreal Engine Versions:

   • (Windows only) Use the Unreal Engine Editor's Switch Unreal Engine Version option (Right-Click on the Project File -> Switch Unreal Engine Version). This will update the project configuration, including the EngineVersion field, and make it compatible with the specified version.
   • (All OS) Or launch another UE version and open the existing project from the UE Welcome screen. It will prompt the engine version mismatch and suggest retargeting a project in-place or making a copy.

Plugin Considerations:

• Engine Plugins (Located in the Engine Directory):
  • Copy the plugin from the old engine path to the new engine path.
  • Alternatively, install the plugin via Fab if it is published there.
• Game Plugins (Located in the Game Project Directory):
  • Retarget the game project to the desired Unreal Engine version using the steps above.
  • Open the project in Rider.
• Code Adjustments for Plugin Compatibility:

  • If plugin code fails to compile due to changes in newer Unreal Engine versions (e.g., symbol deprecation or API changes), use preprocessor macros to ensure compatibility. Example:

    #if ENGINE_MAJOR_VERSION == 5 && ENGINE_MINOR_VERSION >= 3
        // UE 5.3+ specific code
    #endif
    

Additional Notes:

• Check and follow the software requirements for each Unreal Engine version:
  • Unreal Engine 5.6 requires MSVC 14.38 and Windows SDK 10.0.22621.0 or newer.
  • Unreal Engine 5.7 requires MSVC 14.44 and does not support MSVC 14.50, while also requiring Windows SDK 10.0.22621.0 or newer.
• Consult the release notes for a specific UE version for more details.

By following these steps and ensuring proper configuration, you can seamlessly use JetBrains Rider to manage projects and plugins across multiple Unreal Engine versions. Should you encounter compilation issues or need further assistance, feel free to contact Rider support.