> ## Documentation Index
> Fetch the complete documentation index at: https://docs.baimoqilin.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 完全な設定

> デフォルト値、コマンドキー、動作メモを含む MineClawd の完全な設定リファレンス。

## 目的

このページでは、MineClawd の設定モデル全体を確認できます。ファイル設定、コマンドキー、再起動要件をまとめています。

## 設定の保存場所

* グローバル設定ファイル: `config/mineclawd.json5`
* プレイヤー単位のチャット表示設定: `mineclawd/player-settings.json`
* soul ファイルとアクティブ soul 状態: `mineclawd/souls/` と `mineclawd/souls/.active/`

## 完全な `mineclawd.json5` テンプレート

```json5 theme={null}
{
  provider: "OPENAI",
  endpoint: "https://api.openai.com/v1",
  apiKey: "",
  model: "gpt-5.2",
  summarizeModel: "gpt-5.2",

  vertexEndpoint: "https://aiplatform.googleapis.com/v1",
  vertexApiKey: "",
  vertexModel: "gemini-3.1-pro-preview",
  vertexSummarizeModel: "gemini-3-flash-preview",

  tavilyApiKey: "",

  debugMode: false,
  limitToolCalls: false,
  toolCallLimit: 16,
  systemPrompt: "",
  dynamicRegistryMode: "AUTO",

  // Client-only (not in server config file)
  enableGui: true
}
```

<Info>
  ファイル形式では enum 値は大文字です（`OPENAI`、`VERTEX_AI`、`AUTO`、`ENABLED`、`DISABLED`）。

  コマンド形式では値は小文字です（`openai`、`vertex-ai`、`auto`、`enabled`、`disabled`）。
</Info>

## キーリファレンス

| File key               | Command key              | Type    | Default                                | Notes                                                                         |
| ---------------------- | ------------------------ | ------- | -------------------------------------- | ----------------------------------------------------------------------------- |
| `provider`             | `provider`               | enum    | `OPENAI`                               | プロバイダー選択。OpenAI 互換または Vertex AI。                                              |
| `endpoint`             | `endpoint`               | string  | `https://api.openai.com/v1`            | OpenAI 互換ベース URL。末尾スラッシュは不要。                                                  |
| `apiKey`               | `api-key`                | string  | empty                                  | OpenAI API キー。                                                                |
| `model`                | `model`                  | string  | `gpt-5.2`                              | OpenAI chat model。                                                            |
| `summarizeModel`       | `summarize-model`        | string  | `gpt-5.2`                              | 最初の応答後の Session タイトル生成に使う OpenAI model。                                       |
| `vertexEndpoint`       | `vertex-endpoint`        | string  | `https://aiplatform.googleapis.com/v1` | Vertex API ベース URL。                                                           |
| `vertexApiKey`         | `vertex-api-key`         | string  | empty                                  | Vertex API キー。                                                                |
| `vertexModel`          | `vertex-model`           | string  | `gemini-3.1-pro-preview`               | Vertex model path または model name。                                             |
| `vertexSummarizeModel` | `vertex-summarize-model` | string  | `gemini-3-flash-preview`               | Session タイトル用の Vertex summarize model。                                        |
| `tavilyApiKey`         | `tavily-api-key`         | string  | empty                                  | Web 検索用 Tavily API キー。設定すると `search` ツールを有効化。                                 |
| `debugMode`            | `debug-mode`             | boolean | `false`                                | 詳細なリクエストとツール動作をログ出力。                                                          |
| `limitToolCalls`       | `limit-tool-calls`       | boolean | `false`                                | リクエストごとのツールループ上限を有効化。                                                         |
| `toolCallLimit`        | `tool-call-limit`        | integer | `16`                                   | 許容範囲は `1` から `20`。                                                            |
| `systemPrompt`         | `system-prompt`          | string  | empty                                  | 空なら内蔵システムプロンプト。コマンドでは `default` でリセット。                                        |
| `dynamicRegistryMode`  | `dynamic-registry-mode`  | enum    | `AUTO`                                 | 動的プレースホルダー実行モードを制御。変更後は再起動が必要。                                                |
| `enableGui`            | --                       | boolean | `true`                                 | クライアント専用。オーバーレイ GUI の表示切替。**Mod Menu** -> **MineClawd** -> **Configure** で設定。 |

## プレイヤー単位設定

### broadcast-requests-to

コマンド専用、プレイヤー単位。

* Command key: `broadcast-requests-to`
* Allowed values: `self`, `all`, `ops`
* Stored in: `mineclawd/player-settings.json`
* Purpose: prompt のエコーとタスク開始/完了行を誰に表示するかを制御します。

### assistivetouch

トグル専用、プレイヤー単位。

* Command: `/mineclawd assistivetouch`
* Stored in: `mineclawd/player-settings.json`
* Default: enabled (visible)
* Purpose: GUI 全体を無効化せずに、フローティング Assistive Touch オーブの表示を切り替えます。

## Dynamic registry mode の動作

* `AUTO`: クライアント実行時（シングルプレイ）で有効化し、専用サーバーでは無効化します。
* `ENABLED`: すべての実行環境で強制有効化します。
* `DISABLED`: 完全に無効化します。

<Warning>
  専用サーバーで `ENABLED` を強制する場合、参加クライアントにも MineClawd の導入が必要です。
</Warning>

## 推奨ベースライン

### 初回 OpenAI セットアップ向け

```bash theme={null}
/mineclawd config provider openai
/mineclawd config endpoint https://api.openai.com/v1
/mineclawd config api-key <your-key>
/mineclawd config model gpt-5.2
/mineclawd config summarize-model gpt-5.2
```

### 初回 Vertex セットアップ向け

```bash theme={null}
/mineclawd config provider vertex-ai
/mineclawd config vertex-endpoint https://aiplatform.googleapis.com/v1
/mineclawd config vertex-api-key <your-key>
/mineclawd config vertex-model gemini-3.1-pro-preview
/mineclawd config vertex-summarize-model gemini-3-flash-preview
```

## GUI パス

* In game: **Mod Menu** -> **MineClawd** -> **Configure**
* Command fallback: `/mineclawd config ...`
* Overlay menu: ハンバーガーアイコン -> **Config**

クライアントで GUI を開けない場合は、コマンドキー経由で設定してください。

<Info>
  `enableGui` はオーバーレイウィンドウの表示を制御します。OFF にしても YACL 設定画面には影響しないため、**Mod Menu** や `/mineclawd config` から設定画面は開けます。
</Info>