pyrct2 0.3.3

Interact with OpenRCT2 from python!

pyrct2

Python client for OpenRCT2. Launch headless games, read state, execute actions, all in Python!

Connects to the openrct2-bridge plugin over TCP. Every game action, state query, and enum is auto-generated from OpenRCT2 C++ source by openrct2-codegen.

Install

pip install pyrct2
pyrct2 setup        # finds OpenRCT2, installs the bridge plugin

Usage

from pyrct2.client import RCT2
from pyrct2.scenarios import Scenario
from pyrct2.enums import StaffType, AdvertisingCampaignType, ResearchFundingLevel

with RCT2.launch(Scenario.CRAZY_CASTLE) as game:
    # state queries return typed Pydantic models
    park = game.state.park()
    print(f"{park.name}: rating {park.rating}, cash ${park.cash}")

    # actions take typed enums — no magic ints
    game.actions.staff_hire_new(auto_position=True, staff_type=StaffType.MECHANIC, costume_index=0, staff_orders=0)
    game.actions.park_marketing(type=AdvertisingCampaignType.PARK_ENTRY_FREE, item=0, duration=4)
    game.actions.park_set_research_funding(priorities=0xFF, funding_amount=ResearchFundingLevel.MAXIMUM)

    # tick-step the simulation forward
    game.advance_ticks(100)
    print(f"Rating: {game.state.park_rating()}")

# or attach to an already-running instance
with RCT2.connect() as game:
    print(game.state.scenario_name())

Requirements

• Python 3.13+
• OpenRCT2 installed with RCT2 game data