ブループリントをドキュメント化するプラグインです。
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Binaries/Win64
Config
Content/Sample
Plugins/BlueprintToDoc
Source
BlueprintToDocSample.uproject
LICENSE
README.md

README.md

BlueprintToDoc

ブループリントをドキュメント化するプラグインです。

プラグインの追加

PluginsフォルダにあるBlueprintToDocを任意のPluginsフォルダにコピーして下さい。
エディタ起動後にBlueprintToDocのボタンが追加されていること確認して下さい。
表示されていなければ、プラグインブラウザからプラグインを有効にしてく下さい。

ドキュメント化の手順

エディタに追加された「BlueprintToDoc」ボタンを押して下さい。
ドキュメント化が終了したらダイアログが表示されます。

各種設定

ProjectSettingsのPlugins – BlueprintToDocで設定ができます。

  • Document Root Path ドキュメントの出力フォルダの指定
    ドライブ名の指定がなければプロジェクトからの相対パスになります。
  • Content Paths ドキュメント化するアセットの階層を個別に指定することができます。
    /Game/がContentフォルダのルートになります。
  • Listup Categories カテゴリ名をもとにプロパティをリストアップすることができます。
    使用例として、調整パラメータをカテゴリ「Settings」に設定すると、
    全てのブループリントの調整パラメータの一覧を作ることができます。

ドキュメントの使い方

ドキュメントの出力先にあるindex.htmlファイルを開くと作成したドキュメントを見ることができます。