https://github.com/praydog/reframework

Scripting platform, modding framework and VR support for all RE Engine games
https://github.com/praydog/reframework

cmkr cpp dmc5 first-person freecam lua mhrise modding mods monster-hunter-rise re-engine re2 re3 re4 re7 re8 scripting sf6 virtual-reality vr

Last synced: 5 days ago
JSON representation

Scripting platform, modding framework and VR support for all RE Engine games

• Host: GitHub
• URL: https://github.com/praydog/reframework
• Owner: praydog
• License: mit
• Created: 2019-01-31T16:17:50.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-17T17:07:56.000Z (13 days ago)
• Last Synced: 2024-12-25T23:01:22.989Z (5 days ago)
• Topics: cmkr, cpp, dmc5, first-person, freecam, lua, mhrise, modding, mods, monster-hunter-rise, re-engine, re2, re3, re4, re7, re8, scripting, sf6, virtual-reality, vr
• Language: C++
• Homepage: https://cursey.github.io/reframework-book/
• Size: 36.7 MB
• Stars: 2,956
• Watchers: 76
• Forks: 360
• Open Issues: 302
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# REFramework [![Build status](https://github.com/praydog/reframework/actions/workflows/dev-release.yml/badge.svg)](https://github.com/praydog/REFramework-nightly/releases)

A mod framework, scripting platform, and modding tool for RE Engine games. Inspired by and uses code from [Kanan](https://github.com/cursey/kanan-new)

## Installation

The last stable build can be downloaded from the [Releases](https://github.com/praydog/REFramework/releases) page.

For newer builds, check out the [Nightly Developer Builds](https://github.com/praydog/REFramework-nightly/releases)

### Non-VR

* Extract only the `dinput8.dll` from the zip file into your game folder.

### VR

* Install SteamVR (unless you're using OpenXR on a supported headset)

* Extract the whole zip file into your corresponding game folder.

[VR Troubleshooting/FAQ](https://github.com/praydog/REFramework/wiki/VR-Troubleshooting)

### Proton/Linux

Add the launch option `WINEDLLOVERRIDES="dinput8.dll=n,b" %command%` to your game through Steam's properties after extraction.

Example game folder: G:\SteamLibrary\steamapps\common\RESIDENT EVIL 2 BIOHAZARD RE2

Supports both DirectX 11 and DirectX 12.

## Included Mods

* Lua Scripting API & Plugin System (All games, check out the [Wiki](https://cursey.github.io/reframework-book/))

* VR

  * Generic 6DOF VR support for all games

  * Motion controls for RE2/RE3/RE7/RE8

* First Person (RE2, RE3)

* Manual Flashlight (RE2, RE3, RE8)

* Free Camera (All games)

* Scene Timescale (All games)

* FOV Slider (All games)

* Vignette Disabler (All games)

* Ultrawide/Aspect Ratio fixes (All games)

* GUI Hider/Disabler (All games)

## Included Fixes

* RE8 Startup Crash

* RE8 Stutters (killing enemies, taking damage, etc...)

* MHRise/RE8 crashes related to third party DLLs

## Included Tools (Developer Mode)

* Game Objects Display

* Object Explorer

## Supported Games

* Resident Evil 2

* Resident Evil 3

* Resident Evil 4

* Resident Evil 7

* Resident Evil Village

* Devil May Cry 5

* Street Fighter 6

* Monster Hunter Rise

* Dragon's Dogma 2

* Ghosts 'n Goblins Resurrection (Using RE8 build)

* Apollo Justice: Ace Attorney Trilogy (Using DD2 build)

* Kunitsu-Gami: Path of the Goddess (Using DD2 build)

## Thanks

[SkacikPL](https://github.com/SkacikPL) for originally creating the Manual Flashlight mod.

[cursey](https://github.com/cursey/) for helping develop the VR component and the scripting system.

[The Hitchhiker](https://github.com/youwereeatenbyalid/) and [alphaZomega](https://github.com/alphazolam) for the great help stress testing, creating scripts for the scripting system, and helpful suggestions.