はじめに

私は開発する際のメモや設計内容をMarkdown形式でまとめています。

しかし、Godotで開発中に設計書を確認しようとすると、
ブラウザや別エディタ（VS Codeなど）を頻繁に行き来する必要があり、
集中力が削がれるのが悩みでした。

「Godotエディタ内で完結させたい！」と思い調べてみたところ、
「Markdown Book」 という最高のアドオンを見つけたのでご紹介します。

　
このアドオンを導入すれば、
プロジェクト構造と密接に連携した仕様書やメモを、
Godotエディタ内の専用ビューアでいつでも確認できるようになります。

1. 必要なアドオンの準備

Markdown Book は、描画エンジンとして別のアドオンに依存しています。

以下の2つをインストールしてください。

MarkdownLabel (by Daenvil)
MarkdownをRichTextLabelとして描画する核となるライブラリ。
Markdown Book (by phnix-dev)
mdBook形式のディレクトリ構造をエディタ内に表示するUI。

インストール手順

Godot上部の 「AssetLib」 タブをクリック。
MarkdownLabel を検索し、ダウンロード＆インストール。
同様に Markdown Book を検索し、インストール。

注意：有効化の順番
MarkdownLabel を先に有効化しないと、Markdown Book の有効化時にエラーが出る場合があります。必ず MarkdownLabel → Markdown Book の順で有効化してください。

2. プロジェクト設定

インストール後、以下の設定を行うことで利用可能になります。

１） プラグインの有効化

プロジェクト -> プロジェクト設定 -> プラグイン タブで両方を「有効」にチェック。

　
２） ドキュメントフォルダの指定

一般 タブに切り替え、右上の 「高度な設定 (Advanced Settings)」 をONにします。
左リストの下方にある Addons -> Markdown Book を選択。
Docs Folder に、ドキュメントを保存するディレクトリを入力します。

例: res://docs
Tips: ここにフルパス（C:\... など）を指定すると、プロジェクト外で共通管理しているドキュメントも参照可能です。これは複数プロジェクトを並行開発する際に非常に便利です。

３）エディタの再読み込み

設定反映のため、プロジェクトを保存して開き直す（Reload）と確実です。上部メニューに「Markdown」というボタンが出現します。

3. ディレクトリ構造の作成（mdBook準拠）

Markdown Book は、Rust製のドキュメントツール mdBook のルールに従うと本領を発揮します。
指定した docs/ フォルダの中に、以下のような構成を作ってみましょう。

res://docs/
├── SUMMARY.md   # ここが「目次」になります
├── intro.md     # 個別の記事
└── design/
    └── system.md

SUMMARY.md の書き方

このファイルがサイドバーのメニュー（目次）として機能します。

# Summary

- [イントロダクション](intro.md)
- [システム設計](design/system.md)
- [AI壁打ちログ](brain_storming/log_01.md)

4. 実際の活用例：開発効率を上げる運用術

① 「思考ログ」と「決定事項」を分ける

開発中、AIとチャットで壁打ちした内容などは、そのまま brain_storming/ フォルダに放り込みます。
その中から「よし、この数値で行こう」と決まった仕様だけを specifications/ に清書して整理します。
これらを分けることで、実装中に「結局どれが最新の決定事項だっけ？」と迷うことがなくなります。

② 図解（Mermaid）の扱い方

現時点で、本アドオンはMermaid記法の直接レンダリング（図形化）には対応していません。
しかし、以下のように運用することで設計効率を維持できます。

VS Code等で表示してスクショを貼る: Markdown内に ![構成図](path/to/image.png) で画像を埋め込めば、エディタ上でも視覚的に確認できます。
テキストとして管理する: レンダリングはできずとも、Mermaidのコード（テキスト）自体は表示されます。設計の「構造」をロジックとして確認する分にはこれだけでも十分役立ちます。

まとめ

Markdown Book を導入することで、「コードを書く場所」と「考える場所」が統合されます。
特に大規模なロジックや、複雑なアルゴリズムを扱うゲーム開発において、この「1秒で仕様を確認できる環境」は強力な武器になります。

ぜひ皆さんも、Godotエディタ内での快適なドキュメントライフを送ってみてください！