REFramework 实战教程:RE 引擎游戏 Mod 框架 + Lua 脚本一次跑通

REFramework 实战教程:RE 引擎游戏 Mod 框架 + Lua 脚本一次跑通

【免费下载链接】REFrameworkMod loader, scripting platform, and VR support for all RE Engine games项目地址: https://gitcode.com/GitHub_Trending/re/REFramework

REFramework 是一个面向 RE 引擎游戏(《生化危机》系列、《鬼泣 5》、《街霸 6》、《怪物猎人》等)的 Mod 框架,集 Mod 加载、Lua 脚本平台、C++ 插件与 VR 透视于一体,同时兼容 DirectX 11 和 12。按本文操作,你会从放置dinput8.dll开始,一路做到调出游戏内菜单、跑通仓库自带脚本、写出自己的 Lua 扩展,直到把作品发给别人——全程不用反编译游戏,也不用动游戏本体文件。

按 Insert 就能出菜单:先说结果,再倒推条件

先说你会看到什么:游戏正常进图后,按Insert 键(默认菜单键,可在菜单里改),屏幕上弹出一个覆盖式窗口,分区块列出 Script Runner、各内置 Mod 和 VR 设置——到这里,框架已经完整接管了游戏。

倒推这个结果只需要两个条件:

  • dinput8.dll和游戏主程序同级。框架本体就是这个 DLL:RE 引擎启动时会请求 DirectInput,Windows 自动加载游戏目录里的dinput8.dll,注入就此完成——不需要改注册表,也不需要启动器。非 VR 用户从 Release 包里只解压这一个文件即可;VR 用户先装好 SteamVR,再把整个压缩包含 VR 运行时一起解压到游戏目录,少放文件就会出现"菜单在、VR 功能不响应"的假故障。
  • 游戏目录可写。框架会尝试在目录里写测试文件,写不进去就回退到%APPDATA%\REFramework\<游戏名>\存配置和日志,功能不受影响但日志位置变了,排障时别找错地方。

Linux 上走 Proton:在 Steam 游戏属性里加启动项WINEDLLOVERRIDES="dinput8.dll=n,b" %command%,进游戏按 Insert 有菜单即成功。

成功信号:按 Insert 弹出覆盖菜单,且游戏没崩溃。

用 Script Runner 把仓库自带 Lua 脚本跑起来

先跑通 scripts/ 里的现成脚本

仓库scripts/目录是按游戏命名的实战脚本(re2_xxx.lua、re4_xxx.lua这类),依赖的跨游戏工具库在 scripts/utility/。注意脚本内部用require("utility/RE2")这种相对路径加载工具,所以整个scripts/文件夹要原样放进游戏目录,不要只拷单个文件。

然后:

  1. 打开菜单里的 Script Runner 区块,点Run script,在文件选择框里挑一个.lua;
  2. 以scripts/re2_smooth_movement.lua为例:它会在每帧修正角色 Transform,加载后移动角色直接能感到手感变化;
  3. 点Reset scripts卸载全部脚本,对比卸载前后的差异。

⚠️ 加载成功的信号是Known scripts 列表出现该脚本名且菜单顶部没有红字报错。如果列表显示 "No scripts loaded.",说明文件没选对或目录结构不对。

日志确认脚本真正开始执行的时机

脚本不会在游戏一启动就执行:框架会先等via.SceneManager和当前场景就绪。游戏目录下的re2_framework_log.txt里出现[ScriptRunner] Scene and scene manager found. Loading scripts...才算真正开始加载;等 5 秒没等到也会放行并打一条 warn,这属于正常容错,不用慌。

让脚本每次开游戏自动加载

想省掉手动点Run script,把.lua放进游戏目录下的reframework/autorun/文件夹即可。开游戏时这些脚本会被自动执行,并出现在 Known scripts 列表里,随时可以勾选/取消。reframework/autorun同时会被加进 Lua 的package搜索路径,放在子目录里的脚本也能被require到。

第一次写自己的 Lua 脚本并跑起来

sdk 表就是拿游戏对象的统一入口

sdk是操作游戏托管对象的统一 API:sdk.find_type_definition("类型全名")拿到类型定义,:get_method("方法名")拿到方法再call/call_safe调用;sdk.get_native_singleton和sdk.get_primary_camera是常用快捷方式。类比一下:它相当于给游戏的托管对象开了一组"遥控器按钮",按钮名就是游戏代码里的真实类型名和方法名。具体类型名可以在仓库 shared/sdk/regenny/ 下各游戏目录里对照。

