Skip to content

Using the Submitter

Preparing Your Scene

Before submitting a job:

  1. Make sure your scene is saved
  2. Set up your camera angles, materials, and lighting as desired
  3. Configure animation frames if rendering an animation

Submitting a Job

  1. In KeyShot, on the top toolbar click Scripting Console.
  2. In the Scripting Console, navigate to Scripts → Submit to AWS Deadline Cloud
  3. Click Run

Accessing the Submitter

Submission Options

When you run the submitter, you'll first see a dialog asking how you want to handle file attachments:

Submission Options

Choose one of the following options:

  • The scene BIP file and all external files references (Recommended)
  • Automatically packages your scene file and all referenced files. Internally, the submitter creates a KeyShot Package (KSP) which bundles all linked files and uses relatives paths.
  • Best for scenes with textures, models, and other external assets

  • Ensures workers have all necessary files to render your scene

  • Only the scene BIP file

  • Only submits the KeyShot scene file
  • Use this option if your workers already have access to all referenced files
  • Requires shared network storage or another method to access external files

Render Settings

After selecting your submission option, the Deadline Cloud submitter interface will appear:

Configure your render settings:

  1. Shared job settings Submitter Interface
  2. Job Name: Give your job a descriptive name
  3. If you are using the submitter for the first time, you may need to set your farm and queue. To set them, click the Settings button.

  4. If you're using KeyShot 2023, Deadline Cloud service-managed fleets have built-in support for KeyShot Studio 2024 only. If you're using KeyShot 2023 for submission, you can still render on KeyShot Studio 2024 by specifying the correct version (keyshot=2023.*) in the Conda Packages input.

  5. Job-specific settings Submitter Interface

  6. Frames: Specify which frames to render (e.g., "1-30" for frames 1 through 30)
  7. Output File Path: Set the location and naming pattern for rendered images. The path should include the file's extension, and the extension should match the output format. Use %d as a placeholder for the frame number.

  8. Output Format: Choose the image format (PNG, JPEG, EXR, TIFF, PSD)

  9. Job attachments (optional). Select which files will be uploaded and attached to the job. Files are automatically detected and attched by default.

  10. Host requirements (optional). Allows you to specific which types of hosts will be eligible for picking up tasks for this job.

  11. Click Submit to send your job to Deadline Cloud

Monitoring Your Jobs

After submitting a job, open Deadline Cloud Monitor (DCM) to view the job's progress. The submitter will create a job with a single step and with one task per frame. To view the rendering logs, right click on a task and choose View logs. When the job succeeds, download the result by right clicking the job and choosing Download output.

Getting Help

If you encounter issues or have questions, you can open an issue in this GitHub repository or contact AWS Support.