UnityでExcelの内容をScriptableObjectに一発変換！Unity-QuickSheetの使い方！

2024年12月17日

ころもちゃん

パラメータの管理をエクセルでやっているけど、このエクセルの内容をUnityに一発で反映させたい！

本記事の内容

・ScriptablObjectとは？
・ExcelからScriptablObjectに変換するアセット、「Unity-QuickSheet」の使い方

ScriptableObjectとは？

ScriptableObjectはパラメータなどの設定値をまとめて管理できるデータベース

ゲーム内でアイテムや武器などの複数のバリエーションを持つオブジェクトを管理するには、ScriptablObjectを使用するのがオススメです。

ScriptableObjectの作り方については以下の記事で解説しています。

Unity-QuickSheetの使い方

Excelから取り込む方法

アセットのインストール

まずは下準備です。
アセット自体は以下のGitHubにあります。このページには導入方法が書いていないです。

上記のリンクを開き、Code > DownloadZipを選択。

ダウンロードが完了したら解凍し、Assets > QuickSheet のフォルダをUnityにインポートします。

これでインストールは完了です。

エクセルファイルの準備と取り込み

次に、ScriptablObjectに設定したExcelファイル準備します。
今回はサンプルとして以下のようなエクセルを用意しました。

ItemParameter ダウンロード

まずは、このExcelをUnityに放り込みます。

Excelを開いていると、~$から始まるファイルが生成されることがあります。
これは一時ファイルで、Excelファイルを閉じると削除されます。Gitでプッシュするときにこの一時ファイルがあるとエラーになることがあるので、一区切り付いたらExcelの設定ファイルはこまめに閉じておくことをオススメします。

次に、いま取り込んだExcelをインポートする設定を行っていきます。
プロジェクトウィンドウで右クリックを押して

Create > QuickSheet > Tool > Excelと進みます。

すると、「New Import Setting」というファイルが生成されます。これが、Excelのインポート設定です。
Fileから対象のUnityに取り込んだExcelファイルを選択し、WorkSheetを選択します。

Runtime、Editorの欄には、QuickSheetが自動で生成するスクリプトが格納されるパスを指定します。
今回は、Data/Runtime と Data/Editorというパスを選択しました。

この状態で、Importボタン を押します。すると、以下のようにExcelで設定したヘッダが表示されます。

Typeから型を選択します。

今回、UseItemTypeにはEnumを設定したいので、対応するEnumを以下のように作成しました。

public enum UseItemType 
{
    Heal,
    Attack,
    Important,
}

そして、Typeを以下の画像のように、適切な値でセットします。UseItemTypeにEnumを使っています。

これで準備は完了です！

ScriptablObjectを自動生成する

ScriptablObjectを生成するにはここからまた一癖あるので解説。
ここまでの準備が出来たら、Generateボタンを押します。

すると、Runtime、Editor欄に指定したパスに新規にフォルダとScriptablObjectの元となっているスクリプトファイルが生成されています。

Generateボタンを押しただけだと、スクリプトファイルは出来ますが、ScriptablObjectは作成されていません。最初私は引っかかりました。
ですが、Excelファイル側の値を何かしら更新+保存を行うと、自動でScriptablObjectがExcelと同じフォルダに生成されます。やったね。