Documentation or Tutorial for Excel Importer

Announcements, support questions, and discussion for the Dialogue System.
Post Reply
LostContinentGames
Posts: 15
Joined: Tue Oct 29, 2024 5:28 am

Documentation or Tutorial for Excel Importer

Post by LostContinentGames »

Hello,

I've been looking at ways to streamline the conversation creation process for my game. I've been copying and pasting from a word document or writing directly into DialogueSystem in Unity, but I don't think these are efficient methods.

My game pretty much only uses linear conversations, so I think that the excel import is a good option for me; However, I can't find any documentation on how to actually use it once it's installed (if I can even install it correctly!). I'm also unfamiliar with Unity-Quicksheet, and the GitHub doesn't seem to cover installation.

Anyway, I think the excel import could be very helpful, so do you have any resources that can help me get going with it?

Thank you!
User avatar
Tony Li
Posts: 23238
Joined: Thu Jul 18, 2013 1:27 pm

Re: Documentation or Tutorial for Excel Importer

Post by Tony Li »

Hi,

Documentation is included in the unitypackage. I'll paste a copy here, too:

---

This editor window imports linear conversations from an Excel file into a dialogue database.


SETUP:
------
1. Download Unity-QuickSheet: https://github.com/kimsama/Unity-QuickSheet
To download, open that URL. Click the green Code button and click the Download button.
After downloading, unzip the ZIP file.

2. Then put the "Quick Sheet" folder and "Quick Sheet.meta" files somewhere in your
project's Assets folder, such as in Assets / Dialogue System Extras / Excel Conversation Importer.
You can ignore the other files and folders found in the ZIP file if you like.

3. Unity 2020+ includes a built-in package that conflicts with UnityQuickSheet's GDataPlugin.
To get UnityQuickSheet and the Excel Conversation Importer to work with Unity 2020+, after
adding the Quick Sheet folder to your project, delete the subfolder named "GDataPlugin".
In Unity 2019 and older, you can skip this step.

4. Then select menu item Tools → Pixel Crushers → Dialogue System → Import → Excel.


FORMATTING YOUR FILES:
----------------------
The Excel file should have one conversation per worksheet, where the first column is the Actor
and the second column is the Text.

The first row is ignored. You can use it for notes describing the conversation, or for headers
"Actor" and "Dialogue Text".

By default, each conversation's title will be the same as its worksheet name.
If you want to specify a different title (for example, to include forward slashes, which
Excel doesn't support in worksheet names), tick the importer's Second Row Is Title checkbox.
Then, in the second row, set column A2 to "Conversation" and column B2 to the title.


EXAMPLE FILES:
--------------
The Examples folder contains two Excel files:

- Hello1.xlsx: Importable when Second Row Is Title is UNticked.
- Hello2.xlsx: Importable when Second Row Is Title is ticked.
- Hello3.xls: Same as Hello2 but in XLS format (which QuickSheet on MacOS can read).
Post Reply