SimpleConfigExclude 使用文档

支持的虚幻引擎版本：5.2–5.8

以可视化方式管理 Unreal Engine 项目打包时要包含或排除的配置文件（.ini）。

位置：编辑器 > 项目设置 > Plugins > Simple Config Exclude

• 默认：启用
• 功能：在配置列表中隐藏 DefaultSimpleConfigExclude.ini
• 目的：防止意外排除插件自身的设置

• 默认：启用
• 功能：复制排除文件前删除目标 Config 文件夹
• 目的：确保目标目录仅包含最新排除的文件

• 默认：/Windows
• 功能：复制排除配置文件的目标目录
• 路径格式：相对于项目目录（如 /Windows、/Build/Output）
• 跨平台：支持 Windows、Mac、Linux
• 目录结构：保留原始结构（TargetDir/ProjectName/Config/xxx.ini）
• 复制按钮：将所有 Disallowed 配置文件复制到目标目录

所有 Config 文件夹中 .ini 文件的三态选择器：

点击重新扫描 Config 文件夹。适用于：

• 新增配置文件
• 删除配置文件
• 列表与实际文件不同步

如果有 DefaultDebugSettings.ini 包含不应出现在发行版中的调试热键：

1. 打开 项目设置 > Plugins > Simple Config Exclude
2. 在列表中找到 Config/DefaultDebugSettings.ini
3. 选择 “Disallowed”
4. 打包项目——文件将被排除

如果有 DefaultCustomSettings.ini 必须被打包：

1. 打开插件设置
2. 找到 Config/DefaultCustomSettings.ini
3. 选择 “Allowed”
4. 打包项目——文件将被强制包含

打包后，你可能想手动添加排除的配置：

1. 将 “Copy Target Directory” 设为打包输出路径（如 /Windows）
2. 将要排除的配置设为 “Disallowed”
3. 打包项目
4. 点击 “Copy” 按钮
5. 文件复制到 Windows/YourProject/Config/xxx.ini

所有配置文件默认为 “Default” 状态，使用 UE 的默认打包行为。UE 根据文件类型自动决定（engine.ini、game.ini、input.ini 会被打包）。

插件默认隐藏 DefaultSimpleConfigExclude.ini 因为：

• 它包含插件自身的设置
• 排除它可能导致插件功能异常
• 取消勾选 “Hide Plugin Config” 可以显示它

• 插件设置保存在 DefaultSimpleConfigExclude.ini
• 排除规则保存在 DefaultGame.ini 的 [Staging] 段
• 两个文件都应提交到版本控制

调整规则后，插件会写回 DefaultGame.ini，并重新加载配置，让设置面板与磁盘内容对应。写入涉及版本控制签出或只读文件处理，应检查签出状态及最终文件差异。

启用 “Clean Config Before Copy” 时：

• 复制前删除 TargetDir/ProjectName/Config/ 文件夹
• 仅复制当前 Disallowed 的文件
• 确保目标目录反映当前状态

1. 点击 “Refresh Config List” 按钮
2. 确保文件在 Config 文件夹或子文件夹中
3. 确保文件扩展名为 .ini

1. 检查 DefaultGame.ini 是否包含 [Staging] 段
2. 尝试点击 “Refresh Config List”
3. 重启编辑器并重新打包

检查 “Hide Plugin Config” 设置，启用它以隐藏 DefaultSimpleConfigExclude.ini

启用 “Clean Config Before Copy” 选项，在复制前清理目标 Config 文件夹

Q：这会影响游戏运行时吗？ A：不会，这是仅编辑器插件，只影响打包过程。

Q：支持子文件夹吗？ A：是的，插件递归扫描 Config 文件夹及所有子文件夹，复制时保留目录结构。

Q：复制的排除配置能用吗？ A：取决于配置类型。运行时配置（如 Input）可用，编译时烘焙的配置（如渲染设置）不行。

打开 编辑 → 项目设置，进入 SimpleConfigExclude 设置页，将 Language 设置为 English 或 中文。默认语言为英文。面向用户的界面、提示、通知和功能日志会立即更新，无需重启编辑器；公开 API 名称以及模块启动/关闭日志始终保持英文。

如有使用问题或合作需求，请前往联系页面。

• 联系入口： 联系与合作

在项目设置中选择配置文件的包含与排除状态，并按需复制排除文件。

插件为每个配置文件提供三种状态：

在项目设置面板中，每个 .ini 文件旁边都有一个三态切换控件（SSegmentedControl），点击即可切换。

插件的工作流完全自动化：

1. 编辑器启动时自动扫描 Config 目录下所有 .ini 文件
2. 读取现有规则从 DefaultGame.ini 的 [Staging] 区段
3. 生成配置列表展示在设置面板中
4. 修改即生效切换状态后立即写入 DefaultGame.ini

状态切换会写回配置文件，并处理相关文件的可写状态。

被排除的配置文件不会出现在打包目录中。部署到不同环境等场景下，可能需要手动补充这些文件。

插件提供了一键复制功能：

• 配置目标目录（默认 /Windows）
• 点击 Copy 按钮
• 所有标记为 Disallowed 的配置文件会被复制到目标目录
• 可选在复制前清理目标 Config 文件夹

复制功能可用于在部署时补充不同环境的配置文件。

• 隐藏插件自身配置：默认隐藏 DefaultSimpleConfigExclude.ini，防止误操作导致插件配置丢失
• 源控制集成：修改 DefaultGame.ini 前自动检出（支持 Perforce/Git）
• 只读保护：未使用源控制时自动移除只读属性

将插件文件夹复制到项目的 Plugins 目录，重启编辑器。

路径：Edit > Project Settings > Plugins > Simple Config Exclude

面板分为三个区域：

1. Settings：通用设置（是否隐藏插件配置、复制前是否清理目标目录）
2. Copy：复制排除文件到目标目录
3. Config Exclude Rules：配置文件列表和三态选择器

1. 找到你要排除的配置文件
2. 点击 Disallowed 即可排除
3. 需要强制包含的点击 Allowed
4. 修改即时生效，无需额外保存

正常打包项目，检查打包目录中的 Config 文件夹，确认排除的文件不存在。

项目中有 DefaultDebug.ini 存储调试参数，生产环境不需要：

DefaultDebug.ini → Disallowed

1. 将测试环境配置标记为 Disallowed
2. 打包得到干净的基础版本
3. 用 Copy 功能将排除的配置复制到测试环境部署目录
4. 生产环境使用打包后的默认配置

DefaultEncryption.ini → Disallowed  // 密钥配置不随包发布
DefaultServer.ini → Disallowed      // 服务器配置通过运维单独部署

修改配置状态会写回 DefaultGame.ini。复制排除文件时，检查目标目录及是否启用了复制前清理。