Skip to content
Tutorials Center
My learning

Topics

Lesson 33 of 38 ยท Packaging and Performance

Packaging and Build Configurations

Ship your Unreal Engine game. Development, Test and Shipping configurations, cooking, pak files, Project Launcher, platform settings and a pre-release checklist.

A game that only runs in the editor is a prototype. To ship, you must package it: compile the code, cook the assets into platform-specific formats and bundle everything into a standalone build. Packaging also finds problems the editor hides, such as references to missing assets or code that only works in editor builds, so you should do it early and often, not on release day.

The Unreal Editor is not available on this site, so the steps are described in words. The Python stand-ins model the size and checklist logic.

Build configurations

Unreal compiles code in several configurations. They differ in optimization, logging and available tools:

Configuration Optimized Logging and console Use
Debug No Full Stepping through engine and game code (needs a debug engine build)
DebugGame Game code unoptimized, engine optimized Full Debugging only your game code
Development Mostly Full, console available Daily work, the default for packaging tests
Test Yes Limited, profiling kept Final QA and performance tests
Shipping Yes Console, logs and cheats stripped What players get

Pick the configuration in Platforms > Package Project > Build Configuration or in the IDE. Shipping is the only one you should release. Because logging and check macros are removed, bugs may only appear in Shipping, so test it.

Targets matter too: Game (client with content), Client, Server (dedicated server, no rendering) and Editor. Dedicated server and client targets need a source-built engine from GitHub.

Cooking and packaging

Cooking converts editor assets (textures, meshes, Blueprints) into the format a given platform needs: compressed textures (BCn on desktop, ASTC on mobile), compiled shaders and so on. Packaging then stages the executable and cooked content and, by default, bundles content into .pak (or the newer IoStore, .utoc and .ucas) archives.

To package from the editor on Windows:

  1. Set the default and startup maps in Project Settings > Project > Maps and Modes. A missing default map is the most common cause of a build that opens to a black screen.
  2. In Project Settings > Project > Packaging, check Build Configuration, Use IoStore, Use Pak File, and optionally Create compressed cooked packages.
  3. Choose Platforms > Windows > Package Project and select an empty folder.
  4. Wait. The first cook compiles a large number of shaders and can take a long time; later cooks are incremental.

The Project Launcher (Tools > Project Launcher) is the more powerful route: build profiles for several platforms, cook options (by the book, only changed files), launch arguments and deployment to devices.

Command-line packaging uses UAT (Unreal Automation Tool), important for build servers:

Text
RunUAT.bat BuildCookRun -project="C:\Games\MyGame\MyGame.uproject" -platform=Win64 ^
    -clientconfig=Shipping -build -cook -stage -pak -archive -archivedirectory="C:\Builds"

Choosing what ships

Unreal cooks the maps listed in List of maps to include in a packaged build and everything they reference, plus Additional Asset Directories to Cook. Content that is only loaded by name or by soft path at run time must be listed there, or it will be missing in the build. The Asset Audit window and the Size Map (right-click an asset > Size Map) show what is large and why it is referenced.

Platform considerations:

  • Windows/Linux/macOS: straightforward; Windows needs the Visual Studio toolchain, macOS needs Xcode, and Linux cross-compiles from Windows with the Linux toolchain download.
  • Android: requires Android Studio and SDK/NDK set up through the Android SDK settings, and a signing keystore for Play Store builds.
  • iOS: requires a Mac, an Apple Developer account and provisioning profiles.
  • Consoles: require developer-program access and platform SDKs.

Estimating download size

Textures are usually most of a game's size. The stand-in estimates how much space a texture set takes with different compression, so you can see why choosing a format matters.

Python Stand-in: texture memory and compression

Press Run (or Ctrl + Enter) to see the result here.

Program input ยท what you'd type while the program runs

Type the answers before you press Run, one per line. Each time the program reads a line (with input()), it gets the next line from this box.

Halving texture resolution divides memory by four. That single decision can make a package far smaller; do it where nobody can see the difference (distant props, small objects).

A pre-release checklist

Python Stand-in: release checklist runner

Press Run (or Ctrl + Enter) to see the result here.

Program input ยท what you'd type while the program runs

Type the answers before you press Run, one per line. Each time the program reads a line (with input()), it gets the next line from this box.

Troubleshooting a package

  • "Cook failed": open the log in the Output Log (and Saved/Logs); the first Error: line is usually the cause, often a Blueprint with a compile error or a missing asset.
  • Black screen or no level: default map not set or not cooked.
  • Missing content at run time: soft-referenced assets not added to the cook list.
  • Crash only in Shipping: logging and check removed; an uninitialized variable or a null pointer hidden in Development. Use Test configuration with crash reporting to investigate.
  • Huge package: audit with the Size Map, lower texture sizes, compress audio, remove unused plugins in the Plugins window and the .uproject.
  • Shader hitching on first use: ship a PSO cache (pipeline state object cache), gathered during playtests, to avoid stutter on first draw.

Common mistakes

  • Packaging only at the end. Package a development build weekly.
  • Shipping a Development build. It is larger and exposes the console.
  • Hard-coding editor paths such as /Game assets by absolute disk path. Use asset references.
  • Not testing a clean install. Delete saved data and run the build on a machine without the engine.

See Profiling and stat commands for finding performance problems before you ship.

Check your understanding

Quick check ยท 4 questions

of 4 answered You scored / 4 ยท perfect!

  1. 1. Which build configuration is intended for the version players receive?

    Shipping is fully optimized with the console, logging and cheats removed.
  2. 2. What does cooking do?

    Cooking prepares content for a target platform; packaging stages and archives it.
  3. 3. A packaged game opens to a black screen. What should you check first?

    A missing default or startup map is a common cause.
  4. 4. Why test the Shipping configuration separately?

    Shipping removes checks and logs that can hide uninitialized values or null pointers.

Summary

  • Development is for daily work, Test for QA and profiling, Shipping for release.
  • Cooking converts assets per platform; packaging bundles them into pak or IoStore files.
  • Set default maps, list extra cook directories and audit size with the Size Map.
  • Package early, test a clean install, and keep a release checklist.

Next: Profiling and Stat Commands