How to Use REFramework | Complete Guide

REFramework is a powerful modding framework and scripting platform for games built on Capcom’s RE Engine, including Resident Evil titles, Devil May Cry 5, Monster Hunter Rise, and more. It allows for Lua scripting, performance tweaks, VR support, and advanced modding capabilities.

This guide will walk you through the main steps to install and use REFramework effectively.

---

1. Installation

The first step is placing REFramework into your game directory.

Step 1: Download REFramework

• Obtain the correct version for your specific game from the official REFramework download page.
• Games supported include RE2, RE3, RE4, DMC5, MHRise, and Dragon’s Dogma 2.

Step 2: Extract Files

• The download comes as a ZIP file. Inside, you’ll find:
  • dinput8.dll
  • A folder named reframework (may include additional files for VR or plugins)

Step 3: Place in Game Folder

• Copy the dinput8.dll and reframework folder directly into your game’s root directory (where the game executable, e.g., re2.exe or MHRise.exe, is located).

---

2. Accessing the In-Game Menu (GUI)

Once REFramework is installed, it runs alongside your game.

1. Launch the Game – Start the game normally.
2. Open the REFramework Menu – Press the Insert (Ins) key on your keyboard.

Tip: If your keyboard lacks an Insert key or it conflicts with another function, check the configuration file re_framework_config.txt in the game folder to view or change the menu key.

---

3. Key Functions and Usage

The REFramework menu provides access to multiple tools and modding features.

Menu Section	Purpose	How to Use
Configuration	Change keybinds, general settings, and UI options	Navigate here to rebind the Menu Key or adjust console font size and other settings
Script Generated UI	Manage specific mods (Lua scripts)	Installed scripts often create their own settings here. Select the mod name to adjust options
ScriptRunner	Manually execute Lua scripts	Click “Run Script” and select the .lua file to run
Object Explorer (Developer Tools)	Inspect game objects, variables, and functions	Explore the game’s exposed data for mod development
VR (If Applicable)	Enable/configure VR support	For VR headsets, adjust motion controls, camera decoupling, and VR settings
Camera	Control in-game camera	Use Free Camera (WASD + mouse) and adjust Field of View (FOV)
Hotkeys/Keybinds	View and assign shortcuts	Check or modify hotkeys for toggling Free Camera, fast-forward, or other REFramework functions

---

4. Installing Mods (Lua Scripts and Plugins)

REFramework supports both Lua scripts and native DLL plugins.

A. Automatic Lua Script Loading (Recommended)

1. Navigate to the reframework folder in your game directory.
2. Open the autorun folder (create one if it doesn’t exist).
3. Place any .lua scripts you want to load automatically into this folder.

REFramework will automatically run these scripts every time the game starts.

B. Installing Native Plugins (DLLs)

1. Navigate to the reframework/plugins folder inside your game directory.
2. Place the downloaded plugin’s .dll file here.
3. Launch the game and manage the plugin via the REFramework menu.

---

5. Summary of Usage

The core workflow for REFramework is simple:

Install → Launch → Press Insert → Configure → Run Mods

• Lua scripts load automatically from the autorun folder or can be run manually via ScriptRunner.
• Plugins are installed in the plugins folder and integrated into the REFramework menu.

Official Resources:

• Download REFramework: REFramework Download Page
• Documentation & Guides: REFramework Comprehensive Documentation