PrefabDocumenter公開

 

 

こんにちは、exiiiでソフトウェアエンジニアインターンをしている太田です!

今回は、Unityのアセットにドキュメントを付けられるエディタ拡張を作りましたのでご紹介します。

 

 

概要

Unityによってメタファイルが作られるアセットに対応してドキュメントをつける事ができます。

PrefabDocumenterは3つの種類があり、それぞれ役割が異なります。

 

PrefabDocumenter

 

  • PrefabDocumenterの本体です。
  • PrefabDocumenterそのものはUnityを必要としませんが、ターゲットとなるアセットはUnityにメタファイルを作成して貰う必要があります。
  • メタファイルを読み込み、ファイル構成の記録や下書きのテンプレートファイルの出力、データベースの出力を行います。

 

 

PrefabDocumenterPage

PrefabDocumenterPage 

  • PrefabDocumenterから出力されたデータベースを読み込み、表示するサイトです。
  • netlifyがmasterブランチを追従してホスティングしています。

 

uPrefabDocumenterViewer

uPrefabDocumenterViewer

  • Unityエディタの拡張です。
  • PrefabDocumenterから出力された下書きファイルを読み込み、表示したり書き込んだりすることが出来ます。

 

使い方

  1. GitHubのリリースページから最新のPrefabDocumenterをダウンロードします。
  2. PrefabDocumenterのREADME.mdに書かれている手順でデータベースを作成します。
  3. PrefabDocumenterPageでデータベースを読み込み、表示することができます。
  4. 他に、DraftをuPrefabDocumenterViewerに読み込ませることで編集や表示をすることができます。

 

出力されるファイルのデータ構造

  • MetaFileTree
    • <MetaFiles> : MetaFileの親
    •  SelectFolderPath : 指定したフォルダの絶対パス
      • <MetaFile> : metaファイル
      • Name : メタファイルと対応付けられたファイルの名前
      • Path : メタファイルまでのパス
      • Guid : Unityによって生成されるGuid
      • Type : File、もしくはFolder。未実装
  • Draft
    • <MetaFiles> : MetaFileの親
      • <MetaFile> : metaファイル
      • Name : メタファイルと対応付けられたファイルの名前
      • Guid : Unityによって生成されるGuid
        • <Description> : 中に説明文を入れる。

 

  • データベース
    • テーブル定義  : |guid TEXT PRIMARY KEY NOT NULL|filename TEXT NOT NULL|filepath TEXT NOT NULL|indentlevel INT NOT NULL|description TEXT|
    • indentlevelはまだ未実装

 

おわりに

ソフトウェアとしてまだまだ荒削りですが、是非活用してみて下さい。