クライアントオプション
createClient(options) に渡せる全オプションです。
基本
| オプション | 型 | 既定値 | 説明 |
|---|---|---|---|
host | string | '127.0.0.1' | 接続先ホスト。realms 指定時は不要 |
port | number | 19132 | 接続先ポート |
version | Version | 自動判定 | 接続時に装うバージョン(例: '1.21.50')。未指定時は事前 ping でサーバーに一致させる |
offline | boolean | false | true で Microsoft/Xbox Live 認証を無効化する |
認証
| オプション | 型 | 既定値 | 説明 |
|---|---|---|---|
username | string | —(必須) | プロファイル名。オフラインモードでは表示名として使われる。オンラインモードではアカウントキャッシュのキーとして内部利用される |
profilesFolder | string | false | .minecraft | 認証トークンのキャッシュディレクトリ。.minecraft が見つからない場合は node_modules 配下 |
onMsaCode | (data: ServerDeviceCodeResponse) => void | — | デバイスコード認証開始時に呼ばれるコールバック。未指定時は情報がコンソールに出力される |
authTitle | string | Titles.MinecraftNintendoSwitch | サインイン時に申告するゲームエディション。一部サーバーはこれを検証する |
deviceOS | number | authTitle から導出 | Bedrock の DeviceOS 列挙値(Android=1 / iOS=2 / PS=11 / Switch=12)。既知タイトル以外を使う場合は必須 |
flow | string | 'live' | prismarine-auth の認証フロー |
対応表と詳細はエコシステムガイドを参照してください。
接続動作
| オプション | 型 | 既定値 | 説明 |
|---|---|---|---|
connectTimeout | number | 9000 | 接続試行のタイムアウト(ms) |
skipPing | boolean | false | 事前 ping(バージョン確認)をスキップして即接続する |
followPort | boolean | realms 未指定時 true | ping 応答で告知されたポートに接続先を合わせる |
autoInitPlayer | boolean | true | play_status(spawn)受信後に SetPlayerInitialized を自動送信するか |
viewDistance | number | — | 要求するチャンク視距離 |
ネットワーク / パフォーマンス
| オプション | 型 | 既定値 | 説明 |
|---|---|---|---|
raknetBackend | 'raknet-native' | 'jsp-raknet' | 'raknet-node' | 'raknet-native' | RakNet 実装。C++/Rust 版はビルドツールが必要な場合がある |
useRaknetWorker | boolean | true(実装既定値) | JS 実装の RakNet を Worker で動かすか(クライアントのみ影響) |
compressionAlgorithm | 'none' | 'deflate' | 'snappy' | バージョン依存(1.19.30+ は none から開始) | 圧縮アルゴリズム。1.19.30 以上では network_settings 応答でサーバーと同期される |
compressionLevel | number | 7 | zlib 圧縮レベル |
batchingInterval | number | 20 | 送信キューのフラッシュ間隔(ms)。なお level_chunk のみキューを素通りして即送信される |
ライフサイクル
| オプション | 型 | 既定値 | 説明 |
|---|---|---|---|
delayedInit | boolean | false | new Client() 時の自動初期化を止める。init() → connect_allowed → connect() の手動フロー用。低レベルガイド参照 |
ログ
| オプション | 型 | 既定値 | 説明 |
|---|---|---|---|
conLog | any | console.log | 接続ログの 出力先。null で無効化 |
Realms
| オプション | 型 | 説明 |
|---|---|---|
realms.realmId | string | 参加する Realm の ID |
realms.realmInvite | string | 招待リンク / コード |
realms.pickRealm | (realms: Realm[]) => Realm | 参加・所有中の Realm 配列から 1 つ返す関数(async 可) |
詳細は Realms ガイド を参照してください。
非推奨オプション
useNativeRaknet は非推奨です。true は raknetBackend: 'raknet-native'、false は JS 実装と同等になります。