STALKERonUE
STALKERonUE copied to clipboard
Port the original STALKER game series to Unreal Engine 5
STALKER on UE
Welcome to the world of STALKER on UE - a revolutionary modification that ports the original STALKER trilogy and the X-Ray Engine logic onto the incredibly powerful Unreal Engine 5! As a bonus, it provides the ability to create new and port existing mods for the original X-Ray.
Supported games
| Call of Pripyat | Clear Sky | Shadow of Chernobyl |
|---|---|---|
| Beta | Beta | Yes |
How to Build
Currently, it is possible to build the project for the following platforms:
- Windows 10 20H2 64-bit and newer
In the future, it will be possible to build for all other platforms, including mobile devices.
[!NOTE] Pay attention to the order. It is crucial to build X-Ray Engine first and then Unreal Engine!
Cloning the Project
You need to do this recursively using the --recursive parameter
git clone https://github.com/RedPandaProjects/STALKERonUE.git --recursive
Automatic build
1. Run build script
Run build.bat and just wait.
2. Launching the Project
After a successful build, you can launch the editor either by clicking the Launch button in VS or through the {src}/Stalker.uproject file.
Manual Build
1. Building X-Ray Engine
X-Ray is located at the following path:
{src}/Source/XRayEngine/Source/Engine.sln
You need to open this project and compile it with the required configuration.
Build Example
Building DebugGame Editor in the Unreal project. To do this, I need to build all solutions with the Debug configuration.
[!WARNING] Everything should be as described in that table; otherwise, it won't work!
2. Building the UE Project
2.1. Creating a Visual Studio Project for UE Build
After successfully building X-Ray Engine, return to the repository's root folder and generate the project.
Note
- If you don't see the "Generate Visual Studio project files" options, you can fix it with this video.
- Before generating the project, to avoid compilation errors, keep only the latest version of MSVC in Visual Studio Installer.
2.2. Compiling Files to Launch the Unreal Engine Project
After generating the Visual Studio project, open it and select the desired build configuration.
The generated file can be found at {src}/Stalker.sln.
Warning!!! Select "Games / Stalker" in the project explorer and press "Build".
Note
- After the build, you can run the editor, but you won't be able to play until you install the full content.
- You can find the current content build for the latest release in our Discord channel #last-build.
3. Launching the Project
After a successful build, you can launch the editor either by clicking the Launch button in VS or through the {src}/Stalker.uproject file.
Documentation:
More information can be found on our website and Discord server. Make sure to visit our help in discord server.
More details
It is a place to share ideas on what to implement, gather people that want to work on the engine, and work on the source code.
If you find a bug or have an enhancement request, file an Issue.
Pull requests appreciated! However, the following things should be taken into consideration:
- Major changes should be discussed before implementation
Be advised that this project is not sanctioned by GSC Game World in any way – and they remain the copyright holders of all the original source code.