REFramework has been updated to fix the crashes and hook failures caused by Enigma Protector. This does not fix Steam Deck compatibility, that is not REFramework's fault.
REFramework has been updated with Sunbreak support.
REFramework works with the Game Pass version. You will need to globally set a custom install directory in the Xbox app or the folder will not be accessible.
If you are using ANY overlays like the Discord overlay, Overwolf, etc... Turn them off if you are crashing on startup.
If you are infinite loading after an update, you have a file-based/pak based mod that is no longer compatible, this is not REFramework's fault.
If you are crashing then upload your re2_framework_log.txt, and your reframework_crash.dmp to the GitHub's issues page. DO NOT POST IT HERE. SNIPPETS OF IT DO NOT HELP.
To uninstall REFramework temporarily, simply remove the dinput8.dll file from your game directory. To completely remove it along with ALL mods, you will need to delete the reframework folder, re2_fw_config.txt, re2_framework_log.txt, and reframework_crash.dmp as well (if it exists).
If you're running Rise on Linux or the Steam Deck, REFrameworks works fine, but here are some details.
If you're using MangoHUD with REFramework, make sure MangoHUD's window isn't hidden at startup. The "no_display" option should not be enabled in the MangoHUD config or the REF window will not show.
Further, you must let the MangoHUD window stay up until the REF window shows up. If you hide it via a keybind before REF has shown up, REF will not show up. There is some weird interaction between the two.
Re: resolution and borderless windowed. I'm running at native res (3440x1440) and REF correctly places its window in the top left. I'm running a GNOME desktop and using fullscreen mode, not borderless windowed mode because GNOME will turn off the desktop compositor when running in fullscreen mode which is a good thing for performance.
I'm using Proton 7.0-3 and not experimental and have had no issues. The launch command is MANGOHUD=1 VKD3D_CONFIG=dxr PROTON_ENABLE_NVAPI=1 WINEDLLOVERRIDES="dinput8=n,b" gamemoderun %command%
The 2nd and 3rd environment variables there enable DLSS (and RTX, but Rise doesn't use RT). DLSS works fine in-game.
I'm also using MangoHUD to get frame limiting and better vsync than the game provides (vsync=2 in MangoHUD's config). But as mentioned above let the MangoHUD window remain on screen until you see the REF window pop up or it will never pop up.
Bumping this since the latest release of REFramework as of July 11th, the one with the long filepath fix, also allows mods with DLL plugins like Charm Editor to work under Linux/Proton. This is pretty huge for Linux games and I daresay should allow those mods to work on the Steam Deck as well.
Thanks much @praydog2!
Edit: REFramework Direct2D and all the mods that depend on it also work on Linux/Proton.
Edit 2: All of this also works on the Steam Deck as you'd expect, being Arch Linux under the hood. Here're a couple pictures showing REFramework and some other mods running on there: https://imgur.com/gallery/sQLJWJw
Copy over the dinput8.dll file and the mods that need to go into the reframework folder. In my case, I could copy both over from my existing modded game.
Then go to the Game screen, click the Settings gear icon > Properties > General > Launch Options > WINEDLLOVERRIDES="dinput8=n,b" %command%
Enter that string as is in the Launch Options box, that is.
After placing dinput8.dll to my game directory folder, the game will crash. this is the only mod that I added yet the game wont load. Removed dinput8.dll and the game works normally.
I can't for the life of me get rid of this, every time I delete reframework folder, re2_fw_config.txt, re2_framework_log.txt they just come right back as soon as i start the game again.
Just thought I let anyone know If your a Steam Deck User, aside from reading the stuff above, When I did all the setup on Steam Deck and updated any outdated files (Had not played in a while). Aside from setting the launch command and stuff, The game would crash immediately I tried every proton version and then Presto! Proton 9.0 Beta works. At least for me it did. If the others dont work like me give 9.0 Beta a try.
You still have to use the Github one if you get a hook failure.
Give Feedback
1924 comments
REFramework has been updated with Sunbreak support.
REFramework works with the Game Pass version. You will need to globally set a custom install directory in the Xbox app or the folder will not be accessible.
If you are using ANY overlays like the Discord overlay, Overwolf, etc... Turn them off if you are crashing on startup.
If you are infinite loading after an update, you have a file-based/pak based mod that is no longer compatible, this is not REFramework's fault.
If you are crashing then upload your re2_framework_log.txt, and your reframework_crash.dmp to the GitHub's issues page. DO NOT POST IT HERE. SNIPPETS OF IT DO NOT HELP.
To uninstall REFramework temporarily, simply remove the dinput8.dll file from your game directory. To completely remove it along with ALL mods, you will need to delete the reframework folder, re2_fw_config.txt, re2_framework_log.txt, and reframework_crash.dmp as well (if it exists).
Pirated copies are not supported. There are no anti-piracy checks built into REFramework.
If you're using MangoHUD with REFramework, make sure MangoHUD's window isn't hidden at startup. The "no_display" option should not be enabled in the MangoHUD config or the REF window will not show.
Further, you must let the MangoHUD window stay up until the REF window shows up. If you hide it via a keybind before REF has shown up, REF will not show up. There is some weird interaction between the two.
Re: resolution and borderless windowed. I'm running at native res (3440x1440) and REF correctly places its window in the top left. I'm running a GNOME desktop and using fullscreen mode, not borderless windowed mode because GNOME will turn off the desktop compositor when running in fullscreen mode which is a good thing for performance.
I'm using Proton 7.0-3 and not experimental and have had no issues. The launch command is
MANGOHUD=1 VKD3D_CONFIG=dxr PROTON_ENABLE_NVAPI=1 WINEDLLOVERRIDES="dinput8=n,b" gamemoderun %command%
The 2nd and 3rd environment variables there enable DLSS (and RTX, but Rise doesn't use RT). DLSS works fine in-game.
I'm also using MangoHUD to get frame limiting and better vsync than the game provides (vsync=2 in MangoHUD's config). But as mentioned above let the MangoHUD window remain on screen until you see the REF window pop up or it will never pop up.
Thanks much @praydog2!
Edit: REFramework Direct2D and all the mods that depend on it also work on Linux/Proton.
Edit 2: All of this also works on the Steam Deck as you'd expect, being Arch Linux under the hood. Here're a couple pictures showing REFramework and some other mods running on there: https://imgur.com/gallery/sQLJWJw
Copy over the dinput8.dll file and the mods that need to go into the reframework folder. In my case, I could copy both over from my existing modded game.
Then go to the Game screen, click the Settings gear icon > Properties > General > Launch Options > WINEDLLOVERRIDES="dinput8=n,b" %command%
Enter that string as is in the Launch Options box, that is.
You still have to use the Github one if you get a hook failure.
How to fix it?
Windows 11 23H2, 7900XTX.