Poco SDK

To integrate PocoSDK into a Unity3D project, follow these steps:

1. Clone the Repository: Clone the source code from the poco-sdk repository.
2. Import Files: Copy the Unity3D folder from the repository into your Unity project's Scripts folder.
3. Clean up UI Framework Folders: To avoid conflicts, delete the subfolders for the UI frameworks you are not using:
   • If using ngui: Delete Unity3D/ugui and Unity3D/fairygui.
   • If using ugui: Delete Unity3D/ngui and Unity3D/fairygui.
   • If using fairygui: Refer to the specific fairygui guide.
4. Initialize the SDK: Add the Unity3D/PocoManager.cs script as a component to any GameObject in your scene. It is recommended to attach it to the Main Camera or a dedicated empty GameObject.

To integrate Poco SDK into an Egret project, follow these steps:

1. Download Poco SDK: Obtain the SDK files.
2. Configure egretProperties.json: Add the SDK to the modules property. The name attribute must be set to poco.

   "modules": [
     {
       "name": "poco",
       "path": "path/to/poco-sdk"
     }
   ]

   The path can be relative or absolute.
3. Build the project: Open a terminal (Ctrl + `) and run:

   egret build -e

4. Initialize PocoManager: In your entry file main.ts, create a new PocoManager instance inside the rungame function and pass this.stage to it.
5. Start the Broker: Run the proxy server in your terminal:

   python -m poco.utils.net.stdbroker ws://*:5003 tcp://*:15004

   Note: The default websocket port is 5003. If you change this port, you must pass the new port parameter when initializing PocoManager in your code.

// In main.ts
function rungame() {
    // ...
    const pocoManager = new PocoManager(this.stage);
}

To inspect UI hierarchies on mobile devices running Egret pages (or WeChat mini-programs/games), follow these steps:

1. Map Ports (Android only): Connect your Android device via USB and ensure adb devices recognizes it. Run the following command to map the mobile port 5003 to your computer's port 5003:

   adb reverse tcp:5003 tcp:5003

2. Start the Broker: On your computer, start the proxy server:

   python -m poco.utils.net.stdbroker "ws://*:5003" "tcp://*:15004"

3. Access the Page: Open the Egret page on the mobile device. It is recommended to use full-screen mode to ensure accurate coordinate positioning. The broker terminal will log connections when successful.
4. Connect in AirtestIDE:
   • Open AirtestIDE.
   • Select the poco Std-broker connection mode.
   • Once connected, you can view the UI hierarchy and run scripts.

# Map ports for Android
adb reverse tcp:5003 tcp:5003

# Start the broker
python -m poco.utils.net.stdbroker "ws://*:5003" "tcp://*:15004"

AirtestIDE supports connecting to Windows browser windows for UI inspection. Note that MacOS window support is currently unavailable.

1. Run Project and Broker: Run your Egret project in a browser and start the broker proxy on your computer:

   python -m poco.utils.net.stdbroker ws://*:5003 tcp://*:15004

2. Configure AirtestIDE: Set the connection mode to embedded mode (使用嵌入模式) in the IDE settings.
3. Connect Window: Use the Select Window (选定窗口) feature in AirtestIDE to connect to the browser window. The browser window will then appear within the IDE.
4. Select Game Area: Use the poco window area select setting to draw a bounding box around the specific game/application area within the browser.
5. Inspect UI: Once the area is defined, you can use the Inspector feature to view and interact with the UI hierarchy.

# Start the broker for desktop connection
python -m poco.utils.net.stdbroker ws://*:5003 tcp://*:15004

You can use the UE4Poco driver to connect to a running Unreal Engine game and interact with its UI tree via Python scripts.

Standard Connection

To connect to a running game process:

from poco.drivers.ue4 import UE4Poco

# Initialize the driver
poco = UE4Poco()

# Interact with a widget
# Example: clicking a button named 'StartButton'
poco("StartButton").click()

Editor Mode Connection

To connect while running in the Unreal Editor (PIE mode), pass ue4_editor=True. Note: The Unreal Editor language must be set to English for this to work.

from poco.drivers.ue4 import UE4Poco

# Initialize for editor mode
poco = UE4Poco(ue4_editor=True)

Custom Window Connection

If the automatic connection fails, you can manually specify the device handle in poco/drivers/ue4/device.py. For example, to connect to a specific Unreal window using a regular expression for its title:

# Example for older UE4 versions (pre-4.26) targeting 'Game Preview Standalone'
dev = connect_device("Windows:///?class_name=UnrealWindow&title_re=.*Game Preview Standalone.*")

# For UE4 versions 4.26 and above, the window name is typically 'Preview [NetMode: Standalone]'

from poco.drivers.ue4 import UE4Poco

poco = UE4Poco()
# example
poco("StartButton").click()