This article is aimed at easing the migration of projects from CRYENGINE 5.3 to CRYENGINE 5.4 and it focus's on the changes made to CRYENGINE's source code format.
Over time, and as we introduce new features we will deprecate the older ones and plan to remove them in future Engine releases.
Finally, the OpenGL Renderer is no longer supported. Source code is still shipped with the Engine, however Vulkan is considered an effective replacement.
New Project CMakeLists setup
The project system has been refactored to automatically generate the CMake setup (CMakeLists.txt) whenever the 'Generate Solution' option is used.
It is not recommended to migrate existing projects to the preview build, as it is not a full release build and many aspects of it still contain (sometimes serious) bugs.
How to Migrate a Project from CRYENGINE 5.3 to CRYENGINE 5.4 (Preview)
- Open the CRYENGINE 5.4 installation directory and navigate to Tools/CryVersionSelector.
- Press Shift and Right-click in the installation folder to select Open PowerShell Window here or Open Command Line Window here.
- Enter the command "cryselect.exe install" in the command line window or ".\cryselect.exe install" in PowerShell, and then press Enter.
- Now, open the 5.3 project's directory and right-click the *.cryproject file to select Switch engine version from the menu.
- In the pop-up window, press the Browse (…) button, and navigate to the CRYENGINE 5.4 installation directory and then press OK (If the engine is already registered, the engine can be selected from the dropdown menu instead, and this step can be skipped).
- In the pop-up window, press OK to initiate the switching process.
- If the version of the project changes, a pop-up will notify the user to make a backup of the project first.
- If the switch was successful, the user will be notified to generate the solution and rebuild the project.
- Now, right click on the *.cryproject file, and click Generate solution from the menu.
- If it is a C++ project, CMake will build the solution in Solutions/Game.win_x64 directory. If it's a C# project, the solution will be generated in the code folder. The solution will be named Game.sln.
- When an error occurs in CMake while generating the solution, make sure that Visual Studio is installed with support for C++ projects.
- The user can now open the solution. For C++ projects, the solution can be opened in Visual Studio. For C# projects, it can be opened with Xamarin Studio if it has the CRYENGINE add-in installed.
For more information, see http://docs.cryengine.com/display/CEPROG/C%23+Programming.
- Now, build the solution by pressing Build/Build solution in Visual Studio, or Build/Build all in Xamarin Studio.
- During Build process if any errors are encountered then they need to be fixed manually by the user.
- If the solution has built successfully, the user can now run CRYENGINE and game launcher.
Necessary code changes to build against CRYENGINE 5.4
If you are using any of the macros listed below, then you will have to update your code to reflect the changes that we have made in the Engine code.