engine

Documentation

Index

• Variables
• func FilterDedupe() func(*Line) *Line
• func InstallLogExe(ctx context.Context, gameRoot string) error
• type Engine
• type EngineFileInfo
  • func NewEngineFileInfo(path string, data []byte) *EngineFileInfo
• type EngineV2
• type FollowGameOptions
• type Line
  • func FilterJapaneseOnly(l *Line) *Line
  • func FilterNonEmpty(l *Line) *Line
  • func ParseLogLine(line string) (*Line, error)

Variables

var ErrInvalidLogLine = errors.New("invalid log line")

var ErrNoEngineFound = errors.New("no supported engine found")

Functions

func FilterDedupe

func FilterDedupe() func(*Line) *Line

func InstallLogExe

func InstallLogExe(ctx context.Context, gameRoot string) error

Types

type Engine

type Engine interface {
	Name() string
	InstallGame(dir string) (*game.Game, error)
	IsDirEngine(dir string) bool
	InstallTextHook(game *game.Game) error
	IsEngine(dir string) bool
	SetCustomPlugin(data string) error
	GetDefaultPlugin() string
	GetFile(g *game.Game, file string) (*EngineFileInfo, error)
}

type EngineFileInfo

type EngineFileInfo struct {
	Name       string
	Data       []byte
	MediaType  string // audio/ogg, audio/wav, audio/mpeg
	Ext        string // .ogg, .wav, .mp3
	SampleRate int
	Channels   int
	BitDepth   int
}

func NewEngineFileInfo

func NewEngineFileInfo(path string, data []byte) *EngineFileInfo

type EngineV2

type EngineV2 interface {
	Name() string

	IsEngine(dir string) bool
	//AddGame Will only work on games that have already been installed/ not the launcher
	// WIll need to set game fields based off the gr runner so we know what to run when we call run game
	AddGame(ctx context.Context, filepath string) (*game.Game, error)
	InstallHook(ctx context.Context, game *game.Game) error
	RunGame(ctx context.Context, game *game.Game) (*gr.Process, error)

	StopGame(ctx context.Context, proc *gr.Process) (*gr.Process, error)
	// GetFile will not be supported on TR
	GetFile(g *game.Game, file string) (*EngineFileInfo, error)

	FollowGameText(ctx context.Context, game *game.Game, opts ...FollowGameOptions) (chan Line, error)

	Shutdown() error
	ManagedGames() []*game.Game
	GetTextractor(game *game.Game) *textractor.Client // or nil for other engines
}

type FollowGameOptions

type FollowGameOptions struct {
	MaxLines int
	History  bool
	Filters  []func(l *Line) *Line
}

type Line

type Line struct {
	Raw     string
	Hook    string
	Text    string
	Speaker string
	Time    time.Time
	RawTime string
	Voice   string
}

func FilterJapaneseOnly

func FilterJapaneseOnly(l *Line) *Line

func FilterNonEmpty

func FilterNonEmpty(l *Line) *Line

func ParseLogLine

func ParseLogLine(line string) (*Line, error)