config

Documentation

Index

• Variables
• func DefaultFilename() string
• type Config
• type Manifest
  • func Parse(bb []byte) (*Manifest, error)
  • func ParseFile(path string) (*Manifest, error)
  • func (m *Manifest) BuildTemplate(inv build.Invocation) (build.Template, error)

Variables

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

Functions

func DefaultFilename

func DefaultFilename() string

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

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 build.Path `toml:"extends"`
}

Configs specifies GDBuild manifest-related settings.

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 build.Godot `toml:"godot"`
	// Template includes settings for building custom export templates.
	Template template.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.

func (*Manifest) BuildTemplate

func (m *Manifest) BuildTemplate(inv build.Invocation) (build.Template, error)

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