Skip to main content

Publishing Standalone Projects

Last Updated Time: 10/11/2023

Overview

This documentation introduces the specific process of publishing standalone projects.

Setting Engine Paths (Except for Non-CPP Code Project)

Click Config (Menu Bar) -> Engine Settings to open the Engine Settings window and set the Engine Code Path here.

image-20231011100304454

Setting Packaging Configuration

Click Config (Menu Bar) -> Project Settings to open the Project Settings window and click the Packaging Settings here. Then the interface is as shown below:

image-20231011100314969

CategoryPropertyDescription
PublicExport ConfigExport packaging configuration.
Import ConfigImport packaging configuration.
Use Pak FileWhether to package. If checked, it will be packaged; if not checked, it will not be packaged.
Cook AssetsWhether to cook assets. If checked, it will be cooked; if not checked, it will not be cooked. (For the Client only, while the Server does not cook by default).
Open Output DirectoryWhether to open the directory after packaging is complete. If checked, it will be opened; if not checked, it will not be opened.
Output DirectoryThe output directory of the package (Non-mandatory configured item).
Path ListThe resource directory necessary for the project (Server and Client).
Root File ListRoot files. The necessary files except for the above necessary resource directory can be found according to the corresponding reference relationships.
ClientBuild PipelineBuild pipeline (User-definable).
Level ListLevels need to be published by the Client of the project.
Ignore Path ListExclude the path list directories when packaging in Client.
Copy PathThe directory that the Client of the project needs to copy separately.
Command Line ARGsAdditional command line arguments appended by the Client.
ServerBuild PipelineServer build pipeline (User-definable).
Level ListLevels need to be published by the Server of the project.
Additional Path ListThe project Server additionally included directories (except the resource directory in the Path List above).
Ignore Path ListExclude the path list directories when packaging in Server.
Command Line ARGsServer command line (used to generate Server startup bat).
Ignore Suffix ListExclude the suffix list when packaging in Server.
Copy PathThe directory that the Server of the project needs to copy separately.

If you need to set Level List, click the image-20230724142619393 button in the Title Bar under the Client to add a new Level File. Then find the level that needs to be packaged from the Project panel, and drag it to the Level File.

image-20231011100347700

After setting:

image-20231011105911155

If you need to add a resource directory, click the image-20230727100845361 button in the Title Bar of Path List to add a new resource File Path. Then click the image-20230727100856457 button on the right side of File Path. Select a resource folder in the pop-up window, and click OK.

image-20231011100411058

After adding:

image-20231011100421645

Platform Settings

Windows Settings

Click Windows Settings under Platform Settings in the Project Settings window.

image-20231011105927468

PropertyDescription
Visual Studio VersionSelect the appropriate version of Visual Studio. If it shows in red, it means that this version is not installed on the device.
Game IconGenerate an icon for the Client (.exe).
Game NameGenerate the name of the Client (.exe). If not set, the generated Client name will be the project name by default.
Windows Ignore Suffix ListWindows excluded suffix list.

Windows One-click Packaging

Click Build (Menu Bar) -> Package Project (Client) -> Windows in the Editor.

image-20230726160140130

Wait for the packaging to complete with the packaged content in the output directory of the packaging configuration. If no output directory is configured, it will be packaged in the outputs directory of the project, for example, test_project/outputs/client/win64.

image-20230724144534693

After packaging:

image-20230726160557845