Home › Researched mods

RimBridgeServer

Frameworks & Libraries UI & Quality of Life

Layer 1 At a glance

What the mod is, how to use it, video

RimBridgeServer
RimBridgeServer — Andreas Pardeike(brrainz。Harmony の作者)

AIがリムワールドを“直接”操作・撮影できるようにする橋渡しMod

Not yet translated This section is available in Japanese only for now.

452Subs
★2.9Workshop rating
26features
3mod images
Basics
Type
前提MOD/開発ツール(AI・テスト自動化用のブリッジ)。ゲーム内容は変えない
Game versions
1.6
Dependencies
About.xml に modDependencies はない。ただし Harmony を使うので、実際には Harmony が必要(推測: 同梱していないため Harmony Mod を入れる前提)。外部ツールとして GABS を推奨
Author
Andreas Pardeike(brrainz。Harmony の作者)
License
MIT
Workshop
3727949765 ・ 452 Subs ・ ★★★★★
Repository
pardeike/RimBridgeServer

▼ Deeper from here

Layer 2 What is inside

Main features, category cards, tier list

At a glance: the flow

How an outside AI drives the game
  1. 1

    An AI (e.g. Claude Code) calls a tool

    #2

  2. 2

    GABS relays it

    #1

  3. About Mod Icon

    RimBridge inside the game (port 5174) receives it

    #1

  4. 4

    Time, camera, building, UI; screenshots come back

    #3 #8 #9 #10

Features

