# ExcelToUnity

**Repository Path**: gusuri/excel-to-unity

## Basic Information

- **Project Name**: ExcelToUnity
- **Description**: Unity游戏开发的Excel导入脚手架
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-01-15
- **Last Updated**: 2025-01-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ExcelToUnity

#### 介绍
如果你在Unity中开发游戏，并且想使用Excel配置游戏数据，还想在游戏中方便的使用Excel数据，甚至可以轻松配置一键导入，那这正是你想要的。
原本的插件名称是 UnityQuickSheet ，来源暂未找到。后续由海螺完成修改使其更简便。

#### 如何移植插件到自己的项目中并使用
1. 将 _QuickSheet_ 文件夹移动至自己项目的 _Assets_ 目录下
2. 点击菜单第一项 _Tools/Excel/Create Init Folder_ 完成准备工作
    1) 该操作会在 _Assets_ 目录下建立 _Excel_ 文件夹，并在Excel文件夹下建立预备目录
    2) 同时会在 _Resources_ 目录下建立 _Excel_ 文件夹，用于存储最后的*.asset文件
3. 在 _Assets/Excel/A_Excel_ 中就可以放置你的表格了，必须以 _.xlsx_ 结尾。这里可以用我准备好的两个表格 _Level.xlsx_ 和 _Example.xlsx_ 
    1) 可以观察到 _Level.xlsx_ 文件下有 _Monster_ 和 _Build_ 两个表格，而 _Example.xlsx_ 文件下只有 _ExcelExample_ 一个表格
    2) 导入是以表格为单位的，这样的配置最后会导入3个表格。且都以表格名字命名而非文件， **请务必确保表格名字之间不重名** 
4. 点击菜单第二项 _Tools/Excel/Generate Excel Intermediate Files_ 可以将Excel的配置信息生成
5. 点击菜单第三项 _Tools/Excel/Reimport Excel Files_ 导入全部表格数据，这项通常在执行完第二项之后点击。平时修改表格后其实不用点这项也会自动执行的。
6. 点击菜单第四项 _Tools/Excel/Update Excel.cs_ 生成集合文件，用于在模块外部一键使用。
    1) 该文件会生成在 _Assets/Excel/Excel.cs_ 中
7. 点击菜单第五项 _Tools/Excel/Delete Generate Files_ 用于清除所有前几步生成的内容，但这并不会清除你的xlsx文件
8. 在使用时，你需要首先执行 Excel.Init(); 将数据加载到程序中
9. 最后你可以在任意位置通过 Excel.XXX[] 来访问数据了

#### 表格规则
1. 表格必须满足
    1) 第一行 – 字段名
    2) 第二行 – 注释名
    3) 第三行 – 字段类型 Undefined, String, Short, Int, Long, Float, Double, Enum, Bool,
    4) 字段类型需满足ScriptPrescription.cs文件下的CellType类型，还可设置为数组
2. 若一个xlsx文件下有多个sheet，则都会被加载。
3. 最终的数据名称以sheet名为准，请务必保证所有的Sheet名不重复