profile

Documentation

Index

• Variables
• func IsValidName(name string) bool
• type Config
• type Manager
  • func NewManager(dataDir string) (Manager, error)
• type Profile
  • func (p *Profile) Config() *Config
• type Type

Variables

var (
	ErrInvalidName = errors.New("invalid profile name")
	ErrNameInUse   = errors.New("name in use")
	ErrNotFound    = errors.New("profile not found")
)

Functions

func IsValidName

func IsValidName(name string) bool

Types

type Config

type Config struct {
	Java string `mapstructure:"java"` // The name of the java installation to use
}

Config represents all the profile specific configuration options. Options not specified in a profile config will be inherited from the global config.

type Manager

type Manager interface {
	// CreateProfile creates a new profile and fills in defaults.
	// The returned profile may be modified, and then Save will save it.
	CreateProfile(name string) (*Profile, error)

	Profiles() []string
	GetProfile(name string) (*Profile, error)

	Save() error
}

func NewManager

func NewManager(dataDir string) (Manager, error)

type Profile

type Profile struct {
	Name      string `json:"name"`
	Directory string `json:"directory"`

	Type Type `json:"type"`
	// Version represents the Minecraft version of the profile.
	// Present no matter the type (except Unknown)
	Version string `json:"version"`
	// contains filtered or unexported fields
}

func (*Profile) Config

func (p *Profile) Config() *Config

type Type

type Type int

const (
	// Unknown indicates that the profile has not been installed yet.
	Unknown Type = iota
	Vanilla
	Fabric
)