写一个每帧回调的小脚本

re.on_frame(fn)把fn挂到每帧回调上——游戏每渲染一帧,框架就替你执行一次,可以理解为"给游戏的心跳订阅了一个定时任务"。新建my_first.lua放进reframework/autorun/:

local frame = 0 re.on_frame(function() frame = frame + 1 if frame % 60 == 0 then -- 每 60 帧执行一次 local cam = sdk.get_primary_camera() if cam then log.info("主相机: " .. tostring(cam)) end end end)

然后重启游戏(或点Reset scripts让它重新走 autorun 加载)。成功信号:Known scripts 里出现my_first.lua,日志每 60 帧滚动一条,且面板显示 "No Script Errors... yet!"。

两个必须知道的行为

  • 沙箱裁剪:Lua 的os库里remove / rename / execute / exit / setlocale / getenv都被框架置空了,想删文件、执行系统命令请改用fs绑定——这是安全设计,不是你环境坏了。
  • 性能习惯:find_type_definition和get_method的结果在脚本顶部取一次并缓存,别在每帧回调里重复查。脚本跑久了占用内存会涨,用 Garbage Collection Stats 里显示的 MB 数值判断,稳定不再上涨就调好了。

编译 C++ 插件:clone 仓库后产出第一个 DLL

开发者线到这里才需要碰编译环境:C++23 编译器(推荐 Visual Studio 2022)加 CMake,完整细节见 COMPILING.md。

先 clone 仓库并拉取第三方依赖:

git clone https://gitcode.com/GitHub_Trending/re/REFramework cd REFramework && git submodule update --init --recursive

然后二选一:直接跑仓库根目录的build_vs2022.bat(Release 构建全部游戏目标,耗时较长),或者用 CMake 只构建你要的游戏,省掉几十分钟:

cmake -S . -B build -G "Visual Studio 17 2022" -A x64 -DCMAKE_BUILD_TYPE=Release cmake --build ./build --config Release --target RE2

examples/example_plugin/ 是最完整的参考

Plugin.cpp里覆盖了插件要面对的全部关键路径:D3D11/D3D12 双后端初始化、每帧渲染回调、以及用create_script_state创建独立 Lua state 沙箱(相当于给你的插件开一个和主脚本隔离的虚拟机)。通读它一遍,比看文档直接。

放对位置就能加载

编译出的 DLL 丢进游戏目录的reframework/plugins/,重启游戏。框架启动时会扫描这个目录并逐个加载其中的.dll,插件需要导出reframework_plugin_required_version和reframework_plugin_initialize两个入口(示例里都有)。

成功信号:重启后菜单正常,日志里出现[PluginLoader] Loaded ...,且没有[Plugin]开头的 error。

报错、没生效、卡顿:三处按序排查

  • Script Runner 面板的红字:Last Script Error会常驻显示最近一次错误和发生时间,勾上Log Lua Errors to Disk后所有 Lua 错误落盘,再点Spawn Debug Console弹控制台看实时输出,三者配合基本能定位 90% 的脚本问题。
  • 在线匹配下脚本被整体卸载:面板会明确提示 "Online match detected. Scripts will not be loaded.",这是框架的主动保护,切回单机模式脚本自动恢复。
  • os库不可用的报错:沙箱裁剪所致,换fs绑定即可。

卡顿只调一处:确认方法指针已缓存、re.on_frame里只有增量计算,然后观察 Garbage Collection Stats 的占用数值是否趋稳;GC 参数(Handler / Mode / Budget)就在这个面板里,每帧由框架统一回收。

把你的 Lua 脚本或 C++ 插件分享给别人

分享成本极低:C++ 插件就是一个 DLL,Lua 脚本就是一个.lua(依赖utility/工具库的话把整个scripts/文件夹一起发)。对方只需把 DLL 放进reframework/plugins/、把脚本放进reframework/autorun/,重启游戏即可,一句说明就够了。

到这里你手里已经有完整闭环:dinput8.dll注入 → Insert 菜单 → 脚本平台 → 自写扩展 → C++ 插件。建议下一步打开 examples/example_plugin/ 跟本文走一遍编译流程,把产出的 DLL 丢进reframework/plugins/重启确认菜单正常——你就完成了从安装到产出的全链路。

【免费下载链接】REFrameworkMod loader, scripting platform, and VR support for all RE Engine games项目地址: https://gitcode.com/GitHub_Trending/re/REFramework

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

