NPC をコーディングして領地経営するゲーム開発(Lua の使い方ドキュメントを書く)
ゲーム中でドキュメントを表示するための仕組みを実装します。
やりたいこと
こんな感じで API を表示する仕組みはもう実装してあります。
ただ、ブログみたいな長めの説明を表示する仕組みはないので実装します。
Unity でドキュメントの項目を処理する
まず、ドキュメントのタイトルをツリービューに表示できるようにしました。
↓ドキュメント名をツリービューに表示する。
よいです。
Unity でドキュメントの内容を表示する
次に表示するドキュメントの作成です。これは Markdown フォーマット記述したファイルを表示できる仕組みにします。
処理概要としては、編集した md ファイルを Python スクリプトで Unity で処理しやすいフォーマットに変換して、それを Unity で読み込んで利用するようにしました。
↓最終的に Unity で表示されたもの
よいです。
レイアウト調整とかコードの予約語の色付けはまた後でやります。
まとめと今後の予定
Markdown フォーマットでドキュメントを作って、それを表示する仕組みを実装しました。これでドキュメントを書けるようになりました。
書くべきドキュメントが多すぎて悩ましいのは、未来の自分にがんばってほしいです。
がんばります。