Skip to main content

Publishing Online Projects

Last Updated Time: 10/11/2023

Overview

This documentation introduces the specific process of publishing online 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-20231011100537577

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-20231011101000268

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 ListServer excluded suffix list.
Copy PathThe directory that the Server of the project needs to copy separately.

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

image-20231011101652699

After setting:

image-20231011101708567

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

image-20231011101718687

After adding:

image-20231011101728446

Platform Settings

Windows Settings

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

image-20231011110154829

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

Client

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

image-20230726160911856

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-20230724150915647

After packaging:

image-20230726162917490

Server

Click Build (Menu Bar) -> Package Project (Server) -> Windows.

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/server/win64.

image-20230724150946190

After packaging:

image-20230726162814122