ciounreal 0.1.0b3

Unreal plugin for Conductor Cloud Rendering Platform.

Conductor for Unreal

Unreal plugin submitter for the Conductor Cloud rendering service.

Install

To install the latest version.

pip install --upgrade ciounreal --target=$HOME/Conductor

To install a specific version, for example 0.1.0.

pip install --upgrade --force-reinstall ciounreal==0.1.0 --target=$HOME/Conductor

Setup the Plugin startup file from a command prompt or Powershell on a Windows machine.

python ~/Conductor/ciounreal/post_install.py

NOTE An alternative is to install from the Plugins page in the Conductor Companion app

Usage

To set up a render, go to Rendering menu in Unreal and choose Render with Conductor.

For detailed help, checkout the tutorial and reference documentation.

Contributing

NOTE: These instructions were written from the point of view of a developer coding on Mac or Linux, and where Unreal on Windows has access to $HOME/ConductorStaging over the network.

Clone the repo.

git clone [e-mail]:ConductorTechnologies/ciounreal.git
cd ciounreal

Set up a clean virtual envirionment with Python 3.7 for development (optional).

python -m virtualenv venv
. ./venv/bin/activate

Install development dependencies

pip install -r requirements_dev.txt

Build and install from this directory into to a convenient location for testing.

pip install --upgrade -r requirements.txt --target=$HOME/ConductorStaging

When you install from the file requirements.txt, the dependency on ciocore is specified as a local sibling of this project, meaning you can develop ciocore and ciomaya in parallel. If you have no interest in using a dev version of ciocore, then replace -r requirements.txt with a dot . instead.

If you develop natively on Windows, please consider adding your workflow steps to this section.

Changelog

Unreleased:

• 0.1.0-beta.3

  Changed

  • Removed the Dependency Root field since asset scraping is now done dynamically. It finds the MRQ node and recurses back from there.

• 0.1.0-beta.2

  Added

  • Log lines in the submit function to enhance debugging and monitoring.
  • Dynamic retrieval of the MRQ asset name, pending validation with beta customers which may replace the need for a manual field.

  Changed

  • Log lines in the submit function to enhance debugging and monitoring.
  • Updated contributor instructions to reflect current project standards and practices.
  • The plugin has been updated for compatibility with Unreal Engine 5.3, ensuring it works with the latest version.

  Fixed

  • A bug related to the serialization of instance types, ensuring correct behavior during data processing.

• 0.1.0-beta.1

  Added

  • CircleCI configuration for automated builds and testing.
  • New conductor logo added to the project assets.

  Changed

  • The initialization script tub now gets rewritten during installation so that we can point to the package.
  • ConductorExecutor has been moved into the ciounreal module.
  • The project has been converted into a plugin format for better modularity and ease of use.
  • Post-installation scripts have been implemented to automatically copy the plugin to Unreal Engine's plugins folder.

  Updated

  • Upgraded to core version 7.0.2, which includes updates to instance types.
  • setup.py now handles versioning and packaging the plugin into distributable zip files.