About the Build Panel

    Each platform’s build will be embedded in the Build panel as a separate plugin, with platform related options placed in a collapsible section (e.g. the Web Desktop in the figure below).

    New Build Task

    Click the New Build Task button at the top right of the Build panel to open the build options configuration panel. After the options are configured, click Build.

    Make sure the content in the Scene panel is saved before you build. If it is not saved, when you click on the Build button, a prompt will pop up asking: Do you want to save the current data before build?. You can choose Save, Ignore or Unbuild. If Save / Ignore is selected, the build will continue, and if Unbuild is selected, a record of cancelled builds will be generated.

    save_scene

    Build Task Name is the name of the release folder generated after the build. It is not modified by default. If the same platform performs multiple builds, the suffix -001, , -003 and so on will be added to the original Build Task Name. If you want to overwrite an old release package, simply manually change the Build Task Name back to its original name.

    task-list

    Run

    Currently, most platforms can directly click the Run button in the Build panel to preview the effect of the project after the build is complete. If there is no Run button, it means that the current platform does not support run in the editor, please refer to the release document of the relevant platform for details.

    Because the build process generates so many log messages, by default only error log are printed to the editor’s Console panel. There are several ways to view all log information:

    • Open Build DevTools

      Click Developer -> Open Build DevTools in the menu bar to see all the log information printed during the build, including the call stack.

    • Log File

    Adjust the build options configuration

    The Build panel has a button below the build task, which can be clicked to see or adjust the configuration of the previous build options. Click the Recompile button after the adjustment is complete, the generated release package will directly overwrite the original.

    The information about the completed build task will be saved in the file of the project. As long as the source file of the corresponding build task is not deleted, either in the Build panel or directly deleted in the project directory, you can view the build options configuration of the previous build after reopening the editor, as well as to run and preview again.

    export

    The Export option at the top right of the Build panel exports the current configuration of build options to a JSON file. This mainly facilitates building from the command-line and sharing the configuration of build options within the same project. The exported configuration of build options are platform-specific. For developers who use the command line to build, you can directly use the JSON configuration file as the configPath of the command-line build options.

    The exported configuration is differentiated by platform and comes with a version number. Please do not delete the version number to prevent failing to migrate the data when importing the configuration across versions.

    The Import option reads configuration file into the Build panel for developers to share build options configuration.

    Recompile

    If you want to adjust the configuration of build options after the project is built, or if you want to recompile the project after a bug fix. There are following two ways:

    Option 1: use the Recompile button at the bottom right of the build task, in the Build panel. This option will directly recompile using the previous configuration of build options.