Updating the Modding SDK

When a new version of the Modding SDK is released on GitHub, it is important to merge it into your project as soon as possible.

Failing to update the SDK in time can lead to:

• Compatibility issues after game updates
• Missing features or fixes
• Errors during cooking or packaging
• Unexpected behavior in-game

In principle, merging a new SDK version is straightforward. However, we strongly recommend doing this in a structured and controlled way to avoid breaking your project.

The safest approach is:

• Download the new SDK version
• Integrate the changes step by step
• Start at the top-level structure and work your way down

Avoid blindly overwriting your existing SDK directory.

After downloading and extracting the new SDK version:

• Open the new SDK folder next to your existing project
• Compare the directory structure starting from the root

Typical root folders include:

• Binaries
• Build
• Config
• Content
• Plugins
• Releases
• Saved
• BuildMod.bat
• SubwaySim2.uproject

Copy or merge folders one by one, checking whether you have made local changes in your existing SDK.

Special attention is required when updating BuildMod.bat.

This file is often customized for your project and must not be overwritten blindly.

After updating the SDK:

• Open the new BuildMod.bat
• Compare it with your existing version
• Manually transfer your project-specific settings

This typically includes:

• DLC / Plugin name
• Level path
• Unreal Engine installation path

Make sure these values are correctly copied into the new BuildMod.bat version.

When updating SDK plugins:

• Never overwrite your own project plugin
• Only merge SDK-provided plugins
• Leave your custom plugin folders untouched

Always verify that:

• Plugin names remain unchanged
• No references to your custom content are lost

After merging the new SDK version:

• Open SubwaySim2.uproject
• Let Unreal Engine recompile shaders if required
• Check the Output Log for warnings or errors
• Run BuildMod.bat once to verify that cooking still works

If everything completes without errors, the SDK update was successful.

Keeping your Modding SDK up to date ensures long-term compatibility with SubwaySim 2 and prevents issues when new game updates are released.