# configoo

**Repository Path**: pipiaha/configoo

## Basic Information

- **Project Name**: configoo
- **Description**: 游戏配置文件解析器
文件解析
转码csv sql json lua
内容+格式检查
- **Primary Language**: Rust
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-15
- **Last Updated**: 2023-11-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# configoo

#### 介绍

游戏配置文件解析器

文件解析

转码csv sql json lua

内容+格式检查

### Roadmap

| func              | status | notes                                                       |
|-------------------|--------|-------------------------------------------------------------|
| 解析excel配置         | ✅      | 使用[calamine](https://crates.io/crates/calamine)读取配置表为指定格式数据 |
| 生成csv             | ✅      | csv                                                         |
| 生成go代码            | ✅      |                                                             |
| 使用模板生成            | ✅      | ~~handlebars/~~[tera](https://tera.netlify.app/docs)        |
| buildArgs         | ✅      | 使用builder模式                                                 |
| csvExporter使用通用入口 | 🚧     | 统一导出流程，拆分构建步骤并支持自定义;完成sql/json模式                            |
| 自定义代码生成           | 🚧     | 自定义外部模板加载；自定义语言支持；自定义模板参数modify；自定义writer                   |
| 自定义配置导出           | 🚧     | 自定义参数modify;自定义writer;(参考LangExporter)                      |
| 终端                | 🚧     | clap                                                        |
| ui终端              | -      | vue3+ElementPlus                                            |
| tauri插件集成桌面版      | -      |                                                             |
| 自定义模式+插件化         | -      | 使用拦截器+管道流处理；自定义代码模板；自定义文件输出；自定义命名规则；自定义输出路径；                |

### 需求

1. 准备流程：

* 选择文件类型xls/xlsx/xml/json/lua;
* 选择输出
    * 文件
        * 文件名产生器
        * 内容产生器
            * 输出sql
            * 输出csv
            * 输出lua
            * 输出json
        * 输出路径
    * 格式
        * 内容产生器
            * java
            * c#
            * 其他自定义
        * 输出路径

* 选择文件上传方式 单个/批量；
* 选择文件头解析方式
    * xls/xlsx ：
        * 首行格式+次行名称+格式解析器
        * 首行格式+首行名称+格式解析器
        * 首行名称+次行格式+三行格式+格式解析器
    * xml/json：
        * 行名称key+行类型key+格式解析器;
    * lua/csv：
      没想好

2 解析流程

* 参数读取
* 上下文构建
* 文件加载
* 文件解析
* 内容输出

3. 解析转码

```
    in
    读取文件夹，过滤文件
    读取单个文件
    文件类型支持： xlsx/xls/csv
    命名方式：文件名/sheet名 + 自定义前后缀
    
    parse
    表头行
    类型行/无类型
    前后类型分离

    out
    输出json
    输出sql
    输出csv

```

#### 软件架构

软件架构说明

#### 安装教程

1. xxxx
2. xxxx
3. xxxx

electron+vue 环境安装

* 工程目录下添加文件 `vue.config.js`
* `src`目录下添加`background.js`

* electron 版本选择了v11.1.1；
* vue-cli-plugin-electron-builder版本选择了2.0.0-rc.5；
* 多次使用npm安装均失败，效果奇差。这里选择yarn，并使用了代理fq，为WebStorm配置了Proxy；
* 执行 `yarn add electron` 或 `npm install electron`
  （没代理fq可以尝试 [切换yarn源](https://zhuanlan.zhihu.com/p/108370177) ）；
* 运行`electron`命令检查安装结果；
* 执行 `vue add electron-builder`；

参考

[vue-cli-plugin-electron-builder](https://github.com/nklayman/vue-cli-plugin-electron-builder/tree/v2.0.0-rc.4)

[electron](https://github.com/electron/electron)

#### 使用说明

1. web调试
2. web打包
3. electron+vue调试

To start a development server:
If you use Yarn (strongly recommended):

```shell script
yarn electron:serve
```

or if you use NPM:

```shell script
npm run electron:serve
```

4. electron+vue打包

To build your app:
With Yarn:

```shell script
yarn electron:build
```

or with NPM:

```shell script
npm run electron:build
```

To see more
documentation, [visit our website](https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/guide.html)

electron+vue 的调试和打包，还可以使用`package.json`中的命令：

```json
{
  "electron:build": "vue-cli-service electron:build",
  "electron:serve": "vue-cli-service electron:serve"
}
```

即：

```shell script 
    vue run electron:build
    vue run electron:serve
```

打包过程中，首次使用`electron-builder`有可能会卡在下载
`electron-xx-xx.zip` ,`winCodeSign-xxx.gz`, `nsis-xx.gz`,`nsis-resource-xx.gz`上，
手动下载后，放在

* windows 分别放在`C:\\user\AppData\electron\Cache\`下,
  `C:\\user\AppData\electron-builder\cache\winCodeSign\`下（需要解压）
  `C:\\user\AppData\electron-builder\cache\nsis\`下（需要解压）
  `C:\\user\AppData\electron-builder\cache\nsis\nsis-resources\`下（需要解压）
* MacOS `~/Library/Caches/electron/`

[参考](https://blog.csdn.net/cctvcqupt/article/details/87904368)

#### rust参考

* [awesome-rust](https://github.com/rustcc/awesome-rust)