Development branch

  • v0.3.10
    • Commands contributed in pull request #91, authored by @bennihepp
      • Add vget /camera/[id]/pose, vset /camera/[id]/pose
      • Add vget/vset /camera/[id]/horizontal_fieldofview
      • Add vget /camera/[id]/vis_depth npy and vget /camera/[id]/plane_depth npy
      • Add vset /object/[id]/show, vset /object/[id]/hide
      • Add vset /action/input/enable, vset /action/input/disable
    • Add more commands
      • Add vget /object/[id]/mobility, vget /object/[id]/location, vget /object/[id]/rotation
      • Add vget /camera/[id]/normal npy
      • Add vset /action/eyes_distance [eye_distance]
      • Add vset /action/game/pause
    • Update the python client to support python3
    • Improve documentation
  • v0.3.9
    • Fix a bug that prevents object mask generation, which is introduced in v0.3.7
    • Fix #53 that the painting of object does not work
    • Fix #49 python3 support, thanks to @jskinn and @befelix
  • v0.3.8 :
    • Integrate cnpy into unrealcv
    • Add vget /camera/depth npy, which can return tensor as a numpy binary.
  • v0.3.7 :
    • Add vget /camera/lit png to retrieve binary data without saving it.
  • v0.3.6 :
    • Change docs from markdown to reStructuredText
    • Add docker to automate tests
    • Add vset /action/keyboard [key_name] [delta]
  • v0.3.5 : Add vexec to support the invocation of blueprint functions, Add GetWorld() in FCommandHandler.
  • v0.3.4 : Delay the object mask painting from initialization code
  • v0.3.3 : Add vget /scene/name
  • v0.3.2 :
    • Add vget /unrealcv/version
    • Add vset /action/eyes_distance
    • Fix vget /camera/[id]/location to support multiple cameras
    • Update test code
  • v0.3.1 : Fix GWorld issue

v0.3.0 - Stability improvement

  • Add support for Unreal 4.13, 4.14
  • Stability improvement, fix crash caused by the usage of GWorld
  • Fix some incorrect ground truth, blueprint actor not correctly displayed.
  • Add playground project
  • Add docs to
  • Add API documentation created by doxygen
  • Fix an issue that prevents the packaging of games.
  • Add vrun command to exec UE4 built-in command

API update:

  • vrun [built-in command]
  • vset /camera/[id]/moveto [x] [y] [z] # With collision enabled

v0.2.0 - First public release


  • Add communication to UE4Editor and a compiled game
  • Add Python and MATLAB client to communicate with UnrealCV server
  • Add ground truth extraction, include: depth, object-mask, surface normal
  • Add support for Linux, Win and Mac

Initial API, see more details in the command list

  • vget /objects
  • vget /object/[obj_name]/color
  • vset /object/[obj_name]/color [r] [g] [b]
  • vget /camera/[id]/location
  • vget /camera/[id]/rotation
  • vset /camera/[id]/location [x] [y] [z]
  • vset /camera/[id]/rotation [pitch] [yaw] [roll]
  • vget /camera/[id]/[viewmode]
  • vget /camera/[id]/[viewmode] [filename]
  • vset /viewmode [viewmode]
  • vget /viewmode
  • vget /unrealcv/status
  • vget /unrealcv/help

The upcoming release will follow the concept of Semantic Versioning