koolo

Documentation

Index

• type Bot
  • func NewBot(logger *slog.Logger, hm health.Manager, ab *action.Builder, ...) *Bot
  • func (b *Bot) Run(ctx context.Context, firstRun bool, runs []run.Run) (err error)
  • func (b *Bot) TogglePause()
• type Companion
• type CompanionGameData
• type CompanionSupervisor
  • func NewCompanionSupervisor(name string, bot *Bot, runFactory *run.Factory, statsHandler *StatsHandler, ...) (*CompanionSupervisor, error)
  • func (s *CompanionSupervisor) JoinGame(gameName, password string)
  • func (s CompanionSupervisor) Name() string
  • func (s *CompanionSupervisor) Start() error
  • func (s CompanionSupervisor) Stats() Stats
  • func (s CompanionSupervisor) Stop()
  • func (s CompanionSupervisor) TogglePause()
• type GameStats
• type RunStats
• type SinglePlayerSupervisor
  • func NewSinglePlayerSupervisor(name string, bot *Bot, runFactory *run.Factory, statsHandler *StatsHandler, ...) (*SinglePlayerSupervisor, error)
  • func (s SinglePlayerSupervisor) Name() string
  • func (s *SinglePlayerSupervisor) Start() error
  • func (s SinglePlayerSupervisor) Stats() Stats
  • func (s SinglePlayerSupervisor) Stop()
  • func (s SinglePlayerSupervisor) TogglePause()
• type Stats
  • func (s Stats) TotalChickens() int
  • func (s Stats) TotalDeaths() int
  • func (s Stats) TotalErrors() int
  • func (s Stats) TotalGames() int
• type StatsHandler
  • func NewStatsHandler(name string, logger *slog.Logger) *StatsHandler
  • func (h *StatsHandler) Handle(_ context.Context, e event.Event) error
  • func (h *StatsHandler) SetStatus(status SupervisorStatus)
  • func (h *StatsHandler) Stats() Stats
• type Supervisor
• type SupervisorManager
  • func NewSupervisorManager(logger *slog.Logger, additionalEventHandlers []event.Handler) *SupervisorManager
  • func (mng *SupervisorManager) AvailableSupervisors() []string
  • func (mng *SupervisorManager) Start(characterName string) error
  • func (mng *SupervisorManager) Status(characterName string) Stats
  • func (mng *SupervisorManager) Stop(characterName string)
  • func (mng *SupervisorManager) TogglePause(characterName string)
• type SupervisorStatus

Types

type Bot

type Bot struct {
	// contains filtered or unexported fields
}

Bot will be in charge of running the run loop: create games, traveling, killing bosses, repairing, picking...

func NewBot

func NewBot(
	logger *slog.Logger,
	hm health.Manager,
	ab *action.Builder,
	container container.Container,
	supervisorName string,
	eventChan chan<- event.Event,
) *Bot

func (*Bot) Run

func (b *Bot) Run(ctx context.Context, firstRun bool, runs []run.Run) (err error)

func (*Bot) TogglePause

func (b *Bot) TogglePause()

type Companion

type Companion interface {
	JoinGame(gameName, password string)
}

type CompanionGameData

type CompanionGameData struct {
	GameName string
	Password string
}

type CompanionSupervisor

type CompanionSupervisor struct {
	// contains filtered or unexported fields
}

func NewCompanionSupervisor

func NewCompanionSupervisor(name string, bot *Bot, runFactory *run.Factory, statsHandler *StatsHandler, listener *event.Listener, c container.Container) (*CompanionSupervisor, error)

func (*CompanionSupervisor) JoinGame

func (s *CompanionSupervisor) JoinGame(gameName, password string)

func (CompanionSupervisor) Name

func (s CompanionSupervisor) Name() string

func (*CompanionSupervisor) Start

func (s *CompanionSupervisor) Start() error

Start will return error if it can not be started, otherwise will always return nil

func (CompanionSupervisor) Stats

func (s CompanionSupervisor) Stats() Stats

func (CompanionSupervisor) Stop

func (s CompanionSupervisor) Stop()

func (CompanionSupervisor) TogglePause

func (s CompanionSupervisor) TogglePause()

type GameStats

type GameStats struct {
	StartedAt  time.Time
	FinishedAt time.Time
	Reason     event.FinishReason
	Runs       []RunStats
}

type RunStats

type RunStats struct {
	Name        string
	Reason      event.FinishReason
	StartedAt   time.Time
	Items       []data.Item
	FinishedAt  time.Time
	UsedPotions []event.UsedPotionEvent
}

type SinglePlayerSupervisor

type SinglePlayerSupervisor struct {
	// contains filtered or unexported fields
}

func NewSinglePlayerSupervisor

func NewSinglePlayerSupervisor(name string, bot *Bot, runFactory *run.Factory, statsHandler *StatsHandler, listener *event.Listener, c container.Container) (*SinglePlayerSupervisor, error)

func (SinglePlayerSupervisor) Name

func (s SinglePlayerSupervisor) Name() string

func (*SinglePlayerSupervisor) Start

func (s *SinglePlayerSupervisor) Start() error

Start will return error if it can not be started, otherwise will always return nil

func (SinglePlayerSupervisor) Stats

func (s SinglePlayerSupervisor) Stats() Stats

func (SinglePlayerSupervisor) Stop

func (s SinglePlayerSupervisor) Stop()

func (SinglePlayerSupervisor) TogglePause

func (s SinglePlayerSupervisor) TogglePause()

type Stats

type Stats struct {
	StartedAt        time.Time
	SupervisorStatus SupervisorStatus
	Details          string
	Games            []GameStats
}

func (Stats) TotalChickens

func (s Stats) TotalChickens() int

func (Stats) TotalDeaths

func (s Stats) TotalDeaths() int

func (Stats) TotalErrors

func (s Stats) TotalErrors() int

func (Stats) TotalGames

func (s Stats) TotalGames() int

type StatsHandler

type StatsHandler struct {
	// contains filtered or unexported fields
}

func NewStatsHandler

func NewStatsHandler(name string, logger *slog.Logger) *StatsHandler

func (*StatsHandler) Handle

func (h *StatsHandler) Handle(_ context.Context, e event.Event) error

func (*StatsHandler) SetStatus

func (h *StatsHandler) SetStatus(status SupervisorStatus)

func (*StatsHandler) Stats

func (h *StatsHandler) Stats() Stats

type Supervisor

type Supervisor interface {
	Start() error
	Name() string
	Stop()
	TogglePause()
	Stats() Stats
}

type SupervisorManager

type SupervisorManager struct {
	// contains filtered or unexported fields
}

func NewSupervisorManager

func NewSupervisorManager(logger *slog.Logger, additionalEventHandlers []event.Handler) *SupervisorManager

func (*SupervisorManager) AvailableSupervisors

func (mng *SupervisorManager) AvailableSupervisors() []string

func (*SupervisorManager) Start

func (mng *SupervisorManager) Start(characterName string) error

func (*SupervisorManager) Status

func (mng *SupervisorManager) Status(characterName string) Stats

func (*SupervisorManager) Stop

func (mng *SupervisorManager) Stop(characterName string)

func (*SupervisorManager) TogglePause

func (mng *SupervisorManager) TogglePause(characterName string)

type SupervisorStatus

type SupervisorStatus string

const (
	NotStarted SupervisorStatus = "Not Started"
	Starting   SupervisorStatus = "Starting"
	InGame     SupervisorStatus = "In game"
	Paused     SupervisorStatus = "Paused"
	Crashed    SupervisorStatus = "Crashed"
)