https://github.com/tuokri/ue3shadercachepatcher
Windows app that patches ShaderCache object references in UE3 script (.u) packages to make the shader caches automatically load when loading mod scripts.
https://github.com/tuokri/ue3shadercachepatcher
binary-patching kf2 killing-floor-2 material rising-storm-2-vietnam rs2vietnam shader-cache shader-loader ue3 unreal-engine-3 unreal-package upk
Last synced: 8 months ago
JSON representation
Windows app that patches ShaderCache object references in UE3 script (.u) packages to make the shader caches automatically load when loading mod scripts.
- Host: GitHub
- URL: https://github.com/tuokri/ue3shadercachepatcher
- Owner: tuokri
- License: apache-2.0
- Created: 2023-01-23T18:51:13.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-07-08T08:49:57.000Z (11 months ago)
- Last Synced: 2025-07-08T09:47:45.566Z (11 months ago)
- Topics: binary-patching, kf2, killing-floor-2, material, rising-storm-2-vietnam, rs2vietnam, shader-cache, shader-loader, ue3, unreal-engine-3, unreal-package, upk
- Language: C#
- Homepage:
- Size: 48.8 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UE3 Shader Cache Patcher
Patches UE3 cooked script packages so that their shader caches
are automatically loaded in game. Tested with Rising Storm 2: Vietnam
and Killing Floor 2.
## Use Case
Anyone who has tried using custom master materials in UnrealScript mods for
Rising Storm 2 or Killing Floor 2 (and perhaps other UE3 games) has seen this
dreaded message after loading the cooked mod in game.
```
[0037.39] ScriptLog: Mutators shaderloader.shaderloadermutator
[0037.39] Log: Missing cached shader map for material M_VN_MASTER_PBR_copy, compiling.
[0037.39] Log: Can't compile M_VN_MASTER_PBR_copy with seekfree loading path on console, will attempt to use default material instead
[0037.39] Warning: Warning, Failed to compile Material M_SLM_Test.Materials.M_VN_MASTER_PBR_copy for platform PC-D3D-SM5, Default Material will be used in game.
[0037.39] Warning: Warning, Failed to compile Material Instance M_SLM_Test.Materials.M_CustomTest_INST with Base M_VN_MASTER_PBR_copy for platform PC-D3D-SM5, Default Material will be used in game.
```
After patching the cooked script package (ShaderLoader.u in this case), the
custom materials work in game!
```
[0043.63] ScriptLog: Mutators shaderloader.shaderloadermutator
[0043.63] DevShaders: ... Loaded 230 shaders (0 legacy, 230 redundant)
[0043.63] DevShaders: Shader cache for shaderloader contains 2 materials (0 redundant)
```
## Download
Download from releases: https://github.com/tuokri/UE3ShaderCachePatcher/releases
## Examples
Killing Floor 2 demo repo: https://github.com/tuokri/KF2CustomMaterialTest
Rising Storm 2: Vietnam demo repo: https://github.com/tuokri/RS2-ShaderLoaderMutator
Video demo: https://youtu.be/u-m0W_edhj8
## Command Line Tool
A simple command line tool is also included. See [UE3ShaderCachePatcherCLI](./UE3ShaderCachePatcherCLI/)
for details and usage instructions.
## Notes
[Material-Message-Box](https://github.com/tuokri/Material-Message-Box) is used as a submodule
to patch it to work properly with MaterialDesignInXamlToolkit >= 5.0.0.
## Credits
Powered by Unreal-Library from EliotVU: https://github.com/EliotVU/Unreal-Library
## Development TODOs
- Write some (unit) tests for the CLI app.
- Write some (unit) tests for the model part of the GUI app.
## License
```
Copyright 2023-2025 Tuomo Kriikkula
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```