如何自定义REFramework配置？从基础设置到高级技巧全解析

REFramework作为RE引擎游戏的mod框架，提供了丰富的配置选项来优化游戏体验。本文将系统讲解配置系统的工作原理，帮助你掌握从基础设置到高级定制的全过程，打造个性化的游戏增强环境。

理解REFramework配置系统

REFramework的配置系统采用模块化设计，核心由配置定义、逻辑实现和持久化存储三部分组成。配置文件默认名为re2_fw_config.txt，采用键值对格式存储用户偏好设置。配置系统的核心代码位于src/mods/REFrameworkConfig.hpp和src/mods/REFrameworkConfig.cpp两个文件中，分别负责配置项声明和逻辑实现。

配置加载流程遵循以下三个步骤：

1. 游戏启动时，REFrameworkConfig::on_initialize()方法创建配置实例
2. on_config_load()方法从配置文件读取参数并应用到内存变量
3. 用户通过UI修改设置后，on_config_save()方法将当前配置写回文件

掌握核心配置功能

管理菜单交互设置

菜单控制是REFramework最基础也最常用的功能，通过以下配置项可以自定义菜单的交互方式：

• MenuKey_V2

  • 作用：设置打开/关闭菜单的快捷键
  • 默认值：VK_INSERT（插入键）
  • 修改建议：对于常用功能，建议设置为键盘中上部的按键，如F5或F12，避免与游戏操作冲突

• RememberMenuState

  • 作用：控制是否记忆上次菜单状态（打开/关闭）
  • 默认值：false
  • 修改建议：如果经常需要使用菜单功能，建议设为true，避免每次重启游戏都需要重新打开菜单

相关实现代码展示了记忆菜单状态的逻辑：

// 应用记忆的菜单状态
if (m_remember_menu_state->value()) {
    // 根据保存的状态设置UI显示
    g_framework->set_draw_ui(m_menu_open->value(), false);
}

定制界面显示效果

REFramework提供了多项界面显示设置，让你可以根据个人习惯优化视觉体验：

光标控制选项

• DrawCursorWithMenuOpen

  • 作用：控制菜单打开时是否显示光标
  • 默认值：RE8为true，其他游戏为false
  • 修改建议：使用鼠标操作菜单时设为true，使用键盘导航时可设为false

• ShowCursorKey

  • 作用：快速切换光标显示状态的快捷键
  • 默认值：未设置
  • 修改建议：建议设置为不与游戏操作冲突的按键，如Scroll Lock

字体个性化设置

REFramework支持自定义字体和大小，让菜单文本显示更符合个人阅读习惯：

• FontSize

  • 作用：设置菜单字体大小
  • 默认值：16
  • 修改建议：高分辨率显示器建议增大到18-20，笔记本等小屏幕可保持默认或减小

• FontFile

  • 作用：指定自定义字体文件
  • 默认值："DEFAULT"（使用内置字体）
  • 修改建议：如需更换字体，将.otf或.ttf格式字体文件放入reframework/fonts目录，然后在此项中输入文件名

字体加载的核心实现代码：

// 扫描字体目录并加载可用字体
const auto fonts_path = REFramework::get_persistent_dir() / "reframework" / "fonts";
fs::create_directories(fonts_path);  // 确保目录存在
for (const auto& entry : fs::directory_iterator(fonts_path)) {
    if (fs::is_regular_file(entry)) {
        const auto ext = entry.path().extension();
        // 只加载支持的字体格式
        if (ext == ".otf" || ext == ".ttf") {
            fonts.push_back(entry.path().filename().string());
        }
    }
}

配置操作实践指南

基本配置流程

通过REFramework的配置界面，你可以直观地修改各项设置：

1. 按下默认快捷键Insert打开主菜单
2. 找到并展开"Configuration"折叠项
3. 在展开的树形菜单中找到需要修改的配置项
4. 修改完成后设置会自动保存，部分设置需要重启游戏才能生效

配置界面的实现代码展示了UI绘制逻辑：

