# Komugi Documentation (llms.txt)

> Komugi is a high-performance Minecraft Bedrock Edition relay server (MITM proxy) written in Go.
> It supports packet inspection & logging (stdout/file/SQLite),
> resource pack caching, F3 debug overlay, chunk borders, TPS monitoring, shop alerts,
> PROXY protocol v2, backend health checks with Limbo fallback, and real-time UNIX IPC CLI tools.

## Documentation Index

- [Komugi ドキュメント](/): Minecraft Bedrock Edition 向け高機能 MITM リレープロキシサーバー
- [環境変数リファレンス](/reference/env-vars/): komugi の設定可能な全環境変数一覧と既定値、詳細説明。
- [インストール・ビルド手順](/setup/installation/): Komugi リレーサーバーの必要環境、ソースコード取得、ビルドおよび起動手順。
- [初回起動と Xbox 認証](/setup/first-run/): Komugi の起動フロー、Minecraft Bedrock クライアントからの接続、Xbox Live デバイスコード認証の手順。
- [環境設定 (.env)](/setup/configuration/): Komugi の .env ファイルの作成方法、必須パラメータおよび推奨設定ガイド。
- [コントリビューション](/development/contributing/): Komugi プロジェクトへの貢献ガイドライン、新機能・独自コマンドの追加手順、およびドキュメント自動反映。
- [内部アーキテクチャ](/development/architecture/): Komugi の内部パッケージ構造、パケットパイプライン、並行処理設計およびデータモデル。
- [ビルド・テスト・開発コマンド](/development/building/): Komugi 本体の開発用コマンド、ユニットテスト実行、静的解析およびクロスコンパイル手順。
- [ログ機能と設定](/admin/logging/): Komugi のパケット中継ログ、運用ログ、SQLite WAL 保存、および日別ファイルローテーションの設定。
- [CLIによる監視と保守](/admin/monitoring/): komugi status および komugi logs CLI によるリアルタイム監視、ログ検索、および AI エージェント連携。
- [リソースパック中継](/admin/resource-packs/): 上流サーバーのリソースパック自動取得・キャッシュ、必須適用設定、および内蔵パック。
- [トラブルシューティング](/admin/troubleshooting/): Komugi 運用時によくあるトラブル、原因と具体的な解決手順。
- [ゲーム内コマンド一覧](/usage/commands/): Komugi 独自の中継インターセプトコマンドと利用方法。
- [デバッグ・計測ツール](/usage/debug-tools/): F3 画面オーバーレイ、チャンク境界線表示、実効 TPS 計測、ping レイテンシ確認機能。
- [ショップアラート (/shop_alert)](/usage/shop-alert/): プレイヤーショップの出品やチャット取引を常時監視し、狙ったアイテムの出品を即座に通知する機能。

## Agent Integration Quick Reference

### 1. SQLite Packet Log Search CLI (Agent Friendly JSONL)
```bash
# Output 1 JSON object per line for streaming parsing
komugi logs tail -n 50 --level error --format jsonl
komugi logs search "disconnect" --since 24h --format jsonl
komugi logs stats --by packet --since 1h --format json
```

### 2. Relay Status UNIX IPC CLI (Agent Friendly JSON / JSONL)
```bash
# Real-time connected players, latency, effective TPS, backend status
komugi status --format json
komugi status --format jsonl
```

### 3. Key Environment Variables (.env)
- `TARGET_HOST`: Backend Bedrock server host (required)
- `TARGET_PORT`: Backend Bedrock server port (default: 19132)
- `RELAY_HOST`: Relay listen host (default: 0.0.0.0)
- `RELAY_PORT`: Relay listen port (default: 19132)
- `LOG_OUTPUT`: Logging destination (stdout | file | sqlite | none)
- `DB_PATH`: User SQLite database path (default: ./komugi.db)
- `LOG_DB_PATH`: Packet log SQLite path (default: ./komugi-logs.db)
- `STATUS_SOCKET_PATH`: IPC UNIX domain socket (default: /tmp/komugi.sock)

### Full Documentation Access
For the complete, unpaginated markdown documentation in a single file, fetch:
`/llms-full.txt`