mc

Documentation

Overview

Package mc implements facilities for detecting and working with Minecraft instances.

Index

• Constants
• type Instance
  • func NewInstance(info InstanceInfo, conf *cfg.Profile, x *x11.Client) Instance
  • func (i *Instance) Click() error
  • func (i *Instance) Focus()
  • func (i *Instance) FocusAndUnpause(timestamp xproto.Timestamp, idle bool)
  • func (i *Instance) PressEsc(timestamp xproto.Timestamp)
  • func (i *Instance) PressF3(timestamp xproto.Timestamp)
  • func (i *Instance) PressF3Esc(timestamp xproto.Timestamp)
  • func (i *Instance) Reset(timestamp xproto.Timestamp)
  • func (i *Instance) Stretch(conf cfg.Profile) error
  • func (i *Instance) Unstretch(conf cfg.Profile) error
• type InstanceInfo
  • func FindInstances(x *x11.Client) ([]InstanceInfo, error)
• type InstanceState

Constants

const (
	StMenu    int = iota // Main menu
	StDirt               // Dirt world generation screen
	StPreview            // World preview
	StIdle               // World generation finished
	StIngame             // Currently being played
)

The set of possible states an instance can be in.

Types

type Instance

type Instance struct {
	InstanceInfo
	// contains filtered or unexported fields
}

Instance represents a single Minecraft instance and takes care of reading its log file and performing actions on it.

func NewInstance

func NewInstance(info InstanceInfo, conf *cfg.Profile, x *x11.Client) Instance

NewInstance creates a new Instance from the given instance information.

func (*Instance) Click

func (i *Instance) Click() error

Click clicks on the instance's window.

func (*Instance) Focus

func (i *Instance) Focus()

Focus focuses the instance's window. If an error occurs, it will be logged.

func (*Instance) FocusAndUnpause

func (i *Instance) FocusAndUnpause(timestamp xproto.Timestamp, idle bool)

FocusAndUnpause focuses the instance's window and then unpauses if the user has set `unpause_on_focus` in their config. If an error occurs, it will be logged.

func (*Instance) PressEsc

func (i *Instance) PressEsc(timestamp xproto.Timestamp)

PressEsc presses escape to [un]pause the instance. If an error occurs, it will be logged.

func (*Instance) PressF3

func (i *Instance) PressF3(timestamp xproto.Timestamp)

PressF3 presses F3 to hide the pie chart.

func (*Instance) PressF3Esc

func (i *Instance) PressF3Esc(timestamp xproto.Timestamp)

PressF3Esc presses F3+Escape to pause the instance without the pause menu. If an error occurs, it will be logged.

func (*Instance) Reset

func (i *Instance) Reset(timestamp xproto.Timestamp)

Reset presses the instance's reset key. If an error occurs, it will be logged.

func (*Instance) Stretch

func (i *Instance) Stretch(conf cfg.Profile) error

Stretch stretches the instance's window.

func (*Instance) Unstretch

func (i *Instance) Unstretch(conf cfg.Profile) error

Unstretch resizes the window back to its normal dimensions.

type InstanceInfo

type InstanceInfo struct {
	Id       int           // Instance number
	Pid      uint32        // Process ID
	Wid      xproto.Window // Window ID
	Dir      string        // .minecraft directory
	Version  int           // Minecraft version
	ResetKey x11.Key       // Atum reset key
}

InstanceInfo contains information about how to interact with a Minecraft instance, such as its game directory and window ID.

func FindInstances

func FindInstances(x *x11.Client) ([]InstanceInfo, error)

FindInstances returns a list of all running Minecraft instances.

type InstanceState

type InstanceState struct {
	State    int // Current state of the instance
	Progress int // World generation progress (0 to 100)
}

InstanceState contains information about the current state of the instance.