Show the other 26 features
1GABPサーバーを内蔵。ゲームを起動すると、TCP(初期値 5174番ポート)で外部ツールからの接続を待つ
ログに「GABP server running standalone on port 5174」と、接続用のトークンが出る
2ツールは全128個(rimbridge/* 18個、rimworld/* 110個)
外部のAIから呼び出す
3時間の操作: 一時停止、速度1〜4、指定ミリ秒だけ再生して止める、次のレターが来るまで再生、tick単位のコマ送り
画面右下の時間操作と同じ動き
4セーブ・ロード: 一覧(Modの整合チェック付き)、名前を付けて保存、ロード、ロードして描画が終わるまで待つ
5開発用クイックテスト入植地の起動、メインメニューへ戻る
開発者モードの「Quick test」と同じ
6開発者メニュー(Debug actions)の検索・一覧・実行。マス目指定、ポーン指定にも対応
開発者メニューの「Spawn thing...」などを、AIがパス指定で実行する
7任意の ThingDef を指定マスに直接スポーン(スタック数指定可。defName が見つからないと、defName かラベルに「含まれる/含む」名前を最大8件、候補として返す。つづり違いは候補0)
8カメラ: 状態取得、マス・ポーンへジャンプ、相対移動、ズーム、複数ポーンが画面に収まるよう調整、矩形範囲を画面に収める、ズーム範囲の拡張(そのセッションだけ)
9スクリーンショット: 全画面、ウィンドウやボタン単位で切り抜き、マップの矩形範囲で切り抜き(撮影後にカメラを元の位置へ戻す)、保存先フォルダの指定
RimWorld 標準の撮影機能を使う。「撮影しました」通知は既定で出さない
10UIの読み取りと操作: 開いているウィンドウ、ボタン、ラベル、スクロール領域を、IDと座標付きで取得。クリック、文字入力(人がタイプしているような速さ・揺らぎも出せる)、スクロール、キー入力、決定・キャンセル
ウィンドウがOSで前面になくても操作できる
11仮想カーソル(ホバー): UI要素、マス、ポーンの上にカーソルがあることにして、ツールチップやハイライトを撮れる
本物のマウスを動かすと解除される
12マップのクリック、右クリックメニューの取得と実行、ドラッグ(範囲選択や隊形移動)
本物のクリックと同じ処理を通る
13建築メニュー(Architect): カテゴリと設計の一覧、選択、矩形の範囲に配置(素材と向きを指定可、試し置きも可)、ゴッドモードの切り替え
14ゾーンとエリア: 一覧、作成、選択、クリア、削除、計画(Plan)の一覧
15マップ調査: 1マスまたは最大1024マスの中身、近くの空きマスを探す、つながった範囲を塗りつぶして調べる
16選択とポーン: 入植者の一覧、選択、徴兵、所持品、選択中の物の詳細(インスペクト文)、ギズモの一覧と実行、インスペクトタブを開く
17通知: メッセージ、レター、アラートの一覧。レターを開く・消す、アラートをクリック
18メインタブ(仕事、研究など。Modが追加したタブも含む)を開く・閉じる。型名を指定して任意のウィンドウを開く
19Mod管理: Mod一覧、有効・無効の切り替え、並べ替え(ModsConfig.xml に保存)、各Modの ModSettings の読み書き、設定画面を開く
20言語の切り替え(設定にも保存される)
21スクリプト実行: JSONスクリプト、制限付きのLua(MoonSharpで読み込んでJSONに変換)、.luaファイル
複数のツールを1回の呼び出しでまとめて実行
22Dubs Performance Analyzer 連携: 計測対象の指定、結果の取得、リセット、停止
DPA を入れているときだけ使える
23診断: ping、ブリッジの状態、操作履歴とイベント、ログ(エラーを含む)の取得、待機系(ロード完了、長い処理の終了)
24Attention(注意喚起): 処理の後で重いエラーが出ると、GABS 側で通常の呼び出しを止め、AIに確認と了承を求める
25他のModからの拡張: SDKを使って [Tool] を付けたDLLを BridgeTools フォルダに置くと、ツールとして追加される
26同梱の拡張例: Multiplayer Mod の自動操作(ローカルでホスト・参加、勢力、時間、セーブ)
プレイヤー向けの配布物には含まれない

▼ Deeper from here

Layer 3 Numbers and caveats

Full stat tables, gaps to vanilla, husbandry, compatibility and caveats

Not yet translated This section is available in Japanese only for now.

紹介文に書かれていない/分かりにくい機能

Open
  • 起動すると勝手に TPS カウンター表示を ON にする。動画を撮るときは画面に余計な数字が出るので要注意。
  • 速度4(Ultrafast)の高速化を常に ON にする。開発者モードの「超高速」と同じ。set_time_speed の ultraSpeedBoost:false で戻せる。
  • バックグラウンドでも止まらない: Application.runInBackground = true にして、設定の再適用(PrefsData.Apply パッチ)後も維持する。ウィンドウが前面になくてもAIが操作できる。
  • ズーム範囲を広げられる: そのセッションだけズームの上限・下限を 0〜100 に広げる。ただし set_camera_zoom の値は 8〜140 に丸められる(ViewCapabilityModule の定数)。
  • 人間らしいタイピング(set_text_field の mode:"typed"、毎秒9文字、揺らぎ35%)。名前入力の場面などを動画っぽく見せられる。
  • screenshot_cell_rect: マップの範囲を指定するだけで、カメラを合わせて撮り、切り抜いて、カメラを元に戻す。
  • ロード前のModの整合チェック: セーブに記録されたModがすべて有効でないとロードを断る(ignoreModCompatibility で無視できる)。
  • AIのやり取りが長くなりすぎないよう、応答を約3万文字ごとに分ける。

他のModとの連携・相性

Works with

Details
  • Dubs Performance Analyzer: 型をリフレクションで探して、見つかれば計測ツールを有効にする。
  • Pick Up And Haul: 所持品の取得で、PUAHが運搬予定にしている物も返す。
  • Multiplayer: 拡張例のDLLで対応(開発用)。
  • どのModの ModSettings でも読み書きできる。型名を指定すれば、どのModのウィンドウでも開ける。

注意点・既知の制限

  • GUI の描画関数に約30個の Harmony パッチを当てている。UI を記録する仕組みのため、重いModと組み合わせるとわずかに負荷が増える(推測)。
  • 開発・テスト用のMod。普段のプレイ用ではない。セーブデータには何も書き込まないので、途中で入れても外しても問題ない(推測。ThingDef も Comp も追加していない)。
  • spawn_thing は ThingMaker.MakeThing(def) で作るだけ。素材、品質、所属勢力は指定できない。素材が必要な物はエラーログを出して標準の素材になる(推測)。ポーンの種族 ThingDef を渡すのは不適切で、ポーンは開発者メニューから出す。
  • search_debug_actions は、「Spawn thing...」のように開いたときに中身が作られるサブメニューを検索しない。先に list_debug_action_children で開く必要がある。
4 more
  • rimbridge/list_logs が返すのは RimBridge が動き出した後の記録だけ。起動直後の翻訳の警告などは記録の窓に出ても数えない(窓と答えが食い違う。窓の「Clear」でそろえる)。
  • open_window_by_type は記録の窓を短い名前 EditWindow_Log で開ける。Verse.EditWindow_Log は失敗する(本当の型は LudeonTK.EditWindow_Log)。
  • この PCでは、ultraSpeedBoost を入れても切っても速度4の TPS はほぼ同じ(なし 631〜763・あり 635〜647。速度3は 360)。CPU が先に頭打ちになると差が出ない。
  • Lua は一般的な Lua ではなく、変数での添字アクセスもできない機能限定版。

Mod設定の項目

このMod自体の設定画面や ModSettings はない。動作を変える方法は次の3つ。 3 options (table in layer 4).

Settings table ↓

キー操作・ボタン・メニュー

Open(キー操作・ボタン・メニュー)

ゲーム内に追加されるボタン、キー割り当て、Defs はない(Defs/、Languages/、Textures/ フォルダ自体が無い)。操作はすべて外部ツールから行う。

▼ Deeper from here

Layer 4 For the deep divers: how it works in the source

Mechanisms read from source, raw Defs values, formulas, open questions

From here on: site-only detail (not covered in the video)

Not yet translated This section is available in Japanese only for now.

Mod設定の項目

Open the table (3 rows)

このMod自体の設定画面(DoSettingsWindowContents)や ModSettings はない。動作を変える方法は次の3つ。

設定名(画面表示)初期値効果
(環境変数)ポートなし(無ければ 5174)待ち受けるポート。GABS が起動時に渡す
(環境変数)トークンなし(無ければ起動ごとにランダムなGUID)接続に必要な合言葉
(環境変数)ゲームIDなしGABS 側でのゲームの識別名

撮影自動化での使い方

Open(撮影自動化での使い方)

前提: 構成と接続

  • このMod単体は MCP サーバーではない。 中身は GABP という独自プロトコル(TCP の JSON-RPC、最初の hello でトークン認証、Lib.GAB GabpServer)。Claude Code から使うには、同じ作者の GABS(gabs server が MCP の stdio サーバーになる)を間にはさむ。直接接続モードでは、自作のGABPクライアントが必要。
  • 接続の流れ: Claude Code →(MCP stdio)→ GABS →(TCP 127.0.0.1、ポートとトークンを環境変数で渡す)→ RimWorld 内の RimBridgeServer
  • 手順:
    1. Harmony と RimBridgeServer を Mods に入れて有効にする。
    2. GABS のリリース版(gabs.exe)を入れて、gabs games add rimworld を実行する。~/.gabs/config.json の launchMode は SteamManaged(target 294100)か DirectPath(RimWorldWin64.exe のフルパス) にする。SteamAppId(URL起動)だとポートとトークンの環境変数がゲームに届かないので使えない(GABS docs/CONFIGURATION.md)。Windows では stopProcessName: "RimWorldWin64.exe" も付ける。
    3. Claude Code に登録する: claude mcp add gabs -- C:\path\to\gabs.exe server(または .mcp.json に {"mcpServers":{"gabs":{"command":"C:\\path\\to\\gabs.exe","args":["server"]}}})。
    4. Claude Code から games_start {"gameId":"rimworld"} を実行し、games_tool_names で使えるツール名(ゲーム名が先頭に付く)を確かめてから、games_call_tool {"tool":"…","arguments":{…}} で呼ぶ。GABS の公開ツールは games_list、games_show、games_start、games_stop、games_kill、games_status、games_connect、games_tool_names、games_tool_detail、games_call_tool、games_get_attention、games_ack_attention。
  • 直接接続モード(GABS なし): 127.0.0.1:5174 に接続し、Player.log に出るトークンを使う。

セキュリティ

  • 待ち受けは IPAddress.Loopback(127.0.0.1)だけ(Lib.GAB TcpTransport.cs:126)。LAN の他の機器からは接続できない。
  • 認証: 接続の最初に送る hello のトークンが一致しないと断る(GabpServer.cs:247)。トークンは起動のたびに GUID でランダムに作られる。ただし直接接続モードではトークンを平文でログに書く(RimBridgeStartup.cs の Log.Message("[RimBridge] Bridge token: …"))ので、Player.log を他人に渡さないこと。この行はゲーム内の記録の窓(LudeonTK.EditWindow_Log・開発者モードのログ)にも出る=窓を映す前に「Clear」で消す。GABS 経由なら環境変数で渡され、ログには出ない。
  • 通信は暗号化されていない(ローカル専用なので実害は小さい)。
  • 権限が強い: ModsConfig.xml の書き換え、Mod設定の保存、言語の変更(設定ファイルに保存)、run_lua_file での任意パスの .lua の読み込み、outputDirectory での任意フォルダへの書き込み、open_window_by_type での任意のウィンドウ表示ができる。撮影用のセーブとMod構成を、普段のプレイ用と分けておくのが安全。Lua は機能限定版なので、任意の C# やシステムコマンドは実行できない。

録画タスクごとの可否

表を開く(10行)
タスク可否方法
セーブのロード◎rimworld/list_saves で名前を確認 → rimworld/load_game_ready {saveName, readiness:"visual", pauseIfNeeded:true}。Modが一致しないときは ignoreModCompatibility:true
開発者モードで任意の ThingDef をスポーン◎簡単な方法: rimworld/spawn_thing {defName, x, z, stackCount}(素材、品質、勢力は指定不可)。素材や品質を選びたいときは開発者メニューから: rimworld/list_debug_action_children {path:"<Spawn thing のパス>"} で中身を作る → search_debug_actions → execute_debug_action {path, x, z}。ポーンも開発者メニューから出す。完成した建物を置くなら set_god_mode + apply_architect_designator(素材と向きを指定可)。開発者モードの ON/OFF 自体を切り替えるツールはない。ただし開発者メニューは開発者モードが OFF でも実行できる(推測: 実行時に Prefs.DevMode を確認していない)
速度変更・一時停止◎rimworld/pause_game {pause}、rimworld/set_time_speed {speed:"Normal|Fast|Superfast|Ultrafast", ultraSpeedBoost}、rimworld/play_for {durationMs, speed}(決まった時間だけ再生して止める。録画に向く)、rimworld/step_game_ticks {ticks}
カメラのジャンプ◎rimworld/jump_camera_to_cell {x,z}、jump_camera_to_pawn {pawnName|pawnId}、frame_cell_rect {x,z,width,height,paddingCells,rootSize}、frame_pawns {pawnNamesCsv}、move_camera {deltaX,deltaZ}
カメラのズーム◎rimworld/set_camera_zoom {rootSize}(8〜140)、zoom_camera {delta}。標準の範囲より寄りたい・引きたいときは先に set_camera_zoom_extension {enabled:true}
カメラの追従(フォロー)△専用のツールはない。jump_camera_to_pawn を短い間隔で繰り返すか、ポーンを選んで標準の追従機能を使う(推測: press_key で追従のキーを送る)。移動はすべて瞬間ジャンプで、なめらかなパンはできない(JumpToCurrentMapLoc を使うため)
UIを隠す△専用のツールはない。RimWorld 標準のスクリーンショットモード(UIを隠す機能、初期キーは F11)を rimworld/press_key {key:"F11"} で切り替えられる(ただしセーブを読み込んだ後は UI が戻るので押し直す)。UIを入れずにマップだけ撮るなら screenshot_cell_rect の切り抜きが確実。TPSカウンターが勝手に ON になっているので、rimworld/set_debug_setting で showTpsCounter を OFF にする(パスは search_debug_actions で探す。推測)
スクリーンショット◎rimworld/take_screenshot {fileName, clipTargetId, clipPadding, outputDirectory(絶対パス), suppressMessage}、rimworld/screenshot_cell_rect {x,z,width,height,paddingCells,rootSize,doNotResetCamera,outputDirectory}。保存先の初期値は RimWorld の Screenshots フォルダ。動画の録画機能はない(OBS などを別に使う)
画面に文字を出す(字幕)×(拡張で可)標準のツールにはない(メッセージを出すツールも、文字を重ねて描くツールもない)。方法: (a) SDK で拡張DLLを作り、[Tool] の中で Messages.Message(...) を呼ぶか、自前のオーバーレイを描く(BridgeTools/ に置く)。(b) 字幕は動画編集で入れる。(c) 仮想カーソルで既存のツールチップを出す(set_hover_target)
その他の演出○set_hover_target(ツールチップやハイライトを出す)、open_inspect_tab、open_main_tab、open_mod_settings(Mod設定画面を開いて見せる)、set_text_field の typed モード、select_pawn、set_draft、open_context_menu + execute_context_menu_option

全ツールとパラメータ(128個。docs/tool-reference.md は RimBridgeTools.cs から自動生成されている)

表記: 太字は必須。= の後は初期値。

診断・待機(rimbridge/)

  • ping(なし)/get_bridge_status(なし)/get_operation(operationId)
  • list_capabilities(limit=200, providerId, category, source, query, includeParameters=false, offset=0)/get_capability(capabilityIdOrAlias)
  • list_operations(limit=20, includeResults=false)/list_operation_events(limit=50, eventType, afterSequence=0, operationId, includeDiagnostics=false)
  • list_logs(limit=50, minimumLevel="info", afterSequence=0, operationId, rootOperationId, capabilityId)
  • wait_for_operation(operationId, timeoutMs=10000, pollIntervalMs=50)
  • wait_for_game_loaded(timeoutMs=30000, pollIntervalMs=50, readiness=gameData|mapData|currentMap|playable|visual, pauseIfNeeded=false, targetReadiness, waitForVisualReady=false)
  • wait_for_long_event_idle(timeoutMs=30000, pollIntervalMs=100)

スクリプト(rimbridge/)

  • get_script_reference、get_lua_reference(なし)
  • run_script(scriptJson, includeStepResults=true)
  • run_lua(luaSource, parameters, includeStepResults=true)/run_lua_file(scriptPath, parameters, includeStepResults=true)
  • compile_lua(luaSource, parameters)/compile_lua_file(scriptPath, parameters)

ゲーム情報・DPA(rimworld/)

  • get_game_info(なし)
  • dpa_status(includePresets=true)/dpa_patch_methods(category="Tick", inputMode="Method", preset="none", targets="", initialize=true, resetAfterPatch=true, previewLimit=8)/dpa_snapshot(sortBy="average", limit=30)/dpa_reset/dpa_stop/dpa_cleanup(なし)

時間・開発者メニュー・Mod

  • pause_game(pause=true)/set_time_speed(speed="Normal", ultraSpeedBoost)
  • play_for(durationMs, speed="Normal", pollIntervalMs=25, forceRequestedSpeed=false)
  • play_until_letter(timeoutMs=1800000, speed="Normal", pollIntervalMs=250, forceRequestedSpeed=false, includeExistingLetters=false)
  • step_game_ticks(ticks=1, timeoutMs=10000, pollIntervalMs=10, pauseFirst=true, playSound=false)
  • list_debug_action_roots(includeHidden=false)/list_debug_action_children(path, includeHidden=false)
  • search_debug_actions(query, limit=50, includeHidden=false, supportedOnly=false, requiredTargetKind, offset=0)
  • get_debug_action(path, includeChildren=true, includeHiddenChildren=false)
  • execute_debug_action(path, pawnName, pawnId, x, z, thingId)
  • set_debug_setting(path, enabled)/set_colonist_job_logging(pawnName, pawnId, enabled=true)
  • list_mods(includeInactive=true, includeDetails=false, offset=0)/get_mod_configuration_status(なし)
  • set_mod_enabled(modId, enabled, save=true, allowDisableCore=false)/reorder_mod(modId, targetIndex, save=true)
  • list_mod_settings_surfaces(includeWithoutSettings=false)/get_mod_settings(modId, maxDepth=4, maxCollectionEntries=32)
  • update_mod_settings(modId, values, write=true, maxDepth=4, maxCollectionEntries=32)/reload_mod_settings(modId, maxDepth, maxCollectionEntries)/open_mod_settings(modId, replaceExisting=true)

建築・マップ

  • get_designator_state(なし)/set_god_mode(enabled=true)
  • list_architect_categories(includeHidden=false, includeEmpty=false)/list_architect_designators(categoryId, includeHidden=false, includeDetails=false, offset=0)
  • select_architect_designator(designatorId)
  • apply_architect_designator(designatorId, x, z, width=1, height=1, dryRun=false, keepSelected=true, stuffDefName, rotation)
  • list_zones(includeHidden=false, includeEmpty=false)/list_areas(includeEmpty=false, includeAssignableOnly=false)
  • create_allowed_area(label, select=true)/select_allowed_area(areaId)/set_zone_target(designatorId, zoneId)
  • clear_area(areaId)/delete_area(areaId)/delete_zone(zoneId)/list_plans(includeCells=false)
  • get_cell_info(x, z)/get_cells_info(x, z, width=1, height=1, offset=0)
  • find_random_cell_near(x, z, startingSearchRadius=5, maxSearchRadius=60, width=1, height=1, footprintAnchor="top_left", requireWalkable, requireStandable, requireNotFogged, requireNoImpassableThings, reachablePawnName, reachablePawnId, designatorId)
  • flood_fill_cells(x, z, maxCellsToProcess=256, minimumCellCount=0, maxReturnedCells=64, width, height, footprintAnchor, require* 4種, reachablePawnName, reachablePawnId, designatorId)

UI・入力

  • get_ui_state(なし)/list_main_tabs(includeHidden=false)/open_main_tab(mainTabId)/close_main_tab(mainTabId)
  • list_inspect_tabs(includeHidden=false)/open_inspect_tab(inspectTabId)
  • get_ui_layout(surfaceId, timeoutMs=2000, includeOffscreen=false, offset=0)
  • click_ui_target(targetId, timeoutMs=2000)
  • set_text_field(targetId, text, mode="typed", charsPerSecond=9, jitterPercent=35, clearFirst=true, controlName, timeoutMs=0)
  • press_key(key, character, modifiers, timeoutMs=2000)
  • scroll_ui_target(targetId, deltaY=0, deltaX=0, targetY, targetX, timeoutMs=2000)
  • set_hover_target(targetId, x, z, thingId, pawnName, pawnId, anchor="center", offsetX=0, offsetY=0, screenX, screenY, durationMs, settleMs=600)/clear_hover_target(なし)
  • press_accept、press_cancel(なし)/close_window(windowType)/open_window_by_type(windowType, replaceExisting=true)
  • click_screen_target(targetId)/list_languages(なし)/switch_language(language)
  • start_debug_game(なし)/start_debug_game_ready(timeoutMs=120000, pollIntervalMs=50, readiness, pauseIfNeeded=false, targetReadiness, waitForVisualReady=false)/go_to_main_menu(なし)

選択・入植者・通知

  • list_colonists(currentMapOnly=false)/clear_selection(なし)/select_pawn(pawnName, pawnId, append=false)/deselect_pawn(pawnName, pawnId)
  • set_draft(pawnName, pawnId, drafted=true)/get_selected_pawn_inventory_state(なし)
  • get_selection_semantics(なし)/list_selected_gizmos(なし)/execute_gizmo(gizmoId)
  • list_messages(limit=12)/list_letters(limit=40)/open_letter(letterId)/dismiss_letter(letterId)
  • list_alerts(limit=40)/activate_alert(alertId)

カメラ・スクリーンショット

  • get_camera_state(なし)/set_camera_zoom_extension(enabled)/get_screen_targets(なし)
  • get_map_target_info(thingId, pawnName, pawnId)
  • jump_camera_to_pawn(pawnName, pawnId)/jump_camera_to_cell(x, z)/move_camera(deltaX, deltaZ)
  • zoom_camera(delta、正の値で引く)/set_camera_zoom(rootSize)
  • frame_pawns(pawnNamesCsv, pawnIdsCsv。どちらも省略すると選択中のポーン)
  • frame_cell_rect(x, z, width=1, height=1, paddingCells=4, rootSize=0)
  • screenshot_cell_rect(x, z, width=1, height=1, paddingCells=4, fileName, includeTargets=true, suppressMessage=true, doNotResetCamera=false, rootSize=0, outputDirectory)
  • take_screenshot(fileName, includeTargets=true, suppressMessage=true, clipTargetId, clipPadding=8, outputDirectory)

セーブ・スポーン

  • list_saves(compatibleOnly=false, offset=0)/save_game(saveName)
  • load_game(saveName, ignoreModCompatibility=false)
  • load_game_ready(saveName, timeoutMs=120000, pollIntervalMs=50, readiness, pauseIfNeeded=false, targetReadiness, waitForVisualReady=false, ignoreModCompatibility=false)
  • spawn_thing(defName, x, z, stackCount=1)

右クリックメニュー・マップ操作

  • open_context_menu(targetPawnName, targetPawnId, x=0, z=0, mode="vanilla", button="right", holdDurationMs=0, modifiers)
  • right_click_cell(targetPawnName, targetPawnId, x, z, button="right", holdDurationMs=0, modifiers)
  • click_cell(x, z, button="left", holdDurationMs=0, modifiers)
  • drag_cell(fromX, fromZ, toX, toZ, button="left", holdDurationMs=0, modifiers)
  • get_context_menu_options(なし)/execute_context_menu_option(optionIndex=-1(1始まり), label)/close_context_menu(なし)

撮影手順の例(Claude Code に頼む流れ)

  1. games_start → rimbridge/wait_for_game_loaded → rimworld/load_game_ready {saveName:"showcase", readiness:"visual", pauseIfNeeded:true}
  2. set_debug_setting で TPS カウンターを OFF、press_key F11 で UI を隠す
  3. spawn_thing または開発者メニューで紹介するアイテムを置く → frame_cell_rect で画面に収める
  4. OBS で録画を開始(PC側)→ play_for {durationMs:8000, speed:"Normal"} → 必要な場面で take_screenshot {outputDirectory:"C:\\shots"}
  5. 複数の手順は run_script にまとめると、1回の呼び出しで決まった順に実行できる

RimMolt との比較

表を開く(12行)
項目RimBridgeServerRimMolt(ソース非公開。MCP-REFERENCE.md より)
ソース公開(MIT)非公開
接続GABP(TCP)。MCP には GABS が必要。stdioMCP(JSON-RPC 2.0、HTTP POST、localhost:8787)。Claude Code から HTTP で直接つなげる(推測)
認証トークン必須(hello)資料に記載なし
ツールの方向性開発とテスト用(開発者メニュー、UIの自動操作、カメラ、スクリーンショット、Mod設定)AIが入植地を経営する用(仕事の優先度、請求、交易、クエスト、DLCごとの操作、新規ゲームの作成)
セーブのロード◎ load_game_ready(待機付き)○ load_game
スポーン、開発者メニュー◎ spawn_thing、開発者メニュー全体資料にない
速度◎ 4段階、決まった時間だけ再生、コマ送り△ set_speed(一時停止と再開)、wait_for_event
カメラ◎ ジャンプ、ズーム、範囲を収める資料にない(select_zone などで間接的に動く程度か。推測)
UIを隠す△ キー送信で(推測)資料にない
スクリーンショット◎ 切り抜き、保存先指定○ screenshot(ウィンドウ全体)
画面に文字× 拡張DLLが必要◎ say(見ている人に文字を表示)。YouTube ライブチャットの取得(試験的)もある
拡張性SDK でツールを追加できる資料にない

結論: 撮影の自動化(ロード、スポーン、カメラ、スクリーンショット)には RimBridgeServer が向いている。 字幕だけは RimMolt の say が便利。両方を同時に入れる場合はポートが違う(5174 と 8787)のでぶつからない(推測。Harmony パッチが競合しないかは未確認)。字幕は、SDK で Messages.Message を呼ぶ小さな拡張DLLを作るのが、RimBridgeServer だけで済ませる最短の方法。

Features and evidence (files, classes)

Open the table with evidence (26 rows)
#機能ゲーム内での見え方・操作根拠(ファイル/クラス)
1GABPサーバーを内蔵。ゲームを起動すると、TCP(初期値 5174番ポート)で外部ツールからの接続を待つログに「GABP server running standalone on port 5174」と、接続用のトークンが出るRimBridgeStartup.TryStart、Lib.GAB TcpTransport(IPAddress.Loopback で待受)
2ツールは全128個(rimbridge/* 18個、rimworld/* 110個)外部のAIから呼び出すRimBridgeTools.cs、docs/tool-reference.md
3時間の操作: 一時停止、速度1〜4、指定ミリ秒だけ再生して止める、次のレターが来るまで再生、tick単位のコマ送り画面右下の時間操作と同じ動きLifecycleCapabilityModule、RimWorldTickStepper
4セーブ・ロード: 一覧(Modの整合チェック付き)、名前を付けて保存、ロード、ロードして描画が終わるまで待つ(load_game_ready)—LifecycleCapabilityModule、SaveModCompatibility
5開発用クイックテスト入植地の起動、メインメニューへ戻る開発者モードの「Quick test」と同じstart_debug_game(_ready)、RimBridgeDebugGamePause(Game.InitNewGame パッチ)
6開発者メニュー(Debug actions)の検索・一覧・実行。マス目指定、ポーン指定にも対応開発者メニューの「Spawn thing...」などを、AIがパス指定で実行するRimWorldDebugActions、DebugActionExecutionPolicy
7任意の ThingDef を指定マスに直接スポーン(スタック数指定可。defName が見つからないと、defName かラベルに「含まれる/含む」名前を最大8件、候補として返す。つづり違いは候補0)—LifecycleCapabilityModule.SpawnThing
8カメラ: 状態取得、マス・ポーンへジャンプ、相対移動、ズーム、複数ポーンが画面に収まるよう調整、矩形範囲を画面に収める、ズーム範囲の拡張(そのセッションだけ)—ViewCapabilityModule、RimBridgeCameraConfig
9スクリーンショット: 全画面、ウィンドウやボタン単位で切り抜き、マップの矩形範囲で切り抜き(撮影後にカメラを元の位置へ戻す)、保存先フォルダの指定RimWorld 標準の撮影機能(ScreenshotTaker.TakeNonSteamShot)を使う。「撮影しました」通知は既定で出さないViewCapabilityModule.CaptureScreenshotInternal、ScreenshotClipMath
10UIの読み取りと操作: 開いているウィンドウ、ボタン、ラベル、スクロール領域を、IDと座標付きで取得。クリック、文字入力(人がタイプしているような速さ・揺らぎも出せる)、スクロール、キー入力、決定・キャンセルウィンドウがOSで前面になくても操作できるRimBridgeUiWorkbench(GUI.Button や Widgets.Label など約30か所にパッチ)、RimWorldSyntheticInput
11仮想カーソル(ホバー): UI要素、マス、ポーンの上にカーソルがあることにして、ツールチップやハイライトを撮れる本物のマウスを動かすと解除されるRimWorldHover、RimBridgeVirtualPointer
12マップのクリック、右クリックメニュー(FloatMenu)の取得と実行、ドラッグ(範囲選択や隊形移動)本物のクリックと同じ処理を通るContextMenuCapabilityModule、RimBridgeMapClickInjector(Root.OnGUI と UIRoot_Play.UIRootOnGUI のパッチ)
13建築メニュー(Architect): カテゴリと設計の一覧、選択、矩形の範囲に配置(素材と向きを指定可、試し置きも可)、ゴッドモードの切り替え—ArchitectCapabilityModule、RimWorldArchitect
14ゾーンとエリア: 一覧、作成、選択、クリア、削除、計画(Plan)の一覧—RimWorldArchitect
15マップ調査: 1マスまたは最大1024マスの中身、近くの空きマスを探す、つながった範囲を塗りつぶして調べる—get_cell(s)_info、find_random_cell_near、flood_fill_cells
16選択とポーン: 入植者の一覧、選択、徴兵、所持品、選択中の物の詳細(インスペクト文)、ギズモの一覧と実行、インスペクトタブを開く—SelectionCapabilityModule、SelectionSemanticsCapabilityModule、RimWorldInspectTabs
17通知: メッセージ、レター、アラートの一覧。レターを開く・消す、アラートをクリック—NotificationCapabilityModule
18メインタブ(仕事、研究など。Modが追加したタブも含む)を開く・閉じる。型名を指定して任意のウィンドウを開く—RimWorldMainTabs、open_window_by_type
19Mod管理: Mod一覧、有効・無効の切り替え、並べ替え(ModsConfig.xml に保存)、各Modの ModSettings の読み書き、設定画面を開く—ModConfigurationCapabilityModule、ModSettingsCapabilityModule
20言語の切り替え(設定にも保存される)—RimWorldLanguages
21スクリプト実行: JSONスクリプト、制限付きのLua(MoonSharpで読み込んでJSONに変換)、.luaファイル複数のツールを1回の呼び出しでまとめて実行ScriptingCapabilityModule、Core/LuaScriptCompiler、CapabilityScriptRunner
22Dubs Performance Analyzer 連携: 計測対象の指定、結果の取得、リセット、停止DPA を入れているときだけ使えるDpaCapabilityModule
23診断: ping、ブリッジの状態、操作履歴とイベント、ログ(エラーを含む)の取得、待機系(ロード完了、長い処理の終了)—DiagnosticsCapabilityModule、LogJournal、OperationJournal
24Attention(注意喚起): 処理の後で重いエラーが出ると、GABS 側で通常の呼び出しを止め、AIに確認と了承を求める—RimBridgeAttentionPublisher、docs/attention-policy.md
25他のModからの拡張: SDK(RimBridgeServer.Sdk)を使って [Tool] を付けたDLLを BridgeTools フォルダに置くと、ツールとして追加される—RimBridgeExtensionDiscovery、AnnotatedExtensionCapabilityProvider、Source/RimBridgeServer.Sdk
26同梱の拡張例: Multiplayer Mod の自動操作(ローカルでホスト・参加、勢力、時間、セーブ)プレイヤー向けの配布物には含まれないCompanions/Multiplayer

Unverified or inferred statements

Open 11
  • 前提MOD・依存: About.xml に modDependencies はない。ただし Harmony を使う(Source 内の HarmonyLib)ので、実際には Harmony が必要(推測: 同梱していないため Harmony Mod を入れる前提)。外部ツールとして GABS を推奨
  • GUI の描画関数(Label、Button、TextField、Toggle、BeginScrollView など)に約30個の Harmony パッチを当てている。UI を記録する仕組みのため、重いModと組み合わせるとわずかに負荷が増える(推測)。
  • 開発・テスト用のMod。普段のプレイ用ではない。セーブデータには何も書き込まないので、途中で入れても外しても問題ない(推測。ThingDef も Comp も追加していない)。
  • spawn_thing は ThingMaker.MakeThing(def) で作るだけ。素材、品質、所属勢力は指定できない。素材が必要な物はエラーログを出して標準の素材になる(推測)。ポーンの種族 ThingDef を渡すのは不適切で、ポーンは開発者メニューから出す。
  • 開発者モードで任意の ThingDef をスポーン — ◎ …
  • カメラの追従(フォロー) — △ …
  • UIを隠す — △ …
  • 接続 — GABP(TCP)。MCP には GABS が必要。stdio …
  • カメラ — ◎ ジャンプ、ズーム、範囲を収める …
  • UIを隠す — △ キー送信で(推測) …
  • 結論: 撮影の自動化(ロード、スポーン、カメラ、スクリーンショット)には RimBridgeServer が向いている。 字幕だけは RimMolt の say が便利。両方を同時に入れる場合はポートが違う(5174 と 8787)のでぶつからない(推測。Harmony パッチが競合しないかは未確認)。字幕は、SDK で Messages.Message を呼ぶ小さな拡張DLLを作るのが、RimBridgeServer だけで済ませる最短の方法。

Commit read

https://github.com/pardeike/RimBridgeServer
2c01448

Credit

RimBridgeServer — Andreas Pardeike(brrainz。Harmony の作者) ・ Steam Workshop ・ GitHub

Image and license notes (from the report)
  • このModには Textures/ がなく、ゲーム内の画像はない。
  • ライセンス: RimBridgeServer は MIT(Copyright (c) 2025 Andreas Pardeike)。GABS の図は MIT(Copyright (c) 2024 GABS Contributors)。