How to work with Excel

This post shows and helps you how to set up and use Unity-QuickSheet with excel.

Excel versions 97/2000/XP/2003 are suppported for '.xls' (due to that NPOI, an open source project used to read excel spreadsheet for Unity-QuickSheet does not support Excel versions 5.0/95 for '.xls') It's doesn't matter with '.xlsx'

Before starting, check your spreadsheet page again. It should start without an empty row which means the first row should not be an empty one.

Step 1) Create Excel Setting File

First you need thing to do is creating an excel setting file. Simply right click on the Project view and select 'Create > Spreadsheet Tools > Excel'. It creates a new file which shows various setting to create script files and get data from the specified excel file.

Select Excel menu item then it creates setting file. It may be shown like the following:

Let's start to do settinig.

File Setting

File setting is setting for what excel file and its sheet page to import.

First you should specify what excel file to import.

Select an excel file to import with File Open Dialog.

An excel file can have one or more sheet pages so you need to decide what sheet you select and retrieve data from.

Select a sheet page you want to import.
Press Import button imports the specified excel file and shows all column headers.

Type Setting

Importing the specified sheet page shows all column headers of the page. That are neccessary to let you set the type of the each cells.

Set the proper type of the cells.

Currently the following types are supoorted:

string
int
float
double
enum
bool

Path Setting

Path setting are concerned with specifying paths where the generated script files are put.

Note: All paths should be relative without 'Assets/'.`

Template indicates a path where template files which are neccessary to generate script files. In most case you don't need to change it.
Runtime indicates a path where generated script files which are used on runtime will be put.
Editor inidicates a path where generated script files which are used on editor mode will be put.

Step 2) Generating Script Files

If you've done all necessary setting, it's time to generate some script files which are needed for reading data in from the sheet page of the excel file and to store that within ScriptableObject which is being as an asset file in the Project View.

Press Generate button.

After generating some script files, Unity Editor starts to compile those. Wait till Unity ends doing compile then check the specified Editor and Runtime paths all necessary script files are correctly generated.

In Editor folder should have contain two files:

your-sheetpage-nameAssetPostProcessor.cs
your-sheetpage-nameEditor.cs

In Runtime foller should have contain tow files:

your-sheetpag-name.cs
your-sheetpage-nameData.cs

See the your-sheetpage-nameData.cs file. The class members of the file represent each cells of the sheet page.

using UnityEngine;
using System.Collections;

[System.Serializable]
public class FighterData
{
    [SerializeField]
    int meleeskilllevel;

    [ExposeProperty]
    public int Meleeskilllevel {
        get {return meleeskilllevel; }
        set { meleeskilllevel = value;}
    }

    [SerializeField]
    int str;

    [ExposeProperty]
    public int STR { get {return str; } set { str = value;} }

    ...
}

Step 3) Importing Spreadsheet Data

Creating asset file and importing data from the spreadsheet file into that created asset file is done just by simply doing reimport any xls or xlsx file within Project view.

Reimporting xls or xlsx file will automatically create an asset file which has same file name as the sheet page name(not excel file name) and automatically import data from the sheet page of the excel file into the created asset file.

It's done. Hope you enjoy that!

Excel Howto