config

Documentation

Index

• Variables
• func DefaultFilename() string
• func Export(rc *run.Context, m *Manifest, tl *template.Template, target string) (*export.Export, error)
• func Init(path string) error
• func Template(rc *run.Context, m *Manifest) (*template.Template, error)
• type Config
• type Godot
  • func (g *Godot) Configure(rc *run.Context) error
  • func (g *Godot) MergeInto(other any) error
  • func (g *Godot) Validate(_ *run.Context) error
• type Manifest
  • func Parse(bb []byte) (*Manifest, error)
  • func ParseFile(path string) (*Manifest, error)

Variables

var (
	ErrInvalidInput = config.ErrInvalidInput
	ErrMissingInput = config.ErrMissingInput
)

var ErrConflictingValue = errors.New("conflicting setting")

Functions

func DefaultFilename

func DefaultFilename() string

DefaultFilename returns the default name of the 'gdbuild' manifest file.

func Export

func Export(
	rc *run.Context,
	m *Manifest,
	tl *template.Template,
	target string,
) (*export.Export, error)

Export creates an `Export` instance which contains an action for exporting the specified target.

func Init

func Init(path string) error

Init initializes a GDBuild manifest at the specified path. Note that 'path' can be a directory or a '.toml' file.

func Template

func Template(rc *run.Context, m *Manifest) (*template.Template, error)

Template creates a `Template` instance which contains an action for compiling Godot based on the specified configuration.

Types

type Config

type Config struct {
	// Extends is a path to another GDBuild manifest to extend. Note that value
	// override rules work the same as within a manifest; any primitive values
	// will override those defined in the base configuration, while arrays will
	// be appended to the base configuration's arrays.
	Extends osutil.Path `toml:"extends"`
}

Configs specifies GDBuild manifest-related settings.

type Godot

type Godot struct {
	*engine.Source
}

func (*Godot) Configure

func (g *Godot) Configure(rc *run.Context) error

func (*Godot) MergeInto

func (g *Godot) MergeInto(other any) error

func (*Godot) Validate

func (g *Godot) Validate(_ *run.Context) error

type Manifest

type Manifest struct {
	// Config contains GDBuild configuration-related settings.
	Config Config `toml:"config"`
	// Godot contains settings on which Godot version/source code to use.
	Godot Godot `toml:"godot"`
	// Target includes settings for exporting Godot game executables and packs.
	Target map[string]platform.Targets `toml:"target"`
	// Template includes settings for building custom export templates.
	Template platform.Templates `toml:"template"`
}

Manifest defines the supported structure of the GDBuild manifest file.

func Parse

func Parse(bb []byte) (*Manifest, error)

Parse parses a 'Manifest' struct from a 'toml' document.

func ParseFile

func ParseFile(path string) (*Manifest, error)

Parse parses a 'Manifest' struct from a 'toml' file.