AWS Deadline Cloud for Unreal Engine

AWS Deadline Cloud for Unreal Engine is a python package that allows users to create AWS Deadline Cloud jobs from within Unreal Engine. Using the Open Job Description (OpenJD) Adaptor Runtime this package also provides a command line application that adapts Unreal's command line interface to support the OpenJD specification.

Compatibility

This library requires:

1. Python 3.9 or higher; and
2. Windows operating system.

Submitter

This package provides a Unreal Engine plugin that creates jobs for AWS Deadline Cloud using the AWS Deadline Cloud client library. Based on the loaded scene it determines the files required, allows the user to specify render options, and builds an OpenJD template that defines the workflow.

Adaptor

The Unreal Engine Adaptor implements the OpenJD interface that allows render workloads to launch Unreal Engien and feed it commands. This gives the following benefits:

• a standardized render application interface,
• sticky rendering, where the application stays open between tasks,

Jobs created by the submitter use this adaptor by default.

Getting Started

The adaptor can be installed by the standard python packaging mechanisms:

$ pip install deadline-cloud-for-unreal-engine

After installation it can then be used as a command line tool:

$ unreal-engine-openjd --help

For more information on the commands the OpenJD adaptor runtime provides, see here.

Versioning

This package's version follows Semantic Versioning 2.0, but is still considered to be in its initial development, thus backwards incompatible versions are denoted by minor version bumps. To help illustrate how versions will increment during this initial development stage, they are described below:

1. The MAJOR version is currently 0, indicating initial development.
2. The MINOR version is currently incremented when backwards incompatible changes are introduced to the public API.
3. The PATCH version is currently incremented when bug fixes or backwards compatible changes are introduced to the public API.

Security

See CONTRIBUTING for more information.

Telemetry

See telemetry for more information.

License

This project is licensed under the Apache-2.0 License.