相关新闻

解决往GitHub提交大文件报错问题

解决往GitHub提交大文件报错问题

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/11/10 3:18:16 阅读更多 →
基于Spring Boot的面点连锁店管理系统设计:权限、库存与业务闭环

基于Spring Boot的面点连锁店管理系统设计:权限、库存与业务闭环

毕设季一到&#xff0c;"管理系统"四个字的含金量就开始被反复讨论。如果只做一个单店的进销存&#xff0c;确实容易让答辩老师觉得平平无奇&#xff1b;但如果加上"连锁"和"面点"这两个词&#xff0c;整个系统的业务复杂度、表结构设计、权限边…

2026/11/10 3:13:17 阅读更多 →
华为eNSP策略路由实验:从配置到排错,避开模拟器那些坑

华为eNSP策略路由实验:从配置到排错,避开模拟器那些坑

1. 策略路由到底解决的是什么问题很多人第一次接触策略路由&#xff0c;是在一个很具体的场景里&#xff1a;公司有两条出口链路&#xff0c;一条贵但快&#xff0c;一条便宜但慢&#xff0c;老板要求"财务系统走快的&#xff0c;其他走便宜的"。这时候如果你只会配静…

2026/11/15 16:28:35 阅读更多 →

最新新闻

Electron桌面应用开发实战:从环境搭建到打包发布全流程

Electron桌面应用开发实战:从环境搭建到打包发布全流程

做前端这些年&#xff0c;我大部分时间都在跟浏览器标签页打交道&#xff0c;直到第一次把桌面应用跑起来&#xff0c;才发现原来自己一直被限制在地址栏和刷新按钮围起来的框框里。Electron这个词&#xff0c;最开始是在某段时间频繁出现在同事的讨论里&#xff0c;一个用HTML…

2026/11/17 8:22:52 阅读更多 →
滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

简介&#xff1a;亚太天能T109滑盖智能锁产品说明书是一份PDF格式的官方技术文档&#xff0c;主要面向智能锁安装人员、终端用户及售后维护者&#xff0c;帮助快速掌握产品安装、配置与常见故障处理。全包仅1个PDF文件&#xff0c;大小4.37MB&#xff0c;内容结构清晰&#xff…

2026/11/17 12:46:04 阅读更多 →
PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

上个月我在调试一台高速AGV的驱动系统&#xff0c;整车要求空载跑到8m/s&#xff0c;电机转速已经拉到额定点&#xff0c;驱动器的输出电压也顶到了母线电压极限附近。再往上踩速度指令&#xff0c;转速纹丝不动&#xff0c;三相电流反而开始震荡。那会儿我的第一反应就是&…

2026/11/17 12:46:04 阅读更多 →
C++核心知识点:从内存管理到STL的实战指南

C++核心知识点:从内存管理到STL的实战指南

C 这门语言我前前后后折腾了十几年&#xff0c;用它写过嵌入式驱动、做过游戏服务端&#xff0c;也搭过基础组件库。每次看到新人一头扎进"C 核心知识点"这个搜索词&#xff0c;我其实挺感慨的——这门语言的难点从来不是语法多&#xff0c;而是知识点之间的耦合太深…

2026/11/17 11:26:33 阅读更多 →
T109滑盖智能锁怎么装?安装调试与故障排查全攻略

T109滑盖智能锁怎么装?安装调试与故障排查全攻略

简介&#xff1a;亚太天能T109滑盖智能锁产品说明书以PDF格式发布&#xff0c;适合智能锁用户、安装人员与售后维修人员阅读。内容围绕T109系列指纹密码刷卡锁展开&#xff0c;先介绍前面板、后面板、锁体、机械钥匙、电池盒盖等部件名称与功能&#xff0c;再给出完整安装步骤&…

2026/11/17 12:46:05 阅读更多 →
LLM知识降熵:从信息垄断到理解权下放

LLM知识降熵:从信息垄断到理解权下放

你有没有过这种经历&#xff1a;翻开源码注释、论文摘要或者一份专业报告&#xff0c;每个字都认识&#xff0c;连在一起却像天书。想找人聊聊&#xff0c;身边要么没人懂&#xff0c;要么懂的懒得跟你解释。后来我试着把同一段内容丢给一个大语言模型&#xff0c;几秒钟之后&a…

2026/11/17 12:46:05 阅读更多 →

日新闻

周新闻

月新闻