UNREAL - Submitting Unreal projects with GM Submission Client [1.0.1+]

UNREAL - Submitting Unreal projects with GM Submission Client [1.0.1+]

This article will guide through the process of submitting an Unreal project to our farm with GM Submission Client. It is highly advised to submit a simple test scene for your first try and not your final project. We are utilizing Unreal's Movie Render Queue feature, you can read about its workflow HERE.

01 - SETTING UP THE SCENE
01.01 - OUTPUT FOLDER PATH
Output folder path set in Unreal must be a relative path (relative to the your project folder), for example:
/_out/MPQ_GMTEST_
Instead of an absolute path:
C:/_out/MPQ_GMTEST_
01.02 - FRAME RANGE
Limit the frame range in the config (rather than just relying on the range limit in the sequence).

01.03 - QUEUE CONFIG
After all settings are set please save the entire Movie Render Queue's Movie Pipeline Config list (you can still use Master Configs that are the configs for the given sequences only but Movie Pipeline Config is required). For our example we'll save it under:
/Game/MPQ_GMTEST_1to1000 (= <PROJECT FOLDER ROOT>\Content\MPQ_GMTEST_1to1000)

02 - SETTING UP THE GM SUBMISSION CLIENT AND JOB SUBMISSION
02.01 - CHECKUP
Make sure Envoy is running and you are logged in with your password and NOT the Access Key.

02.02 - SUBMISSION STEPS
Alert
The whole project will be uploaded included unused assets, so if you have some heavy files present that are not needed it's advised to move or delete them from the project folder.
02.03 - Pick the appropriate entries from the dropdowns and construct cmd-line argument line:



  • Application Unreal
  • Version: select Unreal version that matches yours (if you don't see it in the list please contact us or just pick the latest one)
  • Job file: Point it to your *.uproject file
  • Project name: specify the project name which is the folder used to store all the files for the submission - use the same project folders for many submissions to avoid re-uploading the same project files
  • Input command-line arguments string: construct it based on this matrix - please make sure all paths in the command-line are pointing to assets from /Game (<PROJECT FOLDER ROOT>\Content\) location:
    "<PATH TO THE MAP OR JUST MAP NAME IF IT'S In DEFAULT /Game LOCATION>" -game -MoviePipelineConfig="<QUEUE CONFIG SAVED IN 01.04>"
    For example:
    "Minimal_Default1" -game -MoviePipelineConfig="/Game/Cinematics/MPQ_GMTEST_1to1000"

    Note: Additional parameters are added automatically and you don't need to specify them. For reference:
    -Log -StdOut -allowStdOutLogVerbosity -Unattended -windowed -RenderOffScreen

  • Auto-Download Results: Untick if not needed
  • Select machine type: pick the machine you need (you can also use the Hourly Render Calculator to check for the configurations)
  • Enter a value greater than 0 to set credit budget: credits budget -> set 0 for no budgeting or type in some amount of credits, job will be killed after reaching the limit set here
  • Confirm to submit project: hit Submit, after that you should see files being uploaded in Envoy portal (please refresh the page if you can't see any progress).