bots

Documentation

Overview

Package bots is the root package for the bot subsystem. Bots are loaded and unloaded by the Wrangler package.

Bots monitor audio and video through the AudioMixer and PixelRenderer interfaces. They issue input to the emulation through the input.PushEvent() mechanism.

Index

• type Bot
• type Diagnostic
• type Feedback
• type Input
• type TV

Types

type Bot

type Bot interface {
	BotID() string
	Quit()
	Feedback() *Feedback
}

Bot defines the functions the all bots must implement.

type Diagnostic

type Diagnostic struct {
	Group      string
	Diagnostic string
}

Diagnostic instances are sent over the Feedback Diagnostic channel.

type Feedback

type Feedback struct {
	// consumers of the Images channel should probably only show one frame at a
	// time so a buffer size of 1 is probably sufficient
	Images chan *image.RGBA

	// buffer length of the Log channel should be sufficient long for the bot
	Diagnostic chan Diagnostic
}

Feedback defines the channels that can be used to retrieve information from a running bot.

type Input

type Input interface {
	PushEvent(ports.InputEvent) error
	AllowPushedEvents(bool)
}

Input defines the Input functions required by a bot.

type TV

type TV interface {
	AddPixelRenderer(television.PixelRenderer)
	AddAudioMixer(television.AudioMixer)
	RemovePixelRenderer(television.PixelRenderer)
	RemoveAudioMixer(television.AudioMixer)
}

TV defines the television functions required by a bot.