ドキュメント
ドキュメントは、プロジェクトの知識を長文で記録するためのプロジェクト所有 Markdown ファイルです。.md ファイルが常に権威のあるソースであり、外部テキストエディタとも互換性があります。
所有権とストレージ
Section titled “所有権とストレージ”すべてのドキュメントは <Project>/ProjectDocuments/ 以下にあります。共有またはプライベートのドキュメントスコープはありません。/Game/... 以下のコンテンツブラウザフォルダーは ProjectDocuments/Content/... 以下の対応するパスにマッピングされます。Developers フォルダーもプロジェクトコンテキストであり、プライベート所有権を示すものではありません。
ドキュメントは UAsset、パッケージ、リダイレクタ、ランタイムオブジェクト、クックデータの所有者ではありません。Locus が Markdown を別の権威のある形式で包むこともありません。
Locus ドキュメントとコンテンツブラウザのルート
Section titled “Locus ドキュメントとコンテンツブラウザのルート”ドキュメントツリーには、同じ物理リポジトリ上に 2 つの表示ルートがあります。
- Locus ドキュメントには、予約された
Content/サブツリーの外に保存された通常のプロジェクト所有ドキュメントが含まれます。これらは Locus 内だけに存在し、Unreal のコンテンツブラウザには投影されません。 - コンテンツブラウザには、権威のある相対パスが
Content/で始まるドキュメントだけが含まれます。Locus はツリー上で内部ストレージの接頭辞を隠すため、ProjectDocuments/Content/Blueprints/AI/Behavior.mdは コンテンツブラウザ > Blueprints > AI > Behavior と表示され、/Game/Blueprints/AIに投影されます。
コンテンツブラウザのルートは疎で、ドキュメントを基準に作られます。投影された Locus ドキュメントを直接含むフォルダーと、そこへ到達するために必要な祖先だけを表示します。無関係な /Game フォルダーをミラーリングせず、派生した表示フォルダーを削除しても対応する Unreal フォルダーは削除または変更されません。
投影は、ファイル作成に使った UI ではなく権威のある相対パスに従います。起動時に検出されたマッピング済みドキュメント、Locus で作成したドキュメント、Add > Locus > Locus ドキュメント から作成したドキュメント、インポートしたドキュメント、MCP から作成したドキュメントは、同じインデックス ID と投影動作を持ちます。
ドキュメントを作成して探す
Section titled “ドキュメントを作成して探す”Locus 専用のドキュメントは Locus ドキュメントの下に作成します。対応する /Game コンテキストに投影するマッピング済みドキュメントは コンテンツブラウザの下に作成します。対応するコンテンツブラウザフォルダーで Add > Locus > Locus ドキュメント を使うと、同じマッピング済み ID が作成されます。Locus は実際の外部 .md ファイルを作成し、通常の UI では拡張子を隠して専用のエディタタブを開きます。Markdown のインポートと MCP で作成したドキュメントは、同じローカルの 未追跡作成ポリシーに従います。
ソースコントロールに追加する前に、新しいドキュメントを整理します。
作成 → 名前変更、移動、編集 → パスが確定したら追加用にマーク
ワークスペースは物理フォルダーを参照し、タイトル/パス検索、ステータスフィルター、更新、開く、名前変更、移動、削除、チェックアウト、追加用にマーク、インポート、エクスポートに対応します。複数のドキュメントタブを同時に開けます。すでに開いているパスを開くと、既存のタブにフォーカスします。
インポートするには、コンテンツブラウザの Locus アクションを使い、有効な UTF-8 の .md ファイルを 1 つ選びます。Locus はソースのバイト列と改行を保持し、保存先に同名ファイルがある場合は安全な連番名を使います。
ドキュメント ツールバーは 1 行のままです。優先順位の低いアクションは、徐々に その他の操作 に移動します。 エクスポート と 更新 はそこに残ります。プロバイダーが構成されていない場合、ソース管理アクションは存在しません。
編集して保存する
Section titled “編集して保存する”新しいドキュメントまたは空のドキュメントは 編集モードで開き、内容のあるドキュメントは 閲覧モードで開きます。Ctrl+E で編集モード、Ctrl+R で閲覧モード、Ctrl+S で保存します。ドキュメントはノートのような自動保存ではなく、明示的に保存します。
ソースエディタには、見出し、強調、インラインコードとフェンス付きコード、順序付き/順序なしリスト、タスクリスト、引用、リンク、テーブル、水平線、アセット参照、ピン参照のコマンドがあります。分割プレビューは短い更新遅延の後に、現在保存されていないバッファをソースの横に表示します。プレビューを開いたり更新したりしてもファイルは保存されません。
編集 では、コンパクト ツールバーは 見出し、太字、斜体、インラインコード、箇条書き、番号付きリスト、外部リンク、アセット参照、および ピン参照 を提供します。他のコマンドは 書式 に残ります。 プレビューを分割 は、短いデバウンスの後、保存せずに現在のバッファをソースの横にレンダリングします。その分周器、開いた状態、比率は個人的な好みです。
閲覧モードと Markdown のサポート
Section titled “閲覧モードと Markdown のサポート”閲覧モードは Unreal のネイティブ UI を使います。エディタツールバーに必要な Markdown 構文として、見出し、段落、強調、強い強調、リスト、表示専用のタスク項目、引用、コード、リンク、配置付きテーブル、水平線、取り消し線に対応します。
Locus はブラウザと同等または完全な Markdown レンダリングを保証しません。生の HTML は実行されないソーステキストとして残り、JavaScript は実行されず、安全でない URL スキームは有効化されず、リモートコンテンツは自動取得されません。HTTP と HTTPS のリンクは、オペレーティングシステムのブラウザで明示的なユーザーアクションを行った場合だけ開きます。
アセット参照とピン参照は表示時に可読ラベルを使います。現在のマップのピンにはフォーカスでき、別のマップのピンは自動的に読み込まずに所有するレベルを特定できます。見つからない参照は実行されず、診断可能な状態で残ります。
解決済みアセット、ピン、ノート、ドキュメント、および Actor 参照では、読み取り可能なラベルが使用されます。 Actor 参照は、ロードされた 1 つの適格な World Outliner Actor を編集モードで ドキュメント にドロップすることによってのみ作成されます。 参照を挿入 または @ では提供されていません。生の HTML と JavaScript は実行されず、リモート コンテンツはフェッチされません。
名前変更、移動、削除
Section titled “名前変更、移動、削除”名前変更と移動はドキュメントルート内で行います。名前変更可能な未追跡ドキュメントでは、ツールバーまたはコンテキストメニューの 名前変更、F2、ツールバーの 移動、または有効な既存フォルダーへのドラッグを使えます。名前変更や移動の権威のある場所は Locus ドキュメントワークスペースです。コンテンツブラウザの項目は投影であり、コンテンツブラウザから直接名前を変更することはサポートされません。
追加用にマークした後は、名前変更と移動を意図的に利用できなくします。管理対象のドキュメントでも同様に利用できません。Locus はプロバイダーに依存しないトランザクション形式のソースコントロール移動を保証できないためです。この安全境界により、ファイルシステムの変更でドキュメントとソースコントロールの同期が失われることを防ぎます。未保存または競合中のドキュメントを開いている場合も、ワークスペースでの名前変更、移動、削除はブロックされます。
削除は永久的で確認が必要であり、Unreal を通じて元に戻すことはできません。追跡対象ファイルの場合、Locus は状態を検証し、ローカルのクリーンアップ前にアクティブなプロバイダーを通して削除します。
パスの変更は、ローカルまたは Untracked ドキュメント でのみ使用できます。 Locus はプロバイダーに依存しないデポの移動やパス間のオープン状態の転送を実行しないため、追加用にマーク またはプロバイダー制御の後は、名前変更と移動が無効になります。
エクスポート
Section titled “エクスポート”選択したドキュメント、フォルダー、すべてのドキュメント、またはエディタのコピーをエクスポートできます。エクスポートは現在のソースを保持し、コピーをエクスポートする場合は保存されていないエディタバッファも含められます。フォルダー構造も保持できます。保存先を ProjectDocuments 内にすることはできません。衝突時の選択肢は上書き、スキップ、連番コピーです。エクスポートで元のドキュメント、そのタブ、ソースコントロールの状態が変わることはありません。
復旧と外部編集
Section titled “復旧と外部編集”Locus はドキュメントの復旧データを <Project>/Saved/Locus/Recovery/ドキュメント/ に保存します。保存に成功すると対応するスナップショットを削除します。外部で変更され、ローカルに未保存の変更がない場合は再読み込みされます。未保存のローカルテキストと衝突する外部変更がある場合は、安全な解決を選ぶまで保存がブロックされます。
.md が権威のある形式であるため、外部エディタに対応しています。外部ファイル操作後にワークスペースがすぐに更新されない場合は検出を更新してください。Editor のタブは Unreal Editor の再起動後に自動復元されません。
新しい Locus ドキュメント は、アクティブまたは最近アクティブな Locus ドキュメント タブ スタックを優先します。同じ正規化されたパスは、既存のタブに焦点を当てます。タブは自由にドッキング可能なままですが、エディターを再起動しても復元されません。
選択したドキュメントのプレビュー
Section titled “選択したドキュメントのプレビュー”ドキュメントを選択すると、ワークスペースの詳細パネルに読み取り専用の Markdown プレビューが表示されます。保存済みの権威のあるファイルを表示するため、内容を読むか編集するには専用のドキュメントエディタを使います。通常の短い選択切り替え中は、選択した内容の準備が整うまでプレビューは中立状態に保たれます。約 1 秒を超えて待った場合だけ、古い内容ではなく、ネイティブの簡潔な読み込み説明が表示されます。
ドキュメントのファイル名とパスがワークスペースでの ID になります。Markdown の見出しはコンテンツなので、ファイル名を変更すると表示上のファイル名は更新されますが、# My Title のような見出しは書き換えません。
ドキュメント エディターの 表示 メニューでは、ソースフォントサイズ はソース エディターに影響し、閲覧フォントサイズ は完全な読み取りと分割プレビューに影響します。 Ctrl+mouse wheel は、該当するビューを調整します。
ソースコントロール
Section titled “ソースコントロール”ドキュメントはプロジェクト所有です。新しく作成したドキュメントは 追加用にマークを明示的に選ぶまで 未追跡のままなので、パスが変化している間に整理できます。ローカルまたは未追跡のドキュメントはローカルモードで正当に編集できます。追加用にマークが失敗しても、有効な Markdown はそのまま残り、再試行できます。
既存のデポ管理ドキュメントは読み取り可能ですが、チェックアウトに成功するまで権威のある 編集モードや 保存には入れません。ドキュメントがクリーンでチェックアウトされていない、別のユーザーまたはクライアントがチェックアウトしている、古い、またはプロバイダーから切断されている場合、Locus はこれらのアクションを利用できないままにします。書き込み可能にする回避策はありません。該当する場合は 閲覧モードと コピーをエクスポートを利用できます。
ソースコントロールへ再接続したら、更新すると管理対象の状態が戻ります。チェックアウトに成功するまで、ドキュメントは読み取り専用のままです。Locus は送信、同期、チェンジリスト管理、typemap の変更を行いません。ソースコントロール、プロジェクトへの影響と依存関係、トラブルシューティング を参照してください。
プロバイダーが構成されていない場合、ドキュメント にはソース管理固有のステータス、ガイダンス、ツールヒント、またはアクションが表示されません。構成されているが使用できないプロバイダーは、既知の制御ファイルを保護し続けます。