How to Use REFramework: In-Depth Guide

REFramework is a powerful, open-source modding framework designed for games running on Capcom’s RE Engine, including Resident Evil titles, Monster Hunter Rise (MHRise), Monster Hunter Wilds (MH Wilds), Dragon’s Dogma 2 (DD2), and more. It serves as a mod loader, scripting platform, in-game GUI, and developer toolkit, enabling advanced customization, performance tweaks, and VR support.

This guide covers installation, core features, game-specific use, and VR integration. For additional tutorials, visit the REFramework Blog.


1. What is REFramework?

REFramework (often abbreviated as REF) injects into the game process to enable deep interaction with the RE Engine.

Core Function:

  • Loads a single DLL (dinput8.dll) into the game directory.
  • Provides a Lua scripting API, script autorun functionality, and a GUI for configuration.
  • Supports advanced mods, performance fixes, camera tools, and VR extensions.

Safety Notes:

  • REFramework itself does not modify core game files or save files.
  • Certain mods may alter gameplay or create incompatible data, which can cause save issues, especially in multiplayer titles.

2. Installation and Basic Usage

A. Installation Steps

  1. Download REFramework
    • Obtain the latest stable or nightly release from REFramework or modding hubs like Nexus Mods.
  2. Locate Your Game Directory
    • Steam default: C:\Program Files (x86)\Steam\steamapps\common\[Game Name]\
  3. Extract the Files
    • Extract the .zip or .rar archive.
  4. Place the DLL
    • Copy dinput8.dll into the game root directory (next to the main executable, e.g., DD2.exe).
  5. Launch the Game
    • A small overlay or text in the top-left corner indicates that REFramework has loaded.

B. Accessing the In-Game Menu

  • Default hotkey: Insert (Ins)
  • Press Insert to toggle the REFramework overlay.

C. Loading Mods and Scripts

Lua Scripts:

  • Place .lua files in: [Game Directory]\reframework\autorun\
  • Scripts in autorun are automatically loaded. You can also manually run them from the ScriptRunner tab in the REFramework menu.

Other Mods:

  • Follow the instructions provided by the mod author. Most mods require placing files inside the reframework folder.

3. Core In-Game Features

The REFramework menu provides advanced control over the game environment. Key tabs include:

Tab/FeatureDescription
Script-generated UIDisplays custom UIs from mods, e.g., DPS meters, character editors.
CameraFreeCam, Field-of-View adjustments, cinematic shots.
GraphicsUltrawide fixes, post-processing toggles (Motion Blur, Volumetric Fog, TAA).
Developer ToolsObject Explorer, Timescale adjustments, debugging utilities.
VRControls and settings specific to VR mods (see Section 5).

4. Game-Specific Utility

Monster Hunter Rise (MHRise) & Monster Hunter Wilds (MH Wilds)

GameFeaturesPopular REFramework Mods
MHRiseQuality-of-life mods, performance fixesCoven DPS Meter, Better Shopping, Quest Manager
MH WildsFPS optimization, Ultrawide support, visual tweaksPerformance boosters, Reshade presets, FreeCam

Dragon’s Dogma 2 (DD2)

FeaturesPopular Mods
Performance improvements, FreeCam, Time ControlPawns Stop Yelling, Item Weight Tweaks, FOV sliders, Transmog mods

Other RE Engine Games

  • Supports Resident Evil 2/3/4 Remakes, Village, Devil May Cry 5, Street Fighter 6.
  • Use cases: VR conversions, model swaps, Object Explorer for mod development.

5. REFramework and VR

REFramework extends support to PC VR mods for RE Engine titles:

Key Features:

  • Motion Controller Mapping: Valve Index, Oculus Touch, etc.
  • Head-based movement and smooth locomotion.
  • Performance tweaks: uncapped FPS, disable post-processing, adjust antialiasing.
  • Switch between OpenVR and OpenXR APIs for performance optimization.

6. Troubleshooting & Maintenance

IssueSolution
Game crashes on startupUpdate REFramework; replace dinput8.dll and remove conflicting DLLs like dxgi.dll.
Menu doesn’t openPress Insert (Ins); check keyboard layout or conflicts.
Mods not loadingEnsure scripts are in reframework\autorun and REFramework is loaded.
Multiplayer save corruptionAvoid sharing incompatible or “illegal” data.

Additional Resources