upyrc 0.10.1

Python wrapper around the Unreal engine remote control API.

UnrealRemoteControlWrapper

A (work in progress) python 3 wrapper around Unreal remote control api. It allows to control Unreal engine remotly, from a dcc ( maya, blender, houdini, etc. ), or a webapp, or any other sources, using a simple python api.

upyrc is available on pip:

python -m pip install upyrc

It needs to have the remote API plugin installed on your Unreal project, as well as the server started, you can do that on the cmd:

WebControl.StartServer
WebControl.EnableServerOnStartup

By default, the script use these values bellow as host and port, it matches the default value of the remote plugin from Unreal install, it needs to be set to your values if needed:

DEFAULT_HOST = "127.0.0.1"
DEFAULT_PORT = 30010

Http api endpoints documentation.

Features

✔️ Get remote UObject by path.

✔️ Run query with various filter (class, path, package etc.) to get UObjects.

✔️ Get / Set UObject properties.

✔️ Run UObject functions.

✔️ Get remote blueprint actor and run functions.

✔️ Get remote presets.

✔️ Get / Set remote preset properties, functions, actors.

✔️ Get utilities EditorActorSubsystem and EditorAssetLibrary.

❌ Batch process is not supported at the moment, Unreal crashes when a batch call is executed.

❌ Get thumbnail not supported.

Basic usage

# Default host and port used by the api:
upyrc.DEFAULT_HOST = "127.0.0.1"
upyrc.DEFAULT_PORT = 30010

# Init the connection
conn = upyrc.URConnection()
print("Ping: ", conn.ping())
# >>> Ping: 0:00:00.015211

# Get Remote UObject by path:
chair_path = "/Game/Maps/TestMap.TestMap:PersistentLevel.StaticMeshActor_2"
robj_chair = conn.get_uobject(chair_path)
print("RUObject: " + str(robj_chair))
# >>> RUObject: UObject: /Game/Maps/TestMap.TestMap:PersistentLevel.StaticMeshActor_2, of Class /Script/Engine.StaticMeshActor

# Access property directly on URemoteObject object:
auto_lod_generation = robj_chair.bEnableAutoLODGeneration
# Set property the same way:
robj_chair.bEnableAutoLODGeneration = True

# dir() returns all properties and functions available remotly.
print(dir(robj_chair))
# >>> ['ActorHasTag (function)', 'AddActorLocalOffset (function)', 'AddActorLocalRotation (function)', 'AddActorLocalTransform (function)',  ... 'bRelevantForLevelBounds (property)', 'bRelevantForNetworkReplays (property)', 'bStaticMeshReplicateMovement (property)']

# You can also load a blueprint actor.
blueprint_path = "/Game/Maps/TestMap.TestMap:PersistentLevel.BUA_TestBlueprint_C_1"
blueprint = conn.get_uobject(blueprint_path)
print("Blueprint: ", blueprint)
# >>> UObject: /Game/Maps/TestMap.TestMap:PersistentLevel.BUA_TestBlueprint_C_1, of Class /Game/Blueprints/BUA_TestBlueprint.BUA_TestBlueprint_C

# And a function with argument(s) too and a return value:
function_result = blueprint.run_function("SimpleTestFuncArgs", MyString="Hello from python !")
print("Function result: ", function_result)
# ---> In Unreal: LogBlueprintUserMessages: [BUA_TestBlueprint_C_UAID_D89EF37396CEAA5E01_2120751343] Hello from python !
# >>> Function result: {'OutputData': True, 'MessagePrinted': 'Hello from python !'}

Infos

More infos on file: test_uremote.py

As well as help() on objects:

help(upyrc.URConnection)
help(upyrc._URemoteObject)
# etc..

Contact

🔗 www.cgtoolbox.com

✉️ [e-mail]