// 配置界面绘制
if (!ImGui::CollapsingHeader("Configuration")) { return; }
ImGui::TreePush("Configuration");
m_menu_key->draw("Menu Key");               // 菜单快捷键设置
m_show_cursor_key->draw("Show Cursor Key"); // 光标显示快捷键
m_remember_menu_state->draw("Remember Menu State"); // 记忆菜单状态
m_always_show_cursor->draw("Draw Cursor With Menu Open"); // 菜单打开时显示光标
if (m_font_file->draw("Font")) {            // 字体选择
    g_framework->set_font(m_font_file->value());
}
if (m_font_size->draw("Font Size")) {       // 字体大小设置
    g_framework->set_font_size(m_font_size->value());
}
ImGui::TreePop();

直接编辑配置文件

对于熟悉配置项的高级用户，可以直接编辑配置文件进行设置：

1. 找到游戏目录下的re2_fw_config.txt文件
2. 使用文本编辑器打开
3. 按照"参数名=值"的格式修改配置
4. 保存文件并重启游戏使设置生效

例如，要将菜单快捷键修改为F5，可以添加或修改以下行：

MenuKey_V2=VK_F5

高级配置技巧

实现批量配置管理

REFramework的配置系统通过ValueList统一管理所有配置选项，便于批量操作：

// 配置项列表定义
ValueList m_options {
    *m_menu_key,           // 菜单快捷键
    *m_menu_open,          // 菜单默认状态
    *m_remember_menu_state,// 记忆菜单状态
    *m_always_show_cursor, // 菜单打开时显示光标
    *m_show_cursor_key,    // 光标显示快捷键
    *m_font_size,          // 字体大小
};

通过遍历这个列表，可以实现配置的批量加载：

// 批量加载配置
for (IModValue& option : m_options) {
    option.config_load(cfg);  // 对每个配置项执行加载操作
}

这种设计不仅简化了代码，还使得添加新的配置项变得非常容易，只需在列表中添加新的配置对象即可。

创建配置备份与恢复机制

为了避免配置错误导致的问题，建议定期备份配置文件。你可以创建简单的脚本或批处理文件来自动备份：

# 备份REFramework配置文件的批处理示例
copy re2_fw_config.txt re2_fw_config_backup_%date:~0,4%%date:~5,2%%date:~8,2%.txt

当配置出现问题时，只需将备份文件重命名为re2_fw_config.txt即可恢复之前的设置。

解决常见配置问题

配置修改后游戏崩溃

如果修改配置后游戏无法启动或频繁崩溃，可能是配置参数设置不当导致：

1. 关闭游戏
2. 删除或重命名re2_fw_config.txt文件
3. 重新启动游戏，REFramework会自动生成默认配置文件
4. 尝试逐步修改配置，找出导致问题的具体参数

自定义字体不生效

当自定义字体无法正常显示时，请检查以下几点：

1. 字体文件格式是否为.otf或.ttf
2. 字体文件是否放置在正确目录：reframework/fonts
3. 文件名是否包含特殊字符或空格
4. 配置项中指定的文件名是否与实际文件名完全一致（包括大小写）

快捷键设置无反应

如果设置的快捷键没有效果，可能有以下原因：

1. 快捷键与游戏本身的快捷键冲突
2. 选择的按键可能被系统或其他软件占用
3. 某些特殊按键（如多媒体键）可能不受支持
4. 配置文件中按键名称是否正确（需使用VK_前缀的按键代码）

配置系统架构解析

REFramework的配置系统采用了模块化和面向对象的设计思想，主要包含以下组件：

• 配置项定义：在REFrameworkConfig.hpp中声明各种配置项，使用ModKey、ModBool等类型封装不同类型的配置
• 配置管理逻辑：在REFrameworkConfig.cpp中实现配置的加载、保存和UI交互
• 持久化存储：使用简单的键值对文本文件存储配置，确保设置可以在游戏重启后保持

这种架构设计使得配置系统具有良好的可扩展性，开发者可以轻松添加新的配置项，用户也可以根据自己的需求定制游戏体验。通过灵活运用这些配置选项，你可以打造最适合自己的游戏增强环境，充分发挥REFramework的强大功能。

掌握REFramework的配置系统不仅能提升游戏体验，还能深入了解模块化配置设计的实现方式，为自己的项目开发提供参考。无论是简单的快捷键修改还是复杂的界面定制，REFramework都为你提供了强大而灵活的配置工具。