ue4.py

Unreal Engine 4 - Cube sample script

usage: ue4.py [-h] [--loglevel {DEBUG,INFO,WARNING,ERROR}]
              [--logformat LOGFORMAT] [-c CLUSTER_ID] [-e]
              {env,prepare,build,build-cloud,load,unload,upload-images} ...

Positional Arguments

command Possible choices: env, prepare, build, build-cloud, load, unload, upload-images

Named Arguments

--loglevel

Possible choices: DEBUG, INFO, WARNING, ERROR

Set the script log level

--logformat Set the script log format
-c, --cluster_id
 

The cluster id. If not set with the command line, uses the environment variable GENVID_CLUSTER_ID if it exists. Otherwise defaults to ‘local’

Default: “local”

-e, --envpath

Use engine root from environment variables.

Default: False

Sub-commands:

env

Print environment variables

ue4.py env [-h]

prepare

Copy SDK and generate the project files

ue4.py prepare [-h] [-n] [--quiet] [--progress]

Named Arguments

-n, --dry-run

Just print what it will do

Default: False

--quiet

Suppress progress log.

Default: False

--progress

Show progress log.

Default: False

build

Build the specified target

ue4.py build [-h] [-e] [-v VERSION] [--vs {auto,vs2015,vs2017}]
             [targets [targets ...]]

Positional Arguments

targets The targets to build

Named Arguments

-e, --envpath

Use engine root from environment variables.

Default: False

-v, --version The engine version to use
--vs

Possible choices: auto, vs2015, vs2017

Force the usage of a Visual Studio version when building.

Default: auto

build-cloud

Build the specified target for the cloud

ue4.py build-cloud [-h] [-e] [-v VERSION] [--vs {auto,vs2015,vs2017}]
                   [targets [targets ...]]

Positional Arguments

targets The targets to build

Named Arguments

-e, --envpath

Use engine root from environment variables.

Default: False

-v, --version The engine version to use
--vs

Possible choices: auto, vs2015, vs2017

Force the usage of a Visual Studio version when building.

Default: auto

load

Load the specified target definition in the cloud

ue4.py load [-h] [targets [targets ...]]

Positional Arguments

targets The targets to build

unload

Unload the specified target definition in the cloud

ue4.py unload [-h] [targets [targets ...]]

Positional Arguments

targets The targets to build

upload-images

Upload Cube sample images to the cloud

ue4.py upload-images [-h] [-b BUCKET] [-p PATH] [-u] [--region REGION]
                     [targets [targets ...]]

Positional Arguments

targets The targets to upload

Named Arguments

-b, --bucket Name of the bucket to use. Default is a combination of AWS account, bastion, and cluster IDs.
-p, --path

The path in the bucket (default: “/images/ue4_Cube”).

Default: “/images/ue4_Cube”

-u, --update-config
 

Upload configuration to the current cluster.

Default: False

--region Region where the images will be uploaded.