FlaxEngine/Source/Engine/Core/Config/BuildSettings.h

// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.

#pragma once

#include "Engine/Core/Config/Settings.h"
#include "Engine/Serialization/Serialization.h"
#include "Engine/Core/Collections/Array.h"
#include "Engine/Content/Asset.h"
#include "Engine/Content/AssetReference.h"
#include "Engine/Content/SceneReference.h"

/// <summary>
/// The game building rendering settings.
/// </summary>
API_CLASS(sealed, Namespace="FlaxEditor.Content.Settings") class FLAXENGINE_API BuildSettings : public SettingsBase
{
    DECLARE_SCRIPTING_TYPE_MINIMAL(BuildSettings);

public:
    /// <summary>
    /// Name of the output app created by the build system. Used to rename main executable (eg. MyGame.exe) or final package name (eg. MyGame.apk). Custom tokens: ${PROJECT_NAME}, ${COMPANY_NAME}.
    /// </summary>
    API_FIELD(Attributes="EditorOrder(0), EditorDisplay(\"General\")")
    String OutputName = TEXT("${PROJECT_NAME}");

    /// <summary>
    /// The maximum amount of assets to include into a single assets package. Asset packages will split into several packages if need to.
    /// </summary>
    API_FIELD(Attributes="EditorOrder(10), Limit(1, ushort.MaxValue), EditorDisplay(\"General\", \"Max assets per package\")")
    int32 MaxAssetsPerPackage = 4096;

    /// <summary>
    /// The maximum size of the single assets package (in megabytes). Asset packages will split into several packages if need to.
    /// </summary>
    API_FIELD(Attributes="EditorOrder(20), Limit(1, ushort.MaxValue), EditorDisplay(\"General\", \"Max package size (in MB)\")")
    int32 MaxPackageSizeMB = 1024;

    /// <summary>
    /// The game content cooking keycode. Use the same value for a game and DLC packages to support loading them by the build game. Use 0 to randomize it during building.
    /// </summary>
    API_FIELD(Attributes="EditorOrder(30), EditorDisplay(\"General\")")
    int32 ContentKey = 0;

    /// <summary>
    /// If checked, the builds produced by the Game Cooker will be treated as for final game distribution (eg. for game store upload). Builds done this way cannot be tested on console devkits (eg. Xbox One, Xbox Scarlett).
    /// </summary>
    API_FIELD(Attributes="EditorOrder(40), EditorDisplay(\"General\")")
    bool ForDistribution = false;

    /// <summary>
    /// If checked, the output build files won't be packaged for the destination platform. Useful when debugging build from local PC.
    /// </summary>
    API_FIELD(Attributes="EditorOrder(50), EditorDisplay(\"General\")")
    bool SkipPackaging = false;

    /// <summary>
    /// The list of additional assets to include into build (into root assets set).
    /// </summary>
    API_FIELD(Attributes="EditorOrder(1000), EditorDisplay(\"Additional Data\")")
    Array<AssetReference<Asset>> AdditionalAssets;

    /// <summary>
    /// The list of additional scenes to include into build (into root assets set).
    /// </summary>
    API_FIELD(Attributes="EditorOrder(1000), EditorDisplay(\"Additional Data\")")
    Array<SceneReference> AdditionalScenes;

    /// <summary>
    /// The list of additional folders with assets to include into build (into root assets set). Paths relative to the project directory (or absolute).
    /// </summary>
    API_FIELD(Attributes="EditorOrder(1010), EditorDisplay(\"Additional Data\")")
    Array<String> AdditionalAssetFolders;

    /// <summary>
    /// Disables shaders compiler optimizations in cooked game. Can be used to debug shaders on a target platform or to speed up the shaders compilation time.
    /// </summary>
    API_FIELD(Attributes="EditorOrder(2000), EditorDisplay(\"Content\", \"Shaders No Optimize\")")
    bool ShadersNoOptimize = false;

    /// <summary>
    /// Enables shader debug data generation for shaders in cooked game (depends on the target platform rendering backend).
    /// </summary>
    API_FIELD(Attributes="EditorOrder(2010), EditorDisplay(\"Content\")")
    bool ShadersGenerateDebugData = false;

    /// <summary>
    /// If checked, skips bundling default engine fonts for UI. Use if to reduce build size if you don't use default engine fonts but custom ones only.
    /// </summary>
    API_FIELD(Attributes="EditorOrder(2100), EditorDisplay(\"Content\")")
    bool SkipDefaultFonts = false;

    /// <summary>
    /// If checked, .NET Runtime won't be packaged with a game and will be required by user to be installed on system upon running game build. Available only on supported platforms such as Windows, Linux and macOS.
    /// </summary>
    API_FIELD(Attributes="EditorOrder(3000), EditorDisplay(\"Scripting\", \"Skip .NET Runtime Packaging\")")
    bool SkipDotnetPackaging = false;

    /// <summary>
    /// If checked, .NET Runtime packaging will skip unused libraries from packaging resulting in smaller game builds.
    /// </summary>
    API_FIELD(Attributes="EditorOrder(3010), EditorDisplay(\"Scripting\", \"Skip Unused .NET Runtime Libs Packaging\")")
    bool SkipUnusedDotnetLibsPackaging = true;

public:
    /// <summary>
    /// Gets the instance of the settings asset (default value if missing). Object returned by this method is always loaded with valid data to use.
    /// </summary>
    static BuildSettings* Get();

    // [SettingsBase]
    void Deserialize(DeserializeStream& stream, ISerializeModifier* modifier) final override
    {
        DESERIALIZE(MaxAssetsPerPackage);
        DESERIALIZE(MaxPackageSizeMB);
        DESERIALIZE(ContentKey);
        DESERIALIZE(ForDistribution);
        DESERIALIZE(SkipPackaging);
        DESERIALIZE(AdditionalAssets);
        DESERIALIZE(AdditionalAssetFolders);
        DESERIALIZE(ShadersNoOptimize);
        DESERIALIZE(ShadersGenerateDebugData);
        DESERIALIZE(SkipDefaultFonts);
        DESERIALIZE(SkipDotnetPackaging);
        DESERIALIZE(SkipUnusedDotnetLibsPackaging);
    }
};