export

type Export struct {
	// Arch is the architecture of the exported artifacts.
	Arch platform.Arch
	// EncryptionKey is an encryption key used to encrypt game assets with.
	EncryptionKey string
	// Features contains the slice of Godot project feature tags to build with.
	Features []string
	// Options are 'export_presets.cfg' overrides, specifically the preset
	// 'options' table, for the exported artifact.
	Options map[string]any
	// PackFiles defines the game files exported as part of this artifact.
	PackFiles []PackFile
	// PathTemplate is a path to the export template to use during exporting.
	PathTemplate osutil.Path `hash:"ignore"`
	// PathTemplateArchive is an optional path to a non-cached export template
	// archive containing the export template to use. If specified, this will
	// take priority over 'Template'.
	PathTemplateArchive osutil.Path `hash:"ignore"`
	// Template specifies the export template to use.
	Template *template.Template `hash:"string"`
	// RunBefore contains an ordered list of actions to execute prior to
	// exporting the target.
	RunBefore action.Action `hash:"string"`
	// RunAfter contains an ordered list of actions to execute after exporting
	// the target.
	RunAfter action.Action `hash:"string"`
	// Runnable is whether the export artifact should be executable. This should
	// be true for client and server targets and false for artifacts like DLC.
	Runnable bool
	// Server configures the target as a server-only executable, enabling some
	// optimizations like disabling graphics.
	Server bool
	// Version is the editor version to use for exporting.
	Version engine.Version
}

type FileVisualMode string

type Mode string

type PackFile struct {
	// Embed defines whether the associated '.pck' file should be embedded in
	// the binary. If true, then the target this 'PackFile' is associated with
	// must be runnable.
	Embed *bool `toml:"embed"`
	// Encrypt determines whether or not to encrypt the game files contained in
	// the resulting '.pck' files.
	Encrypt *bool `toml:"encrypt"`
	// Exclude is a slice of glob expressions to filter *out* game files for
	// this pack file. These expressions will be evaluated from the directory
	// containing the GDBuild manifest.
	Exclude []string `hash:"ignore" toml:"exclude"`
	// Include is a slice of glob expressions to match game files against to
	// include in this pack file. These expressions will be evaluated from the
	// directory containing the GDBuild manifest.
	Include []string `hash:"ignore" toml:"include"`
	// Name is the name of the pack file. If omitted a name will be chosen based
	// on the pack files index within the target configuration.
	Name osutil.Path `toml:"name"`
	// PackFilePartition is a ruleset for how to split the files matched by
	// 'glob' into one or more '.pck' files.
	Partition PackFilePartition `toml:"partition"`
	// Visuals sets whether the resources in this pack file will have visuals
	// stripped. Only usable when exporting as a server and defaults to 'true'.
	Visuals *bool `toml:"visuals"`
	// Zip defines whether to compress the matching game files. The pack files
	// will use the '.zip' extension instead of '.pck'.
	Zip *bool `toml:"zip"`
}

type PackFilePartition struct {
	// Depth is the maximum folder depth from the project directory containing
	// the GDBuild manifest to split files between. Any folders past this depth
	// limit will all be included within the same '.pck' file.
	Depth uint `toml:"depth"`
	// Limit describes limits on the files within individual '.pck' files in the
	// partition.
	Limit PackFilePartitionLimit `toml:"limit"`
}

type PackFilePartitionLimit struct {
	// Size is a human-readable file size limit that all '.pck' files within the
	// partition must adhere to.
	Size string `toml:"size"`
	// Files is the maximum count of files within a single '.pck' file within a
	// partition.
	Files uint `toml:"files"`
}

type Preset struct {
	Arch            platform.Arch     `ini:"-"`
	CustomizedFiles map[string]string `ini:"-"`
	Embed           bool              `ini:"-"`
	Encrypt         bool              `ini:"encrypt_pck"`
	EncryptIndex    bool              `ini:"encrypt_directory"`
	Encrypted       []string          `ini:"encryption_include_filters"`
	EncryptionKey   string            `ini:"-"`
	Exclude         string            `ini:"exclude_filter"`
	ExportedFiles   []string          `ini:"export_files"`
	// ExportMode sets the type of export to use. Should be 'resources' for a
	// standard pack file and 'customized' for dedicated server pack files.
	ExportMode   Mode        `ini:"export_filter"`
	Features     []string    `ini:"custom_features"`
	Include      string      `ini:"include_filter"`
	Name         string      `ini:"name"`
	PathTemplate osutil.Path `ini:"-"`
	Platform     platform.OS `ini:"-"`
	Runnable     bool        `ini:"runnable"`
	Server       bool        `ini:"dedicated_server"`

	Options map[string]string `ini:"-"`
}