Basic usage in a new project¶

ue4: 4.14, unrealcv: v0.3.9, level: basic, updated: 06/27/2017

This tutorial assumes the basic knowledge of using a command line. If you are a windows user and do not have much knowledge of using command line and find it difficult to understand, please let us know.

1. Install the plugin (build from source code in this tutorial)¶

In this tutorial the project and plugin folders are refered as the console varialbe plugin_folder and project_folder

export plugin_folder=$HOME/workspace/unrealcv

# Clone the UnrealCV repository
git clone https://github.com/unrealcv/unrealcv ${plugin_folder}

# Switch to version `v0.3.10`
cd {plugin_folder}
git checkout v0.3.10

# Build the plugin binary
export UE4="/Users/Shared/Epic Games/UE_4.14/"
python build.py --UE4 ${UE4}

More details about the plugin installation can be found in Install UnrealCV Plugin.

2. Create a new project and copy the plugin to the project folder¶

Creat a ‘Blueprint - First Person’ project.

Refer the project folder with a project_folder variable

export project_folder="$HOME/Documents/Unreal Projects/MyProject"

# Copy the compiled plugin to the project folder to install it.
cp -r "${plugin_folder}"/Plugins/ "${project_folder}"/Plugins/

Restart the UE4 project and make sure the plugin is successfully loaded

Basic usage in a new project¶

1. Install the plugin (build from source code in this tutorial)¶

2. Create a new project and copy the plugin to the project folder¶

3. Open the Unreal project and make sure the plugin is installed¶

4. Try the command in UE4Editor¶

5. Try the command is the python console¶