UConfigTool

操作演示

备用链接：

• Gitee Raw 视频地址
• 仓库内视频文件

UConfigTool 是一个基于 Electron + React + TypeScript 的开源配置工具，面向游戏/客户端/服务端项目中的配置编辑与代码生成场景。

本项目适合作为公开仓库长期维护，支持可视化配置管理、JSON 导出、多语言类型代码导出，以及 Windows 安装包分发。

功能特性

• 可视化管理配置类型与配置表
• 支持配置字段定义（基础类型、数组、嵌套类型）
• 支持配置表内容编辑与保存
• 配置导出
• 选择配置类型导出 JSON
• 选择编程语言导出类型代码
• 已支持导出语言：
• C#
• Lua
• TypeScript
• Python
• Java
• Go
• C++
• Rust
• 桌面端工程化能力
• 主进程/渲染进程/共享层分层
• 类型化 IPC 通信模型
• 可打包 Windows 安装包（NSIS）

运行环境

• Node.js 18+
• npm 9+
• Windows（当前主要打包目标）

快速开始

npm install
npm run dev

常用命令

• npm run dev：启动开发环境（Vite + Electron）
• npm run build：构建渲染层
• npm run build:electron：编译主进程与 preload
• npm run typecheck：类型检查
• npm run test：运行测试
• npm run check:all：完整质量门禁检查
• npm run dist:win：打包 Windows 安装包

打包发布（Windows）

npm run dist:win

安装包输出目录：

• release/

默认安装包文件名示例：

• UConfigTool Setup 1.0.0.exe

导出目录结构（示例）

当在应用中执行导出后，目标目录下默认会生成：

• 类型文件夹/：按所选语言输出类型代码
• 配置表文件夹/：按所选配置类型输出 JSON 配置表

项目结构（简要）

• src/renderer/：渲染层界面与交互逻辑
• electron/main/：主进程（窗口、IPC、配置存储、导出服务）
• electron/preload/：安全桥接 API（window.appApi）
• shared/：主/渲染共享类型与协议
• docs/：架构、规范、发布文档

文档索引

• 架构说明
• 开发约定
• 上手指南
• 发布说明
• 项目结构
• 详细结构说明

开源维护建议

建议在 Gitee 仓库中补充以下内容，便于公开协作：

• LICENSE（推荐 MIT）
• CHANGELOG.md
• CONTRIBUTING.md
• CODE_OF_CONDUCT.md（可选）
• Issue / PR 模板（可选）

贡献方式

欢迎提交 Issue 和 Pull Request：

1. Fork 仓库并创建功能分支
2. 完成开发并通过本地检查（npm run check:all）
3. 提交 PR，说明变更目的与影响范围

免责声明

本项目按“现状”提供，使用者需根据自身业务场景进行验证与适配。

常用游戏引擎支持说明

本工具可用于多种游戏项目的配置表管理与代码导出

• Unity（C#）：优先导出 C# 类型定义与 JSON 配置，建议在客户端通过加载配置文件并反序列化到强类型对象使用。
• Unreal Engine（C++）：可导出 C++ 类型定义与 JSON 配置，建议在工程内封装统一配置加载模块，处理字段默认值与版本兼容。
• Cocos Creator（TypeScript / JavaScript）：优先导出 TypeScript 类型定义与 JSON 配置，便于在前端脚本中获得类型提示与校验。
• Godot（GDScript / C#）：推荐导出 JSON 配置，并按项目需要搭配 C# 或脚本侧结构映射进行读取。
• 自研引擎：可基于现有导出结构接入任意运行时，建议通过中间层统一字段转换与热更新策略。

建议实践：

• 在仓库中固定配置导出目录（如 Config/Generated/），避免手工文件分散。
• 将“配置源文件、导出脚本、运行时加载代码”一并纳入版本管理，便于多人协作与回溯。
• 通过 CI 在提交或发版前执行配置导出与结构校验，降低线上配置错误风险。